在前端开发中，我们经常需要对代码进行重构和优化。这个过程中，一个好的 coding style 可以帮助我们更好地维护和管理代码。在代码的清洁和规范方面，npm 包 code-janitor 是非常好的一个工具。
简介
code-janitor 是一个轻量级的代码审查工具，用于在项目中查找代码中的问题，并提供一些自动修复的选项。它可以检查 JavaScript 和 TypeScript 代码，并提供一套预定义的规则，例如检查代码中的空格、缩进、命名、格式等。通过使用 code-janitor，可以使代码更具可读性、清晰易懂。
在本文中，我们将介绍如何使用 code-janitor，包括下载、安装和使用。
安装
安装 code-janitor，你可以在你的终端中运行以下命令：
npm install code-janitor --save-dev
使用
配置文件
一旦 code-janitor 安装完成，你将需要一个配置文件。code-janitor 的配置文件使用 JSON 格式，其中包括要检查的文件和检查规则。
你可以在项目根目录下创建一个名为 .codejanitor.json 的文件。配置文件的格式示例如下：
-- -------------------- ---- -------
-
------- --------------- ----------------
-------- -
-------- -
------------------------------
-
---------- -----
--------- ------
-------- ----
-
--
--------- ----------
-
-在配置文件中，find 属性指定了要检查的文件，可以是数组或单个字符串，支持 glob 模式。rules 属性指定了检查规则，您可以从规则列表中选择所需的规则。可以为每个规则指定选项，以更改其行为。
检查代码
运行 code-janitor 命令，可以检查代码，并输出相应提示。您可以找到问题并决定是否修复。修复选项在输出中也会被呈现。运行以下命令：
./node_modules/.bin/codejanitor
或者，您可以将这个命令放入 package.json，以便更轻松的引用：
{
"scripts": {
"check": "codejanitor"
}
}然后可以在终端中输入 npm run check 命令执行检查。
自动修复
使用 --fix 选项，code-janitor 可以自动修复一些问题，例如空格或缩进。要自动修复问题，请运行以下命令：
./node_modules/.bin/codejanitor --fix
或者，您可以使用 package.json，将这个命令放入：
{
"scripts": {
"fix": "codejanitor --fix"
}
}然后可以在终端中输入 npm run fix 命令自动修复。
示例代码
检查 JavaScript
以下示例代码展示如何使用 code-janitor 检查 JavaScript 代码：
// demo.js
function test () {
console.log('Hello, World!');
}创建 .codejanitor.json 文件：
-- -------------------- ---- -------
-
------- ------------
-------- -
-------------- -
-----
--------
-
-
-然后在终端中输入 ./node_modules/.bin/codejanitor 命令运行检查，输出结果：
demo.js
1:1 error Expected indentation to be 4 spaces but found 2 indentation修复 JavaScript
要自动修复问题，请将 --fix 选项添加到命令中，并运行以下命令：
./node_modules/.bin/codejanitor --fix
输出结果：
demo.js
1:1 fixed Expected indentation to be 4 spaces but found 2 indentation此时，demo.js 文件中代码的缩进已自动修复。
检查 TypeScript
以下示例代码展示如何使用 code-janitor 检查 TypeScript 代码：
// demo.ts
class Test {
public sayHello() {
console.log('Hello, World!');
}
}创建 .codejanitor.json 文件：
-- -------------------- ---- -------
-
------- ------------
-------- -
-------------- -
-----
------
-
-
-运行检查：
./node_modules/.bin/codejanitor
输出结果：
demo.ts
1:1 error Expected indentation to be tabs but found 2 spaces indentation修复 TypeScript
继续添加 --fix 选项，并运行以下命令：
./node_modules/.bin/codejanitor --fix
输出结果：
demo.ts
1:1 fixed Expected indentation to be tabs but found 2 spaces indentation此时，demo.ts 文件中代码的缩进已由 2 个空格改为 tab，以符合规则。
结语
在本文中，我们已经介绍了如何使用 npm 包 code-janitor 对 JavaScript 和 TypeScript 代码进行审查和自动修复。使用这个工具可以帮助我们在开发项目时保持代码的清洁和统一。如果你想更深入地了解 code-janitor，可以查看其官方文档。
如果这篇文章能帮到您，欢迎在下面留言。如果有任何问题或建议，欢迎提出来。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60057c4881e8991b448ebcde