commitlint-plugin-cspell
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

commitlint-plugin-cspell

Node.js CI

Install

pnpm add commitlint-plugin-cspell -D

Configure rules

This config shows all the rules provided by this plugin. You must use at least one of them to get spell checking.

ℹ️ If you're using conventional commits, you'll probably want to use cspell/type, cspell/scope, and cspell/subject instead of cspell/header.


Example commitlint.config.mjs:

/**
 * @type {import('@commitlint/types').UserConfig}
 */
export default {
  plugins: ['commitlint-plugin-cspell'],
  rules: {
    'cspell/type': [2, 'always'],
    'cspell/scope': [2, 'always'],
    'cspell/subject': [2, 'always'],
    'cspell/header': [2, 'always'],
    'cspell/body': [2, 'always'],
    'cspell/footer': [2, 'always'],
  },
};

Package Sidebar

Install

npm i commitlint-plugin-cspell

Weekly Downloads

555

Version

0.2.0

License

MIT

Unpacked Size

10.3 kB

Total Files

15

Last publish

Collaborators

  • webdeveric