README.md

⬡ Node.js linters

📖 How to use

Download repo via git subtree (see here). Customize configurations files (if needed).

• ESLint

To use locally, install these dependencies:

npm i -D eslint
npm run lint-config-install

To run:

npm run lint

• Stylelint

To use locally, install these dependencies:

npm i -D stylelint
npm run lint-scss-config-install

To run:

npm run lint-scss

• (Opt.) Prettier

To use locally, enable configurations and customize

• Enable/disable eslint-config-prettier in ESlint config file Install these dependencies:

npm i -D prettier

To run:

npm run formatter

💻 How to configure your IDE

Since linters configurations aren't directly in the project tree, if you use liting plugins in your editor, you have to instruct them about correct path. Here are some examples:

• VSCode

In .vscode/settings.json

{
    "editor.formatOnSave": true,
    "eslint.options": {
        "overrideConfigFile": ".github/configurations/node_linters/eslint/.eslintrc.json"
    },
    "eslint.format.enable": true,
    "stylelint.configFile": ".github/configurations/node_linters/stylelint/.stylelintrc.json",
    "stylelint.validate": ["css", "less", "postcss", "scss"],
    "stylelint.snippet": ["css", "less", "postcss", "scss"],
    "prettier.configPath": ".github/configurations/node_linters/prettier/.prettierrc.js",
    "editor.semanticHighlighting.enabled": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "[javascriptreact]": {
        "editor.defaultFormatter": "dbaeumer.vscode-eslint"
    },
    "[javascript]": {
        "editor.defaultFormatter": "dbaeumer.vscode-eslint"
    }
}