CSpell

https://github.com/streetsidesoftware/cspell
Admin
CSpell is a spell checker for code that helps detect and correct spelling errors in source code,...
Tokens:185,444
Snippets:2,416
Trust Score:9.3
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Quick start: corepack enable and pnpm ibt

Source: https://github.com/streetsidesoftware/cspell/blob/main/CONTRIBUTING.md

Quick start commands for setting up the cspell repository. Run `corepack enable` first, then `pnpm ibt` which installs, builds, and tests the project.

```sh
corepack enable
pnpm ibt
```

--------------------------------

### Start the local development server

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/README.md

Run pnpm start to start the Docusaurus development server.

```bash
$ pnpm start
```

--------------------------------

### Installation commands for the website

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/README.md

Enable corepack and install dependencies with pnpm.

```bash
$ corepack enable
$ pnpm i
```

--------------------------------

### Install @cspell/dynamic-import

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/dynamic-import/README.md

Install the @cspell/dynamic-import package as a dependency.

```sh
npm install -S @cspell/dynamic-import
```

--------------------------------

### Install and lint with Yarn

Source: https://github.com/streetsidesoftware/cspell/blob/main/examples/yarn/cspell-eslint-plugin/README.md

Install dependencies and run the linter in a Yarn-based project that uses the @cspell/eslint-plugin. The first command installs packages, the second runs the lint script.

```bash
yarn
yarn lint
```

--------------------------------

### Install @cspell/cspell-json-reporter

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/README.md

Install the reporter as a development package in the repository that will use it.

```sh
npm install -SD @cspell/cspell-json-reporter
```

--------------------------------

### Install @cspell/dictionary-bundler-plugin

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md

Install the plugin as a dev dependency.

```bash
npm i -D @cspell/dictionary-bundler-plugin
```

--------------------------------

### Install CSpell-Tools

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-tools/README.md

Install the @cspell/cspell-tools package globally using npm.

```sh
npm install -g @cspell/cspell-tools
```

--------------------------------

### Install cspell globally with npm

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Install cspell globally using npm. This is the standard installation method.

```sh
npm install -g cspell
```

--------------------------------

### Install @cspell/cspell-resolver

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-resolver/README.md

Install the @cspell/cspell-resolver package as a dependency.

```sh
npm install -S @cspell/cspell-resolver
```

--------------------------------

### Install @cspell/cspell-types

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-types/README.md

Install the @cspell/cspell-types package as a dependency.

```bash
npm i -S @cspell/cspell-types
```

--------------------------------

### dictionaries and dictionaryDefinitions example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/index.mdx

Example of using dictionaries and dictionaryDefinitions in cspell.json. Relative paths are relative to the config file, and URLs are retrieved via HTTP GET.

```javascript
"language": "en",
// Dictionaries "spanish", "ruby", and "corp-terms" will always be checked.
// Including "spanish" in the list of dictionaries means both Spanish and English
// words will be considered correct.
"dictionaries": ["spanish", "ruby", "corp-terms", "fonts"],
// Define each dictionary:
//  - Relative paths are relative to the config file.
//  - URLs will be retrieved via HTTP GET
"dictionaryDefinitions": [
    { "name": "spanish", "path": "./spanish-words.txt"},
    { "name": "ruby", "path": "./ruby.txt"},
    {
      "name": "corp-terms",
      "path": "https://shared-company-repository/cspell-terms.txt"
    },
],
```

--------------------------------

### Install @cspell/strong-weak-map

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-strong-weak-map/README.md

Install the @cspell/strong-weak-map package using npm.

```sh
npm install -S @cspell/strong-weak-map
```

--------------------------------

### cspell-gitignore CLI example

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-gitignore/README.md

Example CLI output showing a matched .gitignore pattern.

```sh
$ cspell-gitignore -r . node_modules
.gitignore:58:node_modules/       node_modules
```

--------------------------------

### ESLint Configuration Example

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-eslint-plugin/README.md

Example of configuring the `@cspell/eslint-plugin` in an `eslint.config.js` file.

```APIDOC
## ESLint Configuration Example

### Description
Example of configuring the `@cspell/eslint-plugin` in an `eslint.config.js` file.

### Example
```js
import cspellPlugin from '@cspell/eslint-plugin';

export default [
  {
    plugins: { '@cspell': cspellPlugin },
    rules: {
      '@cspell/spellchecker': ['warn', { checkComments: false, autoFix: true }]
    }
  }
];
```
```

--------------------------------

### Install @cspell/normalize-json

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-normalize-json/README.md

Install the @cspell/normalize-json package as a dependency.

```sh
npm install -S @cspell/normalize-json
```

--------------------------------

### Install @cspell/cspell-junit-reporter

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-junit-reporter/README.md

Install the reporter as a development package in the repository that will use it.

```sh
npm install -SD @cspell/cspell-junit-reporter
```

--------------------------------

### Farm plugin setup

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md

Farm configuration using the plugin.

```ts
// farm.config.js
import InlineCSpellConfig from '@cspell/dictionary-bundler-plugin/farm';

export default {
  /* ... */
  plugins: [InlineCSpellConfig()]
};
```

--------------------------------

### Example cspell.json file

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Example cspell.json configuration file. Sets version to 0.2, language to en, lists words to always consider correct, and flagWords to always consider incorrect.

