CODEWITHSUNDEEP
eslint
Kevin Amiranoff
Kevin Amiranoff

Reputation: 14543

ESLint ignore specific rule for a specific directory

Is it possible with ESLint to ignore one specific rule for an entire directory?

In my case, I would like to ignore import/prefer-default-export for a directory named commonComponents

Upvotes: 100

Views: 63089

Answers (4)

user2226755
user2226755

Reputation: 13223

YAML version :

rules:
  no-unused-expressions: true

overrides:
  - files: *-tests.js
    rules:
      no-unused-expressions: false

Upvotes: -2

cartant
cartant

Reputation: 58430

ESLint configuration (.eslintrc) files are hierarchical:

ESLint will automatically look for them in the directory of the file to be linted, and in successive parent directories all the way up to the root directory of the filesystem. This option is useful when you want different configurations for different parts of a project or when you want others to be able to use ESLint directly without needing to remember to pass in the configuration file.

You can disable the import/prefer-default-export rule for the commonComponents directory by creating a .eslintrc file with the following content in that directory:

{
    "rules": {
        "import/prefer-default-export": "off"
    }
}

Upvotes: 177

Patrick
Patrick

Reputation: 7205

You can also use the "overrides" key to declare rules for different glob patterns.

Have a read of Configuration Based on Glob Patterns

Sometimes a more fine-controlled configuration is necessary, for example if the configuration for files within the same directory has to be different. Therefore you can provide configurations under the overrides key that will only apply to files that match specific glob patterns, using the same format you would pass on the command line (e.g., app/**/*.test.js).

I use this to remove the no-unused-expressions rule from my test files like so;

"overrides": [{
  "files": [ "*.spec.js" ],
  "rules": {
    "no-unused-expressions": 0
  }
}]

Upvotes: 115

tibalt
tibalt

Reputation: 16184

If there are multiple directories that you want to apply your rules to, then you can create different configs for different purposes. For example:

  • .eslintrc.json for common config
  • .eslintrc-main.json for main linting and run eslint -c .eslintrc-main src test
  • .eslintrc-comp.json for components and run eslint -c .eslintrc-comp commonComponents fooBarComponent

Upvotes: 3

Related Questions