项目配置eslint、stylelint、commitlint
文章目录
在实际开发中难免会有协同开发的时候,每个开发编写代码的风格、提交代码备注信息等方面的风格不尽一致,因此事先统一风格变得尤为重要。本文将在项目中集成eslint、stylelint、commitlint帮助校验JS脚本代码规范、CSS脚本规范以及commit msg规范。
搭建工程
使用create-react-app脚手架搭建示例工程,工程支持typescript
$ create-react-app react-lint --template typescript配置eslint
ESLint 是在 ECMAScript/JavaScript 代码中识别和报告模式匹配的工具,它的目标是保证代码的一致性和避免错误。
$ npx eslint --init在终端执行上面命令初始化eslint配置,执行后,终端会出现人机交互,按照自己需求勾选想要的配置即可

最后一步会提示需要安装以下这些插件
eslint-plugin-react@latest
@typescript-eslint/eslint-plugin@latest
eslint-config-standard@latest
eslint@^7.12.1
eslint-plugin-import@^2.22.1
eslint-plugin-node@^11.1.0
eslint-plugin-promise@^4.2.1
@typescript-eslint/parser@latest解释下这些插件的作用:
eslint-plugin-react:请注意,支持JSX语法并不等同于支持React。React对ESLint无法识别的JSX语法应用特定的语义。如果你正在使用React并且想要React语义支持,我们建议你使用eslint-plugin-react@typescript-eslint/parser:ESLint默认使用Espree作为其解析器,@typescript-eslint/parser解析器将TypeScript转换成与estree兼容的形式,以便在ESLint中使用。eslint-config-standard:是一个比较流行的脚本风格插件,里面提供了很多代码风格规则。@typescript-eslint/eslint-plugin:为TypeScript代码库提供lint规则。eslint-plugin-import:该插件旨在支持ES2015 +(ES6 +)导入/导出语法的检查,并防止文件路径和导入名称拼写错误的问题。eslint-plugin-node:针对node语法的检查。eslint-plugin-promise:针对Promise语法的检验。
执行完npx eslint --init后会在根目录生成.eslintrc配置文件,也可以自己手动创建或者在 package.json 里创建一个 eslintConfig属性,在那里定义你的配置
module.exports = {
env: {
browser: true,
es2021: true
},
extends: [
'plugin:react/recommended',
'standard'
],
parser: '@typescript-eslint/parser', // 将 TypeScript 转换成与 estree 兼容的形式,以便在ESLint中使用
parserOptions: {
ecmaFeatures: {
jsx: true // 启用 JSX
},
ecmaVersion: 12, // 指定你想要使用的 ECMAScript 版本
sourceType: 'module'
},
plugins: [
'react', // eslint-plugin-react的缩写,使ESLint支持 React 语义
'@typescript-eslint' // @typescript-eslint/eslint-plugin的缩写,为TypeScript代码库提供lint规则
],
rules: {
semi: [2, 'always'],
'no-use-before-define': 'off' // 'React' was used before it was defined
}
};配置好了之后,eslint服务会自动校验.tsx脚本文件,比如语句结尾缺少分号:

但是,如果报错的地方比较多了,手动一个一个去改太麻烦了。在VScode中安装eslint拓展插件,并且在.vscode/settings.json中配置保存触发自动修复,如下:
// 如何配置在eslint拓展插件中有使用说明
{
"eslint.validate": [
"javascript",
"javascriptreact",
{
"language": "typescript",
"autoFix": true
},
{
"language": "typescriptreact",
"autoFix": true
}
],
"stylelint.validate": ["css", "scss"],
"eslint.autoFixOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
},
"eslint.enable": true,
}当Ctrl+S保存时会自动修复代码格式化问题。
配置stylelint
StyleLint 是『一个强大的、现代化的 CSS 检测工具』, 与 ESLint 类似, 是通过定义一系列的编码风格规则帮助我们避免在样式表中出现错误.
(1)安装stylelint、stylelint-config-standard,stylelint-config-standard继承stylelint-config-recommended,提供一些常用的CSS规则,是stylelint推荐的配置
$ yarn add stylelint stylelint-config-standard -D(2)在根目录下生成.stylelintrc.json配置文件,并根据如下初始化配置
{
"extends": "stylelint-config-standard"
}(3)安装stylelint-order、stylelint-config-rational-order,stylelint-order用于强制你按照某个顺序编写 css,stylelint-config-rational-order提供了CSS顺序的规则,这两个插件可以帮助矫正样式顺序,根据如下完善配置:
{
"extends": ["stylelint-config-standard", "stylelint-config-rational-order"],
"plugins": ["stylelint-order"],
"rules": {
"string-quotes": "single"
}
}stylelint-config-rational-order提供的规则中排除了对scss中'composes', '@import', '@extend', '@mixin', '@at-root'这些属性的处理。因为stylelint可能对scss有些场景的处理不是很好,通过设置property-no-unknown规则忽略scss提供的特性

(4)VScode安装stylelint拓展插件,并在.vscode/settings.json增加如下配置,按Ctrl+S后会自动触发对样式格式化

// .vscode/settings.json
"stylelint.validate": ["css", "scss"],
"editor.codeActionsOnSave": {
"source.fixAll.stylelint": true
},precommit触发检视
git hooks介绍
Git Hooks 就是那些在Git执行特定事件(如commit、push、receive等)后触发运行的脚本,挂钩是可以放置在挂钩目录中的程序,可在git执行的某些点触发动作。
默认情况下,hooks存放在.git/hooks目录下

Git 默认会放置一些脚本样本在这个目录中,除了可以作为挂钩使用,这些样本本身是可以独立使用的。所有的样本都是shell脚本,其中一些还包含了Perl的脚本。不过,任何正确命名的可执行脚本都可以正常使用 ,也可以用Ruby或Python,或其他脚本语言。
上图是git 初始化的时候生成的默认钩子,已包含了大部分可以使用的钩子,但是 .sample 拓展名防止它们默认被执行。为了安装一个钩子,你只需要去掉 .sample 拓展名。或者你要写一个新的脚本,你只需添加一个文件名和上述匹配的新文件,去掉.sample拓展名。把一个正确命名且可执行的文件放入 Git 目录下的 hooks子目录中,可以激活该挂钩脚本,之后他一直会被 Git 调用。
一个简单的 Hooks 例子
使用shell 这里尝试写一个简单的钩子,安装一个prepare-commit-msg钩子。去掉脚本的.sample拓展名,在文件中加上下面这两行:
#!/bin/sh
echo "# Please include a useful commit message!" > $1接下来你每次运行git commit时,你会看到默认的提交信息都被替换了。
脚本语言
git自己生成的默认钩子的脚本大多是shell和Perl语言的,但你可以使用任何脚本语言,只要它们最后能编译到可执行文件。每次脚本中的 #!/bin/sh 定义了你的文件将被如何解析。#!/bin/sh表示是shell脚本
钩子的作用域
对于任何Git仓库来说钩子都是本地的,而且它不会随着git clone一起复制到新的仓库。而且,因为钩子是本地的,任何能接触得到仓库的人都可以修改。在开发团队中维护钩子是比较复杂的,因为.git/hooks目录不随你的项目一起拷贝,也不受版本控制影响。
常见钩子
pre-commit(预先提交):这个钩子由git commit调用,可以使用--no-verify选项绕过它。它不接受任何参数,并在获取建议的提交日志消息和进行提交之前被调用。一般会在这个钩子里头进行eslint、stylelint校验修正。pre-merge-commit(合并前提交):这个钩子由git merge调用,可以使用--no-verify选项绕过它。它不接受任何参数,并在合并成功执行之后和获取建议的提交日志消息以进行提交之前调用。prepare-commit-msg(准备提交消息):git commit在准备默认日志消息之后,在启动编辑器之前调用此钩子。commit-msg(提交信息):这个钩子由git commit和git merge调用,可以使用--no-verify选项绕过它。它接受一个参数,即保存建议的提交日志消息的文件的名称,会在用户输入提交信息之后被调用。一般会在这个钩子中使用commitlint校验提交信息
手动修改钩子文件
上面讲述到git 初始化生成的默认钩子携带.sample 拓展名,防止它们默认被执行,如果我们想启用precommit钩子,需要去掉 .sample 拓展名,并且添加如下脚本代码:
STAGE_FILES=$(git diff --cached --name-only --diff-filter=ACM -- '*.js')
if test ${#STAGE_FILES} -gt 0
then
echo '开始eslint检查'
which eslint &> /dev/null
if [[ "$?" == 1 ]]; then
echo '没安装eslint'
exit 1
fi
PASS=true
for FILE in $STAGE_FILES
do
eslint $FILE
if [[ "$?" == 1 ]]; then
PASS=false
fi
done
if ! $PASS; then
echo "eslint检查没通过!"
exit 1
else
echo "eslint检查完毕"
fi
else
echo '没有js文件需要检查'
fi
exit 0稍微解释一下
- 首先用
git diff获取到提交到暂存区的文件,我这里添加了过滤只获取.js文件 - 然后判断
eslint是否已安装,接着再对获取到的文件依次检查,当某个文件检查不通过时不会中断进程,会继续遍历所有文件,这样最后在控制台可以显示出所有检查不通过的文件信息 exit即表示退出当前脚本进程、后面接上状态码,0表示正常,会继续执行git commit的操作,其他情况表示出错,不会继续commit
git diff --diff-filter 可以过滤几种不同的变化:
--diff-filter=[(A|C|D|M|R|T|U|X|B)…[*]]
Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (i.e. regular file, symlink, submodule, …) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B).
只选择那些添加 (A), 赋值 (C), 删除 (D), 修改 (M), 重命名 (R)的文件, 它们的类型(如 普通文件, 符号链接, 子模块, …) 是否改变 (T), 是否未合并 (U), 是未知 (X), 或它们的对崩溃(B). 任何过滤字符的组合(包括none)均可使用
当执行git commit -m 'xxx'时会触发precommit钩子继而进行eslint检视,正常效果:

另外,.git里面的文件,无法提交到代码仓库,最好在git目录最外层新建一个同名的hooks文件夹,把写好的脚步放里面。新clone该项目时,在根目录执行一下cp hooks/* .git/hooks/把脚本文件复制到.git里去。
husky + lint-staged
lint-staged
在代码提交之前,进行代码规则检查能够确保进入git库的代码都是符合代码规则的。但是整个项目上运行lint速度会很慢,lint-staged能够让lint只检测暂存区的文件(lint-staged过滤文件采用glob模式),所以速度很快。
从v3.1开始,你现在可以使用不同的方式进行配置,一般都会选择在package.json配置:
lint-staged在你的对象package.jsonlintstagedrc格式为JSON或YML的文件,也可以通过文件扩展名来明确显示该文件:lintstagedrc.jsonlintstagedrc.yamllintstagedrc.yml
lint-staged.config.js,.lintstagedrc.js或.lintstagedrc.cjsJS格式的文件
使用示例:
{
"scripts": {
"lint": "npm run lint-staged"
},
"lint-staged": {
"src/**/*.{ts,tsx}": [
"eslint --fix",
"git add"
],
"src/**/*.scss": [
"stylelint --fix",
"git add"
]
},
}husky
husky 是一个 Git Hook 工具,可以让我们向项目中添加git hooks。
如果使用0.14.x下的低版本,配置如下:
{
"scripts": {
"precommit": "lint-staged",
"commitmsg": "commitlint -E GIT_PARAMS"
},
}如果需要从0.14.x下版本升级,需要运行husky-upgrade以自动升级您的配置:
npx --no-install husky-upgrade您也可以手动执行。将现有的钩子移至husky.hooks字段并使用原始Git钩子名称。另外,如果您使用的是GIT_PARAMS env 变量,请将其重命名为HUSKY_GIT_PARAMS。
{
"scripts": {
- "precommit": "lint-staged",
- "commitmsg": "commitlint -E GIT_PARAMS"
},
+ "husky": {
+ "hooks": {
+ "pre-commit": "lint-staged",
+ "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+ }
+ }
}从1.0.0开始,husky 可以使用配置.huskyrc,.huskyrc.json,.huskyrc.js或husky.config.js文件。
// .huskyrc
{
"hooks": {
"pre-commit": "lint-staged"
}
}配置husky + lint-staged
安装husky、lint-staged
yarn add lint-staged husky -D然后,执行下面操作
# Active hooks
npx husky install
# or
yarn husky install
# Add pre-commit hook
npx husky add .husky/pre-commit 'npx lint-staged'
# or
yarn husky add .husky/pre-commit 'yarn lint-staged'执行npx husky install后会在根目录下生成.husky文件夹

执行npx husky add .husky/pre-commit 'npx lint-staged'后,会在.husky目录下生成pre-commit脚本并添加npx lint-staged。

执行git commit时,会触发pre-commit钩子,执行脚本中lint-staged命令

配置commitlint校验commit msg
(1)安装@commitlint/cli、@commitlint/config-conventional
$ yarn add @commitlint/cli @commitlint/config-conventional -D@commitlint/cli提供commitlint命令校验提交信息规范@commitlint/config-conventional提供commit msg规则
(2)根目录下创建.commitlintrc.json配置文件,并配置规则,规则的使用这里不过多讲述,网上搜一下就能找到答案
{
"extends": ["@commitlint/config-conventional"],
"rules": {
"type-enum": [
2,
"always",
[
"feat",
"fix",
"docs",
"style",
"refactor",
"test",
"revert",
"config",
"chore"
]
],
"type-empty": [2, "never"],
"subject-empty": [2, "never"],
"subject-full-stop": [0, "never"],
"subject-case": [0, "never"]
}
}(3)将commitlint校验命令添加到commit-msg钩子中
# Add commit-msg hook
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
# or
yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'(4)执行git commit时会先执行pre-commit钩子校验脚本规范,然后执行commit-msg钩子校验提交信息

(5)如果项目需要通过gerrit code review,git push时会报错没有change-id

但提示了解决方案,让我们从gerrit server上拉取commit-msg钩子脚本,在这个钩子中会帮助生成change-id,执行如下命令:
scp -p -P 29418 a02313@gerrit.casstime.net:hooks/commit-msg .husky注意:a02313账号部分改成自己的然后再将yarn commitlint --edit $1命令添加到commit-msg钩子脚本中
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
if test "$#" != 1 ; then
echo "$0 requires an argument."
exit 1
fi
if test ! -f "$1" ; then
echo "file does not exist: $1"
exit 1
fi
// 在生成change-id之前先执行commitlint校验commit msg
yarn commitlint --edit $1
# Do not create a change id if requested
if test "false" = "`git config --bool --get gerrit.createChangeId`" ; then
exit 0
fi
# $RANDOM will be undefined if not using bash, so don't use set -u
random=$( (whoami ; hostname ; date; cat $1 ; echo $RANDOM) | git hash-object --stdin)
dest="$1.tmp.${random}"
trap 'rm -f "${dest}"' EXIT
if ! git stripspace --strip-comments < "$1" > "${dest}" ; then
echo "cannot strip comments from $1"
exit 1
fi
if test ! -s "${dest}" ; then
echo "file is empty: $1"
exit 1
fi
# Avoid the --in-place option which only appeared in Git 2.8
# Avoid the --if-exists option which only appeared in Git 2.15
if ! git -c trailer.ifexists=doNothing interpret-trailers \
--trailer "Change-Id: I${random}" < "$1" > "${dest}" ; then
echo "cannot insert change-id line in $1"
exit 1
fi
if ! mv "${dest}" "$1" ; then
echo "cannot mv ${dest} to $1"
exit 1
fi参考文章:
GitHook 工具 —— husky介绍及使用
commitlint
使用git钩子对提交代码进行检查(pre-commit)
评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论