```jsonc
// cSpell Settings
{
  // Version of the setting file.  Always 0.2
  "version": "0.2",
  // language - current active spelling language
  "language": "en",
  // words - list of words to be always considered correct
  "words": ["mkdirp", "tsmerge", "githubusercontent", "streetsidesoftware", "vsmarketplacebadge", "visualstudio"],
  // flagWords - list of words to be always considered incorrect
  // This is useful for offensive words and common spelling errors.
  // For example "hte" should be "the"
  "flagWords": ["hte"]
}
```

--------------------------------

### overrides setting example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Example of the `overrides` setting that applies settings to specific files. It forces `*.hrr` and `*.crr` files to be treated as `cpp` files, and forces `*.txt` files in the `dutch` directory to use the Dutch dictionary (which must be installed separately).

```javascript
"overrides": [
  // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:
  {
    "filename": "**/{*.hrr,*.crr}",
    "languageId": "cpp"
  },
  // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):
  {
    "language": "nl",
    "filename": "**/dutch/**/*.txt"
  }
]
```

--------------------------------

### Webpack plugin setup

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md

Webpack configuration using the plugin.

```js
// webpack.config.js
import InlineCSpellConfig from '@cspell/dictionary-bundler-plugin/webpack';

export default {
  /* ... */
  plugins: [InlineCSpellConfig()]
};
```

--------------------------------

### Known Issues File Format Example

Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0004 known issues/README.md

Shows the format for a known issues file: each line is a path, line, character offset, and word in parentheses. Comments start with #.

```text
django/conf/global_settings.py:108:26 (Luxembourgish)
django/conf/locale/fr/*.py:*:* (octobre)
tests/aggregation_regress/tests.py:728:11 (realiased)
tests/aggregation_regress/tests.py:812:8 (referer)
tests/aggregation_regress/tests.py:915:102 (grep)
```

--------------------------------

### Install cspell-config-lib

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-config-lib/README.md

Install the cspell-config-lib package as a dependency in your project.

```sh
npm install -S cspell-config-lib
```

--------------------------------

### Install cspell-gitignore

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-gitignore/README.md

Install the cspell-gitignore package as a dependency.

```sh
npm install -S cspell-gitignore
```

--------------------------------

### Run cspell lint --help with Docker

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Example of running the cspell lint command with the Docker image to display help.

```sh
docker run -it -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest lint --help
```

--------------------------------

### Install @cspell/eslint-plugin

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-eslint-plugin/README.md

Install the plugin as a dev-dependency before configuring ESLint.

```sh
npm install --save-dev @cspell/eslint-plugin
```

--------------------------------

### Example cspell.config.mjs file

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Example cspell.config.mjs file using defineConfig from cspell. Exports a configuration with a custom words list.

```js
// @ts-check

import { defineConfig } from 'cspell';

export default defineConfig({
  words: ['mycompany']
});
```

--------------------------------

### cspell lint examples

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/src/components/help-lint.md

Example invocations of cspell lint showing how to check files, globs, and stdin input.

```text
Examples:
    cspell .                        Recursively check all files.
    cspell lint .                   The same as "cspell ."
    cspell "*.js"                   Check all .js files in the current directory
    cspell "**/*.js"                Check all .js files recursively
    cspell "src/**/*.js"            Only check .js under src
    cspell "**/*.txt" "**/*.js"     Check both .js and .txt files.
    cspell "**/*.{txt,js,md}"       Check .txt, .js, and .md files.
    cat LICENSE | cspell stdin      Check stdin
    cspell stdin://docs/doc.md      Check stdin as if it was "./docs/doc.md"
```

--------------------------------

### Install flatpack-json with npm

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/flatpack-json/README.md

Install the flatpack-json package as a dependency using npm.

```sh
npm install -S flatpack-json
```

--------------------------------

### dictionaries and dictionaryDefinitions example

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Example of using dictionaries and dictionaryDefinitions to include custom dictionaries like Spanish, Ruby, and company terms. Relative paths are relative to the config file.

```javascript
"language": "en",
// Dictionaries "spanish", "ruby", and "company-terms" will always be checked.
// Including "spanish" in the list of dictionaries means both Spanish and English
// words will be considered correct.
"dictionaries": ["spanish", "ruby", "company-terms", "fonts"],
// Define each dictionary. Relative paths are relative to the config file.
"dictionaryDefinitions": [
    { "name": "spanish", "path": "./spanish-words.txt"},
    { "name": "ruby", "path": "./ruby.txt"},
    { "name": "company-terms", "path": "./corp-terms.txt"}
],
```

--------------------------------

### ignoreRegExpList with Email and ftp pattern

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/patterns.md

Example of using ignoreRegExpList with a predefined pattern 'Email' and a custom regex '/ftp:[^\s]*/g' to ignore email addresses and text starting with 'ftp:' until the first space.

```yaml
ignoreRegExpList:
  - Email
  - >-
    /ftp:[^\s]*/g
```

--------------------------------

### esbuild plugin setup

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md

esbuild build script using the plugin.

```ts
import { build } from 'esbuild';
import InlineCSpellConfig from '@cspell/dictionary-bundler-plugin/esbuild';

build({
  plugins: [InlineCSpellConfig()]
});
```

