gitHooks: commit-msg

一、背景

提交代码时,如果不能形成有效约束,依靠个人的自觉,这样即使每个人是积极的状态,但是每个人的知识构成不同,也会造成提交风格迥异。

引入今天的主角,gitHooks配置commit-msg

二、实现步骤

2.1、配置package.json,增加commit-msg

"gitHooks": {
    "pre-commit": "lint-staged",
    "commit-msg": "node scripts/verifyCommitMsg.js"
},

2.2、根目录创建scripts文件夹

2.3、scripts文件夹创建文件verifyCommitMsg.js

gitHooks: commit-msg

2.4、verifyCommitMsg.js文件内容

const chalk = require('chalk')  // eslint-disable-line
const msgPath = process.env.GIT_PARAMS
const msg = require('fs').readFileSync(msgPath, 'utf-8').trim()

const commitRE = /^(v\d+\.\d+\.\d+(-(alpha|beta|rc.\d+))?$)|((revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types|build)(\(.+\))?: .{1,50})/

if (!commitRE.test(msg)) {
  console.log()
  console.error(
    `  ${chalk.bgRed.white(' ERROR ')} ${chalk.red(`invalid commit message format.`)}\n\n` +
    chalk.red(`  Proper commit message format is required for automated changelog generation. Examples:\n\n`) +
    `    ${chalk.green(`feat(compiler): add 'comments' option`)}\n` +
    `    ${chalk.green(`fix(v-model): handle events on blur (close #28)`)}\n\n` +
    chalk.red(`  See .github/COMMIT_CONVENTION.md for more details.\n`) +
    chalk.red(`  You can also use ${chalk.cyan(`npm run commit`)} to interactively generate a commit message.\n`)
  )
  process.exit(1)
}

2.5、这个时候提交代码就会起到作用了。

配置前提交代码可以任意提交,配置后要按照规则提交。

这样是ok的:

gitHooks: commit-msg

 这样是有问题的:

gitHooks: commit-msg

出现拦截:

 gitHooks: commit-msg

 三、简要说明

 commit代码时要根据本次内容不同加上响应的前缀,前缀list:

feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types|build

分别对应了:

feat:新功能

fix:修改bug

docs:文档修改

style:代码格式修改,注意不是css修改(例如分号修改)

refactor:代码重构(重构,在不影响代码内部行为、功能下的代码修改)

perf:更改代码,以提高性能

test:测试用例新增、修改

workflow:工作流相关文件修改

ci:持续集成想相关文件修改

chore:其他修改(不在上述类型的修改)

types:类型、特征

build:影响项目构建或依赖项修改

四、欢迎交流指正。

上一篇:猿猿有责,维持整洁的 Git 提交记录,三个锦囊送给你


下一篇:git commit message规范