Skip to content
This repository was archived by the owner on Apr 14, 2023. It is now read-only.

Commit 023058e

Browse files
Update read me
1 parent d673838 commit 023058e

File tree

1 file changed

+10
-34
lines changed

1 file changed

+10
-34
lines changed

README.md

Lines changed: 10 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -30,70 +30,46 @@ Browse detailed information for each alert, including the file location, style,
3030

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

33-
### Quick Fixes (Vale Server only)
33+
### Quick Fixes
3434

3535
<p align="center">
3636
<img src="https://user-images.githubusercontent.com/8785025/89957413-2eabd780-dbec-11ea-97e1-9a04bce950ce.png" />
3737
</p>
3838

39-
Fix misspellings, 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>)
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>)
4040

41-
### Vocab Management (Vale Server only)
42-
43-
<p align="center">
44-
<img src="https://user-images.githubusercontent.com/8785025/89957619-b8f43b80-dbec-11ea-846d-0d9ee7f50088.png" />
45-
</p>
46-
47-
Add words and phrases to your active Vocab through the in-editor context menu.
48-
49-
<p align="center">
50-
<img src="https://user-images.githubusercontent.com/8785025/89957701-f062e800-dbec-11ea-9d03-2d9ce2542f03.png" />
51-
</p>
52-
53-
Jump to your active Vocab files directly from the Command Palette.
54-
55-
### Folder Reports (Vale Server only)
56-
57-
Use the `Vale: View Folder Report` command to generate a [report for the active folder](https://docs.errata.ai/vale-server/gui#summary).
41+
Spelling errors are currently not supported, but will be supported in a future version.
5842

5943
## Settings
6044

6145
The extension offers a number of settings and configuration options (_Preferences > Extensions > Vale_)..
6246

63-
<!-- TODO: Deprecating values and names -->
64-
65-
- `vale.server.provideFixes` (default: `true`): Offer solutions to alerts using the 'Quick Fix' button.
66-
67-
> **NOTE**: The fixes feature currently has an occasional issue when it reports that a "suggestion is out of date". We are working on a long-term fix, but in the meantime, saving the file fixes the issue.
68-
69-
- `vale.server.lintContext` (default: `0`): Only lint the *active* portion of a document (as determined by the cursor position), allowing for efficient on-the-fly linting of large documents. There are three supported values: `-1` (applies to all files), `0` (disabled), `n` (applies to any file with `lines >= n`).
70-
71-
- `vale.valeCLI.config` (default: `null`): Absolute path to a Vale configuration file. Use the predefined [`${workspaceFolder}`](https://code.visualstudio.com/docs/editor/variables-reference#_predefined-variables) variable to reference configuration file from a custom location. (**NOTE**: On Windows you can use '/' and can omit `.cmd` in the path value.) If not specified, the extension uses the default search process (relative to the current file).
47+
- `vale.config` (default: `null`): Absolute path to a Vale configuration file. Use the predefined [`${workspaceFolder}`](https://code.visualstudio.com/docs/editor/variables-reference#_predefined-variables) variable to reference configuration file from a custom location. (**NOTE**: On Windows you can use '/' and can omit `.cmd` in the path value.) If not specified, the extension uses the default search process (relative to the current file).
7248

7349
**Example**
7450

7551
```jsonc
7652
{
7753
// You can use ${workspaceFolder} it will be replaced by workspace folder path
78-
"vale.valeCLI.config": "${workspaceFolder}/node_modules/some-package/.vale.ini"
54+
"vale.config": "${workspaceFolder}/node_modules/some-package/.vale.ini"
7955

8056
// or use some absolute path
81-
"vale.valeCLI.config": "/some/path/to/.vale.ini"
57+
"vale.config": "/some/path/to/.vale.ini"
8258
}
8359
```
8460

85-
- `vale.valeCLI.path` (default: `null`): Absolute path to the Vale binary. Use the predefined [`${workspaceFolder}`](https://code.visualstudio.com/docs/editor/variables-reference#_predefined-variables) variable to reference a non-global binary. (**NOTE**: On Windows you can use '/' and can omit `.cmd` in the path value.)
61+
- `vale.path` (default: `null`): Absolute path to the Vale binary. Use the predefined [`${workspaceFolder}`](https://code.visualstudio.com/docs/editor/variables-reference#_predefined-variables) variable to reference a non-global binary. (**NOTE**: On Windows you can use '/' and can omit `.cmd` in the path value.)
8662

8763
**Example**
8864

8965
```jsonc
9066
{
9167
// You can use ${workspaceFolder} it will be replaced by workspace folder path
92-
"vale.valeCLI.path": "${workspaceFolder}/node_modules/.bin/vale"
68+
"vale.path": "${workspaceFolder}/node_modules/.bin/vale"
9369
9470
// or use some absolute path
95-
"vale.valeCLI.path": "/some/path/to/vale"
71+
"vale.path": "/some/path/to/vale"
9672
}
9773
```
9874

99-
- `vale.valeCLI.minAlertLevel` (default: `inherited`): Defines from which level of errors and above to display in the problems output.
75+
- `vale.minAlertLevel` (default: `inherited`): Defines from which level of errors and above to display in the problems output.

0 commit comments

Comments
 (0)