Git：CommitMessage规范和代码格式校验Commit Message 规范
以 angular 规范为例，格式如下：
type(scope): subject        # head 必填，其中 type 和 subject 必填。
# 空⾏
72-character wrapped.      # body 选填。
# 空⾏
BREAKING CHANGE: msg.      # footer 选填。
其中：
head 部分
type （只允许下列7个标识）：
feat：新功能（feature）
fix：修补bug
docs：⽂档（documentation）
style： 格式（不影响代码运⾏的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助⼯具的变动
注意：feat和fix类型的 commit 将出现在 Change log 中。
scope（选填）：
此次提交的影响范围，如数据层、控制层、视图层等，多个可以⽤ * 代替，必须在type 之后、⼩括号之内。
subject：
此次提交的简要描述，必须在 type 之后的冒号之后的⼀个空格之后，结尾没有句号。
angular安装
body 部分（选填）
此次提交的详细描述，应包含变动描述、变动理由等内容，使⽤第⼀⼈称现在时描述。
必须和 head 部分间隔⼀个空⾏，每超过72的字符必须换⼀⾏。
foot 部分（选填）
包含两种情况：1.当前代码不兼容上⼀个版本，BREAKING CHANGE冒号空格，后跟变动描述、变动理由和迁移⽅法；2.关闭Issue，Closes #234 。
特殊情况：当前 commit ⽤于撤销之前的 commit，revert冒号空格，后跟要撤销的 commit 的 head。
Commit Message 规范约束⼯具
在项⽬中安装 commitizen ：
npm i -D commitizen cz-conventional-changelog
在项⽬根⽬录创建 .czrc ⽂件：
{ "path": "cz-conventional-changelog" }
修改项⽬中 package.json ⽂件：
"script":{
"commit":"git-cz",
},
"config":{
"commitizen":{
"path":"node_modules/cz-conventional-changelog",
},
},
此时，在项⽬中使⽤ git cz 或 npm run commit 命令可以代替 git commit 命令，在提交时会⾃动带出 angular 规范的 commit message 编辑选项，下⾯将使⽤ cz-customizable 实现⾃定义规范。
在项⽬中安装 ：
npm i -D cz-customizable
修改项⽬中 .czrc ⽂件：
{ "path": "cz-customizable" }
修改项⽬中 package.json ⽂件：
"script":{
"commit":"git-cz",
},
"config":{
"commitizen":{
"path":"node_modules/cz-customizable",
},
},
在项⽬根⽬录创建 .cz-config.js ⽂件，配置项如下：
type: {Array of Object}：项⽬中使⽤的 type 和默认描述。
scopes: {Array of Strings}：预设项⽬中使⽤的可选 scope 。如：在⼀个银⾏系统项⽬中使⽤ [“acccounts”, “payments”]；
在⼀个旅⾏应⽤中使⽤ [“bookings”, “search”, “profile”]。
scopeOverrides: {Object where key contains a Array of String}：当您想重写特定提交类型的作⽤域时，使⽤此⽅法。如：在类型为“fix”时指定范围 { fix: [ {name: 'merge'}, {name: 'style'}, {name: 'e2eTest'},{name: 'unitTest'} ] }。
allowCustomScopes: {boolean, default false}：增加⾃定义 scope 选项，开启可以在设置 scope 时⽀持直接输⼊。
allowBreakingChanges: {Array of Strings: default none}：配置想要 breaking change 弹出提⽰的scope列表，如：[‘feat’,‘fix’]。
appendBranchNameToCommitMessage：当配合 cz-customizable-ghooks 使⽤ cz-customizable 时, 可⾃动获取分⽀名称并添加到commit message 中，此功能已经在 cz-customizable-ghooks实现，对应选项已经被添加到 cz-customizable-ghooks, v1.3.0. 中，默认值为 true。
breakingPrefix: {string, default ‘BREAKING CHANGE:’}：设置⾃定义 breaking change 块。
footerPrefix: {string, default ‘ISSUES CLOSED:’}：设置⾃定义 foot 块。
下⾯是是⼀个⽰例，具体可以参考项⽬根⽬录下node_modules下cz-customizable下cz-config-EXAMPLE.js⽂件：
types: [
{value: 'feat',    name: 'feat:    A new feature'},
{value: 'fix',      name: 'fix:      A bug fix'}
],
scopes: [
{name: 'accounts'},
{name: 'admin'}
],
messages: {
type: 'Select the type of change that you\'re committing:',
scope: '\nDenote the SCOPE of this change (optional):',
customScope: 'Denote the SCOPE of this change:',
// used if allowCustomScopes is true
},
allowCustomScopes: true,
allowBreakingChanges: ['feat', 'fix']
}
此时，在使⽤ commit 命令会⾃动带出 ⾃定义 规范的 commit message 编辑选项。
Commit Message 校验
在项⽬中安装 ：
npm i -D @commitlint/cli @commitlint/config-conventional
在项⽬根⽬录创建 fig.js ⽂件：
此时，commitlint 默认按照angular 规范对 commit message 校验，要校验⾃定义规范可以通过 rules 参数来实现。
extends: ['@commitlint/config-conventional'],
rules: {
'type-enum': [2, 'always',
["feat", "fix", "docs", "style", "refactor", "test", "chore", "revert"]
],
'subject-full-stop': [0, 'never'],
'subject-case': [0, 'never']
}
}
由于前⾯使⽤了 cz 来⾃定义 commit message 规范，下⾯将实现根据 cz 规范进⾏校验。
在项⽬中安装 commitlint-config-cz ：
npm i -D commitlint-config-cz @commitlint/cli
修改项⽬中 fig.js ⽂件：
此时 commitlint 虽然可以校验之前指定的 commit message 规范，但是没有关联到 commit 指令上，下⾯将实现在提交代码时按照规范约束并⾃动校验。
在项⽬中安装 husky ：
npm i -D husky
修改项⽬ package.json ⽂件：
"husky": {
"hooks": { "commit-msg":"commitlint -e $GIT_PARAMS" }
},
此时，在提交代码时将按照之前⾃定义的规范约束 commit message 并⾃动按照对应规范进⾏校验，下⾯将实现⾃动⽣成 Change
log（需要符合 angular 规范）。
在项⽬中安装 ：
npm i -D conventional-changelog-cli
输出 Change log
conventional-changelog -p angular -i CHANGELOG.md -s
根据实际需要，可以将输出 Change log 命令，加⼊项⽬中 package.json ⽂件：
"script":{
"commit":"git-cz",
"changelog":"conventional-changelog -p angular -i CHANGELOG.md -s",
}
代码格式校验
在项⽬中安装eslint：
npm i -D eslint
在项⽬中创建 .eslintrc.json / .eslintrc / .eslintrc.js （任⼀即可，⾮ json ⽂件需要导出） ，详细配置参考 ，下⾯是⽰例代码：
{ // 务必删除注释
"env": { // 环境变量
"node": true, // brower、node、es6、mocha等
"es6": true
},
"globals": { // 全局变量
"vue": true, // "$"、"wx"、"ng"等
},
"parserOptions": { // 格式配置
"ecmaVersion": 6,  //es 版本，默认5，可选3、6（2015）、7（2016）等
"ecmaFeatures": { // 附加语⾔特征，globalReturn、impliedStrict、jsx
"globalReturn": true,
"jsx": true
}
},
"rules": { // 规则配置，0或'off'：关闭规则；1或'warn'：打开规则，且作为警告（检查通过）；2或'error'：打开规则，且作为错误（退出码为1，检查不通过）。    "camelcase": 2,
"curly": 2,
"brace-style": [2, "1tbs"],
"quotes": [2, "single"],
"semi": [2, "always"],
"space-in-brackets": [2, "never"],
"space-infix-ops": 2
}
}
除了⼿动设置规范还可以使⽤⽬前 eslint 三种（、、）流⾏规范，并在其基础上进⼀步⾃定义，安装⽅式如下：
npm i eslint-config-google -D
npm i eslint-config-standard eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-standard -D
npm i eslint-config-airbnb eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react -D
修改项⽬中 package.json ⽂件：
"husky": {
"hooks": {
"commit-msg": "commitlint -e $GIT_PARAMS",
"pre-commit" : "eslint ./app/**/*.js --fix"
}
},
配置好eslint 规则之后，在提交时会⾃动带出之前的⾃定义约束，输⼊完成后⾃动校验 commit message ，并⾃动校验代码规范，只有全
部通过才能提交成功，否则退出 commit ，同时还可以使⽤指令输出 change log ⽂档。
如果在项⽬中使⽤了 typescript，则可以继续添加响应校验：
在项⽬中安装tslint：
npm i -D tslint typescript
在项⽬中创建 tslint.json  ，详细配置参考 ，下⾯是⽰例代码：

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。