npmpackage.info

Gathering detailed insights and metrics for conventional-commits-parser

Other packages similar to conventional-commits-parser

@types/conventional-commits-parser

5.0.1

TypeScript definitions for conventional-commits-parser

conventional-commits-filter

5.0.0

Filter out reverted commits parsed by conventional-commits-parser.

@conventional-commits/parser

0.4.1

reference implementation of conventionalcommits.org spec

@marionebl/conventional-commits-parser

3.0.0

Parse raw conventional commits

Gathering detailed insights and metrics for conventional-commits-parser

conventional-commits-parser - 6.1.0 | npmpackage.info

conventional-commits-parser

Generate changelogs and release notes from a project's commit messages and metadata.

6.1.0

8,081

ISC

TypeScript

73.47 kB

1,179,002,611 4.9

Installations

npm install conventional-commits-parser

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=18

Node Version

18.20.6

NPM Version

10.8.2 Pull Requests

Open

26

Total

842

Closed

292

Merged

524

Issues

Open

220

Total

528

Closed

308

Releases

152

conventional-commits-parser: v6.1.0

conventional-commits-parser-v6.1.0

Updated on Feb 16, 2025

conventional-recommended-bump: v11.0.0

conventional-recommended-bump-v11.0.0

Updated on Feb 16, 2025

conventional-changelog-writer: v8.0.1

conventional-changelog-writer-v8.0.1

Updated on Feb 16, 2025

git-client: v2.0.0

git-client-v2.0.0

Updated on Feb 16, 2025

conventional-changelog-core: v9.0.0

conventional-changelog-core-v9.0.0

Updated on Feb 16, 2025

git-client: v1.0.1

git-client-v1.0.1

Updated on May 06, 2024

View All 152 releases

Languages

TypeScript

JavaScript

Handlebars

TypeScript (78.81%)

JavaScript (18.84%)

Handlebars (2.34%)

Developer

conventional-changelog

Download Statistics

Total Downloads

1,179,002,611

Last Day

1,555,570

Last Week

8,464,958

Last Month

35,119,075

Last Year

356,019,065

GitHub Statistics

ISC License

8,081 Stars

1,741 Commits

731 Forks

55 Watchers

6 Branches

150 Contributors

Updated on May 09, 2025

Maintainers

View All 150 Contributors

Package Meta Information

Latest Version

6.1.0

Package Id

conventional-commits-parser@6.1.0

Unpacked Size

73.47 kB

Size

19.70 kB

File Count

NPM Version

10.8.2

Node Version

18.20.6

Published on

Feb 16, 2025

Total Downloads

Cumulative downloads

Total Downloads

1,179,002,611

Last Day

61.4%

1,555,570

Compared to previous day

Last Week

8.3%

8,464,958

Compared to previous week

Last Month

-2.1%

35,119,075

Compared to previous month

Last Year

39.1%

356,019,065

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

meow

conventional-commits-parser

Parse raw conventional commits.

Install • Usage • Message format • API • CLI

Install

1# pnpm
2pnpm add conventional-commits-parser
3# yarn
4yarn add conventional-commits-parser
5# npm
6npm i conventional-commits-parser

Usage

1import {
2  CommitParser,
3  parseCommits,
4  parseCommitsStream
5} from 'conventional-commits-parser'
6import { pipeline } from 'stream/promises'
7import { Readable } from 'stream'
8
9const rawCommitMessage = 'feat(scope): broadcast $destroy event on scope destruction\nCloses #1'
10
11// to parse raw commit message manually:
12const parser = new CommitParser(options)
13
14console.log(parser.parse(rawCommitMessage))
15
16// to parse raw commit messages async iterables:
17await pipeline(
18  [rawCommitMessage],
19  parseCommits(options),
20  async function* (parsedCommits) {
21    for await (const commit of parsedCommits) {
22      console.log(commit)
23    }
24  }
25)
26
27// to parse raw commit messages streams:
28Readable.from([rawCommitMessage])
29  .pipe(parseCommitsStream(options))
30  .on('data', commit => console.log(commit))

Parser expects raw commit message. Examples:

1'feat(scope): broadcast $destroy event on scope destruction\nCloses #1'
2'feat(ng-list): Allow custom separator\nbla bla bla\n\nBREAKING CHANGE: some breaking change.\nThanks @stevemao\n'

It will return parsed commit object. Examples:

1{
2  type: 'feat',
3  scope: 'scope',
4  subject: 'broadcast $destroy event on scope destruction',
5  merge: null,
6  header: 'feat(scope): broadcast $destroy event on scope destruction',
7  body: null,
8  footer: 'Closes #1',
9  notes: [],
10  references:
11   [{
12     action: 'Closes',
13     owner: null,
14     repository: null,
15     issue: '1',
16     raw: '#1',
17     prefix: '#'
18   }],
19  mentions: [],
20  revert: null
21}
22{
23  type: 'feat',
24  scope: 'ng-list',
25  subject: 'Allow custom separator',
26  merge: null,
27  header: 'feat(ng-list): Allow custom separator',
28  body: 'bla bla bla',
29  footer: 'BREAKING CHANGE: some breaking change.\nThanks @stevemao',
30  notes:
31   [{
32     title: 'BREAKING CHANGE',
33     text: 'some breaking change.\nThanks @stevemao'
34   }],
35  references: [],
36  mentions: ['stevemao'],
37  revert: null
38}

Conventional Commit Message Format

A minimum input should contain a raw message.

Each commit message consists of a merge header, a header (mandatory), a body and a footer. Mention (optional) someone using the @ notation.

<merge>
<header>
<body>
<footer>

merge

The merge header may optionally have a special format that includes other parts, such as branch, issueId or source.

Merge branch <branch>
Merge pull request <issue-id> from <source>

header

The header may optionally have a special format that includes other parts, such as type, scope and subject. You could reference (optional) issues here.

<type>(<scope>): <subject>

footer

The footer should contain any information about Important Notes (optional) and is also the place to reference (optional) issues.

<important note>
<references>

other parts

This module will only parse the message body. However, it is possible to include other fields such as hash, committer or date.

My commit message
-sideNotes-
It should warn the correct unfound file names.
Also it should continue if one file cannot be found.
Tests are added for these

Then sideNotes will be It should warn the correct unfound file names.\nAlso it should continue if one file cannot be found.\nTests are added for these. You can customize the fieldPattern.

API

`new CommitParser(options?: ParserOptions)`

Creates parser instance with parse method.

`parseCommits(options?: ParserOptions)`

Create async generator function to parse async iterable of raw commits. If there is any malformed commits it will be gracefully ignored (an empty data will be emitted so down async iterable can notice).

`parseCommitsStream(options?: ParserOptions)`

Creates an transform stream. If there is any malformed commits it will be gracefully ignored (an empty data will be emitted so down stream can notice).

ParserOptions

mergePattern

Type: RegExp Default: null

Pattern to match merge headers. EG: branch merge, GitHub or GitLab like pull requests headers. When a merge header is parsed, the next line is used for conventional header parsing.

For example, if we have a commit

Merge pull request #1 from user/feature/feature-name

feat(scope): broadcast $destroy event on scope destruction

We can parse it with these options and the default headerPattern:

1{
2  mergePattern: /^Merge pull request #(\d+) from (.*)$/,
3  mergeCorrespondence: ['id', 'source']
4}

mergeCorrespondence

Type: string[], Default: null

Used to define what capturing group of mergePattern.

headerPattern

Type: RegExp, Default: /^(\w*)(?:$([\w\$\.\-\* ]*)$)?\: (.*)$/

Used to match header pattern.

headerCorrespondence

Type: string[], Default ['type', 'scope', 'subject']

Used to define what capturing group of headerPattern captures what header part. The order of the array should correspond to the order of headerPattern's capturing group. If the part is not captured it is null.

referenceActions

Type: string[], Default: ['close', 'closes', 'closed', 'fix', 'fixes', 'fixed', 'resolve', 'resolves', 'resolved']

Keywords to reference an issue. This value is case insensitive.

Set it to null to reference an issue without any action.

issuePrefixes

Type: string[], Default: ['#']

The prefixes of an issue. EG: In gh-123 gh- is the prefix.

issuePrefixesCaseSensitive

Type: boolean, Default: false

Used to define if issuePrefixes should be considered case sensitive.

noteKeywords

Type: string[], Default: ['BREAKING CHANGE', 'BREAKING-CHANGE']

Keywords for important notes. This value is case insensitive.

notesPattern

Type: function, Default: noteKeywordsSelection => ^[\\s|*]*(' + noteKeywordsSelection + ')[:\\s]+(.*) where noteKeywordsSelection is join(noteKeywords, '|')

A function that takes noteKeywordsSelection and returns a RegExp to be matched against the notes.

fieldPattern

Type: RegExp, Default: /^-(.*?)-$/

Pattern to match other fields.

revertPattern

Type: RegExp, Default: /^Revert\s"([\s\S]*)"\s*This reverts commit (\w*)\./

Pattern to match what this commit reverts.

revertCorrespondence

Type: string[], Default: ['header', 'hash']

Used to define what capturing group of revertPattern captures what reverted commit fields. The order of the array should correspond to the order of revertPattern's capturing group.

For example, if we had commit

