semantic-git-commit-cli
Advanced tools
A CLI to keep semantic git commits. With emoji support 😄 👍
Many projects got different git commit rules. It is hard to remember them all. Usually you start with git commit -m ", and then? You have to think about the projects commit guidelines.
sgc will take care of the commit guidelines, so you can focus on the more important stuff: code
$ npm i -g semantic-git-commit-cli
or
$ yarn global add semantic-git-commit-cli
Forget the times when you used git commit -m "...", now just type:
$ sgc
or if you already have an alias for sgc, use following instead:
$ semantic-git-commit
Note: if any block is added it will get skipped in the questions. If there are still some questions open they will still be asked
Available parameters:
m | message: Add and skip the message blockt | type: Add and skip the type block (this has to be defined in the types as argKey)s | scope: Add and skip the scope blockTo skip some questions you can add parameters:
Following:
$ sgc -t feat -m some new features
Will generate: Feat: some new features
--
Following:
$ sgc -t feat -s myScope -m some new features
Will generate: Feat(myScope): some new features
Configure sgc for the following semantic-release options:
analyzeCommitsandgenerateNotes
First step, install the following plugins with
$ npm install --save-dev sr-commit-analyzer sr-release-notes-generator conventional-changelog-eslint
or
$ yarn add -D sr-commit-analyzer sr-release-notes-generator conventional-changelog-eslint
Then, create a release.config.js file in a config folder in the root folder of your project:
/* eslint-disable no-useless-escape */
module.exports = {
analyzeCommits: {
preset: 'eslint',
releaseRules: './config/release-rules.js', // optional, only if you want to set up new/modified release rules inside another file
parserOpts: { // optional, only you want to have emoji commit support
headerPattern: /^(?::([\w-]*):)?\s*(\w*):\s*(.*)$/,
headerCorrespondence: [
'emoji',
'tag',
'message',
],
},
},
generateNotes: {
preset: 'eslint',
parserOpts: { // optional, only you want to have emoji commit support
headerPattern: /^(?::([\w-]*):)?\s*(\w*):\s*(.*)$/,
headerCorrespondence: [
'emoji',
'tag',
'message',
],
},
},
};
Then, update the semantic-release script to your package.json to this :
"scripts": {
"semantic-release": "semantic-release -e ./config/release.config.js",
}
This will check all commits and will fail if your commits do not meet the defined config.
Flags
start: A commit SHA to start, in case you started using sgc later of your development$ sgc check --start 84a1abd
Just create a
.sgcrcin your project root or you can add everything in yourpackage.jsonwith the valuesgc
You can even create a global config. Just go to your users home and create a .sgcrc. The global config will be triggered if no project configurations are present.
The order and namings of the commit (this can vary with different settings):
<type>(<scope>)<delimiter> <message>
<body>
Options:
Type: boolean
Default: true
Asks if more info (body) should be added. This will open your default editor.
Example:
{
"body": false
}
Type: boolean
Default: false
Asks for the scope in parentheses of the commit.
Example:
{
"scope": true
}
Type: boolean
Default: false
A boolean to enable emoji at the beginning of a commit message
Example:
{
"emoji": true
}
Type: string
Default: :
A string which is the delimiter between the type and the message.
Example:
{
"delimiter": ":"
}
or type specific delimiters, which will overwrite the global one:
{
"delimiter": ":",
"types": [
{
"type": "Feat",
"delimiter": " -"
}, // will generate "Feat - message"
{
"type": "Fix",
} // will generate "Fix: message"
]
}
Type: boolean
Default: false
A boolean to lowercase types.
Example:
{
"lowercaseTypes": true
}
Type: object
Default:
{
"initialCommit": {
"isEnabled": true,
"emoji": ":tada:",
"message": "Initial commit"
}
}
Keys:
isEnabled - Whether an explicit initial commit should be used for the very first commitemoji - An emoji which will be appended at the beginning of the commit (Emoji Cheat Sheet)message - The commit message for the very first commitTypes will define your git commits. If
typesis not set in your own.sgcrc, thetypesof the global .sgcrc
Notice: If the
typeisfalseit will let you to manually add the type. This is usefull especially if you have aprefixnamedSGC-to reference these as a ticket number for your ticket tool
Keys
type (string or false) - This will be your commit convention and will be your start of your commit - e.g.: Feat:prefix (optional) - This option is just valid, if type is falsedescription (optional) - The description to explain what your type is aboutemoji (optional) - An emoji which will be appended at the beginning of the commit (Emoji Cheat Sheet)argKeys | Array (optional) - Keys which will be accessed through the -t parameterThe .sgcrc:
{
"types": [
{
"emoji": ":sparkles:",
"type": "Feat:",
"description": "Any description to describe the type",
"argKeys": ["f", "feat", "feature"]
}
]
}
or the package.json:
{
"name": "Your application name",
"version": "1.0.0",
"sgc": {
"types": [
{
"emoji": ":sparkles:",
"type": "Feat:",
"description": "Any description to describe the type",
"argKeys": ["f", "feat", "feature"]
}
]
}
}
Type: boolean
Default: true
This rule just affects the commit message if
scopeis set to true
If set to false there will be no space between <type> and (<scope>)
Example:
{
"addScopeSpace": false
}
Available rules:
Type: number
Default: 72
If a number is set, it will not allow to commit messages more than the given number. If it is set to -1 the rule is deactivated
Example:
{
"rules": {
"maxChar": -1
}
}
Type: number
Default: 10
If a number is set, it will not allow to commit messages less than the given number. If it is set to -1 the rule is deactivated
Example:
{
"rules": {
"minChar": -1
}
}
Type: boolean
Default: true
If it is set to false, it will not allow to commit messages with a dot at the
Example:
{
"rules": {
"endWithDot": false
}
}
FAQs
A CLI for semantic git commits
The npm package semantic-git-commit-cli receives a total of 323 weekly downloads. As such, semantic-git-commit-cli popularity was classified as not popular.
We found that semantic-git-commit-cli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
Security News
CAI is a new open source AI framework that automates penetration testing tasks like scanning and exploitation up to 3,600× faster than humans.
Security News
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.