diff --git a/docs/contributing.md b/docs/contributing.md index 3845862f..e4861948 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -5,7 +5,30 @@ 3. Write tests 4. Make a pull-request to the core repo -# Project features and feature requests +## linter + +We use [eslint](https://eslint.org) as our linter. It enforces code-style and best-practices + +We don't allow bad code into the repo. To ensure this we run [eslint](https://eslint.org) on `CI`. + +The configuration for the [eslint](https://eslint.org) is found under `package.json` + +**Available CLI-commands:** + + - `yarn lint` lint whole project <- this command runs on CI + - `yarn run eslint ` check files in `` + - `yarn run eslint --fix ` check files in `` and fix them if possible + +**Editor integrations:** + +[Webstorm integration:](https://plugins.jetbrains.com/plugin/7494-eslint) + +[VSCode integration:](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + +[Other editors](https://eslint.org/docs/user-guide/integrations#editors) + + +# Project features and feature requests. Features that aren't checked are available to take diff --git a/docs/getting-started-adv.md b/docs/getting-started-adv.md index 5c29ccf0..d7b1fbf7 100644 --- a/docs/getting-started-adv.md +++ b/docs/getting-started-adv.md @@ -233,28 +233,6 @@ node ./bin/run-multiple-apps @app/ex02back @app/ex02front @app/ex03sockeio Every app should have `multi-app-support.js` file. Check `ex02back`, `ex02front` and `ex02sockio` examples. -## linter - -We use [eslint](https://eslint.org) as our linter. It enforces code-style and best-practices - -We don't allow bad code into the repo. To ensure this we run [eslint](https://eslint.org) on `CI`. - -The configuration for the [eslint](https://eslint.org) is found under `package.json` - -**Available CLI-commands:** - - - `yarn lint` lint whole project <- this command runs on CI - - `yarn run eslint ` check files in `` - - `yarn run eslint --fix ` check files in `` and fix them if possible - -**Editor integrations:** - -[Webstorm integration:](https://plugins.jetbrains.com/plugin/7494-eslint) - -[VSCode integration:](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - -[Other editors](https://eslint.org/docs/user-guide/integrations#editors) - ## Tips ### yarn add