--------------------------------

### Core pnpm commands for install, build, and test

Source: https://github.com/streetsidesoftware/cspell/blob/main/docs/build-and-packaging.md

Use these commands to set up the repository, build all packages, run tests, and execute the CLI from the repo. Always run a build before testing. The `test:update-snapshots` command requires a prior build, and `test:yarn` needs network access.

```sh
corepack enable
pnpm ibt                                   # install, build, test
pnpm run build                             # build everything; always before testing
pnpm test
pnpm --filter cspell test                  # one package's tests
pnpm --filter cspell exec vitest run src/options.test.ts   # one test file
pnpm --filter cspell... run build          # a package and its dependencies
pnpm run build:prod                        # skip test-packages
node ./bin.mjs lint <files>                # run the CLI from the repo
pnpm run test:update-snapshots             # update snapshots, after a build
pnpm run test:yarn                         # install and test the Yarn projects (needs network)
```

--------------------------------

### package.json cspell configuration example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/index.mdx

Example of storing CSpell configuration in the cspell field of a package.json file. CSpell looks for configuration in this field.

```js
{
  "name": "cspell-docs",
  "description": "Documentation for CSpell",
  // ...
  "cspell": {
    "version": "0.2",
    "useGitignore": true
  }
}
```

--------------------------------

### Enable all file types with exceptions using enableFiletypes

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Example showing how to enable all file types with a wildcard '*' and then disable json. The '!' prefix disables the file type.

```text
*           // enable checking for all file types
!json       // except for json
```

--------------------------------

### Install @cspell/url with npm

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-url/README.md

Install the @cspell/url package as a dependency using npm.

```sh
npm install -S @cspell/url
```

--------------------------------

### Install @cspell/cspell-pipe with npm

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-pipe/README.md

Use this command to install the @cspell/cspell-pipe package as a dependency.

```sh
npm install -S @cspell/cspell-pipe
```

--------------------------------

### JSON flagWords with suggestions

Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0001 suggestions/README.md

Example JSON configuration for flagWords with suggestions, showing the same entries as the YAML example but in JSON format.

```json
"flagWords": [
  "crap",
  ["hte", "the"],
  ["acadmic", "academic"],
  ["accension", "accession", "ascension"]
]
```

--------------------------------

### Install @cspell/filetypes with npm

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-filetypes/README.md

Install the @cspell/filetypes package as a dependency using npm.

```sh
npm install -S @cspell/filetypes
```

--------------------------------

### Rolldown/tsdown plugin setup

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md

Rolldown/tsdown configuration using the plugin.

```ts
// rolldown.config.ts / tsdown.config.ts
import InlineCSpellConfig from '@cspell/dictionary-bundler-plugin/rolldown';

export default {
  plugins: [InlineCSpellConfig()]
};
```

--------------------------------

### Install and link dictionary globally

Source: https://github.com/streetsidesoftware/cspell/blob/main/test-packages/dictionaries/companies/README.md

Install the dictionary package globally and add it to cspell global settings.

```sh
npm install -g @cspell/dict-companies
cspell link add @cspell/dict-companies
```

--------------------------------

### Compile MDX with Frontmatter and Highlighting

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/mdx-js/mdx/snapshot.txt

Compiles MDX with both remark and rehype plugins. This example combines frontmatter and syntax highlighting.

```js
import {compile} from '@mdx-js/mdx'

const code = await compile('export const Component = () => <div>Hello</div>', {remarkPlugins: [remarkFrontmatter], rehypePlugins: [rehypeHighlight]})

```

--------------------------------

### Enable individual file types with enableFiletypes

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Example showing how to enable or disable individual file types using the enableFiletypes setting. Lines with '!' disable the file type, while others enable it.

```text
jsonc       // enable checking for jsonc
!json       // disable checking for json
kotlin      // enable checking for kotlin
```

--------------------------------

### Enable all file types with exceptions using enabledFileTypes

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Table example showing how to enable all file types with a wildcard '*' and disable checking for json files. The values are boolean true/false.

```text
| File Type | Enabled | Comment |
| --------- | ------- | ------- |
| `*`       | `true`  | Enable all file types. |
| `json`    | `false` | Disable checking for json files. |
```

--------------------------------

### Install cspell-lib with npm

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/README.md

Install the cspell-lib package as a dependency using npm.

```bash
npm i -S cspell-lib
```

--------------------------------

### Install cspell-trie globally

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-trie/README.md

Install the cspell-trie package globally using npm.

```sh
npm install -g cspell-trie
```

--------------------------------

### Rspack plugin setup

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md

Rspack configuration using the plugin.

```ts
// rspack.config.js
import InlineCSpellConfig from '@cspell/dictionary-bundler-plugin/rspack';

export default {
  /* ... */
  plugins: [InlineCSpellConfig()]
};
```

--------------------------------

### Install hunspell-reader as a library

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/hunspell-reader/README.md

Installs the hunspell-reader package as a dependency for library usage.

```bash
npm install hunspell-reader
```

--------------------------------

### patterns and ignoreRegExpList example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/index.mdx

Example of defining named patterns and using them with ignoreRegExpList. Patterns can be combined into a single named pattern.

