@programinglive/commiter

v1.2.18

Published

3 months ago

Commiter keeps repositories release-ready by enforcing conventional commits, generating icon-rich changelog entries, and orchestrating semantic version bumps without manual toil. It bootstraps Husky hooks, commitlint rules, and release scripts that inspec

Downloads

0High
0Medium
0Low

moszes

commit conventional-commits standard-version changelog versioning semantic-release git-hooks husky commitlint

Commiter 🚀

A standardized commit convention and release management tool for your repository using standard-version.

Features

✅ Enforced Commit Conventions - Uses Conventional Commits format
🎯 Automated Versioning - Semantic versioning (major, minor, patch)
📝 Changelog Generation - Automatic CHANGELOG.md with icons
🔒 Git Hooks - Pre-commit and commit-msg validation via Husky
🎨 Icon Support - Each commit type has a dedicated icon in releases

Installation

Install the package globally or as a dev dependency in your project:

# Install globally
npm install -g @programinglive/commiter

# Or install as dev dependency
npm install --save-dev @programinglive/commiter

# Or use npx (no installation required)
npx @programinglive/commiter

After installation in your project, the Husky hooks will be automatically set up for commit message validation.

Recommended MCP workflow companion

For a guided end-to-end engineering workflow, install the Development Workflow MCP Server alongside Commiter:

npm install --save-dev @programinglive/dev-workflow-mcp-server

Follow the configuration steps in that repository's README to connect your IDE assistant and automate the standard development workflow (start task → implement → test → document → commit → release).

Commit Message Format

All commits must follow the Conventional Commits specification:

<type>(<scope>): <subject>

<body>

<footer>

Commit Types with Icons

| Type | Icon | Description | Changelog Section | |------|------|-------------|-------------------| | feat | ✨ | New feature | ✨ Features | | fix | 🐛 | Bug fix | 🐛 Bug Fixes | | perf | ⚡ | Performance improvement | ⚡ Performance | | refactor | ♻️ | Code refactoring | ♻️ Refactors | | docs | 📝 | Documentation changes | 📝 Documentation | | style | 💄 | Code style changes | 💄 Styles | | test | ✅ | Test additions/changes | ✅ Tests | | build | 🏗️ | Build system changes | 🏗️ Build System | | ci | 👷 | CI/CD changes | 👷 Continuous Integration | | chore | 🧹 | Maintenance tasks | 🧹 Chores | | revert | ⏪ | Revert previous commit | ⏪ Reverts |

Examples

# Feature
git commit -m "feat(auth): add JWT authentication"

# Bug fix
git commit -m "fix(api): resolve null pointer exception"

# Breaking change
git commit -m "feat(api)!: redesign user endpoint

BREAKING CHANGE: The user endpoint now returns different data structure"

# With scope and body
git commit -m "perf(database): optimize query performance

Reduced query time by 50% using indexed columns"

Release Commands

Patch Release (1.0.0 → 1.0.1)

For bug fixes and minor changes:

npm run release:patch

Minor Release (1.0.0 → 1.1.0)

For new features (backwards compatible):

npm run release:minor

Major Release (1.0.0 → 2.0.0)

For breaking changes:

npm run release:major

Automatic Release

Let standard-version determine the version bump based on commits:

npm run release

What Happens During Release?

🧪 Runs tests - Detects your package manager and runs the test script automatically (tests only run during release, not on commit)
📊 Analyzes commits - Examines commits since last release
📘 Verifies documentation – Warns if docs/PRD.md is missing so every project keeps an up-to-date PRD
🔢 Bumps version - Updates version in package.json
📝 Updates changelog - Generates CHANGELOG.md with icons
🏷️ Creates tag - Creates a git tag for the release
💾 Commits release - Commits changes with format: chore(release): v1.2.3 🚀

Push Your Release

After running a release command, push to remote:

git push --follow-tags origin main

Pre-commit Hooks

The following hooks are automatically enforced:

commit-msg: Validates commit message format using commitlint
pre-commit: Empty hook (tests are run only during release, not on commit)

Configuration Files

package.json - Contains standard-version configuration
commitlint.config.js - Commitlint rules
.husky/commit-msg - Commit message validation hook
.husky/pre-commit - Pre-commit test hook

Troubleshooting

Commit message validation fails

Ensure your commit message follows the format:

type(scope): subject

Valid types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert

Release commits generated by standard-version such as chore(release): 1.0.0 🚀 are automatically ignored by commitlint.

First Release

For new projects without any version tags, use the first release command to start from version 0.0.1:

npm run release:first

Running the first release command:

Sets the initial version to 0.0.1
Creates the first git tag
Generates the initial CHANGELOG.md
Commits the release with proper formatting

This ensures your project starts with a clean, semantic version foundation. Replace the default test script with your real test command once available.

Dry run

To see what would happen without making changes:

npm run release -- --dry-run

Website

The project includes a professional landing page in the web/ directory.

Local Development

To run the website locally:

npm run web

This will serve the website at http://localhost:3000.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

MIT License - see the LICENSE file for details.

This project is open source and free to use, modify, and distribute at your own risk.