From 736f2a4b3c5569f3e2644525845245477e7ba2ff Mon Sep 17 00:00:00 2001 From: Derick Montague Date: Mon, 26 Oct 2020 14:22:31 -0500 Subject: Add coding standards overview page Signed-off-by: Derick Montague Change-Id: I2dd0fb44a78da62864442fd633654a3e4f887184 --- docs/guide/coding-standards/readme.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/guide/coding-standards/readme.md (limited to 'docs/guide') diff --git a/docs/guide/coding-standards/readme.md b/docs/guide/coding-standards/readme.md new file mode 100644 index 00000000..dae3a8ad --- /dev/null +++ b/docs/guide/coding-standards/readme.md @@ -0,0 +1,23 @@ +# Overview +This project uses the following libraries to determine the best practices and guidelines for both SCSS and JavaScript syntax. +- [ESLint](https://eslint.org/) +- [Prettier](https://prettier.io/) +- [ESLint Plugin for Vue](https://eslint.vuejs.org/) + +The guidelines we are following are: +- [Vue Recommended](https://eslint.vuejs.org/rules/#priority-c-recommended-minimizing-arbitrary-choices-and-cognitive-overhead-for-vue-js-3-x) +- [ESLint Recommended](https://eslint.org/docs/rules/) +- [Prettier](https://prettier.io/docs/en/options.html) + +The rules are applied in the following order: +1. Vue rules +1. ESLint recommended +1. Prettier + +## Overrides +Any overrides to a rule are located in the ESLint configuration file, `.eslintrc.js`, located in the root directory. + +## Running the lint test +To 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. + +The 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. \ No newline at end of file -- cgit v1.2.3