CSpell TypeScript Dictionary

1.1.5 · active · verified Sun Apr 19

@cspell/dict-typescript (current stable version 3.2.3) provides a specialized dictionary for spell-checking TypeScript and JavaScript-specific terms, keywords, and common libraries within projects using the `cspell` spell checker. As part of the larger `cspell-dicts` monorepo, it receives updates as new programming terms emerge, often aligned with the monorepo's generally frequent release cadence. This dictionary is crucial for developers seeking to reduce false positives and improve the accuracy of spell checks in JavaScript and TypeScript codebases, differentiating it from general English dictionaries by its focus on programming-specific vocabulary like "camelCase", "enum", "typedef", "ESM", and framework-specific terms. It acts as an extension to `cspell`, enhancing its ability to understand code context, helping maintain consistency and reduce errors in technical documentation and code comments.

Common errors

```
Error: Dictionary 'typescript' not found.
```
cause The `@cspell/dict-typescript` package is not installed, or `cspell` cannot locate it based on your configuration or global link setup.

fix Ensure the package is installed: `npm install @cspell/dict-typescript` (local) or `npm install -g @cspell/dict-typescript && cspell-dict-typescript-link` (global). Verify your `cspell.json` properly references `"dictionaries": ["typescript"]`.
```
cspell-dict-typescript-link: command not found
```
cause The global linking command `cspell-dict-typescript-link` is not available in your system's PATH, usually because the package was not installed globally or the global binaries directory is not in your PATH.

fix Install the package globally: `npm install -g @cspell/dict-typescript`. If the problem persists, ensure your npm global binaries directory is correctly added to your system's PATH environment variable.

Warnings

gotcha The package name in the npm registry is `@cspell/dict-typescript` (version 3.2.3), differing from the provided `cspell-dict-typescript` (version 1.1.5). Always use `@cspell/dict-typescript` for installation to get the latest and correct package.
Fix: Ensure you install `@cspell/dict-typescript` using `npm install @cspell/dict-typescript` or `yarn add @cspell/dict-typescript`.
gotcha Newer versions of `cspell` (v6.x and above) often bundle many common dictionaries, including `typescript`. You might not need to install `@cspell/dict-typescript` explicitly if your `cspell` version already includes it, as this can lead to redundant dictionary loading or configuration conflicts.
Fix: Check your `cspell` installation's bundled dictionaries first. If 'typescript' is already listed, you may not need to install this package. Consult the `cspell` documentation for your version.
gotcha When configuring in `cspell.json` or similar files, you enable the dictionary by its short name `typescript` in the `dictionaries` array. Attempting to use the full package name (`@cspell/dict-typescript`) or a file path directly in this array will not work for dictionary loading.
Fix: Ensure your configuration uses `"dictionaries": ["typescript"]` and not `"dictionaries": ["@cspell/dict-typescript"]`.

Install

npm install cspell-dict-typescript npm
yarn add cspell-dict-typescript yarn
pnpm add cspell-dict-typescript pnpm

Imports

typescript
wrong:
```
import { typescript } from '@cspell/dict-typescript';
```
correct:
```
{ "dictionaries": ["typescript"] }
```
This package is a dictionary extension for `cspell`, not a JavaScript module. Its "import" is configured within `cspell.json` or editor settings (e.g., VS Code's `cSpell.dictionaries` setting) by referencing its name 'typescript'.
cspell-ext.json
wrong:
```
require('@cspell/dict-typescript/cspell-ext.json');
```
correct:
```
{ "import": ["<path to node_modules>/@cspell/dict-typescript/cspell-ext.json"] }
```
For manual configuration or older `cspell` setups, the dictionary's configuration can be directly imported into `cspell.json` using the `import` array, specifying the path to the `cspell-ext.json` file within the installed package.
cspell-dict-typescript-link
wrong:
```
import cspellDictTypescriptLink from 'cspell-dict-typescript/link';
```
correct:
```
npm install -g @cspell/dict-typescript
cspell-dict-typescript-link
```
For global installation and integration with `cspell`, a CLI tool `cspell-dict-typescript-link` is provided to register the dictionary with `cspell`'s global settings. This is a shell command, not a JavaScript import.

Quickstart

This quickstart demonstrates how to configure `cspell.json` to enable the `typescript` dictionary for a project. It assumes `cspell` is already installed or will be installed as a dev dependency alongside the dictionary package. This JSON configuration directs `cspell` to use the specialized dictionary when spell-checking TypeScript and JavaScript files.

{
  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
  "version": "0.2",
  "language": "en",
  "dictionaries": [
    "typescript" // Enable the TypeScript dictionary
  ],
  "words": [],
  "ignorePaths": [
    "node_modules",
    "dist",
    "build",
    "coverage"
  ]
}

// To use this, first install cspell and the dictionary:
// npm install -D cspell @cspell/dict-typescript
// Then run cspell:
// npx cspell "**/*.{ts,tsx,js,jsx}"

view raw JSON →