conventional-changelog-action/node_modules/@commitlint/parse
Conventional Changelog Action 2eb3616352 chore(release): v3.9.1 2021-10-05 21:16:53 +00:00
..
CHANGELOG.md chore(release): v3.9.1 2021-10-05 21:16:53 +00:00
README.md chore(release): v3.9.1 2021-10-05 21:16:53 +00:00
license.md chore(release): v3.9.1 2021-10-05 21:16:53 +00:00
package.json chore(release): v3.9.1 2021-10-05 21:16:53 +00:00

README.md

Parse commit messages to structured data

@commitlint/parse

Install

npm install --save @commitlint/parse

Use

const parse = require('@commitlint/parse');

API

parse(message: string, parser: Function, parserOpts: Object)

  • message: Commit message to parser
  • parser: Sync parser function to use. Defaults to sync of conventional-commits-parser
  • parserOpts: Options to pass to parser
    {
      commentChar: null, // character indicating comment lines
      issuePrefixes: ['#'] // prefix characters for issue references
    }