Revert "throw an error if a callback is passed"

This reverts commit 9bb4d6c.

If configured correctly, the parsed result would be

1{
2  revert: {
3    header: 'throw an error if a callback is passed',
4    hash: '9bb4d6c'
5  }
6}

It implies that this commit reverts a commit with header 'throw an error if a callback is passed' and hash '9bb4d6c'.

commentChar

Type: string or null, Default: null

What commentChar to use. By default it is null, so no comments are stripped. Set to # if you pass the contents of .git/COMMIT_EDITMSG directly.

If you have configured the git commentchar via git config core.commentchar you'll want to pass what you have set there.

warn

Type: function or boolean, Default: () => {}

What warn function to use. For example, console.warn.bind(console). By default, it's a noop. If it is true, it will error if commit cannot be parsed (strict).

CLI

You can use cli to practice writing commit messages or parse messages from files. Note: the sample output might be different. It's just for demonstration purposes.

If you run conventional-commits-parser without any arguments

1$ conventional-commits-parser --help # for more details

You will enter an interactive shell. To show your parsed output enter "return" three times (or enter your specified separator).

1> fix(title): a title is fixed
2
3
4{"type":"fix","scope":"title","subject":"a title is fixed","header":"fix(title): a title is fixed","body":null,"footer":null,"notes":[],"references":[],"revert":null}

You can also use cli to parse messages from files.

If you have log.txt

1feat(ngMessages): provide support for dynamic message resolution
2
3Prior to this fix it was impossible to apply a binding to a the ngMessage directive to represent the name of the error.
4
5BREAKING CHANGE: The `ngMessagesInclude` attribute is now its own directive and that must be placed as a **child** element within the element with the ngMessages directive.
6
7Closes #10036
8Closes #9338

And you run

1$ conventional-commits-parser log.txt
2# or
3$ cat log.txt | conventional-commits-parser

An array of json will be printed to stdout.

1[
2{"type":"feat","scope":"ngMessages","subject":"provide support for dynamic message resolution","header":"feat(ngMessages): provide support for dynamic message resolution","body":"Prior to this fix it was impossible to apply a binding to a the ngMessage directive to represent the name of the error.","footer":"BREAKING CHANGE: The `ngMessagesInclude` attribute is now its own directive and that must be placed as a **child** element within the element with the ngMessages directive.\nCloses #10036\nCloses #9338","notes":[{"title":"BREAKING CHANGE","text":"The `ngMessagesInclude` attribute is now its own directive and that must be placed as a **child** element within the element with the ngMessages directive."}],"references":[{"action":"Closes","owner":null,"repository":null,"issue":"10036","raw":"#10036"},{"action":"Closes","owner":null,"repository":null,"issue":"9338","raw":"#9338"}],"revert":null}
3]

Commits should be split by at least three newlines (\n\n\n) or you can specify a separator as the second argument.

Eg: in log2.txt

1
2docs(ngMessageExp): split ngMessage docs up to show its alias more clearly
3===
4
5fix($animate): applyStyles from options on leave
6
7Closes #10068

And you run

1$ conventional-commits-parser log2.txt '==='

1[
2{"type":"docs","scope":"ngMessageExp","subject":"split ngMessage docs up to show its alias more clearly","header":"docs(ngMessageExp): split ngMessage docs up to show its alias more clearly","body":null,"footer":null,"notes":[],"references":[],"revert":null}
3,
4{"type":"fix","scope":"$animate","subject":"applyStyles from options on leave","header":"fix($animate): applyStyles from options on leave","body":null,"footer":"Closes #10068","notes":[],"references":[{"action":"Closes","owner":null,"repository":null,"issue":"10068","raw":"#10068"}],"revert":null}
5]

Will be printed out.

You can specify one or more files. The output array will be in order of the input file paths. If you specify more than one separator, the last one will be used.

License

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/checks.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/checks.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/checks.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/checks.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/checks.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/checks.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/checks.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/checks.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/checks.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/checks.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commit.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/commit.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/commit.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/commit.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commit.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/commit.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-all.yaml:7: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/publish-all.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-all.yaml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/publish-all.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-all.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/publish-all.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-submodules.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/release-submodules.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-submodules.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/release-submodules.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-submodules.yaml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/release-submodules.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-submodules.yaml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/release-submodules.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-submodules.yaml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/release-submodules.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-submodules.yaml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/release-submodules.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-submodules.yaml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/release-submodules.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yaml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yaml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yaml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yaml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yaml:102: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yaml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/conventional-changelog/conventional-changelog/tests.yaml/master?enable=pin
Info: 0 out of 19 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 14 third-party GitHubAction dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

4.9

/10

Last Scanned on 2025-05-05

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More