@cspell/dict-latex

What is @cspell/dict-latex?

@cspell/dict-latex is an npm package that provides a LaTeX dictionary for the CSpell spell checker. It helps in identifying and correcting spelling errors in LaTeX documents by providing a comprehensive list of LaTeX-specific terms.

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

Integration with CSpell

This feature allows you to integrate the LaTeX dictionary with CSpell by adding 'latex' to the list of dictionaries in your CSpell configuration file. This enables CSpell to recognize LaTeX-specific terms and reduce false positives.

{
  "dictionaries": ["latex"]
}

Custom Dictionary Path

This feature allows you to specify a custom path for the LaTeX dictionary. By defining the dictionary path in the CSpell configuration, you can ensure that the correct dictionary is used during spell checking.

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

Other packages similar to @cspell/dict-latex

@cspell/dict-python

@cspell/dict-python provides a Python dictionary for the CSpell spell checker. Similar to @cspell/dict-latex, it helps in identifying and correcting spelling errors in Python code by providing a list of Python-specific terms. It is useful for developers working with Python who want to ensure their code is free of spelling errors.

@cspell/dict-html

@cspell/dict-html offers an HTML dictionary for the CSpell spell checker. It is designed to recognize HTML-specific terms and reduce false positives when spell checking HTML documents. This package is beneficial for web developers who want to maintain the quality of their HTML code.

README

CSpell LaTeX Dictionary

LaTeX cspell dictionary

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

Uninstall from cspell

cspell link remove @cspell/dict-latex

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-latex/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

4.0.3 (2022-11-03)

Build System

• deps-dev: bump @cspell/cspell-tools from 6.13.2 to 6.13.3 (#1567) (35340bf)
• deps: bump cspell from 6.13.2 to 6.13.3 (#1566) (aae17b7)

Updates and Bug Fixes

• add deref - dereference (#1572) (ab43d95)

Continuous Integration

• Workflow Bot -- Build Dictionaries (#1573) (522f6a5)
• Workflow Bot -- Update ALL Dependencies (6800779)
• Workflow Bot -- Update ALL Dependencies (4060070)
• Workflow Bot -- Update ALL Dependencies (d24d693)
• Workflow Bot -- Update ALL Dependencies (main) (#1569) (d24d693)
• Workflow Bot -- Update ALL Dependencies (main) (#1570) (4060070)
• Workflow Bot -- Update ALL Dependencies (main) (#1571) (6800779)