什么是 eslint
Eslint 是一个代码检查工具，能够帮助我们检查项目中的代码规范，避免常见的错误，提高代码质量。
eslint-find-rules 的作用
@akameco/eslint-find-rules 是一个用来查找指定项目中可用的 eslint 规则的工具。
安装
npm i -g @akameco/eslint-find-rules
如何使用
以下是一些已存在的规则和插件用于测试。
npm i -D \ eslint \ eslint-plugin-import \ eslint-config-airbnb-base
查找本地项目中可用的规则
eslint-find-rules ./package.json
输出将是所有找到的规则，格式如下：
- import/no-unresolved (import) Import paths are incorrect or it could not find a module to import - import/named (import) Ensure named imports correspond to a named export in the remote file - import/default (import) Ensure a default export is present, given a default import - ...
查找可用规则的详细信息
eslint-find-rules ./package.json --fields name,description,docs,url
该命令行选项将更详细地输出规则，包括规则名称，规则描述，文档地址和标准化规则的链接。
-- -------------------- ---- ------- - ---------- -------- --- -- --------- --------- ------------------------------------------------ - --------- -------- --- -- ------------------ -- ------------------ ----------------------------------------------- - -------------------- -------- ------- ------------ -- ---- ------- ---------------------------------------------------------- - ---展开代码
查找某个规则的详细信息
eslint-find-rules ./package.json --rule no-console
可以根据规则名称来查找详细信息，这里以禁用 console 为例。
Disallow console (no-console) Disallow the use of `console` [Docs](https://eslint.org/docs/rules/no-console)
如果你想在你的项目中使用这个规则，你可以添加一个 .eslintrc.js 文件，内容如下：
module.exports = { rules: { 'no-console': 'error' } }
这样，在你的项目中任何使用 console 的地方，eslint 都会提醒你，并显示错误信息。
总结
以上是 @akameco/eslint-find-rules 的使用教程，它可以帮助我们查找可用的 eslint 规则和了解规则的详细信息。在项目中启用这些规则可以让我们更容易遵守代码规范，提高代码质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb733b5cbfe1ea0611773