```javascript
"patterns": [
    {
        "name": "comment-single-line",
        "pattern": "/#.*/g"
    },
    {
        "name": "comment-multi-line",
        "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g"
    },
    // You can also combine multiple named patterns into one single named pattern
    {
        "name": "comments",
        "pattern": ["comment-single-line", "comment-multi-line"]
    }
],

"ignoreRegExpList": ["comments"]
```

--------------------------------

### Vite plugin setup

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md

Vite configuration using the plugin.

```ts
// vite.config.ts
import InlineCSpellConfig from '@cspell/dictionary-bundler-plugin/vite';

export default defineConfig({
  plugins: [InlineCSpellConfig()]
});
```

--------------------------------

### flagWords configuration example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Example of the flagWords setting in a configuration file. Entries can be a single word, word:suggestion, or word->suggestion, suggestions. Words in flagWords override words.

```json
"flagWords": [
  "color: colour",
  "incase: in case, encase",
  "canot->cannot",
  "cancelled->canceled"
]
```

--------------------------------

### patterns setting example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Example of the `patterns` setting that defines named patterns for use with `ignoreRegExpList` and `includeRegExpList`. It shows single-line and multi-line comment patterns and how to combine them into a single named pattern.

```javascript
"ignoreRegExpList": ["comments"],
"patterns": [
  {
    "name": "comment-single-line",
    "pattern": "/#.*/g"
  },
  {
    "name": "comment-multi-line",
    "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g"
  },
  // You can also combine multiple named patterns into one single named pattern
  {
    "name": "comments",
    "pattern": ["comment-single-line", "comment-multi-line"]
  }
]
```

--------------------------------

### Install hunspell-reader globally

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/hunspell-reader/README.md

Installs the hunspell-reader package globally so the command-line tool is available on your PATH.

```bash
npm install -g hunspell-reader
```

--------------------------------

### ignorePaths example

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Example of the ignorePaths configuration setting. Causes cspell to ignore anything in the node_modules directory.

```json
"ignorePaths": ["node_modules/**"]
```

--------------------------------

### Compile MDX with Frontmatter and Math

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/mdx-js/mdx/snapshot.txt

Compiles MDX with both remark and rehype plugins. This example combines frontmatter and math rendering.

```js
import {compile} from '@mdx-js/mdx'

const code = await compile('export const Component = () => <div>Hello</div>', {remarkPlugins: [remarkFrontmatter], rehypePlugins: [rehypeKatex]})

```

--------------------------------

### Install cspell-trie-lib via npm

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-trie-lib/README.md

Install the cspell-trie-lib package using npm. Run this command in your project directory to add the library as a dependency.

```sh
npm install -S cspell-trie-lib
```

--------------------------------

### Compile MDX with All Plugins

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/mdx-js/mdx/snapshot.txt

Compiles MDX with multiple remark and rehype plugins. This example combines GFM, frontmatter, syntax highlighting, and math rendering.

```js
import {compile} from '@mdx-js/mdx'

const code = await compile('export const Component = () => <div>Hello</div>', {remarkPlugins: [remarkGfm, remarkFrontmatter], rehypePlugins: [rehypeHighlight, rehypeKatex]})

```

--------------------------------

### Example JUnit XML output

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-junit-reporter/README.md

Example output for a single file with one spelling issue, showing the structure of testsuites, testsuite, and testcase elements.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="cspell" tests="1" failures="1" errors="0" time="0.001">
  <testsuite name="src/example.ts" tests="1" failures="1" errors="0" time="0.001">
    <testcase name="teh (3:5)" classname="src/example.ts">
      <failure type="spelling" message="Unknown word: &quot;teh&quot;">Unknown word: "teh"</failure>
    </testcase>
  </testsuite>
