conventional-changelog-conventionalcommits

npmpackage.info

Gathering detailed insights and metrics for conventional-changelog-conventionalcommits

Other packages similar to conventional-changelog-conventionalcommits

@mattclough/conventional-changelog-conventionalcommits

5.1.1

conventional-changelog conventionalcommits.org preset

@avolantis/conventional-changelog-conventionalcommits

0.1.3

Shared conventional changelog preset for Avolantis commit conventions

conventional-changelog-conventionalcommits-factorio

2.0.3

conventional-changelog preset for factorio mod changelogs

@xunnamius/conventional-changelog-projector

1.2.2

⛔️ [DEPRECATED] conventional-changelog @xunnamius/projector preset originally forked from conventional-changelog-conventionalcommits

Gathering detailed insights and metrics for conventional-changelog-conventionalcommits

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 Usage and with the --config or -n parameter, pass a js config that looks like this:

1import createPreset from 'conventional-changelog-conventionalcommits' 2 3createPreset({ 4 issuePrefixes: ['TEST-'], 5 issueUrlFormat: 'https://myBugTracker.com/{{prefix}}{{id}}' 6}).then((config) => { 7 // do something with the config 8})

or json config like that:

1{ 2 "options": { 3 "preset": { 4 "name": "conventionalcommits", 5 "issuePrefixes": ["TEST-"], 6 "issueUrlFormat": "https://myBugTracker.com/{{prefix}}{{id}}" 7 } 8 } 9}

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-conventionalcommits.

Specific Options

Option	Description
ignoreCommits	Regular expression to match and exclude commits from the changelog. Commits matching this pattern will be ignored.
types	Array of commit type objects defining which types to include in the changelog. Hidden types are excluded from the changelog but may still trigger version bumps. Default value accessible via `DEFAULT_COMMIT_TYPES` export.
bumpStrict	When `true`, version bumps occur only for breaking changes or non-hidden commit types. When `false` (default), any commit can trigger a version bump.
scope	String or array of scope names to filter commits. Only commits with matching scopes will be included. When `scopeOnly` is `false` (default), commits without any scope are also included.
scopeOnly	When `true` and `scope` is specified, excludes commits that have no scope. When `false` (default), includes both scoped and unscooped commits when filtering by scope.

Option

Description

ignoreCommits

Regular expression to match and exclude commits from the changelog. Commits matching this pattern will be ignored.

types

Array of commit type objects defining which types to include in the changelog. Hidden types are excluded from the changelog but may still trigger version bumps. Default value accessible via DEFAULT_COMMIT_TYPES export.

bumpStrict

When true, version bumps occur only for breaking changes or non-hidden commit types. When false (default), any commit can trigger a version bump.

scope

String or array of scope names to filter commits. Only commits with matching scopes will be included. When scopeOnly is false (default), commits without any scope are also included.

scopeOnly

When true and scope is specified, excludes commits that have no scope. When false (default), includes both scoped and unscooped commits when filtering by scope.

Other packages similar to conventional-changelog-conventionalcommits

Other packages similar to conventional-changelog-conventionalcommits

Installations

Developer Guide

No

ESM

>=18

20.19.3

10.8.2

Score

Pull Requests

22

858

297

539

Issues

220

533

313

Releases

Languages

Developer

conventional-changelog

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

conventional-changelog-conventionalcommits

Install

Indirect Usage (as preset)

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

Specific Options

10

10

10

10

9

0

0

0

0

0

0

0

4.7

/10