# @cspell/dict-git

> CSpell configuration for GIT.

Latest version **3.1.0** (published 2026-01-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cspell/dict-git
pnpm add @cspell/dict-git
yarn add @cspell/dict-git
bun add @cspell/dict-git
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2026-01-24 |
| First published | 2022-04-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 289 |
| Author | Street Side Software |
| Maintainers | jason-dent |
| Keywords | cspell, cspell-ext, git, dictionary, spelling |

## Links

- npm: https://www.npmjs.com/package/@cspell/dict-git
- Repository: https://github.com/streetsidesoftware/cspell-dicts
- Homepage: https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/vue#readme
- Issues: https://github.com/streetsidesoftware/cspell-dicts/issues
- npm.io page: https://npm.io/package/@cspell/dict-git

## Recent versions

- 3.1.0 (latest) — 2026-01-24
- 3.0.7 — 2025-07-09
- 3.0.6 — 2025-06-10
- 3.0.5 — 2025-05-16
- 3.0.4 — 2024-12-30
- 3.0.3 — 2024-10-11
- 3.0.0 — 2023-12-25
- 2.0.0 — 2022-10-10
- 1.0.1 — 2022-04-08

## README

# CSpell Git Configuration

Configuration for spell checking Git Commit messages.

<!--- @@inject: ../../static/requirements.md --->

## Requirements

| Tool                                                                                                                                 | Version |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| [cspell](https://github.com/streetsidesoftware/cspell)                                                                               | `>= 8`  |
| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4`  |

<!--- @@inject-end: ../../static/requirements.md --->

<!--- @@inject: ./static/install.md --->

## Local Installation

**This package is bundled with CSpell.**

## Configuration

<details>
<summary>VSCode Settings</summary>

Add the following to your VSCode settings:

**`.vscode/settings.json`**

```jsonc
{
  "cSpell.dictionaries": ["git"],
}
```

</details>

<details>
<summary>CSpell Settings <code>cspell.json</code></summary>

**`cspell.json`**

```jsonc
{
  "dictionaries": ["git"],
}
```

</details>

<details>
<summary>CSpell Settings <code>cspell.config.yaml</code></summary>

**`cspell.config.yaml`**

```yaml
dictionaries:
  - git
```

</details>

## Local Installation using CDN

> **NOTE:** This package is bundled with CSpell.

## Dictionary Information

| Name  | Enabled | Description |
| ----- | ------- | ----------- |
| `git` |         | Git Terms   |

## Language Settings

| Name  | Locale | File Type                  |
| ----- | ------ | -------------------------- |
| `git` |        | `commit-msg`, `git-commit` |
| `git` |        | `shellscript`              |

<!--- @@inject-end: ./static/install.md --->

<!--- @@inject: ../../static/contributing.md --->

## Contributing

Please help correct any mistakes in the dictionaries.

See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)

Special thanks to all of our amazing contributors!

### Dictionary Development

See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)

<!--- @@inject-end: ../../static/contributing.md --->

## Usage commit-msg

**`.git/hooks/commit-msg`**

```sh
#!/bin/sh

exec npx cspell --language-id commit-msg $1
```

## License

MIT

> Some packages may have other licenses included.

<!--- @@inject: ../../static/footer.md --->

<br/>

---

<p align="center">
Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
</a>
</p>

<!--- @@inject-end: ../../static/footer.md --->

---
_Source: https://npm.io/package/@cspell/dict-git · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._