https://github.com/webdeveric/commitlint-plugin-cspell

Spellcheck your commit messages with CSpell
https://github.com/webdeveric/commitlint-plugin-cspell

commitlint commitlint-plugin commitlintplugin cspell spellcheck

Last synced: 5 months ago
JSON representation

Spellcheck your commit messages with CSpell

• Host: GitHub
• URL: https://github.com/webdeveric/commitlint-plugin-cspell
• Owner: webdeveric
• License: mit
• Created: 2024-07-26T22:22:15.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-17T00:48:38.000Z (6 months ago)
• Last Synced: 2025-04-17T13:50:19.150Z (6 months ago)
• Topics: commitlint, commitlint-plugin, commitlintplugin, cspell, spellcheck
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/commitlint-plugin-cspell
• Size: 630 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# `commitlint-plugin-cspell`

[![Node.js CI](https://github.com/webdeveric/commitlint-plugin-cspell/actions/workflows/node.js.yml/badge.svg)](https://github.com/webdeveric/commitlint-plugin-cspell/actions/workflows/node.js.yml)

## Install

```sh

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.

:information_source: 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`:

```js

/**

 * @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'],

  },

};

```