ESLint 是一款用于确保代码风格一致和减少错误的静态分析工具。当我们在开发前端项目时，使用 ESLint 可以帮助我们避免一些低级错误并保持代码一致性。
但是，eslint 的配置可以是十分繁琐的，尤其是对于那些初学者。因此，我们可以采用一些预先配置好的 eslint 配置来简化我们的工作。
这篇文章将会介绍 eslint-config-crocodile 这个 npm 包，并指导您如何将其添加到您的项目中。
什么是 eslint-config-crocodile
Eslint-config-crocodile 是一个预设 eslint 配置，它包含了一些常用的 eslint 配置项和 plugin，它是为了方便项目中新手开发者和老手的使用。
并且，这个配置了 TypeScript、React、prettier 的 eslint-config-crocodile ，我相信能满足大部分开发者的需求。当然，如果你对它的配置不满意，你也可以对它进行调整。
如何使用 eslint-config-crocodile
- 安装 eslint-config-crocodile
npm install eslint-config-crocodile --save-dev
- 安装 Eslint
eslint-config-crocodile 是 eslint 的一个配置，因此需要先安装 eslint。
npm install eslint --save-dev
- 创建
.eslintrc.js文件
在项目根目录下创建一个 .eslintrc.js 文件，并将以下代码添加到文件中。
module.exports = {
"extends": [
"eslint-config-crocodile"
]
}甚至你可以通过添加插件和规则来自定义你的 .eslintrc.js 文件。例如：
-- -------------------- ---- -------
-------------- - -
---------- -
-------------------------
--
-------- -
------------- -----
--
---------- -
-------------
-
-以上的规则禁用了 no-console 规则，而插件 react-hooks 也被引入了。
- 运行 eslint
然后，您就可以在项目的根目录下运行 eslint，以确保您符合您的 eslint 配置了。
./node_modules/.bin/eslint yourfile.js
总结
本文介绍了如何使用 eslint-config-crocodile 将 eslint 的配置简化，并用示例代码展示了如何在项目中使用它。当然，本文还展示了如何通过添加插件和规则来自定义您的 eslint 配置文件。
通过使用 eslint-config-crocodile ，您可以让您的项目变得更易维护和一致，同时也可以让您节省大量配置时间，欢迎尝试~
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f393748dbf7be33b2566fc3