super-commit
Advanced tools
A powerful, fully customizable conventional commit CLI tool that makes creating standardized commit messages effortless. Built with TypeScript and designed for modern development workflows.
No installation needed! Just use it directly:
npx super-commit
npm install -g super-commit
npm install --save-dev super-commit
Simply run the command and answer the prompts:
npx super-commit
You'll be guided through:
For quick commits without prompts:
# Basic commit
npx super-commit --type feat --message "add user authentication"
# With scope
npx super-commit -t fix -s api -m "fix login endpoint"
# With body and breaking change
npx super-commit -t feat -m "redesign API" -b "Complete API redesign" --breaking
# With issue references
npx super-commit -t fix -m "fix memory leak" -i "fix #123"
-t, --type <type> - Commit type (feat, fix, docs, etc.)-s, --scope <scope> - Commit scope-m, --message <message> - Short description-b, --body <body> - Detailed description--breaking - Mark as breaking change-i, --issues <issues> - Issue referencesCreate a customized configuration file:
npx super-commit init
This will guide you through creating a .supercommitrc.json file with your preferences:
Create a .supercommitrc.json file in your project root:
{
"language": "en",
"types": [
{
"value": "feat",
"name": "feat: A new feature",
"description": "Introduces a new feature to the codebase",
"emoji": "✨"
},
{
"value": "fix",
"name": "fix: A bug fix",
"description": "Patches a bug in your codebase",
"emoji": "🐛"
}
],
"scopes": [
{ "value": "api", "name": "api: API related changes" },
{ "value": "ui", "name": "ui: User interface changes" }
],
"validation": {
"subjectMaxLength": 72,
"subjectMinLength": 1,
"scopeRequired": false,
"allowCustomScopes": true
},
"format": {
"useEmoji": false,
"emojiPosition": "before-type"
}
}
Define custom commit types:
{
"types": [
{
"value": "feat",
"name": "feat: A new feature",
"description": "Optional description",
"emoji": "✨"
}
]
}
Default types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
Define allowed scopes:
{
"scopes": [
{ "value": "api", "name": "api: API related changes" },
{ "value": "ui", "name": "ui: User interface" }
]
}
{
"validation": {
"subjectMaxLength": 72,
"subjectMinLength": 1,
"bodyMaxLineLength": 100,
"typeRequired": true,
"scopeRequired": false,
"subjectRequired": true,
"allowCustomScopes": true,
"allowEmptyBody": true
}
}
{
"format": {
"useEmoji": true,
"emojiPosition": "before-type",
"separator": ":",
"lineBreaksBetweenSections": 1
}
}
Emoji Positions: before-type, after-type, after-subject
Customize prompt messages (supports i18n):
{
"promptMessages": {
"type": "Select the type of change:",
"scope": "Denote the SCOPE of this change:",
"subject": "Write a SHORT description:",
"body": "Provide a LONGER description:",
"breaking": "Are there any breaking changes?",
"issues": "Add issue references:"
}
}
Automatically use Super Commit for all commits in your repository:
npx super-commit husky
This command will:
prepare-commit-msg hook (for interactive mode)commit-msg hook (for validation)package.json scriptsInteractive Mode Only (No validation):
git commit -mInteractive + Validation Mode (Recommended):
git commit -mAfter setup, Super Commit will be integrated with your git workflow!
If you prefer manual setup:
npm install --save-dev husky
npx husky init
.husky/prepare-commit-msg:# Check if this is not an amend, merge, or squash commit
if [ -z "$2" ]; then
# Run super-commit in interactive mode
exec < /dev/tty && npx super-commit
# If super-commit succeeds, prevent the default commit message editor
if [ $? -eq 0 ]; then
exit 0
fi
fi
chmod +x .husky/prepare-commit-msg
.husky/commit-msg for validation:# Validate commit message using super-commit
# Try to use the local installation if available, otherwise use npx
if [ -f "$(dirname "$0")/../dist/cli.js" ]; then
node "$(dirname "$0")/../dist/cli.js" validate --file "$1"
else
npx super-commit validate --file "$1"
fi
if [ $? -ne 0 ]; then
echo ""
echo "════════════════════════════════════════════════════════════"
echo "❌ COMMIT REJECTED"
echo "════════════════════════════════════════════════════════════"
echo ""
echo "Your commit message does not follow conventional commits format."
echo ""
echo "💡 Quick Fix Options:"
echo " 1. Use: npx super-commit (interactive mode)"
echo " 2. Or format: <type>(<scope>): <subject>"
echo ""
echo "📖 More info: https://www.conventionalcommits.org"
echo ""
exit 1
fi
chmod +x .husky/commit-msg
Standalone command to validate commit messages. Perfect for CI/CD pipelines and custom git hooks:
# Validate a message string
npx super-commit validate --message "feat: add new feature"
# Validate from a file (useful in git hooks)
npx super-commit validate --file .git/COMMIT_EDITMSG
# Silent mode (only exit code, no output)
npx super-commit validate --message "feat: test" --silent
echo $? # 0 = valid, 1 = invalid
CI/CD Pipeline:
# GitHub Actions example
- name: Validate Commit Message
run: |
npx super-commit validate --message "${{ github.event.head_commit.message }}"
Custom Git Hook:
#!/bin/bash
# .git/hooks/commit-msg
npx super-commit validate --file "$1"
Pre-receive Hook (Server-side):
#!/bin/bash
while read oldrev newrev refname; do
git log $oldrev..$newrev --format=%s | while read msg; do
echo "$msg" | npx super-commit validate --message "$msg" --silent || exit 1
done
done
Super Commit follows the Conventional Commits specification:
<type>(<scope>): <subject>
<body>
<footer>
Simple feature:
feat: add user authentication
With scope:
fix(api): resolve login endpoint error
With body:
feat(ui): redesign dashboard layout
Completely redesigned the dashboard with a new card-based layout.
Improved mobile responsiveness and added dark mode support.
Breaking change:
feat(api): redesign authentication API
BREAKING CHANGE: Authentication endpoints have been redesigned.
All clients need to update their integration.
With issue reference:
fix(parser): handle edge case in date parsing
fix #123
Super Commit supports multiple languages. Currently available:
en)tr)To use Turkish:
{
"language": "tr"
}
Want to add more languages? Contributions are welcome!
Add convenient scripts to your package.json:
{
"scripts": {
"commit": "super-commit",
"commit:init": "super-commit init",
"commit:husky": "super-commit husky"
}
}
Then use:
npm run commit
Super Commit can be used in CI/CD pipelines to validate commit messages:
# GitHub Actions example
- name: Validate Commit Message
run: |
npx super-commit --type feat --message "automated build"
Super Commit can be imported and used programmatically:
import { commitCommand } from "super-commit";
await commitCommand({
type: "feat",
message: "add new feature",
scope: "api",
});
Contributions are welcome! Please feel free to submit a Pull Request.
# Clone the repository
git clone https://github.com/osmanekrem/super-commit.git
cd super-commit
# Install dependencies
npm install
# Build the project
npm run build
# Link for local testing
npm link
# Test it
super-commit
MIT
Inspired by Commitizen and Conventional Commits.
Built with:
If you have any questions or need help, please open an issue on GitHub.
Made with ❤️ by osmanekrem, for developers.
FAQs
A powerful conventional commit CLI tool with full customization
The npm package super-commit receives a total of 2 weekly downloads. As such, super-commit popularity was classified as not popular.
We found that super-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
/Product
Socket Firewall Free is now bundled into Docker Hardened Images, adding build-time and dependency-install supply chain protection on top of hardened base images for Node.js, Python, and Rust.
Security News
Season’s greetings from Socket, and here’s to a calm end of year: clean dependencies, boring pipelines, no surprises.
Research
/Security News
Impostor NuGet package Tracer.Fody.NLog typosquats Tracer.Fody and its author, using homoglyph tricks, and exfiltrates Stratis wallet JSON/passwords to a Russian IP address.