前言
随着前端工程化的流行，我们使用的 npm 包也越来越多。其中有一个 npm 包叫做 cj-checklist，是一个方便检查项目中常见问题的工具。在这篇文章中，我们将介绍如何使用 cj-checklist 包来检查常见的问题，并给出一些实际的使用案例。
安装 cj-checklist 包
在开始使用 cj-checklist 包之前，需要先进行安装。在命令行终端中输入以下命令即可完成安装：
npm install cj-checklist --save-dev
使用 cj-checklist 包
在命令行终端中使用
安装完成后，在命令行终端中输入以下命令即可使用 cj-checklist 包：
npx cj-checklist
这个命令将在项目中检查和报告一系列的问题，比如：
- 检查文件和文件夹的命名是否符合规范；
- 检查代码中是否存在未使用的变量或函数；
- 检查代码中是否存在不安全的函数。
在 VS Code 中使用
除了在命令行终端中使用外，也可以在 VS Code 中安装 cj-checklist 插件。安装完插件后，在 VS Code 的侧边栏中可以找到 cj-checklist 插件的图标。点击这个图标即可开始检查项目中的问题。
配置文件
cj-checklist 还提供了一个配置文件，方便我们自定义需要检查的内容。默认情况下，cj-checklist 将会检查大部分的常见问题，但是如果不需要其中的某些检查，可以自定义配置文件。在项目的根目录下新建一个名为 .cj-checklist.json 的配置文件，按照以下格式进行配置：
{
"ignoredRules": ["no-unused-variables", "no-unsafe-funcs"]
}在这个配置文件中，ignoredRules 参数可以传入一个数组，里面存放着需要忽略的检查项的 ID。具体的检查项 ID 可以在 cj-checklist 的官方文档中找到。
实际案例
示例一：检查文件命名是否符合规范
在项目中，我们经常需要对文件进行命名。按照规范命名可以帮助我们更好地组织代码，并且方便其他人阅读我们的代码。使用 cj-checklist，我们可以检查项目中是否存在不符合命名规范的文件。
首先，在我们的项目中新建一个名为 BAD_FILE_NAME.html 的文件，这个名字显然违反了命名规范。然后在命令行终端中输入：
npx cj-checklist
cj-checklist 将会返回如下的检查结果：
┌─────────┬───────────────────────┬─────────────────────────────────────┐ │ (index) │ rule │ filePath │ ├─────────┼───────────────────────┼─────────────────────────────────────┤ │ 0 │ 'bad-file-name-html' │ '/Users/chengjue/Documents/test/BAD_FILE_NAME.html' │ └─────────┴───────────────────────┴─────────────────────────────────────┘
这个结果表明我们刚刚建立的 BAD_FILE_NAME.html 文件存在命名问题。
示例二：检查代码中是否存在未使用的变量或函数
在前端开发中，我们经常会遇到代码中定义了变量或函数，但是却没有使用的情况。这些未使用的代码可能影响我们的代码质量和可维护性。使用 cj-checklist，我们可以检查项目中是否存在这样的问题。
假设在我们的项目中存在下面这段代码：
function foo() {
return 'hello world';
}
const unusedVar = 123;
console.log(foo());在命令行终端中输入：
npx cj-checklist
我们将会得到如下的结果：
┌─────────┬────────────────────┬─────────────────────────────┐ │ (index) │ rule │ filePath │ ├─────────┼────────────────────┼─────────────────────────────┤ │ 0 │ 'no-unused-funcs' │ '/Users/chengjue/Documents/test/test.js' │ │ 1 │ 'no-unused-vars' │ '/Users/chengjue/Documents/test/test.js' │ └─────────┴────────────────────┴─────────────────────────────┘
cj-checklist 发现了 unusedVar 变量和 foo() 函数没有被使用，所以返回了这两个未使用的代码相关信息。
总结
cj-checklist 可以帮助我们在项目中发现诸如文件命名不规范、未使用的变量或函数等问题。通过定期使用 cj-checklist，我们可以提高代码的质量和可维护性，从而更好地开发出高质量的项目。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562e781e8991b448e08c7