使用 ESLint 可以规范 JavaScript 代码风格，但在实际项目中，我们经常会遇到一个问题：配置文件修改了，但是并没有生效。这时候，我们需要在项目中添加 eslintignore 文件来解决。

为什么需要 eslintignore 文件

ESLint 在检查代码时，默认会检查项目中的所有文件。但是我们有些文件不需要检查，例如第三方库、测试文件、构建产物等。如果没有忽略这些文件，ESLint 可能会给我们许多无用的警告，影响开发效率。

添加 eslintignore 文件

在项目根目录下添加 eslintignore 文件，文件名必须是 eslintignore。在这个文件中，可以添加需要忽略的文件或者目录，支持通配符。例如：

node_modules/
build/
dist/
*.log

上述配置中，忽略了 node_modules、build、dist 目录和所有后缀为 .log 的文件。

注意事项

• eslintignore 文件中的路径，以项目根目录为起点。因此，如果在 eslintignore 文件中写相对路径，要保证路径是相对于项目根目录的。
• eslintignore 文件中的注释符号是 #，不是 //。如果使用了 //，ESLint 不会将该行视为注释，而是检查该行代码，可能会导致报错。
• 如果同时存在一个 .eslintignore 文件和 eslintignore 文件，ESLint 会优先使用 .eslintignore 文件。
• 如果你已经知道某个文件或者文件夹下面的文件不需要进行 ESLint 检查，可以在 code editor 的设置中将其排除。例如在 VS Code 中，在 settings.json 中添加以下配置：

"eslint.options": {
    "ignorePatterns": [
        "**/node_modules/*",
        "**/build/*",
        "**/dist/*",
        "**/*.log"
    ]
},

示例代码

以下是一个示例 .eslintignore 文件：

-- -------------------- ---- -------
- -- ----------------------- --
-------------
------
-----

- ---- --- --
-----

- -------
--------------------

总结

通过添加 eslintignore 文件，可以让 ESLint 只对需要检查的文件生效，提高了我们的开发效率。在实际开发中，要根据项目情况灵活使用 eslintignore 文件，避免不必要的警告和错误。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/648671e548841e9894500c07