Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Refactor Issues viewer #2914

Merged
merged 4 commits into from
Nov 1, 2023
Merged

refactor: Refactor Issues viewer #2914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
682de6a
refactor: Rename issueViewer
Jason3S Oct 30, 2023
4e6c3e8
Improve the settings descripitons
Jason3S Oct 31, 2023
ae197fe
refactor the issue viewer
Jason3S Nov 1, 2023
e9ec8eb
Merge branch 'main' into dev-issues
Jason3S Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_includes/generated-docs/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
| `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.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 |
Expand Down
44 changes: 36 additions & 8 deletions docs/_includes/generated-docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Default
| -------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------- |
| [`cSpell.caseSensitive`](#cspellcasesensitive) | resource | Determines if words must match case and accent rules. |
| [`cSpell.customDictionaries`](#cspellcustomdictionaries) | resource | Custom Dictionaries |
| [`cSpell.dictionaries`](#cspelldictionaries) | resource | Optional list of dictionaries to use. Each entry should match the name of the dictionary. To… |
| [`cSpell.dictionaryDefinitions`](#cspelldictionarydefinitions) | resource | Define additional available dictionaries. |
| [`cSpell.dictionaries`](#cspelldictionaries) | resource | Optional list of dictionaries to use. |
| [`cSpell.dictionaryDefinitions`](#cspelldictionarydefinitions) | resource | Dictionary Definitions |
| [`cSpell.flagWords`](#cspellflagwords) | resource | List of words to always be considered incorrect. Words found in `flagWords` override `words`. |
| [`cSpell.ignoreWords`](#cspellignorewords) | resource | A list of words to be ignored by the spell checker. |
| [`cSpell.language`](#cspelllanguage) | resource | Current active spelling language. |
Expand Down Expand Up @@ -132,9 +132,19 @@ Scope

Description
: Optional list of dictionaries to use.
Each entry should match the name of the dictionary.
To remove a dictionary from the list add `!` before the name.
i.e. `!typescript` will turn off the dictionary with the name `typescript`.

Each entry should match the name of the dictionary.

To remove a dictionary from the list add `!` before the name.
i.e. `!typescript` will turn off the dictionary with the name `typescript`.


Example:

```jsonc
// Enable `lorem-ipsum` and disable `typescript`
"cSpell.dictionaries": ["lorem-ipsum", "!typescript"]
```

Default
: _- none -_
Expand All @@ -144,7 +154,7 @@ Default
### `cSpell.dictionaryDefinitions`

Name
: `cSpell.dictionaryDefinitions`
: `cSpell.dictionaryDefinitions` -- Dictionary Definitions

Type
: []
Expand All @@ -153,7 +163,25 @@ Scope
: resource

Description
: Define additional available dictionaries.
: Define custom dictionaries..
If `addWords` is `true` words will be added to this dictionary.

This setting is subject to User/Workspace settings precedence rules: [Visual Studio Code User and Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings#_settings-precedence).

It is better to use `#cSpell.customDictionaries#`

**Example:**

```js
"cSpell.dictionaryDefinitions": [
{
"name": "project-words",
"path": "${workspaceRoot}/project-words.txt",
"description": "Words used in this project",
"addWords": true
}
]
```

Default
: _- none -_
Expand Down Expand Up @@ -1289,7 +1317,7 @@ Description

The default regular expression flags are `gi`. Add `u` (`gui`), to enable Unicode.

| VS Code UI | JSON | Description |
| VS Code UI | settings.json | Description |
| :------------------ | :-------------------- | :------------------------------------------- |
| `/\\[a-z]+/gi` | `/\\\\[a-z]+/gi` | Exclude LaTeX command like `\mapsto` |
| `/\b[A-Z]{3,5}\b/g` | `/\\b[A-Z]{3,5}\\b/g` | Exclude full-caps acronyms of 3-5 length. |
Expand Down
Loading