@bassist/commit
Advanced tools
Simple Commit Lint by @chengpeiquan .
Please configure Git Hooks management tools based on Husky or simple-git-hooks in advance in your project.
Take Husky as an example:
commit-msg hook:npx husky set .husky/commit-msg "npx @bassist/commit"
This is the most popular commit message specification in the world (See: Angular's commit convention).
Whether it is large open source projects or technical teams of large companies, this specification is basically used. Following it will make your work more professional.
In some work scenarios, combined with automated tools, these standardized commit messages can shorten your work time (See: Related tools).
Messages must be matched by the following regex:
/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/
Appears under "Features" header, utils subheader:
feat(utils): add 'formatTime' to format the time as 'yyyy-MM-dd HH:mm:ss'
Appears under "Bug Fixes" header, eslint subheader, with a link to issue #24:
fix(eslint): fix some misconfigurations for React rules
close #24
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
perf(node-utils): enable more new Node.js features
BREAKING CHANGE: Drop support for Node 14.
The following commit and commit afbd143 do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
revert: feat(eslint): add some APIs exports
This reverts commit afbd1436b6b09035f3c17c16daec0493eff54b6d.
A commit message consists of a header, body and footer. The header has a type, scope and subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body, it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
If the prefix is feat, fix or perf, it will appear in the changelog. However, if there is any BREAKING CHANGE, the commit will always appear in the changelog.
Other prefixes are up to your discretion. Suggested prefixes are docs, chore, style, refactor, and test for non-changelog related tasks.
The scope could be anything specifying the place of the commit change. For example utils, node-utils, eslint, uno, tsconfig etc...
Usually classified according to functional modules, if it is Monorepo, it is classified more according to Packages.
The subject contains a succinct description of the change:
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
A tool to analyze your git repository's commit log. It can help you generate daily/weekly or longer work reports.
In the form of programming, combined with Git Tags and CI/CD, a CHANGELOG is generated based on the commit message.
Please refer to CHANGELOG for details.
MIT License © 2023-PRESENT chengpeiquan
FAQs
Simple Commit Lint by @chengpeiquan .
We found that @bassist/commit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.