Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

webdeveric/commitlint-plugin-cspell

Repository files navigation

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.

i️ 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'],
 },
};

Sponsor this project

AltStyle によって変換されたページ (->オリジナル) /