@conventional-commits/parser

Conventional Commits Parser

!ci
!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

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

API

$3

Runs conventional commits parser on the string provided.

* Returns: Object adhering to unist spec.

$3

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.

`ebnf
/ See: https://tools.ietf.org/html/rfc3629#section-4 /
::= "Placeholder for UTF-8 grammar"
::= +

::= "0x000D"
::= "0x000A"
::= [],
::= "(" | ")"
::= "U+FEFF"
::= "U+0009"
::= "U+000B"
::= "U+000C"
::= "U+0020"
::= "U+00A0"
/ See: https://www.ecma-international.org/ecma-262/11.0/index.html#sec-white-space /
::= "Any other Unicode 'Space_Separator' code point"
/ Any non-newline whitespace: /
::= | | | | | |

::=