eslint-config-varp

Go in

1. Setup

2. User cases:

   • Override rules
   • Ignore path

3. Notes

Setup

1. Install:

npm install -D eslint-config-varp

2. Create .prettierrc.js file with content:

module.exports = {
  /* Rrettier rules */
};

3. Create .eslintrc.js file with content:

module.exports = {
  extends: ["varp"],
  rules: {
    /* Eslint rules */
  }
};

4. Add .vscode/settings.json file with content:

{
  "editor.tabSize": 2,
  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
  "eslint.format.enable": true,
  "editor.codeActionsOnSave": {      
    "source.fixAll.eslint": "always"
  },
  "eslint.validate": ["typescript", "typescriptreact", "javascript", "javascriptreact", "markdown", "json"],
}

5. Add new scripts to package.json:

"scripts": {
  "lint": "eslint .",
  "lint:fix": "eslint . --fix"
}

User cases

Override rules

• Add overrides property in config file

module.exports = {
  overrides: [
    {
      files: ["*/**/*.js"],
      rules: {
        /* Overrided rules */
      },
    },
  ],
};

Override rules with file

• Create file in selected folter: .eslintrc.js
• Add content:

module.exports = {
  extends: '../.eslintrc.js',
  rules: {
    /* Overrided rules */
  }
};

Override rules for the folder

overrides: [ 
  {
    files: ["folder/**/*.js"],
    rules: {
    /* Overrided rules */
    }
  }
]

Ignore path

• Create file: .eslintignore
• Add content:

disc

Notes

• typescript package is not on peerDependencies, but it require to be on the project.