</testsuites>
```

--------------------------------

### Install cspell for Git commit-hook

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Install cspell as a dev dependency to set up a Git commit-hook.

```bash
npm install -SD cspell
```

--------------------------------

### Sample known-issues.yaml

Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0004 known issues/README.md

Example of a YAML-based known issues file with a cspell:disable comment and list items.

```yaml
# cspell:disable
- django/conf/global_settings.py:108:26 (Luxembourgish)
- django/conf/locale/fr/*.py:*:* (octobre)
- tests/aggregation_regress/tests.py:728:11 (realiased)
- tests/aggregation_regress/tests.py:812:8 (referer)
- tests/aggregation_regress/tests.py:915:102 (grep)
```

--------------------------------

### Compile MDX with GFM and Math

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/mdx-js/mdx/snapshot.txt

Compiles MDX with both remark and rehype plugins. This example combines GFM and math rendering.

```js
import {compile} from '@mdx-js/mdx'

const code = await compile('export const Component = () => <div>Hello</div>', {remarkPlugins: [remarkGfm], rehypePlugins: [rehypeKatex]})

```

--------------------------------

### Show all help options

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/static/help-lint.txt

Displays the full help output including hidden options.

```bash
cspell --help --verbose
```

--------------------------------

### Compile MDX with Remark and Rehype Plugins

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/mdx-js/mdx/snapshot.txt

Compiles MDX with both remark and rehype plugins. This example combines GFM and syntax highlighting.

```js
import {compile} from '@mdx-js/mdx'

const code = await compile('export const Component = () => <div>Hello</div>', {remarkPlugins: [remarkGfm], rehypePlugins: [rehypeHighlight]})

```

--------------------------------

### Rollup plugin setup

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-dictionary-bundler-plugin/README.md

Rollup configuration using the plugin.

```ts
// rollup.config.js
import InlineCSpellConfig from '@cspell/dictionary-bundler-plugin/rollup';

export default {
  plugins: [InlineCSpellConfig()]
};
```

--------------------------------

### Configure suggestion costs with YAML example

Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0002 improve dictionary suggestions/README.md

Example YAML configuration for defining suggestion costs in a DictionaryDefinition. It shows multiple cost entries for accented vowels, vowels, multi-character maps, accent marks, Arabic vowels, and keyboard adjacency, each with specific insDel, replace, and swap values.

```yaml
costs:
  - description: Accented Vowel Letters
    map: 'aáâäãå|eéêë|iíîï|oóôöõ|uúûü|yÿ'
    insDel: 50
    replace: 10
  - description: Vowels
    map: 'aáâäãåeéêëiíîïoóôöõuúûüyÿ'
    insDel: 50
    replace: 25 # Replacing one vowel with another is cheap
    swap: 25 # Swapping vowels are cheap
  - description: Multi Character example
    map: 'ß(ss)|œ(ae)|f(ph)'
    replace: 10
  - description: Appending / Removing Accent Marks
    map: '\u0641' # Shadda
    insDel: 10
  - description: Arabic Vowels
    map: '\u064f\u0648\u064e\u0627\u0650\u64a\u0652' # Damma, Wāw, Fatha, Alif, Kasra, Ya', Sukūn
    insDel: 20
    replace: 20
  - description: Keyboard Adjacency
    map: 'qwas|aszx|wesd|sdxc|erdf|dfcv|rtfg|fgvb|tygh|ghbn|yuhj|hjnm|uijk|jkm|iokl|opl'
    replace: 50 # make it cheaper to replace near-by keyboard characters
```

--------------------------------

### Example cspell.config.js

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/docs/configuration.md

Example cspell.config.js file that defines a custom pattern to ignore #include lines in C++ files and a custom dictionary. It uses the CSpellUserSettings type and exports the configuration object.

```javascript
'use strict';

/** @type { import("@cspell/cspell-types").CSpellUserSettings } */
const cspell = {
  description: 'Company cspell settings',
  languageSettings: [
    {
      languageId: 'cpp',
      allowCompoundWords: false,
      patterns: [
        {
          // define a pattern to ignore #includes
          name: 'pound-includes',
          pattern: /^\s*#include.*/g
        }
      ],
      ignoreRegExpList: ['pound-includes']
    }
  ],
  dictionaryDefinitions: [
    {
      name: 'custom-words',
      path: './custom-words.txt'
    }
  ],
  dictionaries: ['custom-words']
};

module.exports = cspell;

```

--------------------------------

### Dictionary repMap example

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Shows the repMap dictionary definition option, which replaces characters before dictionary search. The example replaces various tick marks with a single apostrophe.

```javascript
// Replace various tick marks with a single '
"repMap": [["'|`|’", "'"]]
```

--------------------------------

### Experimental attribute example

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt

Shows the Experimental attribute with a feature name and action.

```csharp
Experimental("MyRemoting.PSSSHRemoting", "Show")]
```

--------------------------------

### cSpell word list format example

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-tools/wordlists.md

Shows the basic cSpell word list format. Lines starting with # are comments, ! marks forbidden words, ~ removes accents and case, and * or + control compound word behavior.

```plaintext
# Comment
word
!forbid
English
~english
~cafe       # accent removed from é
café
error*
*code
+ending
```

--------------------------------

### ignoreRegExpList JSON example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

JSON example of ignoreRegExpList to ignore ALL-CAPS words. Uses JavaScript regular expression syntax.

```json
"ignoreRegExpList": ["/\\b[A-Z]+\\b/g"]
```

--------------------------------

### Run package setup scripts

Source: https://github.com/streetsidesoftware/cspell/blob/main/docs/build-and-packaging.md

Run these scripts to set repository metadata and create GitHub labels for a new package. The Lint workflow runs fix-package-json.mts with --dry-run and fails if the file needs fixing, but does not check GitHub labels.

```sh
node ./scripts/fix-package-json.mts      # sets repository, homepage, and (if published) bugs; sorts fields
node ./scripts/create-package-labels.mts # creates missing package labels on GitHub
```

--------------------------------

### Compile MDX with Multiple Remark Plugins

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/mdx-js/mdx/snapshot.txt

Compiles MDX with multiple remark plugins. This example combines GFM and frontmatter support.

```js
import {compile} from '@mdx-js/mdx'

const code = await compile('export const Component = () => <div>Hello</div>', {remarkPlugins: [remarkGfm, remarkFrontmatter]})

```

--------------------------------

### package.json dependencies for cspell and bundled dictionaries

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-bundled-dicts/README.md

Example package.json showing cspell as a devDependency and the bundled dictionaries as a dependency.

```json
  "devDependencies": {
    "cspell": "^10"
  },
  "dependencies": {
    "@cspell/cspell-bundled-dicts": "^10"
  }
