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