@cspell/dict-npm

What is @cspell/dict-npm?

@cspell/dict-npm is a dictionary package for the CSpell spell checker. It provides a list of words related to npm packages, which helps in identifying and correcting spelling errors in npm-related terms.

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

Adding npm dictionary to CSpell

This feature allows you to add the npm dictionary to your CSpell configuration, enabling spell checking for npm-related terms.

{
  "dictionaries": ["npm"]
}

Using npm dictionary in a project

This feature demonstrates how to configure CSpell to use the npm dictionary in a project, ensuring that npm-specific terms are recognized and checked.

{
  "language": "en",
  "dictionaries": ["npm"],
  "dictionaryDefinitions": [
    {
      "name": "npm",
      "path": "@cspell/dict-npm/cspell-ext.json"
    }
  ]
}

Other packages similar to @cspell/dict-npm

@cspell/dict-python

@cspell/dict-python provides a dictionary for Python-related terms for the CSpell spell checker. It is similar to @cspell/dict-npm but focuses on Python terminology.

@cspell/dict-html

@cspell/dict-html offers a dictionary for HTML-related terms for the CSpell spell checker. It is comparable to @cspell/dict-npm but is tailored for HTML vocabulary.

@cspell/dict-typescript

@cspell/dict-typescript supplies a dictionary for TypeScript-related terms for the CSpell spell checker. It is akin to @cspell/dict-npm but is designed for TypeScript-specific terms.

README

Cspell NPM Dictionary

NPM dictionary for cspell.

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

Installation

Global Install and add to cspell global settings.

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

Uninstall from cspell

cspell link remove @cspell/dict-npm

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-npm/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.

Changelog

12.0.6 (2023-05-24)

Build System

• deps: bump streetsidesoftware/cspell-action from 2.26.1 to 2.26.2 (#2176) (871f102)

Continuous Integration

• Workflow Bot -- Update ALL Dependencies (main) (#2175) (59a07f7)
• Workflow Bot -- Update ALL Dependencies (main) (#2185) (3948b15)

Updates and Bug Fixes

• add words to companies, data_science, and software-terms (#2182) (ffba724)
• Workflow Bot -- Build Dictionaries (#2186) (d1594c5)