Logo for jsDocs.io

@commitlint/lint

  • Version 19.2.2
  • Published
  • 14 kB
  • 4 dependencies
  • MIT license

Install

npm i @commitlint/lint
yarn add @commitlint/lint
pnpm add @commitlint/lint

Overview

Lint a string against commitlint rules

Index

Functions

Functions

function lint

lint: (
    message: string,
    rawRulesConfig?: QualifiedRules,
    rawOpts?: LintOptions
) => Promise<LintOutcome>;

    Package Files (1)

    Dependencies (4)

    Dev Dependencies (2)

    Peer Dependencies (0)

    No peer dependencies.

    Badge

    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@commitlint/lint.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@commitlint/lint)
    • HTML
      <a href="https://www.jsdocs.io/package/@commitlint/lint"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>