@cspell/dict-k8s

What is @cspell/dict-k8s?

@cspell/dict-k8s is a dictionary extension for the CSpell spell checker that includes Kubernetes-related terms. It helps developers working with Kubernetes by providing a comprehensive list of Kubernetes-specific words, ensuring that these terms are not flagged as spelling errors.

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

Kubernetes Dictionary Integration

This feature integrates the Kubernetes dictionary into the CSpell spell checker configuration. By adding 'k8s' to the dictionaries array, CSpell will recognize and not flag Kubernetes-specific terms as spelling errors.

{
  "dictionaries": ["k8s"]
}

Custom Dictionary Path

This feature allows users to specify a custom path for the Kubernetes dictionary file. This can be useful if the dictionary file is located in a different directory or if multiple dictionary files are being used.

{
  "dictionaryDefinitions": [
    { "name": "k8s", "path": "@cspell/dict-k8s/k8s.txt" }
  ],
  "dictionaries": ["k8s"]
}

Other packages similar to @cspell/dict-k8s

@cspell/dict-python

@cspell/dict-python is a dictionary extension for the CSpell spell checker that includes Python-related terms. Similar to @cspell/dict-k8s, it helps developers by providing a comprehensive list of Python-specific words, ensuring that these terms are not flagged as spelling errors.

@cspell/dict-java

@cspell/dict-java is a dictionary extension for the CSpell spell checker that includes Java-related terms. It serves a similar purpose to @cspell/dict-k8s by providing a list of Java-specific words to prevent them from being marked as spelling errors.

@cspell/dict-html

@cspell/dict-html is a dictionary extension for the CSpell spell checker that includes HTML-related terms. Like @cspell/dict-k8s, it ensures that HTML-specific terms are recognized and not flagged as spelling errors.

README

CSpell K8s Dictionary

K8s 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-k8s
cspell link add @cspell/dict-k8s

Uninstall from cspell

cspell link remove @cspell/dict-k8s

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

chmod u+x ./src/build.sh
npm run build

License

MIT

Some packages may have other licenses included.

Changelog

21.0.3 (2023-12-05)

Updates and Bug Fixes

• Add OPTARG to bash-words.txt (#2758) (0d4dc9c)
• Workflow Bot -- Build Dictionaries (#2765) (237283b)
• Workflow Bot -- Build Dictionaries (#2772) (ffdf583)