Skip to content

Commit 550c857

Browse files
Read me and code tidy, dependency updates
1 parent 39c7fbf commit 550c857

File tree

6 files changed

+553
-378
lines changed

6 files changed

+553
-378
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,45 @@
44
55
The Vale extension for VS Code provides customizable spelling, style, and grammar checking for a variety of markup formats (Markdown, AsciiDoc, reStructuredText, HTML, and DITA).
66

7-
As of **v0.15.0**, the extension drops support for [Vale Server](https://errata.ai/vale-server/) which has ceased development. Many of the features from Vale Server will find their way into the Vale CLI tool, and this extension.
8-
97
## Installation
108

119
1. Install [Vale](https://docs.errata.ai/vale/install);
1210
2. install `vale-vscode` (this extension) via the [Marketplace](https://marketplace.visualstudio.com/items?itemName=chrischinchilla.vale-vscode);
13-
3. restart VS Code (recommended).
11+
3. Restart VS Code (recommended).
1412

1513
## Features
1614

17-
### Detailed Problems View
15+
### Detailed problems view
1816

1917
<p align="center">
2018
<img src="https://user-images.githubusercontent.com/8785025/89956665-76c9fa80-dbea-11ea-9eba-3f272a5a26e5.png" />
2119
</p>
2220

2321
Browse detailed information for each alert, including the file location, style, and rule ID.
2422

25-
### Go-To Rule
23+
### Go-to rule
2624

2725
<p align="center">
2826
<img src="https://user-images.githubusercontent.com/8785025/89956857-d1635680-dbea-11ea-8e50-8e2715721e5d.png" />
2927
</p>
3028

3129
Navigate from an in-editor alert to a rule's implementation on your `StylesPath` by clicking "View Rule".
3230

33-
### Quick Fixes
31+
### Quick fixes
3432

3533
<p align="center">
3634
<img src="https://user-images.githubusercontent.com/8785025/89957413-2eabd780-dbec-11ea-97e1-9a04bce950ce.png" />
3735
</p>
3836

39-
Fix word usage, capitalization, and more using [Quick Fixes](https://code.visualstudio.com/docs/editor/refactoring#_code-actions-quick-fixes-and-refactorings) (macOS: <kbd>cmd</kbd> + <kbd>.</kbd>, Windows/Linux: <kbd>Ctrl</kbd> + <kbd>.</kbd>). The quick fixes feature depends on the underlying rule implementing an action that VSCode can then trigger.
37+
Fix word usage, capitalization, and more using [Quick Fixes](https://code.visualstudio.com/docs/editor/refactoring#_code-actions-quick-fixes-and-refactorings) (macOS: <kbd>cmd</kbd> + <kbd>.</kbd>, Windows/Linux: <kbd>Ctrl</kbd> + <kbd>.</kbd>). The quick fixes feature depends on the underlying rule implementing an action that VS Code can then trigger.
4038

4139
### Spell checking
4240

43-
As of version 0.17.0, the extension supports spell-checking. The feature is new and likely to change, you can disable it from the settings if you use other spell checkers or experience performance issues.
41+
> As of version 0.17.0, the extension supports spell-checking. The feature is new and likely to change, you can disable it from the settings if you use other spell checkers or experience performance issues.
42+
43+
**You need a `[spelling](https://vale.sh/docs/topics/styles/#spelling)` style in your Vale configuration to enable spell-checking**.
4444

45-
With no additional Vale configuration, the spell checker uses a Hunspell-compatible US English dictionary. If you want to use other custom dictionaries, then add and configure [a `spelling` style](https://vale.sh/docs/topics/styles/#spelling) with custom dictionaries.
45+
With no additional Vale configuration, the spell checker uses a Hunspell-compatible US English dictionary. If you want to use other custom dictionaries, then configure your [`spelling` style](https://vale.sh/docs/topics/styles/#spelling) with custom dictionaries.
4646

4747
The extension doesn't support adding words to dictionaries. For now, the best option is to add them to ignore files or filters as described in the [Vale documentation](https://vale.sh/docs/topics/styles/#spelling).
4848

@@ -78,4 +78,10 @@ The extension offers a number of settings and configuration options (_Preference
7878
}
7979
```
8080

81-
- `vale.valeCLI.minAlertLevel` (default: `inherited`): Defines from which level of errors and above to display in the problems output.
81+
- `vale.valeCLI.minAlertLevel` (default: `inherited`): Defines from which level of errors and above to display in the problems view.
82+
83+
- `vale.doNotShowWarningForFileToBeSavedBeforeLinting` (default: `false`): Toggle display of warning dialog that you must save a file before Vale lints it.
84+
85+
- `vale.readabilityProblemLocation` (default: `status`): If you have any `Readability` styles, the extension can display the readability score in the status bar, the problems view, or both.
86+
87+
- `vale.enableSpellcheck` (default: `false`): Enable in-built spell checking for any `Spelling` styles.

0 commit comments

Comments
 (0)