# conventional-changelog-comprehensive

> conventional-changelog comprehensive preset

Latest version **0.1.1** (published 2023-01-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install conventional-changelog-comprehensive
pnpm add conventional-changelog-comprehensive
yarn add conventional-changelog-comprehensive
bun add conventional-changelog-comprehensive
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2023-01-05 |
| First published | 2023-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 3 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ali Samar |
| Maintainers | alisamar |
| Keywords | conventional-changelog, preset |

## Links

- npm: https://www.npmjs.com/package/conventional-changelog-comprehensive
- Repository: https://github.com/alisamar/conventional-changelog-comprehensive
- Homepage: https://github.com/alisamar/conventional-changelog-comprehensive#readme
- Issues: https://github.com/alisamar/conventional-changelog-comprehensive/issues
- npm.io page: https://npm.io/package/conventional-changelog-comprehensive

## Dependencies (3)

- [q](https://npm.io/package/q.md) ^1.5.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [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

- 0.1.1 (latest) — 2023-01-05
- 0.1.0 — 2023-01-03

## README

# conventionalcommits.org convention

A concrete implementation of the specification described at
[conventionalcommits.org](https://conventionalcommits.org/) for automated
CHANGELOG generation and version management.

## Installing conventional-changelog-comprehensive

### As a local ``npm run`` script

Install and add to devDependencies:

```bash
npm install --save-dev conventional-changelog-comprehensive
```

## Indirect Usage (as preset)

Use the [Conventional Changelog CLI Quick Start](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#quick-start) with the `-p comprehensive` option.

## Direct Usage (as a base preset so you can customize it)

If you want to use this package directly and pass options, you can use the [Conventional Changelog CLI Quick Start](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#quick-start) and with the `--config` or `-n` parameter, pass a js config that looks like this

```js
'use strict'
const config = require('conventional-changelog-comprehensive')

module.exports = config({
    "issuePrefixes": ["TEST-"],
    "issueUrlFormat": "https://myBugTracker.com/{{prefix}}{{id}}"
})
```

or json config like that:
```js
{
    "options": {
        "preset": {
            "name": "comprehensive",
            "issuePrefixes": ["TEST-"],
            "issueUrlFormat": "https://myBugTracker.com/{{prefix}}{{id}}"
        }
    }
}
```
This last json config way passes the `preset` object to the `conventional-changelog-preset-loader` package, that in turn, passes this same `preset` object as the config for the `conventional-changelog-comprehensive`.



See [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec) for available configuration options.

---
_Source: https://npm.io/package/conventional-changelog-comprehensive · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
