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