概述
在编写 Node.js 应用程序时，为了保持代码风格的一致性，我们需要使用 eslint（一种基于 JavaScript 的静态代码分析工具）来规范我们的代码风格。
@nmjs/eslint-config-node 便是一个专门为 Node.js 应用程序编写的 eslint 配置文件包。它集成了众多优秀的 eslint 规则，并对 Node.js 应用程序开发过程中的常见问题进行了覆盖，可以帮助我们快速地将 Node.js 应用程序的代码规范化。
本文将会详细讲解如何使用 @nmjs/eslint-config-node 包，在我们的 Node.js 应用程序中实现代码规范化。
安装
在使用 @nmjs/eslint-config-node 之前，我们需要先安装一些必要的依赖。
npm install --save-dev eslint @nmjs/eslint-config-node
使用
我们可以在 eslint 的配置文件（一般为 .eslintrc）中配置 @nmjs/eslint-config-node。
1. 创建 .eslintrc.js 文件
在项目根目录下创建一个 .eslintrc.js 文件。
module.exports = {
env: {
node: true
},
extends: [
'@nmjs/node'
]
}2. 配置 eslintignore 文件
忽略一些不需要检测的文件。
echo 'node_modules' >> .eslintignore echo '.vscode' >> .eslintignore echo 'coverage' >> .eslintignore
3. 配置 npm scripts
打开 package.json，添加一些 npm scripts，用于检测代码。
{
"scripts": {
"lint": "eslint ."
}
}通过运行 npm run lint 命令，就可以对项目代码进行检测了。
示例
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------- - ------------------- ----- --- - ---------- ----- ------ - ----------------------- ------------ ----- ---- -- - --------------- --------- --- ------------------- -- -- - -------------------- --- --------- -- ---- -------- ---
这是一个非常简单的 Express 应用程序示例代码。假设我们的文件名为 app.js。
使用 npm run lint 命令进行检测：
npm run lint app.js
输出如下：
/Users/myProject/app.js 7:27 warning Missing function expression name func-names 7:41 error Arrow function should not return assignment no-return-assign ✖ 2 problems (1 error, 1 warning)
说明代码中存在两个问题：缺少函数表达式的名称，并且箭头函数不应该返回赋值。
我们可以根据错误提示进行相应的修改，以达到代码规范化的目的。
总结
在本文中，我们介绍了 @nmjs/eslint-config-node 的 npm 包的使用方法，方便我们快速地将 Node.js 应用程序的代码规范化。同时，也详细地讲解了如何配置 eslint 配置文件、eslintignore 文件以及 npm scripts 文件，以便于您更好地使用 eslint 工具。希望本文对您有所指导帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f86238a385564ab6ccb