Skip to content

Latest commit

 

History

History
 
 

README.md

CSpell TypeScript and JavaScript Dictionary

TypeScript and JavaScript 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": ["typescript"],
}
CSpell Settings cspell.json

cspell.json

{
  "dictionaries": ["typescript"],
}
CSpell Settings cspell.config.yaml

cspell.config.yaml

dictionaries:
  - typescript

Local Installation using CDN

NOTE: This package is bundled with CSpell.

Dictionary Information

Name Enabled Description
typescript TypeScript and JavaScript dictionary.
html External
html-symbol-entities External

Language Settings

Name Locale File Type
typescript * typescript, javascript, typescriptreact, javascriptreact, mdx, astro
html astro
html-symbol-entities astro

Predefined Patterns

Predefined patterns can be used to ignore or include sequences of text to be spell checked.

The following patterns are defined in this dictionary:

Name Description
js-hex-number JavaScript Hexadecimal Number including BigInt.
js-hex-escape JavaScript String Hexadecimal Escape sequence.
js-unicode-escape JavaScript String Unicode Escape sequence.
js-regexp-flags JavaScript Match Regular Expression Flags

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

License

MIT

Some packages may have other licenses included.



Brought to you by Street Side Software Logo Street Side Software