@cspell/dict-software-terms

What is @cspell/dict-software-terms?

@cspell/dict-software-terms is a dictionary extension for the CSpell spell checker that includes a comprehensive list of software-related terms. This package helps developers ensure that their documentation, comments, and code are free from spelling errors related to software terminology.

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

Integration with CSpell

To use the @cspell/dict-software-terms package with CSpell, you need to add it to your CSpell configuration file. Here is an example of how to do this: ```json { "dictionaries": [ "software-terms" ] } ``` This configuration ensures that CSpell uses the software terms dictionary to check for spelling errors.

json

Custom Dictionary

You can also add custom terms to the dictionary to tailor it to your specific needs. Here is an example of how to add custom terms: ```json { "dictionaries": [ "software-terms" ], "words": [ "customTerm1", "customTerm2" ] } ``` This configuration adds 'customTerm1' and 'customTerm2' to the list of recognized terms.

json

Other packages similar to @cspell/dict-software-terms

cspell-dict-python

The cspell-dict-python package is a dictionary extension for CSpell that includes Python-related terms. It is similar to @cspell/dict-software-terms but focuses specifically on Python terminology.

cspell-dict-java

The cspell-dict-java package is a dictionary extension for CSpell that includes Java-related terms. Like @cspell/dict-software-terms, it helps ensure that Java-specific terms are correctly spelled in documentation and code.

cspell-dict-html

The cspell-dict-html package is a dictionary extension for CSpell that includes HTML-related terms. It is useful for web developers who want to ensure that HTML-specific terms are correctly spelled.

README

CSpell software terms Dictionary

Software terms dictionary for cspell.

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

Requirements

Tool	Version
cspell	>= 8
Code Spell Checker - Visual Studio Code	>= 4

Local Installation

This package is bundled with CSpell.

Configuration

VSCode Settings

Add the following to your VSCode settings:

.vscode/settings.json

{
  "cSpell.dictionaries": [
    "software-term-suggestions",
    "softwareTerms",
    "software-tools",
    "networking-terms",
    "web-services",
    "computing-acronyms",
    "coding-compound-terms",
  ],
}

CSpell Settings cspell.json

cspell.json

{
  "dictionaries": [
    "software-term-suggestions",
    "softwareTerms",
    "software-tools",
    "networking-terms",
    "web-services",
    "computing-acronyms",
    "coding-compound-terms",
  ],
}

CSpell Settings cspell.config.yaml

cspell.config.yaml

dictionaries:
  - software-term-suggestions
  - softwareTerms
  - software-tools
  - networking-terms
  - web-services
  - computing-acronyms
  - coding-compound-terms

Local Installation using CDN

NOTE: This package is bundled with CSpell.

Dictionary Information

Name	Enabled	Description
software-term-suggestions	Yes
softwareTerms	Yes	Software terms dictionary.
software-tools	Yes	Software tools dictionary.
networking-terms		Software networking terms dictionary.
web-services	Yes	Web Services and APIs dictionary.
computing-acronyms	Yes	Common acronyms related to computing.
coding-compound-terms	Yes	Common codding compound terms.

Contributing

Please help correct any mistakes in the dictionaries.

See: Contributing

Special thanks to all of our amazing contributors!

Dictionary Development

See: How to Create a New Dictionary

Adding Words

Contributions are welcomed and encouraged, please read src/README.md.

License

MIT

Some packages may have other licenses included.

Brought to you by Street Side Software