@commitlint/parse

v19.5.0
Lint your commit messages
conventional-changelog commitlint library core

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
    }
    
npm i @commitlint/parse

Metadata

  • MIT
  • >=v18
  • Mario Nebl
  • released 9/11/2024

Downloads