```

--------------------------------

### cspell init new options and help

Source: https://github.com/streetsidesoftware/cspell/blob/main/examples/release-notes.md

Adds new init options and shows the full help for the cspell init command.

```text
  -c, --config <path>        Path to the CSpell configuration file. Conflicts
                             with --output and --format.
  --remove-comments          Remove all comments from the config file.
  --stdout                   Write the configuration to stdout instead of a
                             file.
```

```text
Usage: cspell init [options]

Initialize a CSpell configuration file.

Options:
  -c, --config <path>        Path to the CSpell configuration file. Conflicts
                             with --output and --format.
  -o, --output <path>        Define where to write file.
  --format <format>          Define the format of the file. (choices: "yaml",
                             "yml", "json", "jsonc", default: "yaml")
  --import <path|package>    Import a configuration file or dictionary package.
  --locale <locale>          Define the locale to use when spell checking (e.g.,
                             en, en-US, de).
  --dictionary <dictionary>  Enable a dictionary. Can be used multiple times.
  --no-comments              Do not add comments to the config file.
  --remove-comments          Remove all comments from the config file.
  --no-schema                Do not add the schema reference to the config file.
  --stdout                   Write the configuration to stdout instead of a
                             file.
  -h, --help                 display help for command
```

--------------------------------

### Sample known-issues.txt

Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0004 known issues/README.md

Example of a text-based known issues file with a cspell:disable comment at the top.

```text
# cspell:disable
django/conf/global_settings.py:108:26 (Luxembourgish)
django/conf/locale/fr/*.py:*:* (octobre)
tests/aggregation_regress/tests.py:728:11 (realiased)
tests/aggregation_regress/tests.py:812:8 (referer)
tests/aggregation_regress/tests.py:915:102 (grep)
```

--------------------------------

### ignoreRegExpList YAML example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

YAML example of ignoreRegExpList to ignore ALL-CAPS words. Uses JavaScript regular expression syntax.

```yaml
ignoreRegExpList:
  - >-
   /\b[A-Z]+\b/g
```

--------------------------------

### Using GlobMatcher with exclude and include modes

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-glob/README.md

Shows how to create a GlobMatcher with default exclude mode (like .gitignore) and with include mode for explicit matching. The first example uses patterns with negation, the second uses a root and mode option.

```ts
import { GlobMatcher } from 'cspell-glob';

// Patterns behave like the contents of a `.gitignore` file.
const patterns = ['*.test.js', '!important.test.js'];

const matcher = new GlobMatcher(patterns, process.cwd());

matcher.match('src/app.test.js'); // true -- matches `*.test.js`
matcher.match('src/important.test.js'); // false -- excluded by the negated pattern
matcher.match('src/app.js'); // false -- does not match any pattern
```

```ts
const matcher = new GlobMatcher(['src/**/*.ts'], { root: process.cwd(), mode: 'include' });

matcher.match('src/app.ts'); // true
matcher.match('node_modules/lib/index.ts'); // false
```

--------------------------------

### cspell.json with knownIssuesFiles

Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0004 known issues/README.md

Configuration example specifying external known issues files via the 'knownIssuesFiles' key.

```json
{
  "knownIssuesFiles": ["path/to/file.txt"]
}
```

--------------------------------

### Build BTrie file with cspell-tools

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/fixtures/dictionaries/btrie/README.md

Command to build a BTrie dictionary file from a text file. The BTrie file is used in the example configuration.

```bash
cspell-tools btrie ./btrie-words.txt
```

--------------------------------

### Apply settings with languageSettings

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/file-types.mdx

Apply specific settings based on file type using the languageSettings configuration. The YAML and JSON examples show how to add dictionaries for python and javascript files.

```yaml
languageSettings:
- languageId: python,javascript
    dictionaries:
    - html
    - lorem-ipsum
```

```json
{
    "languageSettings": [
        {
        "languageId": "python,javascript",
        "dictionaries": ["html", "lorem-ipsum"]
        }
    ]
}
```

--------------------------------

### Compile MDX with Multiple Rehype Plugins

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/mdx-js/mdx/snapshot.txt

Compiles MDX with multiple rehype plugins. This example combines syntax highlighting and math rendering.

```js
import {compile} from '@mdx-js/mdx'

const code = await compile('export const Component = () => <div>Hello</div>', {rehypePlugins: [rehypeHighlight, rehypeKatex]})

```

--------------------------------

### Build the static site

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/README.md

Run pnpm build:site to generate static content into the build directory.

```bash
$ pnpm build:site
```

--------------------------------

### Import cspell.config.js from cspell.json

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/docs/configuration.md

Example cspell.json file that imports a cspell.config.js file using the import key. This allows reusing configuration from a JavaScript file.

```javascript
{
    "import": ["../cspell.config.js"]
}

```

--------------------------------

### Monorepo directory structure example

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/docs/configuration.md

Shows a monorepo directory structure with configuration files at different levels. The spell checker searches for the nearest configuration file in the directory hierarchy.

```text
repo-root
├── cspell.config.json
├─┬ packages
│ ├─┬ package-A
│ │ ├── cspell.json
│ │ ├── README.md
│ │ └── CHANGELOG.md
│ ├─┬ package-B
│ │ ├── README.md
│ │ └── CHANGELOG.md
│ ├─┬ package-C
│ │ ├── cspell.yaml
│ │ ├── README.md
│ │ └── CHANGELOG.md

