diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e24b8287dd..4ba2111d6f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -17,24 +17,24 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -- Demonstrating empathy and kindness toward other people -- Being respectful of differing opinions, viewpoints, and experiences -- Giving and gracefully accepting constructive feedback -- Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -- Focusing on what is best not just for us as individuals, but for the - overall community +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the + overall community Examples of unacceptable behavior include: -- The use of sexualized language or imagery, and sexual attention or - advances of any kind -- Trolling, insulting or derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or email - address, without their explicit permission -- Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery, and sexual attention or + advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email + address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Enforcement Responsibilities diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 41012e5fb8..2543aaf7de 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -54,10 +54,10 @@ If anything shows up, then the port is still locked. ## Packages -- `client` - the actual extension running in VS Code. -- `_server` - the extension server that processes spell checker requests -- `_settingsViewer` - a webapp that provides a visual interface to the configuration files. -- `_integrationTests` - a test suite that launches the extension in VS Code. +- `client` - the actual extension running in VS Code. +- `_server` - the extension server that processes spell checker requests +- `_settingsViewer` - a webapp that provides a visual interface to the configuration files. +- `_integrationTests` - a test suite that launches the extension in VS Code. ## Adding configurations diff --git a/README.md b/README.md index a4ab6f49a2..87eb128a7d 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ The goal of this spell checker is to help catch common spelling errors while kee ## Support Further Development -- [![GitHub Sponsors](https://img.shields.io/badge/-black?style=social&logo=githubsponsors&label=GitHub%20Sponsor%3A%20Street%20Side%20Software)](https://github.com/sponsors/streetsidesoftware) -- [![Patreon](https://img.shields.io/badge/-black?style=social&logo=patreon&label=Patreon%3A%20Street%20Side%20Software)](https://patreon.com/streetsidesoftware) -- [![PayPal](https://img.shields.io/badge/-black?style=social&logo=paypal&label=PayPal%20Donate%3A%20Street%20Side%20Software)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY) -- [![Open Collective](https://img.shields.io/badge/-black?style=social&logo=opencollective&label=Open%20Collective%3A%20Code%20Spell%20Checker)](https://opencollective.com/code-spell-checker) +- [![GitHub Sponsors](https://img.shields.io/badge/-black?style=social&logo=githubsponsors&label=GitHub%20Sponsor%3A%20Street%20Side%20Software)](https://github.com/sponsors/streetsidesoftware) +- [![Patreon](https://img.shields.io/badge/-black?style=social&logo=patreon&label=Patreon%3A%20Street%20Side%20Software)](https://patreon.com/streetsidesoftware) +- [![PayPal](https://img.shields.io/badge/-black?style=social&logo=paypal&label=PayPal%20Donate%3A%20Street%20Side%20Software)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY) +- [![Open Collective](https://img.shields.io/badge/-black?style=social&logo=opencollective&label=Open%20Collective%3A%20Code%20Spell%20Checker)](https://opencollective.com/code-spell-checker) ## Functionality @@ -28,10 +28,10 @@ To see the list of suggestions: After positioning the cursor in the word, any of the following should display the list of suggestions: -- Click on the 💡 (lightbulb) in the left hand margin. -- [`Quick Fix`](https://code.visualstudio.com/docs/getstarted/keybindings#_rich-languages-editing) Editor action command: - - Mac: `⌘`+`.` or `Cmd`+`.` - - PC: `Ctrl`+`.` +- Click on the 💡 (lightbulb) in the left hand margin. +- [`Quick Fix`](https://code.visualstudio.com/docs/getstarted/keybindings#_rich-languages-editing) Editor action command: + - Mac: `⌘`+`.` or `Cmd`+`.` + - PC: `Ctrl`+`.` ## Install @@ -39,8 +39,8 @@ Open up VS Code and hit `F1` and type `ext` select install and type `code-spell- ## Supported Languages -- English (US) -- English (GB) - turn on by changing `"cSpell.language": "en"` to `"cSpell.language": "en-GB"` +- English (US) +- English (GB) - turn on by changing `"cSpell.language": "en"` to `"cSpell.language": "en-GB"` ## Add-On Dictionaries @@ -50,56 +50,56 @@ Open up VS Code and hit `F1` and type `ext` select install and type `code-spell- ### Language Dictionaries -- [Ancient Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ancient-greek) - Ancient Greek dictionary extension for VS Code. -- [Arabic](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-arabic) - Arabic dictionary extension for VS Code. -- [Australian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-australian-english) - Australian English dictionary extension for VS Code. -- [Austrian German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-austrian-german) - Austrian German dictionary extension for VS Code. -- [Basque](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-basque) - Basque dictionary extension for VS Code. -- [British English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-british-english) - British English dictionary extension for VS Code. -- [Bulgarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-bulgarian) - Bulgarian dictionary extension for VS Code. -- [Canadian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-canadian-english) - Canadian English dictionary extension for VS Code. -- [Catalan](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-catalan) - Catalan dictionary extension for VS Code. -- [Croatian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-croatian) - Croatian dictionary extension for VS Code. -- [Czech](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-czech) - Czech dictionary extension for VS Code. -- [Danish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-danish) - Danish dictionary extension for VS Code. -- [Dutch](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-dutch) - Dutch / Nederlands dictionary extension for VS Code. -- [Esperanto](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-esperanto) - Esperanto dictionary extension for VS Code. -- [Estonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-estonian) - Estonian dictionary extension for VS Code. -- [Finnish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-finnish) - Finnish dictionary extension for VS Code. -- [French](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french) - French dictionary extension for VS Code. -- [French Réforme 90](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french-reforme) - French Réforme 90 dictionary extension for VS Code. -- [German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-german) - German dictionary extension for VS Code. -- [Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-greek) - Greek dictionary extension for VS Code. -- [Hebrew](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hebrew) - Hebrew dictionary extension for VS Code. -- [Hungarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hungarian) - Hungarian dictionary extension for VS Code. -- [Indonesian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-indonesian) - Indonesian dictionary extension for VS Code. -- [Italian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-italian) - Italian dictionary extension for VS Code. -- [Latin](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latin) - Latin dictionary extension for VS Code. -- [Latvian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latvian) - Latvian dictionary extension for VS Code. -- [Lithuanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-lithuanian) - Lithuanian dictionary extension for VS Code. -- [Macedonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-macedonian) - Macedonian dictionary extension for VS Code. -- [Norwegian Bokmål](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-norwegian-bokmal) - Norwegian Bokmål dictionary extension for VS Code. -- [Persian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-persian) - Persian dictionary extension for VS Code. -- [Polish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-polish) - Polish dictionary extension for VS Code. -- [Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese) - Portuguese dictionary extension for VS Code. -- [Brazilian Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese-brazilian) - Brazilian Portuguese dictionary extension for VS Code. -- [Romanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-romanian) - Romanian dictionary extension for VS Code. -- [Russian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-russian) - Russian dictionary extension for VS Code. -- [Serbian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-serbian) - Serbian dictionary extension for VS Code. -- [Slovak](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovak) - Slovak dictionary extension for VS Code. -- [Slovenian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovenian) - Slovenian dictionary extension for VS Code. -- [Spanish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-spanish) - Spanish Add-On for Code Spell Checker -- [Swedish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swedish) - Swedish dictionary extension for VS Code. -- [Swiss German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swiss-german) - Swiss German dictionary extension for VS Code. -- [Turkish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-turkish) - Turkish dictionary extension for VS Code. -- [Ukrainian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ukrainian) - Ukrainian dictionary extension for VS Code. -- [Vietnamese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-vietnamese) - Vietnamese dictionary extension for VS Code. +- [Ancient Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ancient-greek) - Ancient Greek dictionary extension for VS Code. +- [Arabic](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-arabic) - Arabic dictionary extension for VS Code. +- [Australian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-australian-english) - Australian English dictionary extension for VS Code. +- [Austrian German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-austrian-german) - Austrian German dictionary extension for VS Code. +- [Basque](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-basque) - Basque dictionary extension for VS Code. +- [British English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-british-english) - British English dictionary extension for VS Code. +- [Bulgarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-bulgarian) - Bulgarian dictionary extension for VS Code. +- [Canadian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-canadian-english) - Canadian English dictionary extension for VS Code. +- [Catalan](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-catalan) - Catalan dictionary extension for VS Code. +- [Croatian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-croatian) - Croatian dictionary extension for VS Code. +- [Czech](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-czech) - Czech dictionary extension for VS Code. +- [Danish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-danish) - Danish dictionary extension for VS Code. +- [Dutch](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-dutch) - Dutch / Nederlands dictionary extension for VS Code. +- [Esperanto](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-esperanto) - Esperanto dictionary extension for VS Code. +- [Estonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-estonian) - Estonian dictionary extension for VS Code. +- [Finnish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-finnish) - Finnish dictionary extension for VS Code. +- [French](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french) - French dictionary extension for VS Code. +- [French Réforme 90](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french-reforme) - French Réforme 90 dictionary extension for VS Code. +- [German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-german) - German dictionary extension for VS Code. +- [Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-greek) - Greek dictionary extension for VS Code. +- [Hebrew](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hebrew) - Hebrew dictionary extension for VS Code. +- [Hungarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hungarian) - Hungarian dictionary extension for VS Code. +- [Indonesian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-indonesian) - Indonesian dictionary extension for VS Code. +- [Italian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-italian) - Italian dictionary extension for VS Code. +- [Latin](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latin) - Latin dictionary extension for VS Code. +- [Latvian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latvian) - Latvian dictionary extension for VS Code. +- [Lithuanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-lithuanian) - Lithuanian dictionary extension for VS Code. +- [Macedonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-macedonian) - Macedonian dictionary extension for VS Code. +- [Norwegian Bokmål](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-norwegian-bokmal) - Norwegian Bokmål dictionary extension for VS Code. +- [Persian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-persian) - Persian dictionary extension for VS Code. +- [Polish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-polish) - Polish dictionary extension for VS Code. +- [Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese) - Portuguese dictionary extension for VS Code. +- [Brazilian Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese-brazilian) - Brazilian Portuguese dictionary extension for VS Code. +- [Romanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-romanian) - Romanian dictionary extension for VS Code. +- [Russian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-russian) - Russian dictionary extension for VS Code. +- [Serbian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-serbian) - Serbian dictionary extension for VS Code. +- [Slovak](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovak) - Slovak dictionary extension for VS Code. +- [Slovenian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovenian) - Slovenian dictionary extension for VS Code. +- [Spanish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-spanish) - Spanish Add-On for Code Spell Checker +- [Swedish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swedish) - Swedish dictionary extension for VS Code. +- [Swiss German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swiss-german) - Swiss German dictionary extension for VS Code. +- [Turkish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-turkish) - Turkish dictionary extension for VS Code. +- [Ukrainian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ukrainian) - Ukrainian dictionary extension for VS Code. +- [Vietnamese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-vietnamese) - Vietnamese dictionary extension for VS Code. ### Technical Dictionaries -- [Medical Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-medical-terms) - Medical Terms Add-On for Code Spell Checker -- [Scientific Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-scientific-terms) - Scientific Terms dictionary extension for VS Code. -- [Win32](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-win32) - Win32 dictionary extension for VS Code. +- [Medical Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-medical-terms) - Medical Terms Add-On for Code Spell Checker +- [Scientific Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-scientific-terms) - Scientific Terms dictionary extension for VS Code. +- [Win32](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-win32) - Win32 dictionary extension for VS Code. @@ -107,31 +107,31 @@ Open up VS Code and hit `F1` and type `ext` select install and type `code-spell- ## Enabled File Types -- AsciiDoc -- C, C++ -- C# -- css, less, scss -- Dart -- Elixir -- Go -- Html -- Java -- JavaScript -- JSON / JSONC -- LaTeX -- Markdown -- PHP -- PowerShell -- Pug / Jade -- Python -- reStructuredText -- Ruby -- Rust -- Scala -- Text -- TypeScript -- YAML -- SQL +- AsciiDoc +- C, C++ +- C# +- css, less, scss +- Dart +- Elixir +- Go +- Html +- Java +- JavaScript +- JSON / JSONC +- LaTeX +- Markdown +- PHP +- PowerShell +- Pug / Jade +- Python +- reStructuredText +- Ruby +- Rust +- Scala +- Text +- TypeScript +- YAML +- SQL ### Enable / Disable File Types @@ -149,10 +149,10 @@ To _Enable_ or _Disable_ spell checking for a file type: The concept is simple, split camelCase words before checking them against a list of known English words. -- camelCase -> camel case -- HTMLInput -> html input -- Notice that the `I` is associated with `Input` and not `HTML` -- snake_case_words -> snake case words -- camel2snake -> camel snake -- (the 2 is ignored) +- camelCase -> camel case +- HTMLInput -> html input -- Notice that the `I` is associated with `Input` and not `HTML` +- snake_case_words -> snake case words +- camel2snake -> camel snake -- (the 2 is ignored) ### Special case with ALL CAPS words @@ -160,17 +160,17 @@ There are a few special cases to help with common spelling practices for ALL CAP Trailing `s`, `ing`, `ies`, `es`, `ed` are kept with the previous word. -- CURLs -> curls -- trailing `s` -- CURLedRequest -> curled request -- trailing `ed` +- CURLs -> curls -- trailing `s` +- CURLedRequest -> curled request -- trailing `ed` ## Things to note -- This spellchecker is case insensitive. It will not catch errors like english which should be English. -- The spellchecker uses a local word dictionary. It does not send anything outside your machine. -- The words in the dictionary can and do contain errors. -- There are missing words. -- Only words longer than 3 characters are checked. "jsj" is not checked, while "jsja" is checked and will be marked as incorrect because it does not exist in any of the dictionaries. -- All symbols and punctuation are ignored. +- This spellchecker is case insensitive. It will not catch errors like english which should be English. +- The spellchecker uses a local word dictionary. It does not send anything outside your machine. +- The words in the dictionary can and do contain errors. +- There are missing words. +- Only words longer than 3 characters are checked. "jsj" is not checked, while "jsja" is checked and will be marked as incorrect because it does not exist in any of the dictionaries. +- All symbols and punctuation are ignored. ## In Document Settings @@ -179,14 +179,14 @@ This is to help with file specific issues that may not be applicable to the enti All settings are prefixed with `cSpell:` or `spell-checker:`. -- `disable` -- turn off the spell checker for a section of code. -- `enable` -- turn the spell checker back on after it has been turned off. -- `ignore` -- specify a list of words to be ignored. -- `words` -- specify a list of words to be considered correct and will appear in the suggestions list. -- `locale` -- set locale (example: `cSpell:locale fr,en` to use French and English languages) -- `ignoreRegExp` -- Any text matching the regular expression will NOT be checked for spelling. -- `includeRegExp` -- Only text matching the collection of includeRegExp will be checked. -- `enableCompoundWords` / `disableCompoundWords` -- Allow / disallow words like: "stringlength". +- `disable` -- turn off the spell checker for a section of code. +- `enable` -- turn the spell checker back on after it has been turned off. +- `ignore` -- specify a list of words to be ignored. +- `words` -- specify a list of words to be considered correct and will appear in the suggestions list. +- `locale` -- set locale (example: `cSpell:locale fr,en` to use French and English languages) +- `ignoreRegExp` -- Any text matching the regular expression will NOT be checked for spelling. +- `includeRegExp` -- Only text matching the collection of includeRegExp will be checked. +- `enableCompoundWords` / `disableCompoundWords` -- Allow / disallow words like: "stringlength". ### Enable / Disable checking sections of code @@ -194,19 +194,19 @@ It is possible to disable / enable the spell checker by adding comments to your #### Disable Checking -- `cSpell:disable` -- `spell-checker: disable` -- `spellchecker: disable` -- `cspell: disable-line` -- `cspell: disable-next-line` +- `cSpell:disable` +- `spell-checker: disable` +- `spellchecker: disable` +- `cspell: disable-line` +- `cspell: disable-next-line` #### Enable Checking -- `cSpell:enable` -- `spell-checker: enable` -- `spellchecker: enable` +- `cSpell:enable` +- `spell-checker: enable` +- `spellchecker: enable` #### JavaScript Example @@ -344,18 +344,18 @@ def sum_it(self, seq): ### Exclude patterns -- `Urls`1 -- Matches urls -- `HexValues` -- Matches common hex format like `#aaa`, `0xfeef`, `\u0134` -- `EscapeCharacters`1 -- matches special characters: `\n`, `\t` etc. -- `Base64`1 -- matches base64 blocks of text longer than 40 characters. -- `Email` -- matches most email addresses. +- `Urls`1 -- Matches urls +- `HexValues` -- Matches common hex format like `#aaa`, `0xfeef`, `\u0134` +- `EscapeCharacters`1 -- matches special characters: `\n`, `\t` etc. +- `Base64`1 -- matches base64 blocks of text longer than 40 characters. +- `Email` -- matches most email addresses. ### Include Patterns -- `Everything`1 -- By default we match an entire document and remove the excludes. -- `string` -- This matches common string formats like '...', "...", and \`...\` -- `CStyleComment` -- These are C Style comments /\* \*/ and // -- `PhpHereDoc` -- This matches PHPHereDoc strings. +- `Everything`1 -- By default we match an entire document and remove the excludes. +- `string` -- This matches common string formats like '...', "...", and \`...\` +- `CStyleComment` -- These are C Style comments /\* \*/ and // +- `PhpHereDoc` -- This matches PHPHereDoc strings. 1. These patterns are part of the default include/exclude list for every file. @@ -489,33 +489,33 @@ The spell checker includes a set of default dictionaries. ### General Dictionaries -- **wordsEn** - Derived from Hunspell US English words. -- **wordsEnGb** - Derived from Hunspell GB English words. -- **companies** - List of well known companies -- **softwareTerms** - Software Terms and concepts like "coroutine", "debounce", "tree", etc. -- **misc** - Terms that do not belong in the other dictionaries. +- **wordsEn** - Derived from Hunspell US English words. +- **wordsEnGb** - Derived from Hunspell GB English words. +- **companies** - List of well known companies +- **softwareTerms** - Software Terms and concepts like "coroutine", "debounce", "tree", etc. +- **misc** - Terms that do not belong in the other dictionaries. ### Programming Language Dictionaries -- **typescript** - keywords for Typescript and Javascript -- **node** - terms related to using nodejs. -- **php** - _php_ keywords and library methods -- **go** - _go_ keywords and library methods -- **python** - _python_ keywords -- **powershell** - _powershell_ keywords -- **html** - _html_ related keywords -- **css** - _css_, _less_, and _scss_ related keywords +- **typescript** - keywords for Typescript and Javascript +- **node** - terms related to using nodejs. +- **php** - _php_ keywords and library methods +- **go** - _go_ keywords and library methods +- **python** - _python_ keywords +- **powershell** - _powershell_ keywords +- **html** - _html_ related keywords +- **css** - _css_, _less_, and _scss_ related keywords ### Miscellaneous Dictionaries -- **fonts** - long list of fonts - to assist with _css_ +- **fonts** - long list of fonts - to assist with _css_ Based upon the programming language, different dictionaries will be loaded. Here are some of the default rules: -- `"*"` matches any programming language / file type. -- `"locale"` is used to filter based upon the `"cSpell.language"` setting. +- `"*"` matches any programming language / file type. +- `"locale"` is used to filter based upon the `"cSpell.language"` setting. ```javascript { @@ -656,10 +656,10 @@ Example adding medical terms, so words like _acanthopterygious_ can be found. **Explained:** In this example, we have told the spell checker where to find our personal dictionary called `myWords`. -- `name` - this is the name of the dictionary, all references to this dictionary is done by the name. -- `path` - this the path to the dictionary file. Since it is in the user settings, we have to use absolute paths or paths relative to the user directory by using `~/`. -- `scope` - (Optional) this is used to "scope" a dictionary to `user`, `workspace`, or `folder`. Scope is used to help communicate the intended use of the dictionary. -- `addWords` - (Optional) default - `true` - is used to show / hide the dictionary as a possible target for adding words. +- `name` - this is the name of the dictionary, all references to this dictionary is done by the name. +- `path` - this the path to the dictionary file. Since it is in the user settings, we have to use absolute paths or paths relative to the user directory by using `~/`. +- `scope` - (Optional) this is used to "scope" a dictionary to `user`, `workspace`, or `folder`. Scope is used to help communicate the intended use of the dictionary. +- `addWords` - (Optional) default - `true` - is used to show / hide the dictionary as a possible target for adding words. #### Project / Workspace Dictionary using `cspell.json` diff --git a/design-docs/spelling-metrics.md b/design-docs/spelling-metrics.md index b68eacdfc8..83d02aafc6 100644 --- a/design-docs/spelling-metrics.md +++ b/design-docs/spelling-metrics.md @@ -15,14 +15,14 @@ Fixing spelling errors is usually done with a Command. The idea is to record eac Things to record: -- `word`\* - the word with the spelling error. This could be the word or a hash. -- `replacement`\* - the replacement chosen. This could be a word or a hash. -- `timestamp` - the Unix timestamp in milliseconds. Helps use keep track of the order and to diminish weight over time. -- `fileType` - the file type (LanguageID) of the file. -- `locale` - the current locale setting. -- `scheme` - the URI scheme -- `machineId` - a hash of the machine id (does not need to be unique, just consistent). -- `userId` - a hash of the user id (does not need to be unique, just consistent). +- `word`\* - the word with the spelling error. This could be the word or a hash. +- `replacement`\* - the replacement chosen. This could be a word or a hash. +- `timestamp` - the Unix timestamp in milliseconds. Helps use keep track of the order and to diminish weight over time. +- `fileType` - the file type (LanguageID) of the file. +- `locale` - the current locale setting. +- `scheme` - the URI scheme +- `machineId` - a hash of the machine id (does not need to be unique, just consistent). +- `userId` - a hash of the user id (does not need to be unique, just consistent). \* - Necessary fields needed to make the suggestions. @@ -32,7 +32,7 @@ Word Frequency can be used to improve suggestions by pushing words that already Record: -- `word` - the text of the word. (prefer whole words over camel case splits). We might want to limit the length less than 64 characters or use a hash. -- `count` - the number of times the word was seen in the file. -- `fileType` - the file type (LanguageId) of the file. -- `fileId` - the id of the file +- `word` - the text of the word. (prefer whole words over camel case splits). We might want to limit the length less than 64 characters or use a hash. +- `count` - the number of times the word was seen in the file. +- `fileType` - the file type (LanguageId) of the file. +- `fileId` - the id of the file diff --git a/design-docs/v2.md b/design-docs/v2.md index 79f3815abf..dbbb589495 100644 --- a/design-docs/v2.md +++ b/design-docs/v2.md @@ -7,56 +7,56 @@ Issues should be tracked with the `v2` milestone. ### Modifying config files -- [x] Make sure the `cspell.config.js` does not get modified by the extension when changing words or settings. -- [x] Make sure the correct `cspell*.json` files are updated when writing settings. -- [x] Support `package.json` as a target location for `cspell` settings. -- [x] Support `yaml` config files. -- [x] Support concept of readonly configuration files. -- [x] Verify Yarn 2 support +- [x] Make sure the `cspell.config.js` does not get modified by the extension when changing words or settings. +- [x] Make sure the correct `cspell*.json` files are updated when writing settings. +- [x] Support `package.json` as a target location for `cspell` settings. +- [x] Support `yaml` config files. +- [x] Support concept of readonly configuration files. +- [x] Verify Yarn 2 support ### Commands -- [ ] Ignore word should update the correct files. -- [ ] Feature: create dictionary command. -- [x] Create config file command +- [ ] Ignore word should update the correct files. +- [ ] Feature: create dictionary command. +- [x] Create config file command ### Non-File URIs -- [x] Support `untitled` file schema. -- [ ] Support non-`file` schemas. +- [x] Support `untitled` file schema. +- [ ] Support non-`file` schemas. ### Preferences -- [x] Support checking only files in the Workspace -- [ ] Support setting preferences for config location. +- [x] Support checking only files in the Workspace +- [ ] Support setting preferences for config location. ### Documentation -- [ ] Document how to setup a custom dictionary +- [ ] Document how to setup a custom dictionary ### Context Menu -- [x] Fix the options listed in the context menu to include `cspell` as a destination for words -- [x] Do not split words when adding to dictionary. -- [x] When adding a word that is a Diagnostic to the dictionary, do not ask. +- [x] Fix the options listed in the context menu to include `cspell` as a destination for words +- [x] Do not split words when adding to dictionary. +- [x] When adding a word that is a Diagnostic to the dictionary, do not ask. ### Reliability -- [ ] Detect server hangs -- [ ] Warn about documents that take too long to check. -- [ ] Be able to block documents that take too long to check. -- [ ] Be able to re-start the server if necessary. -- [ ] Be able to kill the server if stuck. +- [ ] Detect server hangs +- [ ] Warn about documents that take too long to check. +- [ ] Be able to block documents that take too long to check. +- [ ] Be able to re-start the server if necessary. +- [ ] Be able to kill the server if stuck. ### Bug Fixes -- [x] Fix issue with Accents -- [ ] Support for case sensitive dictionaries. +- [x] Fix issue with Accents +- [ ] Support for case sensitive dictionaries. ### Third-party issues -- [ ] [Support virtual workspaces · Issue #846 · streetsidesoftware/vscode-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker/issues/846) -- [ ] [Support Workspace Trust · Issue #839 · streetsidesoftware/vscode-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker/issues/839) +- [ ] [Support virtual workspaces · Issue #846 · streetsidesoftware/vscode-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker/issues/846) +- [ ] [Support Workspace Trust · Issue #839 · streetsidesoftware/vscode-spell-checker](https://github.com/streetsidesoftware/vscode-spell-checker/issues/839) Workspace Trust is going to require some modifications to `cspell` in order to prevent it from loading any untrusted sources. diff --git a/design-docs/v4.md b/design-docs/v4.md index 887aa6d92a..ddbdb456e0 100644 --- a/design-docs/v4.md +++ b/design-docs/v4.md @@ -2,11 +2,11 @@ ## Checklist -- [ ] Update README.md to match v4 -- [ ] Event Log -- [ ] Record Spelling Corrections / Suggestions Used -- [ ] Sponsorship message -- [ ] Analytics +- [ ] Update README.md to match v4 +- [ ] Event Log +- [ ] Record Spelling Corrections / Suggestions Used +- [ ] Sponsorship message +- [ ] Analytics ## README.md @@ -30,31 +30,31 @@ The idea is to store the suggestions the user has picked and present them at the Compose a sponsorship message to show users. -- Should describe why it is important to become a sponsor -- Provide a link to the Sponsor page. -- Should only be shown if they are using the extension. -- The User can hide the message for about a month, longer if they are a sponsor. +- Should describe why it is important to become a sponsor +- Provide a link to the Sponsor page. +- Should only be shown if they are using the extension. +- The User can hide the message for about a month, longer if they are a sponsor. ## Analytics / Telemetry Data At the moment, the Spell Checker does not collect any Telemetry data. But that is likely to change: -- User must be able to op-out. -- Special care should be made to avoid collecting any sensitive or personally identifiable information. +- User must be able to op-out. +- Special care should be made to avoid collecting any sensitive or personally identifiable information. ### Reasons for Data Collection -- Usage: - - Approximate number of unique users. The key here is to be able to distinguish between users, but not to identify an individual. - - Frequency of use. - - Feature usage. -- Errors: - - Record any Error events. +- Usage: + - Approximate number of unique users. The key here is to be able to distinguish between users, but not to identify an individual. + - Frequency of use. + - Feature usage. +- Errors: + - Record any Error events. ### Metrics -- Throughput - - Words / Second - - Kilobytes / Second -- File type -- Line width (Avg,Med,Max) +- Throughput + - Words / Second + - Kilobytes / Second +- File type +- Line width (Avg,Med,Max) diff --git a/design-docs/wip/configuration.md b/design-docs/wip/configuration.md index 51a67ce308..c7b637ee0e 100644 --- a/design-docs/wip/configuration.md +++ b/design-docs/wip/configuration.md @@ -132,5 +132,5 @@ Priority should be strongly towards local (_folder_) over global (_user_). Notes: -- if a CSpell configuration file contains a custom dictionary definition it should not be part of the selection. -- Adding words should not create a CSpell configuration file or a VS Code `settings.json` file is avoidable. +- if a CSpell configuration file contains a custom dictionary definition it should not be part of the selection. +- Adding words should not create a CSpell configuration file or a VS Code `settings.json` file is avoidable. diff --git a/fixtures/workspaces/unknown-words/example.md b/fixtures/workspaces/unknown-words/example.md index ef7d3ca0b4..c88be70032 100644 --- a/fixtures/workspaces/unknown-words/example.md +++ b/fixtures/workspaces/unknown-words/example.md @@ -2,10 +2,10 @@ This is an exaple with some common errors: -- recieve -> receive -- simpel -> simple -- comon -> common -- thiswodshaserrors: but it isn't reported. +- recieve -> receive +- simpel -> simple +- comon -> common +- thiswodshaserrors: but it isn't reported. This is a peom about recieving incorect words. Not all of them are highlited or hilighted or even highlighted. More comon mispellings like polution are flaged. diff --git a/package-lock.json b/package-lock.json index b48599a8d4..578480ea12 100644 --- a/package-lock.json +++ b/package-lock.json @@ -36,10 +36,10 @@ "devDependencies": { "@eslint/js": "^9.15.0", "@tsconfig/node20": "^20.1.4", - "@types/node": "^20.17.7", + "@types/node": "^20.17.8", "@types/vscode": "1.90.0", "@types/vscode-webview": "^1.57.5", - "@vitest/coverage-istanbul": "^2.1.5", + "@vitest/coverage-istanbul": "^2.1.6", "@vscode/vsce": "^3.2.1", "ansi-styles": "^6.2.1", "chokidar-cli": "^3.0.0", @@ -54,15 +54,15 @@ "jest-mock-vscode": "^4.0.3", "ovsx": "^0.10.1", "patch-package": "^8.0.0", - "prettier": "^3.3.3", + "prettier": "^3.4.1", "prettier-plugin-svelte": "^3.3.2", "rollup": "^4.27.4", "rollup-plugin-dts": "^6.1.1", "shx": "^0.3.4", "typescript": "^5.7.2", - "typescript-eslint": "^8.15.0", + "typescript-eslint": "^8.16.0", "vite": "^5.4.11", - "vitest": "^2.1.5" + "vitest": "^2.1.6" }, "engines": { "node": ">20.0.0", @@ -6910,9 +6910,9 @@ } }, "node_modules/@tanstack/query-core": { - "version": "5.60.6", - "resolved": "https://registry.npmjs.org/@tanstack/query-core/-/query-core-5.60.6.tgz", - "integrity": "sha512-tI+k0KyCo1EBJ54vxK1kY24LWj673ujTydCZmzEZKAew4NqZzTaVQJEuaG1qKj2M03kUHN46rchLRd+TxVq/zQ==", + "version": "5.61.4", + "resolved": "https://registry.npmjs.org/@tanstack/query-core/-/query-core-5.61.4.tgz", + "integrity": "sha512-rsnemyhPvEG4ViZe0R2UQDM8NgQS/BNC5/Gf9RTs0TKN5thUhPUwnL2anWG4jxAGKFyDfvG7PXbx6MRq3hxi1w==", "license": "MIT", "funding": { "type": "github", @@ -6920,12 +6920,12 @@ } }, "node_modules/@tanstack/svelte-query": { - "version": "5.60.6", - "resolved": "https://registry.npmjs.org/@tanstack/svelte-query/-/svelte-query-5.60.6.tgz", - "integrity": "sha512-+67RI61norp2ivb9glP0DEllSgdV0NdfOoOjop3BjQTSjlvNGX5icICLblf4ppY67acT/cbaNOXIlgOpU51U1w==", + "version": "5.61.4", + "resolved": "https://registry.npmjs.org/@tanstack/svelte-query/-/svelte-query-5.61.4.tgz", + "integrity": "sha512-FdyUKJj4B0uVtTMebRJ8/SsNtF5GNOY9OW6fayv+C8teJbORFw+YJ1mh+eii85q1tn6mA2RR4Yt2KLABsc6/Jg==", "license": "MIT", "dependencies": { - "@tanstack/query-core": "5.60.6" + "@tanstack/query-core": "5.61.4" }, "funding": { "type": "github", @@ -7260,9 +7260,9 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "20.17.7", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.7.tgz", - "integrity": "sha512-sZXXnpBFMKbao30dUAvzKbdwA2JM1fwUtVEq/kxKuPI5mMwZiRElCpTXb0Biq/LMEVpXDZL5G5V0RPnxKeyaYg==", + "version": "20.17.8", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.8.tgz", + "integrity": "sha512-ahz2g6/oqbKalW9sPv6L2iRbhLnojxjYWspAqhjvqSWBgGebEJT5GvRmk0QXPj3sbC6rU0GTQjPLQkmR8CObvA==", "license": "MIT", "dependencies": { "undici-types": "~6.19.2" @@ -7486,17 +7486,17 @@ "license": "MIT" }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.15.0.tgz", - "integrity": "sha512-+zkm9AR1Ds9uLWN3fkoeXgFppaQ+uEVtfOV62dDmsy9QCNqlRHWNEck4yarvRNrvRcHQLGfqBNui3cimoz8XAg==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.16.0.tgz", + "integrity": "sha512-5YTHKV8MYlyMI6BaEG7crQ9BhSc8RxzshOReKwZwRWN0+XvvTOm+L/UYLCYxFpfwYuAAqhxiq4yae0CMFwbL7Q==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.15.0", - "@typescript-eslint/type-utils": "8.15.0", - "@typescript-eslint/utils": "8.15.0", - "@typescript-eslint/visitor-keys": "8.15.0", + "@typescript-eslint/scope-manager": "8.16.0", + "@typescript-eslint/type-utils": "8.16.0", + "@typescript-eslint/utils": "8.16.0", + "@typescript-eslint/visitor-keys": "8.16.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", @@ -7520,16 +7520,16 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.15.0.tgz", - "integrity": "sha512-7n59qFpghG4uazrF9qtGKBZXn7Oz4sOMm8dwNWDQY96Xlm2oX67eipqcblDj+oY1lLCbf1oltMZFpUso66Kl1A==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.16.0.tgz", + "integrity": "sha512-D7DbgGFtsqIPIFMPJwCad9Gfi/hC0PWErRRHFnaCWoEDYi5tQUDiJCTmGUbBiLzjqAck4KcXt9Ayj0CNlIrF+w==", "dev": true, "license": "BSD-2-Clause", "dependencies": { - "@typescript-eslint/scope-manager": "8.15.0", - "@typescript-eslint/types": "8.15.0", - "@typescript-eslint/typescript-estree": "8.15.0", - "@typescript-eslint/visitor-keys": "8.15.0", + "@typescript-eslint/scope-manager": "8.16.0", + "@typescript-eslint/types": "8.16.0", + "@typescript-eslint/typescript-estree": "8.16.0", + "@typescript-eslint/visitor-keys": "8.16.0", "debug": "^4.3.4" }, "engines": { @@ -7549,14 +7549,14 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.15.0.tgz", - "integrity": "sha512-QRGy8ADi4J7ii95xz4UoiymmmMd/zuy9azCaamnZ3FM8T5fZcex8UfJcjkiEZjJSztKfEBe3dZ5T/5RHAmw2mA==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.16.0.tgz", + "integrity": "sha512-mwsZWubQvBki2t5565uxF0EYvG+FwdFb8bMtDuGQLdCCnGPrDEDvm1gtfynuKlnpzeBRqdFCkMf9jg1fnAK8sg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.15.0", - "@typescript-eslint/visitor-keys": "8.15.0" + "@typescript-eslint/types": "8.16.0", + "@typescript-eslint/visitor-keys": "8.16.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -7567,14 +7567,14 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.15.0.tgz", - "integrity": "sha512-UU6uwXDoI3JGSXmcdnP5d8Fffa2KayOhUUqr/AiBnG1Gl7+7ut/oyagVeSkh7bxQ0zSXV9ptRh/4N15nkCqnpw==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.16.0.tgz", + "integrity": "sha512-IqZHGG+g1XCWX9NyqnI/0CX5LL8/18awQqmkZSl2ynn8F76j579dByc0jhfVSnSnhf7zv76mKBQv9HQFKvDCgg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/typescript-estree": "8.15.0", - "@typescript-eslint/utils": "8.15.0", + "@typescript-eslint/typescript-estree": "8.16.0", + "@typescript-eslint/utils": "8.16.0", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" }, @@ -7595,9 +7595,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.15.0.tgz", - "integrity": "sha512-n3Gt8Y/KyJNe0S3yDCD2RVKrHBC4gTUcLTebVBXacPy091E6tNspFLKRXlk3hwT4G55nfr1n2AdFqi/XMxzmPQ==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.16.0.tgz", + "integrity": "sha512-NzrHj6thBAOSE4d9bsuRNMvk+BvaQvmY4dDglgkgGC0EW/tB3Kelnp3tAKH87GEwzoxgeQn9fNGRyFJM/xd+GQ==", "dev": true, "license": "MIT", "engines": { @@ -7609,14 +7609,14 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.15.0.tgz", - "integrity": "sha512-1eMp2JgNec/niZsR7ioFBlsh/Fk0oJbhaqO0jRyQBMgkz7RrFfkqF9lYYmBoGBaSiLnu8TAPQTwoTUiSTUW9dg==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.16.0.tgz", + "integrity": "sha512-E2+9IzzXMc1iaBy9zmo+UYvluE3TW7bCGWSF41hVWUE01o8nzr1rvOQYSxelxr6StUvRcTMe633eY8mXASMaNw==", "dev": true, "license": "BSD-2-Clause", "dependencies": { - "@typescript-eslint/types": "8.15.0", - "@typescript-eslint/visitor-keys": "8.15.0", + "@typescript-eslint/types": "8.16.0", + "@typescript-eslint/visitor-keys": "8.16.0", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -7664,16 +7664,16 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.15.0.tgz", - "integrity": "sha512-k82RI9yGhr0QM3Dnq+egEpz9qB6Un+WLYhmoNcvl8ltMEededhh7otBVVIDDsEEttauwdY/hQoSsOv13lxrFzQ==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.16.0.tgz", + "integrity": "sha512-C1zRy/mOL8Pj157GiX4kaw7iyRLKfJXBR3L82hk5kS/GyHcOFmy4YUq/zfZti72I9wnuQtA/+xzft4wCC8PJdA==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.15.0", - "@typescript-eslint/types": "8.15.0", - "@typescript-eslint/typescript-estree": "8.15.0" + "@typescript-eslint/scope-manager": "8.16.0", + "@typescript-eslint/types": "8.16.0", + "@typescript-eslint/typescript-estree": "8.16.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -7692,13 +7692,13 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.15.0.tgz", - "integrity": "sha512-h8vYOulWec9LhpwfAdZf2bjr8xIp0KNKnpgqSz0qqYYKAW/QZKw3ktRndbiAtUz4acH4QLQavwZBYCc0wulA/Q==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.16.0.tgz", + "integrity": "sha512-pq19gbaMOmFE3CbL0ZB8J8BFCo2ckfHBfaIsaOZgBIF4EoISJIdLX5xRhd0FGB0LlHReNRuzoJoMGpTjq8F2CQ==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.15.0", + "@typescript-eslint/types": "8.16.0", "eslint-visitor-keys": "^4.2.0" }, "engines": { @@ -7716,9 +7716,9 @@ "license": "ISC" }, "node_modules/@vitest/coverage-istanbul": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@vitest/coverage-istanbul/-/coverage-istanbul-2.1.5.tgz", - "integrity": "sha512-jJsS5jeHncmSvzMNE03F1pk8F9etmjzGmGyQnGMkdHdVek/bxK/3vo8Qr3e9XmVuDM3UZKOy1ObeQHgC2OxvHg==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@vitest/coverage-istanbul/-/coverage-istanbul-2.1.6.tgz", + "integrity": "sha512-tJBsODJ8acDxwt4J+HERV0+FxOhjOXn+yVYWHQ25iFqcbQNyvptQLBFxEoRvaMbqJqSaYatGOg0/ctiQdB3mSg==", "dev": true, "license": "MIT", "dependencies": { @@ -7737,18 +7737,18 @@ "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "vitest": "2.1.5" + "vitest": "2.1.6" } }, "node_modules/@vitest/expect": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-2.1.5.tgz", - "integrity": "sha512-nZSBTW1XIdpZvEJyoP/Sy8fUg0b8od7ZpGDkTUcfJ7wz/VoZAFzFfLyxVxGFhUjJzhYqSbIpfMtl/+k/dpWa3Q==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-2.1.6.tgz", + "integrity": "sha512-9M1UR9CAmrhJOMoSwVnPh2rELPKhYo0m/CSgqw9PyStpxtkwhmdM6XYlXGKeYyERY1N6EIuzkQ7e3Lm1WKCoUg==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "2.1.5", - "@vitest/utils": "2.1.5", + "@vitest/spy": "2.1.6", + "@vitest/utils": "2.1.6", "chai": "^5.1.2", "tinyrainbow": "^1.2.0" }, @@ -7757,13 +7757,13 @@ } }, "node_modules/@vitest/mocker": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-2.1.5.tgz", - "integrity": "sha512-XYW6l3UuBmitWqSUXTNXcVBUCRytDogBsWuNXQijc00dtnU/9OqpXWp4OJroVrad/gLIomAq9aW8yWDBtMthhQ==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-2.1.6.tgz", + "integrity": "sha512-MHZp2Z+Q/A3am5oD4WSH04f9B0T7UvwEb+v5W0kCYMhtXGYbdyl2NUk1wdSMqGthmhpiThPDp/hEoVwu16+u1A==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "2.1.5", + "@vitest/spy": "2.1.6", "estree-walker": "^3.0.3", "magic-string": "^0.30.12" }, @@ -7772,7 +7772,7 @@ }, "peerDependencies": { "msw": "^2.4.9", - "vite": "^5.0.0" + "vite": "^5.0.0 || ^6.0.0" }, "peerDependenciesMeta": { "msw": { @@ -7784,9 +7784,9 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-2.1.5.tgz", - "integrity": "sha512-4ZOwtk2bqG5Y6xRGHcveZVr+6txkH7M2e+nPFd6guSoN638v/1XQ0K06eOpi0ptVU/2tW/pIU4IoPotY/GZ9fw==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-2.1.6.tgz", + "integrity": "sha512-exZyLcEnHgDMKc54TtHca4McV4sKT+NKAe9ix/yhd/qkYb/TP8HTyXRFDijV19qKqTZM0hPL4753zU/U8L/gAA==", "dev": true, "license": "MIT", "dependencies": { @@ -7797,13 +7797,13 @@ } }, "node_modules/@vitest/runner": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-2.1.5.tgz", - "integrity": "sha512-pKHKy3uaUdh7X6p1pxOkgkVAFW7r2I818vHDthYLvUyjRfkKOU6P45PztOch4DZarWQne+VOaIMwA/erSSpB9g==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-2.1.6.tgz", + "integrity": "sha512-SjkRGSFyrA82m5nz7To4CkRSEVWn/rwQISHoia/DB8c6IHIhaE/UNAo+7UfeaeJRE979XceGl00LNkIz09RFsA==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "2.1.5", + "@vitest/utils": "2.1.6", "pathe": "^1.1.2" }, "funding": { @@ -7811,13 +7811,13 @@ } }, "node_modules/@vitest/snapshot": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-2.1.5.tgz", - "integrity": "sha512-zmYw47mhfdfnYbuhkQvkkzYroXUumrwWDGlMjpdUr4jBd3HZiV2w7CQHj+z7AAS4VOtWxI4Zt4bWt4/sKcoIjg==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-2.1.6.tgz", + "integrity": "sha512-5JTWHw8iS9l3v4/VSuthCndw1lN/hpPB+mlgn1BUhFbobeIUj1J1V/Bj2t2ovGEmkXLTckFjQddsxS5T6LuVWw==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "2.1.5", + "@vitest/pretty-format": "2.1.6", "magic-string": "^0.30.12", "pathe": "^1.1.2" }, @@ -7826,9 +7826,9 @@ } }, "node_modules/@vitest/spy": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-2.1.5.tgz", - "integrity": "sha512-aWZF3P0r3w6DiYTVskOYuhBc7EMc3jvn1TkBg8ttylFFRqNN2XGD7V5a4aQdk6QiUzZQ4klNBSpCLJgWNdIiNw==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-2.1.6.tgz", + "integrity": "sha512-oTFObV8bd4SDdRka5O+mSh5w9irgx5IetrD5i+OsUUsk/shsBoHifwCzy45SAORzAhtNiprUVaK3hSCCzZh1jQ==", "dev": true, "license": "MIT", "dependencies": { @@ -7839,13 +7839,13 @@ } }, "node_modules/@vitest/utils": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-2.1.5.tgz", - "integrity": "sha512-yfj6Yrp0Vesw2cwJbP+cl04OC+IHFsuQsrsJBL9pyGeQXE56v1UAOQco+SR55Vf1nQzfV0QJg1Qum7AaWUwwYg==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-2.1.6.tgz", + "integrity": "sha512-ixNkFy3k4vokOUTU2blIUvOgKq/N2PW8vKIjZZYsGJCMX69MRa9J2sKqX5hY/k5O5Gty3YJChepkqZ3KM9LyIQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "2.1.5", + "@vitest/pretty-format": "2.1.6", "loupe": "^3.1.2", "tinyrainbow": "^1.2.0" }, @@ -21366,9 +21366,9 @@ } }, "node_modules/prettier": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", - "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", + "version": "3.4.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.4.1.tgz", + "integrity": "sha512-G+YdqtITVZmOJje6QkXQWzl3fSfMxFwm1tjTyo9exhkmWSqC4Yhd1+lug++IlR2mvRVAxEDDWYkQdeSztajqgg==", "dev": true, "license": "MIT", "bin": { @@ -24316,9 +24316,9 @@ } }, "node_modules/svelte": { - "version": "5.2.7", - "resolved": "https://registry.npmjs.org/svelte/-/svelte-5.2.7.tgz", - "integrity": "sha512-cEhPGuLHiH2+Z8B1FwQgiZJgA39uUmJR4516TKrM5zrp0/cuwJkfhUfcTxhAkznanAF5fXUKzvYR4o+Ksx3ZCQ==", + "version": "5.2.8", + "resolved": "https://registry.npmjs.org/svelte/-/svelte-5.2.8.tgz", + "integrity": "sha512-VU7a01XwnFi6wXVkH5QY3FYXRZWrhsWZhaE8AYU6UeYZdslE3TFgQq6+HLrbMjOLkVhdKt74NGHYbhFeErQQ6g==", "license": "MIT", "dependencies": { "@ampproject/remapping": "^2.3.0", @@ -25008,9 +25008,9 @@ } }, "node_modules/ts-api-utils": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.4.0.tgz", - "integrity": "sha512-032cPxaEKwM+GT3vA5JXNzIaizx388rhsSW79vGRNGXfRRAdEAn2mvk36PvK5HnOchyWZ7afLEXqYCvPCrzuzQ==", + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.4.2.tgz", + "integrity": "sha512-ZF5gQIQa/UmzfvxbHZI3JXN0/Jt+vnAfAviNRAMc491laiK6YCLpCW9ft8oaCRFOTxCZtUTE6XB0ZQAe3olntw==", "dev": true, "license": "MIT", "engines": { @@ -25369,15 +25369,15 @@ } }, "node_modules/typescript-eslint": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.15.0.tgz", - "integrity": "sha512-wY4FRGl0ZI+ZU4Jo/yjdBu0lVTSML58pu6PgGtJmCufvzfV565pUF6iACQt092uFOd49iLOTX/sEVmHtbSrS+w==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.16.0.tgz", + "integrity": "sha512-wDkVmlY6O2do4V+lZd0GtRfbtXbeD0q9WygwXXSJnC1xorE8eqyC2L1tJimqpSeFrOzRlYtWnUp/uzgHQOgfBQ==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/eslint-plugin": "8.15.0", - "@typescript-eslint/parser": "8.15.0", - "@typescript-eslint/utils": "8.15.0" + "@typescript-eslint/eslint-plugin": "8.16.0", + "@typescript-eslint/parser": "8.16.0", + "@typescript-eslint/utils": "8.16.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -26121,9 +26121,9 @@ } }, "node_modules/vite-node": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-2.1.5.tgz", - "integrity": "sha512-rd0QIgx74q4S1Rd56XIiL2cYEdyWn13cunYBIuqh9mpmQr7gGS0IxXoP8R6OaZtNQQLyXSWbd4rXKYUbhFpK5w==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-2.1.6.tgz", + "integrity": "sha512-DBfJY0n9JUwnyLxPSSUmEePT21j8JZp/sR9n+/gBwQU6DcQOioPdb8/pibWfXForbirSagZCilseYIwaL3f95A==", "dev": true, "license": "MIT", "dependencies": { @@ -26131,13 +26131,13 @@ "debug": "^4.3.7", "es-module-lexer": "^1.5.4", "pathe": "^1.1.2", - "vite": "^5.0.0" + "vite": "^5.0.0 || ^6.0.0" }, "bin": { "vite-node": "vite-node.mjs" }, "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" }, "funding": { "url": "https://opencollective.com/vitest" @@ -26574,19 +26574,19 @@ } }, "node_modules/vitest": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-2.1.5.tgz", - "integrity": "sha512-P4ljsdpuzRTPI/kbND2sDZ4VmieerR2c9szEZpjc+98Z9ebvnXmM5+0tHEKqYZumXqlvnmfWsjeFOjXVriDG7A==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-2.1.6.tgz", + "integrity": "sha512-isUCkvPL30J4c5O5hgONeFRsDmlw6kzFEdLQHLezmDdKQHy8Ke/B/dgdTMEgU0vm+iZ0TjW8GuK83DiahBoKWQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/expect": "2.1.5", - "@vitest/mocker": "2.1.5", - "@vitest/pretty-format": "^2.1.5", - "@vitest/runner": "2.1.5", - "@vitest/snapshot": "2.1.5", - "@vitest/spy": "2.1.5", - "@vitest/utils": "2.1.5", + "@vitest/expect": "2.1.6", + "@vitest/mocker": "2.1.6", + "@vitest/pretty-format": "^2.1.6", + "@vitest/runner": "2.1.6", + "@vitest/snapshot": "2.1.6", + "@vitest/spy": "2.1.6", + "@vitest/utils": "2.1.6", "chai": "^5.1.2", "debug": "^4.3.7", "expect-type": "^1.1.0", @@ -26597,24 +26597,24 @@ "tinyexec": "^0.3.1", "tinypool": "^1.0.1", "tinyrainbow": "^1.2.0", - "vite": "^5.0.0", - "vite-node": "2.1.5", + "vite": "^5.0.0 || ^6.0.0", + "vite-node": "2.1.6", "why-is-node-running": "^2.3.0" }, "bin": { "vitest": "vitest.mjs" }, "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "@edge-runtime/vm": "*", - "@types/node": "^18.0.0 || >=20.0.0", - "@vitest/browser": "2.1.5", - "@vitest/ui": "2.1.5", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "2.1.6", + "@vitest/ui": "2.1.6", "happy-dom": "*", "jsdom": "*" }, @@ -28042,7 +28042,7 @@ "@types/chai": "^5.0.1", "@types/decompress": "^4.2.7", "@types/mocha": "^10.0.10", - "@types/node": "^20.17.7", + "@types/node": "^20.17.8", "chai": "^5.1.2", "cross-env": "^7.0.3" }, @@ -28600,7 +28600,7 @@ "license": "MIT", "devDependencies": { "@tsconfig/node20": "^20.1.4", - "@types/node": "^20.17.7", + "@types/node": "^20.17.8", "ts2mjs": "^3.0.0", "tslib": "^2.8.1" }, @@ -28655,7 +28655,7 @@ "packages/webview-ui": { "version": "0.0.1", "dependencies": { - "@tanstack/svelte-query": "^5.60.6", + "@tanstack/svelte-query": "^5.61.4", "@vscode/webview-ui-toolkit": "^1.4.0", "fast-equals": "^5.0.1", "sirv-cli": "^3.0.0", @@ -28676,7 +28676,7 @@ "rollup-plugin-css-only": "^4.5.2", "rollup-plugin-livereload": "^2.0.5", "rollup-plugin-svelte": "^7.2.2", - "svelte": "^5.2.7", + "svelte": "^5.2.8", "svelte-check": "^4.1.0", "svelte-preprocess": "^6.0.3", "tslib": "^2.8.1", diff --git a/package.json b/package.json index ff7f5e925d..9da071424c 100644 --- a/package.json +++ b/package.json @@ -3961,10 +3961,10 @@ "devDependencies": { "@eslint/js": "^9.15.0", "@tsconfig/node20": "^20.1.4", - "@types/node": "^20.17.7", + "@types/node": "^20.17.8", "@types/vscode": "1.90.0", "@types/vscode-webview": "^1.57.5", - "@vitest/coverage-istanbul": "^2.1.5", + "@vitest/coverage-istanbul": "^2.1.6", "@vscode/vsce": "^3.2.1", "ansi-styles": "^6.2.1", "chokidar-cli": "^3.0.0", @@ -3979,15 +3979,15 @@ "jest-mock-vscode": "^4.0.3", "ovsx": "^0.10.1", "patch-package": "^8.0.0", - "prettier": "^3.3.3", + "prettier": "^3.4.1", "prettier-plugin-svelte": "^3.3.2", "rollup": "^4.27.4", "rollup-plugin-dts": "^6.1.1", "shx": "^0.3.4", "typescript": "^5.7.2", - "typescript-eslint": "^8.15.0", + "typescript-eslint": "^8.16.0", "vite": "^5.4.11", - "vitest": "^2.1.5" + "vitest": "^2.1.6" }, "dependencies": { "@cspell/cspell-bundled-dicts": "^8.16.0", diff --git a/packages/__locale-resolver/data/README.md b/packages/__locale-resolver/data/README.md index 028315506d..5eecb611b6 100644 --- a/packages/__locale-resolver/data/README.md +++ b/packages/__locale-resolver/data/README.md @@ -1,3 +1,3 @@ # Data -- [ISO Script Names.tsv) from [wiki/ISO_15924](https://en.wikipedia.org/wiki/ISO_15924#List_of_codes) +- [ISO Script Names.tsv) from [wiki/ISO_15924](https://en.wikipedia.org/wiki/ISO_15924#List_of_codes) diff --git a/packages/_integrationTests/README.md b/packages/_integrationTests/README.md index f53401638d..7f20b19f07 100644 --- a/packages/_integrationTests/README.md +++ b/packages/_integrationTests/README.md @@ -15,5 +15,5 @@ These are cause because we are running the test runner from a different copy of ## Environment Variables -- `VSIX_LOCATION` - tell the test runner to use a pre-made .vsix file. -- `VSCODE_VERSION` - tell the test runner which version of vscode to download. +- `VSIX_LOCATION` - tell the test runner to use a pre-made .vsix file. +- `VSCODE_VERSION` - tell the test runner which version of vscode to download. diff --git a/packages/_integrationTests/package.json b/packages/_integrationTests/package.json index 6764f011ff..7bd6e0beb7 100644 --- a/packages/_integrationTests/package.json +++ b/packages/_integrationTests/package.json @@ -29,7 +29,7 @@ "@types/chai": "^5.0.1", "@types/decompress": "^4.2.7", "@types/mocha": "^10.0.10", - "@types/node": "^20.17.7", + "@types/node": "^20.17.8", "chai": "^5.1.2", "cross-env": "^7.0.3" }, diff --git a/packages/_integrationTests/sampleWorkspaces/workspace2/README.md b/packages/_integrationTests/sampleWorkspaces/workspace2/README.md index 76e8dfdace..4e8cb7648e 100644 --- a/packages/_integrationTests/sampleWorkspaces/workspace2/README.md +++ b/packages/_integrationTests/sampleWorkspaces/workspace2/README.md @@ -4,4 +4,4 @@ This workspace has a `package.json` with a `cspell` section. Custom words: -- Workspacetwo +- Workspacetwo diff --git a/packages/_server/src/validator.md b/packages/_server/src/validator.md index 753fe29902..81b3f622e0 100644 --- a/packages/_server/src/validator.md +++ b/packages/_server/src/validator.md @@ -12,11 +12,11 @@ There are some files or file types where we only want to spell check strings or #### Challenges -- How to specify which files get special filtering -- How to define the inclusion / exclusion rules +- How to specify which files get special filtering +- How to define the inclusion / exclusion rules #### Thoughts -- Use Regex -- Should we use syntax highlighting expressions? This might make things easier, but it means we need to find a way to import them. -- There are two types of rules, global and nested. A global exclusion rule might exclude urls for example. +- Use Regex +- Should we use syntax highlighting expressions? This might make things easier, but it means we need to find a way to import them. +- There are two types of rules, global and nested. A global exclusion rule might exclude urls for example. diff --git a/packages/client/docs/settings.md b/packages/client/docs/settings.md index 8be8a8638c..545ca79e5d 100644 --- a/packages/client/docs/settings.md +++ b/packages/client/docs/settings.md @@ -10,14 +10,14 @@ A resource level setting that specifies the location of the `cspell.json` file. ## Raw Notes -- need setting to indicate that settings should use `cspell.json` by default. -- need to be able to specify the location of user words, words, ignore words, and forbid words. -- would like to have a format for a single list of words that represents words / ignore / forbid. - - Use the format for cspell 5 - - `!` indicates forbidden - - `+` indicates compound required - - `*` indicates optional compound - - ` ` (don't know yet) indicates do not suggest. +- need setting to indicate that settings should use `cspell.json` by default. +- need to be able to specify the location of user words, words, ignore words, and forbid words. +- would like to have a format for a single list of words that represents words / ignore / forbid. + - Use the format for cspell 5 + - `!` indicates forbidden + - `+` indicates compound required + - `*` indicates optional compound + - ` ` (don't know yet) indicates do not suggest. # Add Remove Locale @@ -29,8 +29,8 @@ When adding / removing locales, the scope is either Global or Workspace. Global - means it is possible to adjust any configuration. Workspaces - means it is possible to adjust any configuration that is not Global. -- Targets are presented from Locale to Global. -- Targets _Inherit_ their values from Global to Local. +- Targets are presented from Locale to Global. +- Targets _Inherit_ their values from Global to Local. ### Adding Locale @@ -56,7 +56,7 @@ The goal of the Toggle is to turn on / off the spell checker in a intuitive and The logic to the Toggler is as follows: -- Find the most local configuration with the `enable` value set. -- Remove it if it will become the same as the inherited value otherwise set it to the negation. +- Find the most local configuration with the `enable` value set. +- Remove it if it will become the same as the inherited value otherwise set it to the negation. Having a scope of Workspace prevents the Global value from being updated, but the rest of the logic is the same. diff --git a/packages/client/src/webview/panels/README.md b/packages/client/src/webview/panels/README.md index 3bafcf7aa5..25159305dc 100644 --- a/packages/client/src/webview/panels/README.md +++ b/packages/client/src/webview/panels/README.md @@ -6,8 +6,8 @@ Types of content that can be contained here: Individual JavaScript / TypeScript files that contain a class which manages the state and behavior of a given webview panel. Each class is usually in charge of: -- Creating and rendering the webview panel -- Properly cleaning up and disposing of webview resources when the panel is closed -- Setting message listeners so data can be passed between the webview and extension -- Setting the HTML (and by proxy CSS/JavaScript) content of the webview panel -- Other custom logic and behavior related to webview panel management +- Creating and rendering the webview panel +- Properly cleaning up and disposing of webview resources when the panel is closed +- Setting message listeners so data can be passed between the webview and extension +- Setting the HTML (and by proxy CSS/JavaScript) content of the webview panel +- Other custom logic and behavior related to webview panel management diff --git a/packages/utils-disposables/README.md b/packages/utils-disposables/README.md index aaff7367c0..22013681f1 100644 --- a/packages/utils-disposables/README.md +++ b/packages/utils-disposables/README.md @@ -4,8 +4,8 @@ This library is to help with creating Disposables that support both VSCode Dispo See: -- [TypeScript 5.2 Release Notes](https://devblogs.microsoft.com/typescript/announcing-typescript-5-2/#using-declarations-and-explicit-resource-management) -- [tc39/proposal: ECMAScript Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management) +- [TypeScript 5.2 Release Notes](https://devblogs.microsoft.com/typescript/announcing-typescript-5-2/#using-declarations-and-explicit-resource-management) +- [tc39/proposal: ECMAScript Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management) This module will polyfill `Symbol.dispose` if necessary. diff --git a/packages/utils-disposables/package.json b/packages/utils-disposables/package.json index 9a9673eeda..7ccaba3048 100644 --- a/packages/utils-disposables/package.json +++ b/packages/utils-disposables/package.json @@ -15,7 +15,7 @@ }, "devDependencies": { "@tsconfig/node20": "^20.1.4", - "@types/node": "^20.17.7", + "@types/node": "^20.17.8", "ts2mjs": "^3.0.0", "tslib": "^2.8.1" }, diff --git a/packages/webview-ui/README.md b/packages/webview-ui/README.md index a008c4e365..5ab19c91a3 100644 --- a/packages/webview-ui/README.md +++ b/packages/webview-ui/README.md @@ -4,7 +4,7 @@ This directory contains all of the code that will be executed within the webview Types of content that can be contained here: -- Frontend framework code (i.e. Svelte, Vue, SolidJS, React, etc.) -- JavaScript files -- CSS files -- Assets / resources (i.e. images, illustrations, etc.) +- Frontend framework code (i.e. Svelte, Vue, SolidJS, React, etc.) +- JavaScript files +- CSS files +- Assets / resources (i.e. images, illustrations, etc.) diff --git a/packages/webview-ui/package.json b/packages/webview-ui/package.json index be86415bdc..a2628b52cd 100644 --- a/packages/webview-ui/package.json +++ b/packages/webview-ui/package.json @@ -14,7 +14,7 @@ }, "type": "module", "dependencies": { - "@tanstack/svelte-query": "^5.60.6", + "@tanstack/svelte-query": "^5.61.4", "@vscode/webview-ui-toolkit": "^1.4.0", "fast-equals": "^5.0.1", "sirv-cli": "^3.0.0", @@ -35,7 +35,7 @@ "rollup-plugin-css-only": "^4.5.2", "rollup-plugin-livereload": "^2.0.5", "rollup-plugin-svelte": "^7.2.2", - "svelte": "^5.2.7", + "svelte": "^5.2.8", "svelte-check": "^4.1.0", "svelte-preprocess": "^6.0.3", "tslib": "^2.8.1", diff --git a/website/docs/extensions.md b/website/docs/extensions.md index 0b85967570..f5ff8b037c 100644 --- a/website/docs/extensions.md +++ b/website/docs/extensions.md @@ -9,56 +9,56 @@ id: extensions ### Language Dictionaries -- [Ancient Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ancient-greek) - Ancient Greek dictionary extension for VS Code. -- [Arabic](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-arabic) - Arabic dictionary extension for VS Code. -- [Australian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-australian-english) - Australian English dictionary extension for VS Code. -- [Austrian German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-austrian-german) - Austrian German dictionary extension for VS Code. -- [Basque](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-basque) - Basque dictionary extension for VS Code. -- [British English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-british-english) - British English dictionary extension for VS Code. -- [Bulgarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-bulgarian) - Bulgarian dictionary extension for VS Code. -- [Canadian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-canadian-english) - Canadian English dictionary extension for VS Code. -- [Catalan](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-catalan) - Catalan dictionary extension for VS Code. -- [Croatian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-croatian) - Croatian dictionary extension for VS Code. -- [Czech](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-czech) - Czech dictionary extension for VS Code. -- [Danish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-danish) - Danish dictionary extension for VS Code. -- [Dutch](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-dutch) - Dutch / Nederlands dictionary extension for VS Code. -- [Esperanto](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-esperanto) - Esperanto dictionary extension for VS Code. -- [Estonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-estonian) - Estonian dictionary extension for VS Code. -- [Finnish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-finnish) - Finnish dictionary extension for VS Code. -- [French](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french) - French dictionary extension for VS Code. -- [French Réforme 90](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french-reforme) - French Réforme 90 dictionary extension for VS Code. -- [German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-german) - German dictionary extension for VS Code. -- [Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-greek) - Greek dictionary extension for VS Code. -- [Hebrew](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hebrew) - Hebrew dictionary extension for VS Code. -- [Hungarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hungarian) - Hungarian dictionary extension for VS Code. -- [Indonesian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-indonesian) - Indonesian dictionary extension for VS Code. -- [Italian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-italian) - Italian dictionary extension for VS Code. -- [Latin](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latin) - Latin dictionary extension for VS Code. -- [Latvian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latvian) - Latvian dictionary extension for VS Code. -- [Lithuanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-lithuanian) - Lithuanian dictionary extension for VS Code. -- [Macedonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-macedonian) - Macedonian dictionary extension for VS Code. -- [Norwegian Bokmål](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-norwegian-bokmal) - Norwegian Bokmål dictionary extension for VS Code. -- [Persian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-persian) - Persian dictionary extension for VS Code. -- [Polish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-polish) - Polish dictionary extension for VS Code. -- [Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese) - Portuguese dictionary extension for VS Code. -- [Brazilian Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese-brazilian) - Brazilian Portuguese dictionary extension for VS Code. -- [Romanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-romanian) - Romanian dictionary extension for VS Code. -- [Russian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-russian) - Russian dictionary extension for VS Code. -- [Serbian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-serbian) - Serbian dictionary extension for VS Code. -- [Slovak](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovak) - Slovak dictionary extension for VS Code. -- [Slovenian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovenian) - Slovenian dictionary extension for VS Code. -- [Spanish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-spanish) - Spanish Add-On for Code Spell Checker -- [Swedish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swedish) - Swedish dictionary extension for VS Code. -- [Swiss German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swiss-german) - Swiss German dictionary extension for VS Code. -- [Turkish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-turkish) - Turkish dictionary extension for VS Code. -- [Ukrainian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ukrainian) - Ukrainian dictionary extension for VS Code. -- [Vietnamese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-vietnamese) - Vietnamese dictionary extension for VS Code. +- [Ancient Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ancient-greek) - Ancient Greek dictionary extension for VS Code. +- [Arabic](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-arabic) - Arabic dictionary extension for VS Code. +- [Australian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-australian-english) - Australian English dictionary extension for VS Code. +- [Austrian German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-austrian-german) - Austrian German dictionary extension for VS Code. +- [Basque](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-basque) - Basque dictionary extension for VS Code. +- [British English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-british-english) - British English dictionary extension for VS Code. +- [Bulgarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-bulgarian) - Bulgarian dictionary extension for VS Code. +- [Canadian English](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-canadian-english) - Canadian English dictionary extension for VS Code. +- [Catalan](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-catalan) - Catalan dictionary extension for VS Code. +- [Croatian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-croatian) - Croatian dictionary extension for VS Code. +- [Czech](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-czech) - Czech dictionary extension for VS Code. +- [Danish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-danish) - Danish dictionary extension for VS Code. +- [Dutch](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-dutch) - Dutch / Nederlands dictionary extension for VS Code. +- [Esperanto](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-esperanto) - Esperanto dictionary extension for VS Code. +- [Estonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-estonian) - Estonian dictionary extension for VS Code. +- [Finnish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-finnish) - Finnish dictionary extension for VS Code. +- [French](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french) - French dictionary extension for VS Code. +- [French Réforme 90](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-french-reforme) - French Réforme 90 dictionary extension for VS Code. +- [German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-german) - German dictionary extension for VS Code. +- [Greek](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-greek) - Greek dictionary extension for VS Code. +- [Hebrew](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hebrew) - Hebrew dictionary extension for VS Code. +- [Hungarian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-hungarian) - Hungarian dictionary extension for VS Code. +- [Indonesian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-indonesian) - Indonesian dictionary extension for VS Code. +- [Italian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-italian) - Italian dictionary extension for VS Code. +- [Latin](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latin) - Latin dictionary extension for VS Code. +- [Latvian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-latvian) - Latvian dictionary extension for VS Code. +- [Lithuanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-lithuanian) - Lithuanian dictionary extension for VS Code. +- [Macedonian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-macedonian) - Macedonian dictionary extension for VS Code. +- [Norwegian Bokmål](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-norwegian-bokmal) - Norwegian Bokmål dictionary extension for VS Code. +- [Persian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-persian) - Persian dictionary extension for VS Code. +- [Polish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-polish) - Polish dictionary extension for VS Code. +- [Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese) - Portuguese dictionary extension for VS Code. +- [Brazilian Portuguese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-portuguese-brazilian) - Brazilian Portuguese dictionary extension for VS Code. +- [Romanian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-romanian) - Romanian dictionary extension for VS Code. +- [Russian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-russian) - Russian dictionary extension for VS Code. +- [Serbian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-serbian) - Serbian dictionary extension for VS Code. +- [Slovak](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovak) - Slovak dictionary extension for VS Code. +- [Slovenian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-slovenian) - Slovenian dictionary extension for VS Code. +- [Spanish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-spanish) - Spanish Add-On for Code Spell Checker +- [Swedish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swedish) - Swedish dictionary extension for VS Code. +- [Swiss German](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-swiss-german) - Swiss German dictionary extension for VS Code. +- [Turkish](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-turkish) - Turkish dictionary extension for VS Code. +- [Ukrainian](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-ukrainian) - Ukrainian dictionary extension for VS Code. +- [Vietnamese](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-vietnamese) - Vietnamese dictionary extension for VS Code. ### Technical Dictionaries -- [Medical Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-medical-terms) - Medical Terms Add-On for Code Spell Checker -- [Scientific Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-scientific-terms) - Scientific Terms dictionary extension for VS Code. -- [Win32](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-win32) - Win32 dictionary extension for VS Code. +- [Medical Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-medical-terms) - Medical Terms Add-On for Code Spell Checker +- [Scientific Terms](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-scientific-terms) - Scientific Terms dictionary extension for VS Code. +- [Win32](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-win32) - Win32 dictionary extension for VS Code. diff --git a/website/docs/release-notes/releasenotes_v2.md b/website/docs/release-notes/releasenotes_v2.md index 298c9f35cd..25fddd04c5 100644 --- a/website/docs/release-notes/releasenotes_v2.md +++ b/website/docs/release-notes/releasenotes_v2.md @@ -7,27 +7,27 @@ id: release-notes-v2.0 ## Highlights -- By default, only files in a workspace are spell checked. -- Be able to specify which files to check by adding globs to `files` setting. -- Spelling suggestions available from the context menu. -- Improved context menu options. -- Upgrades [cspell](https://www.npmjs.com/package/cspell) to version 5.9.0. -- Supports case sensitive dictionaries. See: [Turning on case sensitive spell checking](#turning-on-case-sensitive-spell-checking) -- Full support of Yaml configuration files: `cspell.config.yaml` -- Full support of configuration in `package.json` under `cspell` section. -- Partial support of JavaScript configuration files: `cspell.config.js` - The extension supports reading the configuration but can only write to `.json` and `.yaml` files. -- Supports dictionary entries that have numbers and mixed case. -- Supports more word splitting formats - It correctly splits both `ERRORcode` and `ERRORCode` -- Reduced installation size and faster loading -- Added Commands to move between issues in a document. See: [Previous and Next Issue Commands](#previous-and-next-issue-commands) +- By default, only files in a workspace are spell checked. +- Be able to specify which files to check by adding globs to `files` setting. +- Spelling suggestions available from the context menu. +- Improved context menu options. +- Upgrades [cspell](https://www.npmjs.com/package/cspell) to version 5.9.0. +- Supports case sensitive dictionaries. See: [Turning on case sensitive spell checking](#turning-on-case-sensitive-spell-checking) +- Full support of Yaml configuration files: `cspell.config.yaml` +- Full support of configuration in `package.json` under `cspell` section. +- Partial support of JavaScript configuration files: `cspell.config.js` + The extension supports reading the configuration but can only write to `.json` and `.yaml` files. +- Supports dictionary entries that have numbers and mixed case. +- Supports more word splitting formats + It correctly splits both `ERRORcode` and `ERRORCode` +- Reduced installation size and faster loading +- Added Commands to move between issues in a document. See: [Previous and Next Issue Commands](#previous-and-next-issue-commands) ## Manual Installation -- Download and decompress `code-spell-checker.zip` from [VS Code Spell Checker Releases](https://github.com/streetsidesoftware/vscode-spell-checker/releases) -- From VS Code Install from VSIX `code-spell-checker-2.0.2.vsix` - ![image](https://user-images.githubusercontent.com/3740137/120071300-f0a27600-c08e-11eb-9828-155be0405510.png) +- Download and decompress `code-spell-checker.zip` from [VS Code Spell Checker Releases](https://github.com/streetsidesoftware/vscode-spell-checker/releases) +- From VS Code Install from VSIX `code-spell-checker-2.0.2.vsix` + ![image](https://user-images.githubusercontent.com/3740137/120071300-f0a27600-c08e-11eb-9828-155be0405510.png) # Features @@ -84,7 +84,7 @@ See: [How to Forbid Words - CSpell](https://streetsidesoftware.github.io/cspell/ # Contributions -- [elazarcoh](https://github.com/elazarcoh) - added previous/next issue commands. +- [elazarcoh](https://github.com/elazarcoh) - added previous/next issue commands. ## Enabled File Types -- AsciiDoc -- C, C++ -- C# -- css, less, scss -- Dart -- Elixir -- Go -- Html -- Java -- JavaScript -- JSON / JSONC -- LaTeX -- Markdown -- PHP -- PowerShell -- Pug / Jade -- Python -- reStructuredText -- Ruby -- Rust -- Scala -- Text -- TypeScript -- YAML -- SQL +- AsciiDoc +- C, C++ +- C# +- css, less, scss +- Dart +- Elixir +- Go +- Html +- Java +- JavaScript +- JSON / JSONC +- LaTeX +- Markdown +- PHP +- PowerShell +- Pug / Jade +- Python +- reStructuredText +- Ruby +- Rust +- Scala +- Text +- TypeScript +- YAML +- SQL ### Enable / Disable File Types @@ -154,10 +154,10 @@ To _Enable_ or _Disable_ spell checking for a file type: The concept is simple, split camelCase words before checking them against a list of known English words. -- camelCase -> camel case -- HTMLInput -> html input -- Notice that the `I` is associated with `Input` and not `HTML` -- snake_case_words -> snake case words -- camel2snake -> camel snake -- (the 2 is ignored) +- camelCase -> camel case +- HTMLInput -> html input -- Notice that the `I` is associated with `Input` and not `HTML` +- snake_case_words -> snake case words +- camel2snake -> camel snake -- (the 2 is ignored) ### Special case with ALL CAPS words @@ -165,17 +165,17 @@ There are a few special cases to help with common spelling practices for ALL CAP Trailing `s`, `ing`, `ies`, `es`, `ed` are kept with the previous word. -- CURLs -> curls -- trailing `s` -- CURLedRequest -> curled request -- trailing `ed` +- CURLs -> curls -- trailing `s` +- CURLedRequest -> curled request -- trailing `ed` ## Things to note -- This spellchecker is case insensitive. It will not catch errors like english which should be English. -- The spellchecker uses a local word dictionary. It does not send anything outside your machine. -- The words in the dictionary can and do contain errors. -- There are missing words. -- Only words longer than 3 characters are checked. "jsj" is not checked, while "jsja" is checked and will be marked as incorrect because it does not exist in any of the dictionaries. -- All symbols and punctuation are ignored. +- This spellchecker is case insensitive. It will not catch errors like english which should be English. +- The spellchecker uses a local word dictionary. It does not send anything outside your machine. +- The words in the dictionary can and do contain errors. +- There are missing words. +- Only words longer than 3 characters are checked. "jsj" is not checked, while "jsja" is checked and will be marked as incorrect because it does not exist in any of the dictionaries. +- All symbols and punctuation are ignored. ## In Document Settings @@ -184,14 +184,14 @@ This is to help with file specific issues that may not be applicable to the enti All settings are prefixed with `cSpell:` or `spell-checker:`. -- `disable` -- turn off the spell checker for a section of code. -- `enable` -- turn the spell checker back on after it has been turned off. -- `ignore` -- specify a list of words to be ignored. -- `words` -- specify a list of words to be considered correct and will appear in the suggestions list. -- `locale` -- set locale (example: `cSpell:locale fr,en` to use French and English languages) -- `ignoreRegExp` -- Any text matching the regular expression will NOT be checked for spelling. -- `includeRegExp` -- Only text matching the collection of includeRegExp will be checked. -- `enableCompoundWords` / `disableCompoundWords` -- Allow / disallow words like: "stringlength". +- `disable` -- turn off the spell checker for a section of code. +- `enable` -- turn the spell checker back on after it has been turned off. +- `ignore` -- specify a list of words to be ignored. +- `words` -- specify a list of words to be considered correct and will appear in the suggestions list. +- `locale` -- set locale (example: `cSpell:locale fr,en` to use French and English languages) +- `ignoreRegExp` -- Any text matching the regular expression will NOT be checked for spelling. +- `includeRegExp` -- Only text matching the collection of includeRegExp will be checked. +- `enableCompoundWords` / `disableCompoundWords` -- Allow / disallow words like: "stringlength". ### Enable / Disable checking sections of code @@ -199,19 +199,19 @@ It is possible to disable / enable the spell checker by adding comments to your #### Disable Checking -- `cSpell:disable` -- `spell-checker: disable` -- `spellchecker: disable` -- `cspell: disable-line` -- `cspell: disable-next-line` +- `cSpell:disable` +- `spell-checker: disable` +- `spellchecker: disable` +- `cspell: disable-line` +- `cspell: disable-next-line` #### Enable Checking -- `cSpell:enable` -- `spell-checker: enable` -- `spellchecker: enable` +- `cSpell:enable` +- `spell-checker: enable` +- `spellchecker: enable` #### JavaScript Example @@ -349,18 +349,18 @@ def sum_it(self, seq): ### Exclude patterns -- `Urls`1 -- Matches urls -- `HexValues` -- Matches common hex format like `#aaa`, `0xfeef`, `\u0134` -- `EscapeCharacters`1 -- matches special characters: `\n`, `\t` etc. -- `Base64`1 -- matches base64 blocks of text longer than 40 characters. -- `Email` -- matches most email addresses. +- `Urls`1 -- Matches urls +- `HexValues` -- Matches common hex format like `#aaa`, `0xfeef`, `\u0134` +- `EscapeCharacters`1 -- matches special characters: `\n`, `\t` etc. +- `Base64`1 -- matches base64 blocks of text longer than 40 characters. +- `Email` -- matches most email addresses. ### Include Patterns -- `Everything`1 -- By default we match an entire document and remove the excludes. -- `string` -- This matches common string formats like '...', "...", and \`...\` -- `CStyleComment` -- These are C Style comments /\* \*/ and // -- `PhpHereDoc` -- This matches PHPHereDoc strings. +- `Everything`1 -- By default we match an entire document and remove the excludes. +- `string` -- This matches common string formats like '...', "...", and \`...\` +- `CStyleComment` -- These are C Style comments /\* \*/ and // +- `PhpHereDoc` -- This matches PHPHereDoc strings. 1. These patterns are part of the default include/exclude list for every file. @@ -494,33 +494,33 @@ The spell checker includes a set of default dictionaries. ### General Dictionaries -- **wordsEn** - Derived from Hunspell US English words. -- **wordsEnGb** - Derived from Hunspell GB English words. -- **companies** - List of well known companies -- **softwareTerms** - Software Terms and concepts like "coroutine", "debounce", "tree", etc. -- **misc** - Terms that do not belong in the other dictionaries. +- **wordsEn** - Derived from Hunspell US English words. +- **wordsEnGb** - Derived from Hunspell GB English words. +- **companies** - List of well known companies +- **softwareTerms** - Software Terms and concepts like "coroutine", "debounce", "tree", etc. +- **misc** - Terms that do not belong in the other dictionaries. ### Programming Language Dictionaries -- **typescript** - keywords for Typescript and Javascript -- **node** - terms related to using nodejs. -- **php** - _php_ keywords and library methods -- **go** - _go_ keywords and library methods -- **python** - _python_ keywords -- **powershell** - _powershell_ keywords -- **html** - _html_ related keywords -- **css** - _css_, _less_, and _scss_ related keywords +- **typescript** - keywords for Typescript and Javascript +- **node** - terms related to using nodejs. +- **php** - _php_ keywords and library methods +- **go** - _go_ keywords and library methods +- **python** - _python_ keywords +- **powershell** - _powershell_ keywords +- **html** - _html_ related keywords +- **css** - _css_, _less_, and _scss_ related keywords ### Miscellaneous Dictionaries -- **fonts** - long list of fonts - to assist with _css_ +- **fonts** - long list of fonts - to assist with _css_ Based upon the programming language, different dictionaries will be loaded. Here are some of the default rules: -- `"*"` matches any programming language / file type. -- `"locale"` is used to filter based upon the `"cSpell.language"` setting. +- `"*"` matches any programming language / file type. +- `"locale"` is used to filter based upon the `"cSpell.language"` setting. ```javascript { @@ -661,10 +661,10 @@ Example adding medical terms, so words like _acanthopterygious_ can be found. **Explained:** In this example, we have told the spell checker where to find our personal dictionary called `myWords`. -- `name` - this is the name of the dictionary, all references to this dictionary is done by the name. -- `path` - this the path to the dictionary file. Since it is in the user settings, we have to use absolute paths or paths relative to the user directory by using `~/`. -- `scope` - (Optional) this is used to "scope" a dictionary to `user`, `workspace`, or `folder`. Scope is used to help communicate the intended use of the dictionary. -- `addWords` - (Optional) default - `true` - is used to show / hide the dictionary as a possible target for adding words. +- `name` - this is the name of the dictionary, all references to this dictionary is done by the name. +- `path` - this the path to the dictionary file. Since it is in the user settings, we have to use absolute paths or paths relative to the user directory by using `~/`. +- `scope` - (Optional) this is used to "scope" a dictionary to `user`, `workspace`, or `folder`. Scope is used to help communicate the intended use of the dictionary. +- `addWords` - (Optional) default - `true` - is used to show / hide the dictionary as a possible target for adding words. #### Project / Workspace Dictionary using `cspell.json`