.eslintignore 文件

239 阅读1分钟

.eslintignore 文件中,列出不需要 ESLint 校验的文件或目录,可以防止 ESLint 检查一些不必要的文件(比如打包产物或第三方库),从而提高性能并避免不相关的错误提示。

配置 .eslintignore 文件

如果你想让 ESLint 忽略打包的产物和 node_modules 目录,可以在 .eslintignore 文件中添加以下内容:

dist
node_modules

解释

  • dist:通常是构建(打包)产物所在的目录,包含了编译后的代码或构建后的文件。你通常不希望 ESLint 对这些文件进行检查,因为它们通常是自动生成的,并且不包含开发中的源代码。

  • node_modules:这是所有依赖包的存放目录。由于这些包是第三方的,而且已经由其他工具(如 Babel、TypeScript 等)进行了预处理,你也不需要 ESLint 去检查这些代码。

.eslintignore 文件的工作原理

.eslintignore 文件的作用与 .gitignore 类似,用于指定哪些文件和目录不应被 ESLint 检查。该文件位于项目的根目录下,ESLint 会根据该文件来排除相关文件和目录。

示例 .eslintignore 文件

# 忽略构建产物目录
dist/

# 忽略 node_modules 目录
node_modules/
  • 每一行可以是一个路径,表示要忽略的文件或目录。
  • 你还可以使用 glob 模式 来更灵活地匹配文件路径,如:
    • *.min.js:忽略所有以 .min.js 结尾的文件。
    • **/*.test.js:忽略所有子目录中的 .test.js 文件。

总结

.eslintignore 文件中加入 distnode_modules 目录,可以防止 ESLint 在检查代码时扫描这些文件,从而提高效率并避免不必要的错误或警告。