The meaning of standard commit msg
Standardized and formatted commit message allows us to better track the evolution of demand, quickly find commits when rolling back, and at the very least, it can make our warehouse more professional.
How does the team regulate commit msg? Rely on preaching and documentation? Of course, it depends on tool generation and constraints. There are so many front-end ring wheels, this kind of tool is no problem.
- commitizen question-answer generation commit msg format
- commitlint verification card control commit msg standardization
commitizen
commitizen: simple commit conventions for internet citizens.
commitizen/cz-cli Replace the git commit command with the help of the git cz command it provides to generate a commit message that complies with the specification.
commitizen The default submission specification is strictly stipulated by the angular team. If you want to customize, we also need to cooperate with Adapter (adapter) here.cz-customizable。
Let’s directly introduce project-level configuration.
Configure commitizen
Execute the npm install -D commitizen, npm install -D cz-customizable commands
Then configure the scripts and config fields in the file
{
"scripts": {
"commit": "cz"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
},
"cz-customizable": {
"config": "."
}
}
}
Add . File
Execute in the root directory of the projectnpm run commitTry it
Subsequent tnpm run commitReplacegit commit
commitlint
How to ensure that all members in the group use itnpm run commitWhat about the command? Of course, it's using tools.
Here we use commitlint, which has a similar effect to eslint. Use git hooks to intercept commit msgs that do not comply with the specification.
Installation dependencies
npm install --save-dev @commitlint/{config-conventional,cli}
npm install yorkie --save-dev
Add . File
Extend open source configuration and then add some personalized rules
Configure git hooks
In order to intercept irregular commit msg, you need to use git hookscommit-msgAutomatically execute commitlint
"gitHooks": {
"commit-msg": "commitlint -e $GIT_PARAMS"
}
Try typing a commit msg randomly, and it was very magical. The card control has taken effect.
Follow the above steps to standardize your team's commit msg.
To summarize:
step 1: Installation dependencies
npm install -D commitizen cz-customizable
npm install -D @commitlint/{config-conventional,cli}
npm install -D yorkie
step 2: Add configuration file
Custom format commitizen configuration file . , verification specification . files
Configuration
{
"scripts": {
"commit": "cz"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
},
"cz-customizable": {
"config": "."
}
},
"gitHooks": {
"commit-msg": "commitlint -e $GIT_PARAMS"
}
}
The principle of git cz
If you follow the commitizen globally, you can still use itgit czCommand insteadnpm run commit。
git czWhat is it? git commands and commitizen commands.
By consulting information git cz is a custom git command generated by commitizen using git's file naming specification.
Git follows naming conventionsgit-<subcmd>Automatically parse subcommands in executable files in PATH. These subcommands can be usedgit <subcmd>implement.
Let's take a look at the bin field of the commitizen repository. It's so delicious, it's the custom command of git
"bin": {
"cz": "./bin/git-cz",
"git-cz": "./bin/git-cz",
"commitizen": "./bin/commitizen"
},
The above is the detailed explanation of the meaning of commit msg in the JavaScript development process. For more information on the meaning of commit msg in the development process, please pay attention to my other related articles!