Disable eslint rules for folder

Question

Is there a way to disable specific rules for a folder? For example, I don't want to have required JSDoc comments for all my test files in the test folder. Is there a way to do this?

eslint-babel seems to ignore any .eslint-ignore files and settings. — ivanixmobile, May 01 '18 at 04:14

score 469 · Accepted Answer · edited Apr 01 '19 at 23:20

469

To ignore some folder from eslint rules we could create the file .eslintignore in root directory and add there the path to the folder we want omit (the same way as for .gitignore).

Here is the example from the ESLint docs on Ignoring Files and Directories:

# path/to/project/root/.eslintignore
# /node_modules/* and /bower_components/* in the project root are ignored by default

# Ignore built files except build/index.js
build/*
!build/index.js

edited Apr 01 '19 at 23:20

Beau Smith

33,433
13
94
101

answered Oct 26 '17 at 06:29

YaTaras

5,159
1
20
15

98

This solution doesn't really answer the original question, which asks how to disable *specific* rules for a particular directory. Here you're disabling *all* rules for the given directories. Better answer is here: https://stackoverflow.com/a/41316801/882638 – ericgio Apr 10 '18 at 22:50
5

Excerpt from the [ESLint documentation](https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories) "_In addition to any patterns in a .eslintignore file, ESLint always ignores files in /node_modules/* and /bower_components/*._" So there's no need to add `/node_modules`, `/dist` alone is enough to exclude the both of the directories. Also glob pattern is supported whilst specifying (sub)directories. – ozanmuyes Aug 02 '18 at 12:43
Is there the way to do it with vue.config.js or package.json? – Serge Feb 08 '19 at 08:07
5

Is there anyway of configuring which directories to ignore in the `.eslintrc.json` configuration file itself so we don't need yet another .estlint file and we can inherit ignore values from an `eslint-config-myconfig` shared configuration? – Joshua Pinter Mar 13 '19 at 17:39
1

There are multiple similar posts on this. I needed: `--ignore-path` and/or `--ignore-pattern`, and I think that _also_ accurately answers this question. – Neil Gaetano Lindberg Jul 05 '19 at 17:02
Beware running `eslint src/**` because it somehow bypassed my `.eslinignore` file and caused an error because eslint was trying to apply its linter in subfolders where there was no files, and was crashing because of that. - Fixed it by running `eslint src/` instead – Vadorequest Dec 10 '19 at 17:28
3

To answer my own comment from a year ago, as of ESLint 6.7.0+, you can now use a top-level attribute `ignorePatterns` to provide an Array of patterns to ignore. Read the release announcement here: https://eslint.org/blog/2019/11/eslint-v6.7.0-released – Joshua Pinter May 11 '20 at 03:48

score 137 · Answer 2 · edited Nov 14 '21 at 00:15

137

The previous answers were in the right track, but the complete answer for this is going to be about disabling rules only for a group of files, there you'll find the documentation needed to disable/enable rules for certain folders (Because in some cases you don't want to ignore the whole thing, only disable certain rules). Example:

    {
        "env": {},
        "extends": [],
        "parser": "",
        "plugins": [],
        "rules": {},
        "overrides": [
          {
            "files": ["test/*.spec.js"], // Or *.test.js
            "rules": {
              "require-jsdoc": "off"
            }
          }
        ],
        "settings": {}
    }

edited Nov 14 '21 at 00:15

c69

19,951
7
52
82

answered Apr 23 '19 at 09:50

Alberto Perez

2,561
1
14
21

11

This answer is better because you can turn off a _specific_ rule for a given directory. Instead of just turning off all rules for a directory. – Storm Muller Sep 10 '19 at 10:38
6

This initially didn’t work for me. Make sure you don’t have a `.eslintrc.js` in that folder with an `extends: "../.eslintrc.js"`! – Florian Wendelborn Feb 23 '20 at 17:09
4

In this method, is there any solution to turn off all eslint for the folder? – Anand Feb 10 '21 at 11:58
4

This is the actual answer I was looking for in my search. – x1a4 Sep 28 '21 at 00:56

score 52 · Answer 3 · edited Jul 07 '23 at 11:46

52

In ESLint 6.7.0+ use "ignorePatterns": [].

You can tell ESLint to ignore specific files and directories using ignorePatterns in your config files.

example of .eslintrc.js

module.exports = {
  env: {
    // ...
  },
  extends: [
    // ...
  ],
  parserOptions: {
    // ...
  },
  plugins: [
    // ...
  ],
  rules: {
    // ...
  },
  ignorePatterns: ["src/test/*"], // <<< ignore all files in test folder
};

Or you can ignore files with some extension:

ignorePatterns: ['**/*.js']

You can read the user-guide doc here.

https://eslint.org/docs/user-guide/configuring/ignoring-code

edited Jul 07 '23 at 11:46

Fez Vrasta

14,110
21
98
160

answered Jul 15 '21 at 01:31

Grégori Fernandes de Lima

1,226
11
13

1

And notice that don't start your path with `./src/foo/bar`. Use `src/foo/bar` instead. – Kindred May 03 '22 at 01:53

score 3 · Answer 4 · edited Jun 20 '20 at 09:12

YAML version :

overrides:
  - files: *-tests.js
    rules:
      no-param-reassign: 0

Example of specific rules for mocha tests :

You can also set a specific env for a folder, like this :

overrides:
  - files: test/*-tests.js
    env:
      mocha: true

This configuration will fix error message about describe and it not defined, only for your test folder:

/myproject/test/init-tests.js
6:1 error 'describe' is not defined no-undef
9:3 error 'it' is not defined no-undef

Disable eslint rules for folder

4 Answers4

YAML version :

Example of specific rules for mocha tests :

Linked