1# JavaScript and SASS
2This project uses the following libraries to determine the best practices and
3guidelines for both SCSS and JavaScript syntax.
4- [ESLint](https://eslint.org/)
5- [Prettier](https://prettier.io/)
6- [ESLint Plugin for Vue](https://eslint.vuejs.org/)
7
8The guidelines we are following are:
9- [Vue
10  Recommended](https://eslint.vuejs.org/rules/#priority-c-recommended-minimizing-arbitrary-choices-and-cognitive-overhead-for-vue-js-3-x)
11- [ESLint Recommended](https://eslint.org/docs/rules/)
12- [Prettier](https://prettier.io/docs/en/options.html)
13
14The rules are applied in the following order:
151. Vue rules
161. ESLint recommended
171. Prettier
18
19## Overrides
20Any overrides to a rule are located in the ESLint configuration file,
21`.eslintrc.js`, located in the root directory.
22
23## Running the lint test
24To test all files for linting, run `npm run lint`. This command will evaluate
25the syntax of all files and update any code that that does not require manual
26review.
27
28The linting script runs when code is committed,  during pre-commit, and when the
29CI tool runs after a push to Gerrit. There is a shell script named
30`format-code.sh` that installs node package dependencies and runs the test
31script in your CI.