禁用文件夹的eslint规则

时间:2017-02-15 13:06:04

标签: eslint

有没有办法禁用文件夹的特定规则?例如,我不想对userId文件夹中的所有测试文件都要求JSDoc注释。有没有办法做到这一点?

5 个答案:

答案 0 :(得分:166)

要忽略eslint规则中的某些文件夹,我们可以在根目录中创建文件.eslintignore,并在那里添加我们想要省略的文件夹的路径(与.gitignore相同)。

以下是Ignoring Files and Directories上的ESLint文档中的示例:

# 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

答案 1 :(得分:2)

在 ESLint 6.7.0+ 中使用“ignorePatterns”:[]。

您可以在配置文件中使用 ignorePatterns 告诉 ESLint 忽略特定文件和目录。

.eslintrc.js 示例

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

或者你可以忽略带有一些扩展名的文件:

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

您可以在此处阅读用户指南文档。

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

答案 2 :(得分:1)

YAML版本:

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

摩卡测试特定规则示例:

您还可以为文件夹设置特定的环境,例如:

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

此配置将修复仅针对您的测试文件夹未定义的关于describeit的错误消息:

/myproject/test/init-tests.js
6:1 错误'describe'未定义no-undef
9:3 错误“它”没有定义为un-undef

答案 3 :(得分:0)

答案 4 :(得分:0)

先前的答案在正确的轨道上,但是完整的答案将转到Disabling rules only for a group of files,您将在其中找到禁用/启用某些文件夹规则所需的文档(因为在某些情况下,不想忽略整个事情,只禁用某些规则)。示例:

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