https://github.com/sulthonzh/convlog
Generate CHANGELOGs from conventional git commits. Zero dependencies.
https://github.com/sulthonzh/convlog
changelog changelog-generator conventional-commits git
Last synced: 12 days ago
JSON representation
Generate CHANGELOGs from conventional git commits. Zero dependencies.
- Host: GitHub
- URL: https://github.com/sulthonzh/convlog
- Owner: sulthonzh
- Created: 2026-06-13T04:49:19.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2026-06-15T23:23:28.000Z (21 days ago)
- Last Synced: 2026-06-16T01:20:26.191Z (21 days ago)
- Topics: changelog, changelog-generator, conventional-commits, git
- Language: JavaScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# convlog
Generate CHANGELOGs from [conventional commits](https://www.conventionalcommits.org/). Zero dependencies.
You write commits like `feat(auth): add OAuth2 login` and `fix: crash on empty input`. convlog turns those into a clean, versioned changelog. No config files, no plugins, no nonsense.
## Why
Every changelog generator out there wants your life story in a config file. convlog reads your git log, parses conventional commits, and spits out a changelog. That's it.
Works for solo projects and teams. Handles breaking changes, scopes, semver bumping — all from your commit messages.
## Install
```bash
npm install -g convlog
```
## Usage
### CLI
```bash
# Generate changelog from latest tag to HEAD
convlog
# From a specific tag
convlog --from v1.2.0
# Between two refs
convlog --from v1.0.0 --to v1.1.0
# Group by scope
convlog --scope
# Show stats
convlog --stats
# Output as JSON
convlog --json
# Filter by file path
convlog --path src/auth
```
### Programmatic
```js
const { generate, parseCommit, stats } = require('convlog');
// Parse a single commit message
const parsed = parseCommit('feat(api)!: new response format');
// { type: 'feat', scope: 'api', breaking: true, description: 'new response format' }
// Generate full changelog
const changelog = generate({ cwd: './my-project' });
// Get commit stats
const commits = getCommits({ from: 'v1.0.0' });
const s = stats(commits);
// { total: 42, byType: { feat: 15, fix: 20, ... }, breaking: 3, scopes: ['api', 'ui'] }
```
## What it detects
- **Commit types**: feat, fix, perf, refactor, docs, test, build, ci, chore, style, revert
- **Scopes**: `feat(auth):` → groups under **auth**
- **Breaking changes**: `feat!:` or `BREAKING CHANGE:` in body → marked with **BREAKING**
- **Semver bumping**: fix → patch, feat → minor, breaking → major
## Output format
```markdown
# Changelog
## 1.2.0 (2026-06-13)
### Features
- **api:** add rate limiting (a1b2c3d)
- add search endpoint (e4f5g6h)
### Bug Fixes
- **auth:** fix token expiry (i7j8k9l)
### BREAKING
Changes marked with **BREAKING** are highlighted.
```
## Options
| Flag | Description |
|------|-------------|
| `-f, --from ` | Start from tag (default: latest) |
| `-t, --to ` | End at ref (default: HEAD) |
| `-p, --path ` | Filter by file path |
| `-s, --scope` | Group commits by scope |
| `--stats` | Show commit statistics |
| `--hidden` | Include non-standard commit types |
| `--json` | Output as JSON |
| `--no-header` | Omit changelog header |
| `-h, --help` | Show help |
## API
### `parseCommit(message)` → `object | null`
Parse a conventional commit message. Returns `{ type, scope, description, breaking, body }` or `null`.
### `getCommits(options)` → `array`
Get parsed commits from git log. Options: `{ from, to, cwd, path }`.
### `generateChangelog(commits, options)` → `string`
Generate markdown changelog section for given commits.
### `generate(options)` → `string`
Generate a full changelog including recent version tags.
### `stats(commits)` → `object`
Get statistics about commits: counts by type, breaking changes, scopes.
### `guessNextVersion(tags, commits)` → `string`
Guess the next semver version based on tags and commit types.
## Zero dependencies
convlog runs on Node.js built-ins. No external packages, no supply chain risk, no bloated `node_modules`.
## License
MIT