代码风格统一之代码自动格式化

目标

• 保存时自动格式化
• 保存时不能自动格式化，使其自动格式化

注意事项

• 项目是使用 npm 或 yarn
• 可以自己配置 ESLint 实现代码风格统一

安装 ESLint

安装ESLint

npm i eslint
# or
npm i -S eslint // --save    写入到 dependencies 对象，仅在当前项目安装并使用
# or
npm i -D eslint // --save-dev   写入到 devDependencies 对象，仅在当前项目安装并在 dev 环境使用

配置

ESlint 有两部分需要配置，一部分是项目的配置文件，一部分是 vscode 的配置

配置 vscode 实现保存自动格式化代码风格

在安装好 vscode 的 ESlint 插件后，按 Ctrl + ，打开 vscode 的设置，然后找到扩展点击，找到 ESlint 勾选 Auto Fix On Save

配置 package.js 实现统一格式化代码风格

在配置好上边后，可能会遇到开发同伴没有用 vscode 或者在保存时可能没能自动格式化，这种情况可以在 package.js 中添加一条脚本命令

// 使用 ESlint 修复(--fix) 检查(--ext) 后缀为 .js 的文件 路径是当前目录
"lint": "eslint --fix --ext .js ."

这样只需要在命令行运行 npm run lint 就可以自动格式化代码，有报错的话需要自己手动修复，一般是写错了字符或者逻辑错误