@commitlint/lint

Lint a string against commitlint rules

Last updated 2 years ago by escapedcat .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ gnpm install @commitlint/lint

SYNC missed versions from official npm registry.

Lint a string against commitlint rules

@commitlint/lint

Getting started

npm install --save @commitlint/lint

Example

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.

Current Tags

17.1.0 ... latest (2 years ago)

51 Versions

Maintainers (1)

marionebl

Downloads

Today 0

This Week 0

This Month 2

Last Day 0

Last Week 2

Last Month 0

Dependencies (4)

Dev Dependencies (2)

@commitlint/test ^17.0.0
@commitlint/utils ^17.0.0

Dependents (2)