```

--------------------------------

### Configure cspell.config.js with CSpellUserSettings

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-types/README.md

Example cspell.config.js file using the CSpellUserSettings type to enable type checking and autocompletion.

```js
'use strict';

/** @type { import("@cspell/cspell-types").CSpellUserSettings } */
const cspell = {
  description: 'cspell.config.js file in samples/js-config',
  languageSettings: [
    {
      languageId: 'cpp',
      allowCompoundWords: false,
      patterns: [
        {
          name: 'pound-includes',
          pattern: /^\s*#include.*/g
        }
      ],
      ignoreRegExpList: ['pound-includes']
    }
  ],
  dictionaryDefinitions: [
    {
      name: 'custom-words',
      path: './custom-words.txt'
    }
  ],
  dictionaries: ['custom-words']
};

module.exports = cspell;
```

--------------------------------

### Example trie output

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-trie/README.md

Example output of a trie file for a given word list. Offsets are added for clarity but do not exist in the actual output. The root of the trie is the last offset.

```text
Offset  Output
------- --------
        TrieXv1
        base=10
0       *
1       d,r
2       g
3       n2
4       *e1,i3,s
5       k4
6       l5
7       a6
8       t7,w7
```

--------------------------------

### cspell init command usage

Source: https://github.com/streetsidesoftware/cspell/blob/main/examples/release-notes.md

Shows the help output for the new `cspell init` command, which initializes a CSpell configuration file. Options include `--output`, `--format`, `--import`, `--locale`, `--dictionary`, `--no-comments`, and `--no-schema`.

```text
Usage: cspell init [options]

Initialize a CSpell configuration file.

Options:
  -o, --output <path>        Define where to write file.
  --format <format>          Define the format of the file. (choices: "yaml",
                             "yml", "json", "jsonc", default: "yaml")
  --import <path|package>    Import a configuration file or dictionary package.
  --locale <locale>          Define the locale to use when spell checking (e.g.,
                             en, en-US, de).
  --dictionary <dictionary>  Enable a dictionary.
  --no-comments              Do not add comments to the config file.
  --no-schema                Do not add the schema reference to the config file.
  -h, --help                 display help for command
```

--------------------------------

### Check Node.js version

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/installation.md

Check the installed Node.js version to ensure it meets the requirement of >=18.0.

```sh
node -v
```

--------------------------------

### Create a custom dictionary with a word list and cspell.json definition

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/dictionaries/custom-dictionaries.md

Example 1 shows the two required parts for creating a custom dictionary: a word list file (custom-words.txt) and a dictionary definition in cspell.json. The word list supports comments with # and forbids words with !. The configuration enables the dictionary via the dictionaries array and defines it with dictionaryDefinitions, including the name, path relative to the cspell.json file, and addWords for editor extensions.

```text
# This is a comment
!forbiddenword
these
are
my
favorite
words

```

```js
{
    // Enable your dictionary by adding it to the list of `dictionaries`
    "dictionaries": ["custom-words"],

    // Tell CSpell about your dictionary
    "dictionaryDefinitions": [
        {
            // The name of the dictionary is used to look it up.
            "name": "custom-words",
            // Path to the custom word file. Relative to this `cspell.json` file.
            "path": "./.cspell/custom-words.txt",
            // Some editor extensions will use `addWords` for adding words to your
            // personal dictionary.
            "addWords": true
        }
    ]
}

