https://github.com/visualdiffer/conventional-changelog-visualdiffer
conventional changelog visualdiffer preset
https://github.com/visualdiffer/conventional-changelog-visualdiffer
Last synced: 12 days ago
JSON representation
conventional changelog visualdiffer preset
- Host: GitHub
- URL: https://github.com/visualdiffer/conventional-changelog-visualdiffer
- Owner: visualdiffer
- License: gpl-3.0
- Created: 2026-01-09T13:17:40.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2026-01-10T07:52:59.000Z (28 days ago)
- Last Synced: 2026-01-11T02:15:49.319Z (27 days ago)
- Language: JavaScript
- Size: 27.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# conventional-changelog-visualdiffer
[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) [visualdiffer](https://github.com/visualdiffer/visualdiffer) preset.
## Installation
```bash
npm install -g conventional-changelog-cli \
/absolute/path/to/conventional-changelog-visualdiffer
```
## Usage
```bash
npx conventional-changelog -p visualdiffer -c context.json
```
### `context.json`
The `context.json` file defines repository metadata and controls how commit data is processed.
| Field | Type | Required | Description | Example |
|-----------------------|------|----------|----------------------------------------------------------------------------------------------------|---------|
| `host` | `string` | ✅ | Identical to the `host` property used by `conventional-changelog` | `"https://github.com"` |
| `owner` | `string` | ✅ | Identical to the `owner` property used by `conventional-changelog` | `"visualdiffer"` |
| `repository` | `string` | ✅ | Identical to the `repository` property used by `conventional-changelog` | `"visualdiffer"` |
| `appVersion` | `string` | ❌ | Application version associated with the output, if not present the `version` property will be used | `"1.2.3-alpha.5"` |
| `excludedTypes` | `string[]` | ❌ | List of Conventional Commit types to exclude from the generated output | `["chore", "ci", "build", "style"]` |
```json
{
"host": "https://github.com",
"owner": "visualdiffer",
"repository": "visualdiffer",
"appVersion": "1.2.3-alpha05",
"excludeTypes": [
"chore",
"ci",
"build",
"style"
]
}
```