@cspell/dict-typescript

What is @cspell/dict-typescript?

@cspell/dict-typescript is a dictionary extension for the CSpell spell checker that provides TypeScript-specific terms and keywords. It helps developers ensure that their TypeScript code is free from spelling errors by recognizing TypeScript-specific terminology.

What are @cspell/dict-typescript's main functionalities?

TypeScript-specific dictionary

This feature allows you to include TypeScript-specific terms in your CSpell configuration, ensuring that TypeScript keywords and common terms are not flagged as spelling errors.

{
  "dictionaries": ["typescript"]
}

Integration with CSpell

This feature demonstrates how to integrate the TypeScript dictionary with the CSpell spell checker, including setting the language and ignoring certain paths.

{
  "language": "en",
  "dictionaries": ["typescript"],
  "ignorePaths": ["node_modules/**"]
}

Other packages similar to @cspell/dict-typescript

@cspell/dict-python

@cspell/dict-python is a dictionary extension for the CSpell spell checker that provides Python-specific terms and keywords. Similar to @cspell/dict-typescript, it helps developers ensure that their Python code is free from spelling errors by recognizing Python-specific terminology.

@cspell/dict-java

@cspell/dict-java is a dictionary extension for the CSpell spell checker that provides Java-specific terms and keywords. It serves a similar purpose to @cspell/dict-typescript but is tailored for Java developers.

@cspell/dict-html

@cspell/dict-html is a dictionary extension for the CSpell spell checker that provides HTML-specific terms and keywords. It is useful for web developers who want to ensure their HTML code is free from spelling errors.

README

CSpell TypeScript and JavaScript Dictionary

TypeScript and JavaScript dictionary for cspell.

This is a pre-built dictionary for use with cspell.

Requirements

Tool	Version
cspell	>= 6
Code Spell Checker - Visual Studio Code	>= 2

Installation

Global Install and add to cspell global settings.

npm install -g @cspell/dict-typescript
cspell link add @cspell/dict-typescript

Uninstall from cspell

cspell link remove @cspell/dict-typescript

Manual Installation

The cspell-ext.json file in this package should be added to the import section in your cspell.json file.

{
    // …
    "import": ["@cspell/dict-typescript/cspell-ext.json"],
    // …
}

Building

Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.

npm run build

License

MIT

Some packages may have other licenses included.