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.
CSpell software terms Dictionary
Software terms dictionary for cspell.
This is a pre-built dictionary for use with cspell.
Requirements
Installation
Global Install and add to cspell global settings.
npm install -g @cspell/dict-software-terms
cspell link add @cspell/dict-software-terms
Uninstall from cspell
cspell link remove @cspell/dict-software-terms
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-software-terms/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.