项目规范及工具
集成 EditorConfig
EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。
在项目根目录下增加 .editorconfig 文件， 并配置以下内容：
# Editor configuration, see http://editorconfig.org
# 表示是最顶层的 EditorConfig 配置文件
root = true
# 表示所有文件适用
[*]
# 设置文件字符集为 utf-8
charset = utf-8
# 缩进风格（tab | space）
indent_style = space
# 缩进大小
indent_size = 4
# 控制换行类型(lf | cr | crlf)
end_of_line = lf
# 去除行首的任意空白字符
trim_trailing_whitespace = true
# 始终在文件末尾插入一个新行
insert_final_newline = true
# md 文件适用以下规则
[*.md]
max_line_length = off
trim_trailing_whitespace = false
yaml
::: tip 注意
VSCode 使用 EditorConfig 需要去插件市场下载插件 EditorConfig for VS Code 。WebStorm 则不需要安装，直接使用 EditorConfig 配置即可。
:::
集成 Prettier
Prettier 是一款强大的代码格式化工具，支持
JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具。
- 安装 Prettier
$ npm i prettier -D
shell
- 创建 Prettier 配置文件
Prettier 支持多种格式的配置文件，比如
.json、.yml、.yaml、.js等。 在本项目根目录下创建.prettierrc文件。 - 配置
.prettierrc在本项目中，进行如下简单配置，关于更多配置项信息，请前往官网查看 Prettier-Options 。
{
"useTabs": false,
"tabWidth": 4,
"printWidth": 100,
"singleQuote": true,
"trailingComma": "none",
"bracketSpacing": true,
"semi": false
}
json
Prettier 安装且配置好之后，就能使用命令来格式化代码
- 格式化所有文件（. 表示所有文件）
$ npx prettier --write .
shell
::: tip 注意
VSCode 编辑器使用 Prettier 配置需要下载插件 Prettier - Code formatter； WebStorm 则不需要安装，直接使用 EditorConfig 配置即可。
:::
集成 ESLint
ESLint 是一款用于查找并报告代码中问题的工具，并且支持部分问题自动修复。其核心是通过对代码解析得到的 AST（Abstract Syntax Tree 抽象语法树）进行模式匹配，来分析代码达到检查代码质量和风格问题的能力。
使用 ESLint 可以尽可能的避免团队成员之间编程能力和编码习惯不同所造成的代码质量问题，一边写代码一边查找问题，如果发现错误，就给出规则提示，并且自动修复，长期下去，可以促使团队成员往同一种编码风格靠拢。
- 安装 eslint
$ npm i -D eslint
shell
- 配置 ESLint
ESLint 安装成功后，执行
npx eslint --init，然后按照终端操作提示完成一系列设置来创建配置文件。
- How would you like to use ESLint? ...(你想如何使用 ESLint?…)
我这里选择第三个，检查语法，发现问题，并强制代码样式
- What type of modules does your project use? ... （你的项目使用什么类型的模块?…）
项目支持 es6+语法，所以这里就直接选用第一项：JavaScript modules (import/export)
- Which framework does your project use? ... （你的项目使用哪种框架?…）
这里并未使用 vue 和 react，所以选择 none of these
- Does your project use TypeScript? (你的项目使用 TypeScript 吗?)
项目中并没有使用 Typescript，所以选择 No
- Where does your code run?(你的代码在哪里运行?)
这是 node 项目，所以不需要选择浏览器环境
- How would you like to define a style for your project? ... (你想怎样为你的项目定义风格？)
这里选择 Use a popular style guide（使用一种流行的风格指南）
- Which style guide do you want to follow? ... (你想遵循哪种风格指南?…)
- What format do you want your config file to be in? ... (您希望配置文件的格式是什么?…)
我这里选择 JavaScript
- Would you like to install them now with npm?（你想现在用 npm 安装它们吗?）
默认 Yes，所以可以直接回车
- 所有配置如下
安装成功后，项目的根目录就会多一个.eslintrc.js文件，其中的内容就是在终端中选择的相应配置。
::: tip 注意
VSCode 使用 ESLint 配置文件需要去插件市场下载插件 ESLint 。
:::
Webpack 中使用 ESLint(不推荐)
首先需要安装eslint-loader：
npm install -D eslint-loader
bash
然后在 webpack.config.js 中module.rules添加如下代码：
{
test: /\.js$/,
loader: 'eslint-loader',
enforce: 'pre',
include: [path.resolve(__dirname, 'src')], // 指定检查的目录
options: { // 这里的配置项参数将会被传递到 eslint 的 CLIEngine
formatter: require('eslint-friendly-formatter') // 指定错误报告的格式规范
}
}
js
- ESLint 的配置单独做了一个 Webpack 的
module.rule配置，所以使用了enforce: 'pre'来调整了 loader 加载顺序，保证先检测代码风格，之后再做 Babel 转换等工作； - 也可以放到 Babel 放到一起，不过要将
eslint-loader放到babel-loader之前检测； - 这里为了让 ESLint 报错更加好看一些，使用了eslint-formatter-friendly这个 ESLint
formatter，记得安装它：npm i -D eslint-formatter-friendly
新建一个 entry 文件，内容如下：
import _ from 'lodash';
const a = 1;
const b = 2;
alert(b);
console.log(b);
js
不推荐理由：使用lint-stage 结合 husky就可以做eslint的代码检查与优化了
Webpack 中使用 StyleLint(不推荐)
Webpack 中使用 StyleLint 是通过插件的方式来使用，这个插件的名字是 stylelint-webpack-plugin。
npm install -D stylelint-webpack-plugin
bash
安装之后，按照插件的使用方式在 webpack.config.js 添加配置：
const StyleLintPlugin = require('stylelint-webpack-plugin');
module.exports = {
// ...
plugins: [new StyleLintPlugin(options)]
// ...
};
js
默认 StyleLint-webpack-plugin 会查找项目中的 StyleLint 配置文件，根据配置文件的配置来检测 CSS 代码。
在 stylelint-webpack-plugin 插件中有两个跟 Webpack 编译相关的配置项：
emitErrors：默认是true，将遇见的错误信息发送给 webpack 的编辑器处理；failOnError：默认是false，如果是true遇见 StyleLint 报错则终止 Webpack 编译。
解决 Prettier 和 ESLint 的冲突
本项目中的 ESLint 配置中使用了 Airbnb JavaScript 风格指南校验，其规则之一是代码结束后面要加分号，而在 Prettier 配置文件中加了代码结束后面不加分号的配置项，这样就有冲突了，会出现用 Prettier 格式化后的代码，ESLint 检测到格式有问题的，从而抛出错误提示。
解决两者冲突问题，需要用到 eslint-plugin-prettier 和 eslint-config-prettier。
eslint-plugin-prettier将 Prettier 的规则设置到 ESLint 的规则中。
eslint-config-prettier关闭 ESLint 中与 Prettier 中会发生冲突的规则。
最后形成优先级：Prettier 配置规则 > ESLint 配置规则。
- 安装插件
$ npm i eslint-plugin-prettier eslint-config-prettier -D
shell
- 在
.eslintrc.js添加 prettier 插件
module.exports = {
...
extends: [
'airbnb-base',
'plugin:prettier/recommended' // 添加 prettier 插件
],
...
}
javascript
这样，在执行 eslint --fix 命令时，ESLint 就会按照 Prettier 的配置规则来格式化代码，轻松解决二者冲突问题。
集成 husky 和 lint-staged
在项目中已集成 ESLint 和 Prettier，在编码时，这些工具可以对写的代码进行实时校验，在一定程度上能有效规范写的代码，但团队可能会有些人觉得这些条条框框的限制很麻烦，选择视“提示”而不见，依旧按自己的一套风格来写代码，或者干脆禁用掉这些工具，开发完成就直接把代码提交到了仓库，日积月累，ESLint 也就形同虚设。
所以，还需要做一些限制，让没通过 ESLint 检测和修复的代码禁止提交，从而保证仓库代码都是符合规范的。
为了解决这个问题，需要用到 Git Hook，在本地执行 git commit 的时候，就对所提交的代码进行 ESLint 检测和修复（即执行 eslint --fix），如果这些代码没通过 ESLint 规则校验，则禁止提交。
实现这一功能，借助 husky + lint-staged 。
husky —— Git Hook 工具，可以设置在 git 各个阶段（pre-commit、commit-msg、pre-push 等）触发的命令。 lint-staged —— 在 git 暂存的文件上运行 linters。
配置 husky
::: tip
使用 husky-init 命令快速在项目初始化一个 husky 配置。在配置 husky 之前必须初始化 git，否则可能会配置不成功
:::
$ npx husky-init && npm install
shell
命令执行会经历以下四步流程：
- 安装
husky为开发依赖
- 创建
.husky文件夹
- 在
.husky目录创建pre-commithook，并初始化pre-commit命令为npm test
- 修改
package.json的scripts，增加"prepare": "husky install"
配置 lint-staged
lint-staged 这个工具一般结合 husky 来使用，它可以让 husky 的 hook 触发的命令只作用于 git add那些文件（即 git 暂存区的文件），而不会影响到其他文件。
接下来，使用 lint-staged 继续优化项目。
- 安装 lint-staged
$ npm i lint-staged -Dshell - 在
package.json里增加 lint-staged 配置项"lint-staged": { "*.{vue,js,ts}": "eslint --fix" },json
- 修改
.husky/pre-commit hook的触发命令为：npx lint-staged
至此，husky 和 lint-staged 组合配置完成。
集成stylelint
检测 CSS 语法使用StyleLint。
StyleLint 和 ESLint 很像，它们都只是提供了工具与规则，如何配置这些规则完全取决于使用者，所以要根据需要自己引入或配置规则。StyleLint 的代码风格也有很多社区开源版本，官方推荐的代码风格有两个：
要使用 StyleLint 需要先安装它：
npm install -D stylelint
bash
除了 StyleLint 本身之外，还可以安装stylelint-order 插件，该插件的作用是强制在写 CSS 的时候按照某个顺序来编写。
例如先写定位，再写盒模型，再写内容区样式，最后写 CSS3 相关属性。这样可以极大的保证代码的可读性和风格统一。
StyleLint 的配置文件是.stylelintrc.json，其中的写法跟 ESLint 的配置类似，都是包含extend和rules等内容，下面是一个示例：
{
"extends": ["stylelint-config-standard", "stylelint-config-recess-order"],
"rules": {
"at-rule-no-unknown": [true, {"ignoreAtRules": ["mixin", "extend", "content"]}]
}
}
json
配置文件中单独配置 at-rule-no-unknown 是为了让 StyleLint 支持 SCSS 语法中的 mixin、extend、content 语法，更多详细的规则，可以查看官方文档。