禁用文件夹的eslint规则

Question

有没有办法禁用文件夹的特定规则？例如，我不想在test文件夹中为我的所有测试文件提供必需的JSDoc注释。有办法做到这一点吗？

Answer 1

在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

Answer 2

前面的答案是在正确的轨道上，但完整的答案是关于禁用规则只对一组文件，在那里你会发现需要的留档禁用/启用某些文件夹的规则（因为在某些情况下你不想忽略整个事情，只禁用某些规则）。示例：

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

Answer 3

要从eslint规则中忽略某些文件夹，我们可以在根目录中创建文件.eslintignore，并在那里添加要忽略的文件夹路径（与.gitignore的方法相同）。

以下是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