npmpackage.info

Gathering detailed insights and metrics for @conventional-commits/parser

Other packages similar to @conventional-commits/parser

conventional-commits-parser

6.2.0

Parse raw conventional commits.

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

@marionebl/conventional-commits-parser

3.0.0

Parse raw conventional commits

Gathering detailed insights and metrics for @conventional-commits/parser

@conventional-commits/parser - 0.4.1 | npmpackage.info

@conventional-commits/parser

reference implementation of conventionalcommits.org spec

0.4.1

ISC

JavaScript

28.16 kB

11,835,363

Installations

npm install @conventional-commits/parser

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

14.15.1

NPM Version

6.14.8 Pull Requests

Open

3

Total

32

Closed

1

Merged

28

Issues

Open

11

Total

17

Closed

6

Releases

@conventional-commits/parser v0.4.1

v0.4.1

Updated on Jan 07, 2021

@conventional-commits/parser v0.4.0

v0.4.0

Updated on Jan 07, 2021

@conventional-commits/parser v0.3.0

v0.3.0

Updated on Dec 30, 2020

@conventional-commits/parser v0.2.0

v0.2.0

Updated on Dec 28, 2020

initial release

v0.1.0

Updated on Dec 28, 2020

View All 5 releases

Languages

JavaScript

JavaScript (100%)

Developer

conventional-commits

Download Statistics

Total Downloads

11,835,363

Last Day

6,205

Last Week

111,510

Last Month

561,961

Last Year

9,571,558

GitHub Statistics

ISC License

50 Stars

31 Commits

8 Forks

5 Watchers

6 Branches

11 Contributors

Updated on Jun 03, 2025

Maintainers

View All 11 Contributors

Package Meta Information

Latest Version

0.4.1

Package Id

@conventional-commits/parser@0.4.1

Unpacked Size

28.16 kB

Size

7.98 kB

File Count

NPM Version

6.14.8

Node Version

14.15.1

Total Downloads

Cumulative downloads

Total Downloads

11,835,363

Last Day

41%

6,205

Compared to previous day

Last Week

-0.7%

111,510

Compared to previous week

Last Month

-7.6%

561,961

Compared to previous month

Last Year

506%

9,571,558

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

unist-util-visit unist-util-visit-parents

Dev Dependencies

c8 chai chai-jest-snapshot mocha standard unist-util-inspect unist-util-source unist-util-visit yargs

Conventional Commits Parser

nycrc config on GitHub

Reference implementation of Conventional Commits specification.

Outputs a tree structure based on the unist specification.

Install

npm i @conventional-commits/parser

Usage

1const {parser} = require('@conventional-commits/parser')
2const ast = parser('feat(parser): add support for scopes')

API

`parser(text: string)`

Runs conventional commits parser on the string provided.

Returns: Object adhering to unist spec.

`toConventionalChangelogFormat(ast: object)`

Given an object, representing the parsed commit messages in unist format, returns an object useable by the conventional-changelog ecosystem of libraries.

The Grammar

The parser is based on the following grammar. An effort is made to keep this in sync with the written specification on conventionalcommits.org.

1/* See: https://tools.ietf.org/html/rfc3629#section-4 */
2<UTF8-char>       ::= "Placeholder for UTF-8 grammar"
3<UTF8-octets>     ::= <UTF8char>+
4
5<CR>              ::= "0x000D"
6<LF>              ::= "0x000A"
7<newline>         ::= [<CR>], <LF>
8<parens>          ::= "(" | ")"
9<ZWNBSP>          ::= "U+FEFF"
10<TAB>             ::= "U+0009"
11<VT>              ::= "U+000B"
12<FF>              ::= "U+000C"
13<SP>              ::= "U+0020"
14<NBSP>            ::= "U+00A0"
15/* See: https://www.ecma-international.org/ecma-262/11.0/index.html#sec-white-space */
16<USP>             ::= "Any other Unicode 'Space_Separator' code point"
17/* Any non-newline whitespace: */
18<whitespace>      ::= <ZWNBSP> | <TAB> | <VT> | <FF> | <SP> | <NBSP> | <USP>
19
20<message>         ::= <summary>, <newline>+, <body>, (<newline>+, <footer>)*
21                   |  <summary>, (<newline>+, <footer>)*
22                   |  <summary>, <newline>*
23
24/* "!" should be added to the AST as a <breaking-change> node with the value "!" */
25<summary>         ::= <type>, "(", <scope>, ")", ["!"], ":", <whitespace>*, <text>
26                   |  <type>, ["!"], ":", <whitespace>*, <text>
27<type>            ::= <any UTF8-octets except newline or parens or ":" or "!:" or whitespace>+
28<scope>           ::= <any UTF8-octets except newline or parens>+
29<text>            ::= <any UTF8-octets except newline>*
30
31
32<body>            ::= [<any body-text except pre-footer>], <newline>, <body>*
33                   |  [<any body-text except pre-footer>]
34/* For convenience the <breaking-change>, <separator>, <whitespace>, and
35 * <text> tokens of <body-text> should be appended as children to <body> */
36<body-text>       ::= [<breaking-change>, ":", <whitespace>*], text
37/* Note: <pre-footer> is used during parsing, but not returned in the AST. */
38<pre-footer>      ::= <newline>+, <footer>
39
40<footer>          ::= <token>, <separator>, <whitespace>*, <value>
41/* "!" should be added to the AST as a <breaking-change> node with the value "!" */
42<token>           ::= <breaking-change>
43                   |  <type>, "(" <scope> ")", ["!"]
44                   |  <type>, ["!"]
45<separator>       ::= ":" | " #"
46<value>           ::= <text>, <continuation>+
47                   |  <text>
48<continuation>    ::= <newline>, <whitespace>+, <text>
49
50<breaking-change> ::= "BREAKING CHANGE" | "BREAKING-CHANGE"

No vulnerabilities found.