```

--------------------------------

### cspell lint help output

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/README.md

Full help output for the 'lint' command, including usage patterns, examples, and all available options.

```sh
Usage: cspell lint [options] [globs...] [file://<path> ...] [stdin[://<path>]]

Patterns:
 - [globs...]            Glob Patterns
 - [stdin]               Read from "stdin" assume text file.
 - [stdin://<path>]      Read from "stdin", use <path> for file type and config.
 - [file://<path>]       Check the file at <path>

Examples:
    cspell .                        Recursively check all files.
    cspell lint .                   The same as "cspell ."
    cspell "*.js"                   Check all .js files in the current directory
    cspell "**/*.js"                Check all .js files recursively
    cspell "src/**/*.js"            Only check .js under src
    cspell "**/*.txt" "**/*.js"     Check both .js and .txt files.
    cspell "**/*.{txt,js,md}"       Check .txt, .js, and .md files.
    cat LICENSE | cspell stdin      Check stdin
    cspell stdin://docs/doc.md      Check stdin as if it was "./docs/doc.md"

Check spelling

Options:
  -c, --config <cspell.json>     Configuration file to use.  By default cspell
                                 looks for cspell.json in the current directory.
  --no-config-search             Disable automatic searching for additional
                                 configuration files in parent directories. Only
                                 the specified config file (if any) will be
                                 used.
  --stop-config-search-at <dir>  Specify a directory at which to stop searching
                                 for configuration files when walking up from
                                 the files being checked. Useful for limiting
                                 config inheritance.
  -v, --verbose                  Display more information about the files being
                                 checked. Add more than one -v for increased
                                 verbosity.
  --locale <locale>              Set language locales. i.e. "en,fr" for English
                                 and French, or "en-GB" for British English.
  --language-id <file-type>      Force programming language for unknown
                                 extensions. i.e. "php" or "scala"
  --words-only                   Only output the words not found in the
                                 dictionaries.
  -u, --unique                   Only output the first instance of a word not
                                 found in the dictionaries.
  -e, --exclude <glob>           Exclude files matching the glob pattern. This
                                 option can be used multiple times to add
                                 multiple globs.
  --file-list <path or stdin>    Specify a list of files to be spell checked.
                                 The list is filtered against the glob file
                                 patterns. Note: the format is 1 file path per
                                 line.
  --file [file...]               Specify files to spell check. They are filtered
                                 by the [globs...].
  --force-check                  Force the --file or --file-list documents to be
                                 checked even if it would normally be excluded.
  --no-issues                    Do not show the spelling errors.
  --no-progress                  Turn off progress messages
  --no-summary                   Turn off summary message in console.
  -s, --silent                   Silent mode, suppress error messages.
  --no-exit-code                 Do not return an exit code if issues are found.
  --quiet                        Only show spelling issues or errors.
  --fail-fast                    Exit after first file with an issue or error.
  --continue-on-error            Continue processing files even if there is a
                                 configuration error.
  -r, --root <root folder>       Root directory, defaults to current directory.
  --no-relative                  Issues are displayed with absolute path instead
```

--------------------------------

### cspell init --format=yml

Source: https://github.com/streetsidesoftware/cspell/blob/main/examples/release-notes.md

Allows initializing a cspell.config.yml file by using the --format=yml option.

```text
cspell init --format=yml
```

--------------------------------

### Hunspell AFF content example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Example of Hunspell AFF content for the `aff` field. It must be UTF-8 and can include sections like TRY, MAP, REP, KEY, ICONV, and OCONV.

```hunspell
# Comment
TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`
MAP aàâäAÀÂÄ
MAP eéèêëEÉÈÊË
MAP iîïyIÎÏY
MAP oôöOÔÖ
MAP (IJ)(Ĳ)
```

--------------------------------

### Sample known-issues.json

Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0004 known issues/README.md

Example of a JSONC-based known issues file with a cspell:disable comment as the first array element.

```jsonc
[
  "# cspell:disable",
  "django/conf/global_settings.py:108:26 (Luxembourgish)",
  "django/conf/locale/fr/*.py:*:* (octobre)",
  "tests/aggregation_regress/tests.py:728:11 (realiased)",
  "tests/aggregation_regress/tests.py:812:8 (referer)",
 "tests/aggregation_regress/tests.py:915:102 (grep)"
]
```

--------------------------------

### CostMapDefSwap penalty example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Example configuration for the `penalty` field of `CostMapDefSwap`. It matches adding or removing a `-` at the end of a word, sets a replace cost of 50, and adds a penalty of 100 to discourage that suggestion.

```yaml
map: "$(-$)"
replace: 50
penalty: 100
```

--------------------------------

### CostMapDefInsDel penalty example

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

Example of a CostMapDefInsDel configuration that adds a penalty to discourage adding or removing a hyphen at the end of a word. The map matches the end of a word with `$(-$)`, sets replace cost to 50, and penalty to 100.

```yaml
# Match adding/removing `-` to the end of a word.
map: "$(-$)"
replace: 50
penalty: 100
```

--------------------------------

### cspell.json with knownIssues Array

Source: https://github.com/streetsidesoftware/cspell/blob/main/rfc/rfc-0004 known issues/README.md

Configuration example storing known issues directly in cspell.json under the 'knownIssues' key.

```json
{
  "knownIssues": [
    "django/conf/global_settings.py:108:26 (Luxembourgish)",
    "django/conf/locale/fr/*.py:*:* (octobre)",
    "tests/aggregation_regress/tests.py:728:11 (realiased)",
    "tests/aggregation_regress/tests.py:812:8 (referer)",
    "tests/aggregation_regress/tests.py:915:102 (grep)"
  ]
}
```

--------------------------------

### ignoreRegExpList example in JSON and YAML

Source: https://github.com/streetsidesoftware/cspell/blob/main/website/docs/Configuration/auto_properties.md

These examples show how to configure the ignoreRegExpList setting in JSON and YAML formats to ignore all-caps words. The regular expression uses JavaScript syntax and is wrapped in a string in JSON, while YAML uses a block scalar.

```json
"ignoreRegExpList": ["/\\b[A-Z]+\\b/g"]
```

```yaml
ignoreRegExpList:
  - >-
   /\b[A-Z]+\b/g
```

--------------------------------

### Configure eslint.config.js with recommended preset

Source: https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-eslint-plugin/README.md

Use the recommended configuration in the new eslint.config.js format by importing the recommended preset.

```js
import cspellESLintPluginRecommended from '@cspell/eslint-plugin/recommended';

export default [
  // other config imports
  cspellESLintPluginRecommended
  // other configs
];
```

--------------------------------

### Fully qualified table name

Source: https://github.com/streetsidesoftware/cspell/blob/main/integration-tests/snapshots/ktaranov/sqlserver-kit/snapshot.txt

Example of a fully qualified table name using the server.database.schema.table format. The source notes that this style is used for cross-database references.

```sql
CREATE TABLE PRODSERVER.PRODDB.dbo.MyTable
```
Tokens:
Raw