前言
在前端开发过程中，代码规范是非常重要的一环。eslint 是目前比较常用的代码规范检查工具之一，而 eslint-config-substandard 则是针对 Substandard.js 规范的 eslint 配置。本篇文章将为读者介绍如何使用 eslint-config-substandard 并解析其中的规范。
安装
我们可以直接在 npm 上找到 eslint-config-substandard 并进行安装。
npm install eslint-config-substandard --save-dev
安装完成之后，在项目根目录下创建 .eslintrc.js 文件，并在里面添加如下代码：
module.exports = {
extends: 'substandard',
rules: {
// 在这里自定义规则覆盖默认配置
}
}规范解析
下面解析一下 eslint-config-substandard 中定义的规范。
1. 缩进
默认情况下，eslint-config-substandard 中缩进的空格为两个。
-- -------------------- ---- ------- -- ---- -- ------ - -------------------- - -- ---- -- ------ - -------------------- -
2. 分号
在 eslint-config-substandard 中，分号是必须的。
// 正确示例 let name = 'Lucas'; // 错误示例 let name = 'Lucas'
3. 引号
eslint-config-substandard 中，字符串统一使用单引号。
// 正确示例 let name = 'Lucas'; // 错误示例 let name = "Lucas";
4. 括号
eslint-config-substandard 中，括号不允许省略。if 和 while 的小括号必须和它们关联的语句在同一行。
-- -------------------- ---- ------- -- ---- -- ------ - -------------------- - -- ---- -- ------ - -------------------- -
5. 对象和数组
对象和数组的元素末尾不允许有逗号。
-- -------------------- ---- ------- -- ---- --- --- - --- -- --- --- --- - - ----- -------- ---- -- - -- ---- --- --- - --- -- ---- --- --- - - ----- -------- ---- --- -
常用规则
下面列出几条常用的规则。
1. 禁止使用 var 声明变量
"no-var": "error"
2. 强制使用 const 声明常量
"prefer-const": "error"
3. 禁止使用未定义变量
"no-undef": "error"
4. 禁止使用 console.log 和 debugger
"no-console": "error", "no-debugger": "error"
总结
本篇文章主要介绍了如何使用 eslint-config-substandard 并解析了其中的规范细则。开发者可以通过安装该 npm 包，并按照规范定义 .eslintrc.js 文件配置来约束代码风格，从而更好地保证代码的可维护性和可读性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005591481e8991b448d6840