# conventional-changelog-ghostwriter
> A configurable conventional-changelog preset
Latest version **1.3.2** (published 2024-09-13) · MIT license · 0 weekly downloads
## Install
```sh
npm install conventional-changelog-ghostwriter
pnpm add conventional-changelog-ghostwriter
yarn add conventional-changelog-ghostwriter
bun add conventional-changelog-ghostwriter
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.3.2 |
| Published | 2024-09-13 |
| First published | 2021-06-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Juan Sanchez |
| Maintainers | jsanchezio |
| Keywords | changelog, conventional, conventional-changelog, ghostwriter, preset |
## Links
- npm: https://www.npmjs.com/package/conventional-changelog-ghostwriter
- Repository: https://github.com/JSanchezIO/JSanchezIO
- Homepage: https://github.com/JSanchezIO/JSanchezIO/blob/main/packages/conventional-changelog-ghostwriter
- Issues: https://github.com/JSanchezIO/JSanchezIO/issues
- npm.io page: https://npm.io/package/conventional-changelog-ghostwriter
## Dependencies (2)
- [find-up](https://npm.io/package/find-up.md) ^5.0.0
- [compare-func](https://npm.io/package/compare-func.md) ^2.0.0
## Alternatives
- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads
## Recent versions
- 1.3.2 (latest) — 2024-09-13
- 1.3.1 — 2024-04-01
- 1.3.0 — 2024-01-24
- 1.2.0 — 2023-06-16
- 1.1.3 — 2023-03-23
- 1.1.2 — 2021-07-14
- 1.1.1 — 2021-07-14
- 1.1.0 — 2021-07-09
- 1.0.1 — 2021-06-21
- 1.0.0 — 2021-06-17
## README
conventional-changelog-ghostwriter
[](https://www.npmjs.com/package/conventional-changelog-ghostwriter)
You want to leverage conventional-changelog to create a `CHANGELOG.md` but none of the available
presets support your commit types or tools, e.g., Bitbucket, JIRA, Trello. This preset supports
configuration via a `.changelogrc.js` file.
**This package is best used alongside the other `ghostwriter` tools. Each tool can be configured
using the same `.changelogrc.js` file:**
- [commitlint-config-ghostwriter](../commitlint-config-ghostwriter)
- [cz-ghostwriter](../cz-ghostwriter)
## Installation
npm
```sh
npm install --save-dev conventional-changelog-ghostwriter
```
pnpm
```sh
pnpm install --save-dev conventional-changelog-ghostwriter
```
yarn
```sh
yarn add --dev conventional-changelog-ghostwriter
```
## Usage
1. Create and configure a `.changelogrc.js` file in the root of your repository
2. Update your `CHANGELOG.md` generator to leverage `conventional-changelog-ghostwriter`
- Conventional Changelog CLI
```sh
conventional-changelog-cli -p ghostwriter
```
- Lerna
```json
{
...
"command": {
"version": {
"changelogPreset": "ghostwriter",
"conventionalCommits": true
}
}
...
}
```
- Semantic Release
```js
module.exports = {
...
plugins: [
[
'@semantic-release/commit-analyzer',
{
preset: 'ghostwriter',
},
],
[
'@semantic-release/release-notes-generator',
{
preset: 'ghostwriter',
},
],
],
...
};
```
3. Generate your `CHANGELOG.md`
## Configuration
### `commitUrlFormat` : _string_
---
The URL template to use when generating links to a specific commit hash.
| Template Variable | Description |
| ----------------- | ----------------------------------------- |
| `{{LONG_HASH}}` | The fully qualified git commit hash. |
| `{{SHORT_HASH}}` | The short version of the git commit hash. |
### `compareUrlFormat` : _string_
---
The URL template to use when generating links to a comparison between two git shas.
| Template Variable | Description |
| ------------------ | ------------------------------------------------------------ |
| `{{CURRENT_TAG}}` | The tag of the version the changelog is being generated for. |
| `{{PREVIOUS_TAG}}` | The tag of the last version the changelog was generated for. |
### `issuePrefixes` : _string[]_
---
The array of prefixes used to detect references to issues.
### `issueReferencesPrefix` : _string = "for"_
---
The prefix to use before listing issues that a commit refers to. Defaults to `"for"`.
### `issueUrlFormat` : _string_
---
The URL template to use when generating links to a comparison between two git shas.
| Template Variable | Description |
| ------------------ | ------------------- |
| `{{ISSUE_NUMBER}}` | The issue's number. |
| `{{ISSUE_PREFIX}}` | The issue's prefix. |
### `omitVersionSpacing` : _boolean | undefined_
---
When `true`, omits the `
` tag rendered between version numbers.
### `preset` : _"github" | undefined_
---
The configuration preset to use which will set other configuration properties. If this property is
set the following configuration properties are overwritten, i.e., nullable:
- `commitUrlFormat`
- `compareUrlFormat`
- `issuePrefixes`
- `issueReferencesPrefix`
- `issueUrlFormat`
### `types` : _Array_
---
The array of type objects representing the explicitly supported commit message types, and whether
they should show up in generated CHANGELOGs.
```ts
type CommitType = { description: string; type: string };
type HiddenType = CommitType & { hidden: true; section: undefined };
type VisibleType = CommitType & { hidden: undefined; section: string };
```
## Noteworthy
### Asterisk Scope
If the scope of a commit is `*` it will be omitted from the changelog.
> Inputted Commit:
>
> `feat(*): add awesome things`
>
> Outputted Changelog:
>
> `feat: add awesome things`
---
_Source: https://npm.io/package/conventional-changelog-ghostwriter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._