Skip to content

Latest commit

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..

README.md

Lint a string against commitlint rules

@commitlint/lint

Getting started

npm install --save @commitlint/lint

Example

constlint=require('@commitlint/lint').default;lint('foo: bar',{'type-enum': [1,'always',['foo']]}).then((report)=>console.log(report));// => { valid: true, errors: [], warnings: [] }lint('foo: bar',{'type-enum': [1,'always',['bar']]}).then((report)=>console.log(report));/* => { valid: true, errors: [], warnings: [ { level: 1, valid: false, name: 'type-enum', message: 'type must be one of [bar]' } ] } */

Consult docs/api for comprehensive documentation.