Repository URL to install this package:
|
Version:
0.6.0 ▾
|
Lint a string against commitlint rules
npm install --save @commitlint/lint
const lint = 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.