Skip to content

Commit

Permalink
feat: Improve Spelling Issues Viewer (#3005)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jason3S
Jason3S authored Jan 16, 2024
1 parent 0a85632 commit 1b9a59d
Show file tree
Hide file tree
Showing 44 changed files with 2,181 additions and 745 deletions.
1 change: 1 addition & 0 deletions .prettierignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ samples/php/**/vendor
**/scripts/ts-json-schema-generator.cjs
package-lock.json
packages/webview-ui/public/build
**/*.schema.json
92 changes: 47 additions & 45 deletions docs/_includes/generated-docs/commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,50 @@

# Commands

| Command | Title |
| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `cSpell.addIgnoreWord` | Ignore Words |
| `cSpell.addIgnoreWordsToFolder` | Ignore Word in Folder Settings |
| `cSpell.addIgnoreWordsToUser` | Ignore Words in User Settings |
| `cSpell.addIgnoreWordsToWorkspace` | Ignore Words in Workspace Settings |
| `cSpell.addIssuesToDictionary` | Add All Spelling Issues to Dictionary |
| `cSpell.addWordToCSpellConfig` | Add Words to CSpell Configuration |
| `cSpell.addWordToDictionary` | Add Words to Dictionary |
| `cSpell.addWordToFolderDictionary` | Add Words to Folder Dictionary |
| `cSpell.addWordToFolderSettings` | Add Words to Folder Settings |
| `cSpell.addWordToUserDictionary` | Add Words to User Dictionary |
| `cSpell.addWordToUserSettings` | Add Words to User Settings |
| `cSpell.addWordToWorkspaceDictionary` | Add Words to Workspace Dictionary |
| `cSpell.addWordToWorkspaceSettings` | Add Words to Workspace Settings |
| `cSpell.autoFixSpellingIssues` | Fix all issues with a preferred suggestion in the current document. |
| `cSpell.createCSpellConfig` | Create a CSpell Configuration File. |
| `cSpell.createCustomDictionary` | Create a Custom Dictionary File. |
| `cSpell.disableCurrentLanguage` | Disable Spell Checking Document Language |
| `cSpell.disableForGlobal` | Disable Spell Checking by Default |
| `cSpell.disableForWorkspace` | Disable Spell Checking For Workspace |
| `cSpell.displayCSpellInfo` | Show Spell Checker Configuration Info |
| `cSpell.enableCurrentLanguage` | Enable Spell Checking Document Language |
| `cSpell.enableForGlobal` | Enable Spell Checking by Default |
| `cSpell.enableForWorkspace` | Enable Spell Checking For Workspace |
| `cSpell.goToNextSpellingIssue` | Go to Next Spelling Issue |
| `cSpell.goToNextSpellingIssueAndSuggest` | Go to Next Spelling Issue and Suggest |
| `cSpell.goToPreviousSpellingIssue` | Go to Previous Spelling Issue |
| `cSpell.goToPreviousSpellingIssueAndSuggest` | Go to Previous Spelling Issue and Suggest |
| `cSpell.insertDisableLineDirective` | Insert Disable Current Line Directive |
| `cSpell.insertDisableNextLineDirective` | Insert Disable Next Line Directive |
| `cSpell.insertIgnoreWordsDirective` | Insert Ignore Words Directive |
| `cSpell.insertWordsDirective` | Insert Words Directive |
| `cSpell.issueViewer.item.addWordToDictionary` | Add Word to Dictionary<br>**When:**<br> `view == cspell-info.issuesView` |
| `cSpell.issueViewer.item.autoFixSpellingIssues` | Fix issue with preferred suggestion in the current document.<br>**When:**<br> `view == cspell-info.issuesView` |
| `cSpell.issueViewer.item.openSuggestionsForIssue` | Show Suggestions<br>**When:**<br> `view == cspell-info.issuesView` |
| `cSpell.logPerfTimeline` | Log CSpell performance times to console |
| `cSpell.removeWordFromFolderDictionary` | Remove Words from the Folder Dictionary |
| `cSpell.removeWordFromUserDictionary` | Remove Words from the Global Dictionary |
| `cSpell.removeWordFromWorkspaceDictionary` | Remove Words from the Workspace Dictionaries |
| `cSpell.suggestSpellingCorrections` | Spelling Suggestions...<br>**When:**<br> `editorTextFocus && cSpell.editorMenuContext.showSuggestions` |
| `cSpell.toggleEnableForGlobal` | Toggle Spell Checking in User Settings |
| `cSpell.toggleEnableForWorkspace` | Toggle Spell Checking for Workspace |
| `cSpell.toggleEnableSpellChecker` | Toggle Spell Checking |
| `cSpell.toggleTraceMode` | Toggle Trace Mode |
| Command | Title |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `cSpell.addIgnoreWord` | Ignore Words |
| `cSpell.addIgnoreWordsToFolder` | Ignore Word in Folder Settings |
| `cSpell.addIgnoreWordsToUser` | Ignore Words in User Settings |
| `cSpell.addIgnoreWordsToWorkspace` | Ignore Words in Workspace Settings |
| `cSpell.addIssuesToDictionary` | Add All Spelling Issues to Dictionary |
| `cSpell.addWordToCSpellConfig` | Add Words to CSpell Configuration |
| `cSpell.addWordToDictionary` | Add Words to Dictionary |
| `cSpell.addWordToFolderDictionary` | Add Words to Folder Dictionary |
| `cSpell.addWordToFolderSettings` | Add Words to Folder Settings |
| `cSpell.addWordToUserDictionary` | Add Words to User Dictionary |
| `cSpell.addWordToUserSettings` | Add Words to User Settings |
| `cSpell.addWordToWorkspaceDictionary` | Add Words to Workspace Dictionary |
| `cSpell.addWordToWorkspaceSettings` | Add Words to Workspace Settings |
| `cSpell.autoFixSpellingIssues` | Fix all issues with a preferred suggestion in the current document. |
| `cSpell.createCSpellConfig` | Create a CSpell Configuration File. |
| `cSpell.createCustomDictionary` | Create a Custom Dictionary File. |
| `cSpell.disableCurrentLanguage` | Disable Spell Checking Document Language |
| `cSpell.disableForGlobal` | Disable Spell Checking by Default |
| `cSpell.disableForWorkspace` | Disable Spell Checking For Workspace |
| `cSpell.displayCSpellInfo` | Show Spell Checker Configuration Info |
| `cSpell.enableCurrentLanguage` | Enable Spell Checking Document Language |
| `cSpell.enableForGlobal` | Enable Spell Checking by Default |
| `cSpell.enableForWorkspace` | Enable Spell Checking For Workspace |
| `cSpell.goToNextSpellingIssue` | Go to Next Spelling Issue |
| `cSpell.goToNextSpellingIssueAndSuggest` | Go to Next Spelling Issue and Suggest |
| `cSpell.goToPreviousSpellingIssue` | Go to Previous Spelling Issue |
| `cSpell.goToPreviousSpellingIssueAndSuggest` | Go to Previous Spelling Issue and Suggest |
| `cSpell.insertDisableLineDirective` | Insert Disable Current Line Directive |
| `cSpell.insertDisableNextLineDirective` | Insert Disable Next Line Directive |
| `cSpell.insertIgnoreWordsDirective` | Insert Ignore Words Directive |
| `cSpell.insertWordsDirective` | Insert Words Directive |
| `cSpell.issuesViewByFile.item.addWordToDictionary` | Add Word to Dictionary<br>**When:**<br> `view == cspell.issuesViewByFile` |
| `cSpell.issuesViewByFile.item.autoFixSpellingIssues` | Fix issue with preferred suggestion in the current document.<br>**When:**<br> `view == cspell.issuesViewByFile` |
| `cSpell.issueViewer.item.addWordToDictionary` | Add Word to Dictionary<br>**When:**<br> `view == cspell-info.issuesView` |
| `cSpell.issueViewer.item.autoFixSpellingIssues` | Fix issue with preferred suggestion in the current document.<br>**When:**<br> `view == cspell-info.issuesView` |
| `cSpell.issueViewer.item.openSuggestionsForIssue` | Show Suggestions<br>**When:**<br> `view == cspell-info.issuesView` |
| `cSpell.logPerfTimeline` | Log CSpell performance times to console |
| `cSpell.removeWordFromFolderDictionary` | Remove Words from the Folder Dictionary |
| `cSpell.removeWordFromUserDictionary` | Remove Words from the Global Dictionary |
| `cSpell.removeWordFromWorkspaceDictionary` | Remove Words from the Workspace Dictionaries |
| `cSpell.suggestSpellingCorrections` | Spelling Suggestions...<br>**When:**<br> `editorTextFocus && cSpell.editorMenuContext.showSuggestions` |
| `cSpell.toggleEnableForGlobal` | Toggle Spell Checking in User Settings |
| `cSpell.toggleEnableForWorkspace` | Toggle Spell Checking for Workspace |
| `cSpell.toggleEnableSpellChecker` | Toggle Spell Checking |
| `cSpell.toggleTraceMode` | Toggle Trace Mode |
6 changes: 3 additions & 3 deletions docs/_includes/generated-docs/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ Default
| [`cSpell.maxNumberOfProblems`](#cspellmaxnumberofproblems) | resource | Controls the maximum number of spelling errors per document. |
| [`cSpell.minWordLength`](#cspellminwordlength) | resource | The minimum length of a word before checking it against a dictionary. |
| [`cSpell.numSuggestions`](#cspellnumsuggestions) | resource | Controls the number of suggestions shown. |
| [`cSpell.showAutocompleteSuggestions`](#cspellshowautocompletesuggestions) | language-overridable | Show CSpell in-document directives as you type. |
| [`cSpell.showAutocompleteDirectiveSuggestions`](#cspellshowautocompletedirectivesuggestions) | language-overridable | Show CSpell in-document directives as you type. |
| [`cSpell.showCommandsInEditorContextMenu`](#cspellshowcommandsineditorcontextmenu) | application | Show Spell Checker actions in Editor Context Menu |
| [`cSpell.showStatus`](#cspellshowstatus) | application | Display the spell checker status on the status bar. |
| [`cSpell.showStatusAlignment`](#cspellshowstatusalignment) | application | The side of the status bar to display the spell checker status. |
Expand Down Expand Up @@ -594,10 +594,10 @@ Default

---

### `cSpell.showAutocompleteSuggestions`
### `cSpell.showAutocompleteDirectiveSuggestions`

Name
: `cSpell.showAutocompleteSuggestions`
: `cSpell.showAutocompleteDirectiveSuggestions`

Type
: boolean
Expand Down
3 changes: 2 additions & 1 deletion package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 1b9a59d

Please sign in to comment.