From 88f4f453e8bfde5cc29814043a99bd88c5f3ddeb Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 11 Aug 2020 16:21:45 -0700 Subject: [PATCH 1/8] Update README.md --- README.md | 149 +++++++++++++++++++++++++----------------------------- 1 file changed, 70 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index c975e2b..5dc325f 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,86 @@ -# Vale Extension for VS Code +# Vale + VS Code -> The official Visual Studio Code extension for [Vale](https://errata.ai/vale) and [Vale Server](https://errata.ai/vale-server/). +> The official Visual Studio Code extension for [Vale](https://github.com/errata-ai/vale) and [Vale Server](https://errata.ai/vale-server/). -The Vale extension provides customizable spelling, style, and grammar checking for English text. +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). + +The extension supports both [Vale](https://github.com/errata-ai/vale) (the command-line tool) and [Vale Server](https://errata.ai/vale-server/) (the desktop application). ## Installation -You can use this extension with Vale CLI, Vale server, or both. +> **NOTE**: While both Vale and Vale Server are supported, many of the extension's more [advanced features](#features) (such as Quick Fixes and Vocabulary Management are only available through Vale Server. + +### Using Vale Server + +1. Install [Vale Server](https://errata.ai/vale-server/); + +2. install `vale-vscode` (this extension) via the [Marketplace](https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server); and -To get started with Vale CLI: +3. restart VS Code (recommended). -1. Install [Vale CLI](https://errata.ai/vale) -2. Install and configure styles +### Using Vale -To get started with Vale Server: +1. Install [Vale](https://docs.errata.ai/vale/install); -1. Install [Vale Server](https://errata.ai/vale-server/) +2. install `vale-vscode` (this extension) via the [Marketplace](https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server); -1. Install `vale-vscode` (this extension) via the [Marketplace](https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-vscode); and -2. restart VS Code (if necessary) -3. Toggle using Vale CLI or Server from _Preferences > Extensions > Vale > Use CLI_ +3. restart VS Code (recommended); and + +4. Set [`vale.core.useCLI`](#settings) to `true` in the extension settings (_Preferences > Extensions > Vale > Use CLI_). ## Features - - - - - - - - - - - - - - - - - - - - - - - - - -
Detailed Problems ViewGo-To Rule
- - - - - - - -
- Browse detailed information for each alert. - Easily navigate to any rule's implementation.
Quick FixesBuild your own style according to custom rules
- - - - - - - -
Choose from a selection of provided 'Quick Fixes'.Implement your own rules or follow an existing style guide.
- -## Usage - -Vale for VSCode automatically checks a document when you open or save it. Use the `Vale: Lint workspace` command to check a file manually. - -This extension supports the following file extensions by default, but you can change them with the `vscode-vale.fileExtensions` config item (see below): - -- **Asciidoc**: _.adoc_ and _.asciidoc_ -- **Markdown**: _.md_ and _.markdown_ -- **reStructuredText**: _.rst_ -- **LaTeX**: _.tex_ -- **plain text**: _.txt_ - -## Settings - -The following settings are available: - -- `vale-vscode.useCLI`: (default `false`). Use Vale CLI instead of Vale Server. -- `vscode-vale.configPath`: Absolute path to Vale config file when using CLI. If not specified, uses normal Vale config scoping rules. -- `vscode-vale.path`: (default `vale`). Absolute path to the `vale` binary when using CLI, useful if you don't want to use the global binary. +### Detailed Problems View + +

+ +

+ +Browse detailed information for each alert, including the file location, style, and rule ID. + +### Go-To Rule + +

+ +

+ +Quickly navigate from an in-editor alert to a rule's implementation on your `StylesPath` by clicking "View Rule". + +### Quick Fixes (Vale Server only) + +

+ +

+ +Fix misspellings, word usage, capitalization, and more using [Quick Fixes](https://code.visualstudio.com/docs/editor/refactoring#_code-actions-quick-fixes-and-refactorings) (macOS: cmd + ., Windows/Linux: Ctrl + .) + +### Vocab Management (Vale Server only) + +

+ +

+ +Easily add words and phrases to your active Vocab through the in-editor context menu. + +

+ +

+ +Jump to your active Vocab files directly from the Command Palatte. + +## Settings (_Preferences > Extensions > Vale_) + +The extension offers a number of settings and configuration options, which are split into three groups: `Vale > Core` (Vale and Vale Server), `Vale > Server` (Vale Server only), and `Vale > Vale CLI` (Vale only). + +- `vale.core.useCLI` (default `false`): Use Vale CLI instead of Vale Server. + +- `vale.server.serverURL` (default: `http://127.0.0.1:7777`): URL to your running Vale Server instance. + +- `vale.server.provideFixes` (default: `true`): Offer solutions to alerts using the 'Quick Fix' button. + +- `vale.valeCLI.config` (default `null`):: Absolute path to a Vale config file. If not specified, the default search process will be used (relative to the current file). + +- `vale.valeCLI.path` (default `null`): Absolute path to the Vale binary. The predefined [`${workspaceFolder}`](https://code.visualstudio.com/docs/editor/variables-reference#_predefined-variables) variable can be used to reference a non-global binary. (**NOTE**: On Windows you can use '/' and can omit `.cmd` in the path value.) **Example** @@ -99,6 +93,3 @@ The following settings are available: "vscode-vale.path": "/some/path/to/vale" } ``` - -- `vscode-vale.serverURL`: (default `http://localhost:7777`). URL to running Vale Server instance. -- `vscode-vale.extensions`: (default `".md", ".rst", ".adoc", ".txt"`). File extensions to lint. Note, these also need to be in your Vale config file if you are using Vale CLI. From 082e4933a587e789e7192e96e5af2222249017d7 Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 11 Aug 2020 16:22:42 -0700 Subject: [PATCH 2/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5dc325f..7f8cf68 100644 --- a/README.md +++ b/README.md @@ -78,9 +78,9 @@ The extension offers a number of settings and configuration options, which are s - `vale.server.provideFixes` (default: `true`): Offer solutions to alerts using the 'Quick Fix' button. -- `vale.valeCLI.config` (default `null`):: Absolute path to a Vale config file. If not specified, the default search process will be used (relative to the current file). +- `vale.valeCLI.config` (default: `null`):: Absolute path to a Vale config file. If not specified, the default search process will be used (relative to the current file). -- `vale.valeCLI.path` (default `null`): Absolute path to the Vale binary. The predefined [`${workspaceFolder}`](https://code.visualstudio.com/docs/editor/variables-reference#_predefined-variables) variable can be used to reference a non-global binary. (**NOTE**: On Windows you can use '/' and can omit `.cmd` in the path value.) +- `vale.valeCLI.path` (default: `null`): Absolute path to the Vale binary. The predefined [`${workspaceFolder}`](https://code.visualstudio.com/docs/editor/variables-reference#_predefined-variables) variable can be used to reference a non-global binary. (**NOTE**: On Windows you can use '/' and can omit `.cmd` in the path value.) **Example** From 92011f04d40c947051efbfc7afe74a87460efc2f Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 11 Aug 2020 16:23:42 -0700 Subject: [PATCH 3/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f8cf68..7eb5fa5 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ The extension offers a number of settings and configuration options, which are s - `vale.server.provideFixes` (default: `true`): Offer solutions to alerts using the 'Quick Fix' button. -- `vale.valeCLI.config` (default: `null`):: Absolute path to a Vale config file. If not specified, the default search process will be used (relative to the current file). +- `vale.valeCLI.config` (default: `null`): Absolute path to a Vale config file. If not specified, the default search process will be used (relative to the current file). - `vale.valeCLI.path` (default: `null`): Absolute path to the Vale binary. The predefined [`${workspaceFolder}`](https://code.visualstudio.com/docs/editor/variables-reference#_predefined-variables) variable can be used to reference a non-global binary. (**NOTE**: On Windows you can use '/' and can omit `.cmd` in the path value.) From 4906345366aa238028acbe66c4fd975a670df873 Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 11 Aug 2020 16:25:55 -0700 Subject: [PATCH 4/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7eb5fa5..987dd9f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The extension supports both [Vale](https://github.com/errata-ai/vale) (the comma ## Installation -> **NOTE**: While both Vale and Vale Server are supported, many of the extension's more [advanced features](#features) (such as Quick Fixes and Vocabulary Management are only available through Vale Server. +> **NOTE**: While both Vale and Vale Server are supported, many of the extension's more [advanced features](#features) (such as Quick Fixes and Vocabulary Management) are only available through Vale Server. ### Using Vale Server From 9c7a8210a97781e7c504f9b96f0679a03973b14d Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 11 Aug 2020 16:29:12 -0700 Subject: [PATCH 5/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 987dd9f..650902b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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). -The extension supports both [Vale](https://github.com/errata-ai/vale) (the command-line tool) and [Vale Server](https://errata.ai/vale-server/) (the desktop application). +As of **v0.10.0**, the extension supports both [Vale](https://github.com/errata-ai/vale) (the command-line tool) and [Vale Server](https://errata.ai/vale-server/) (the desktop application). ## Installation From e7c179ab08fd74724c521a34e04cc32d70e5c1b3 Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 11 Aug 2020 16:29:39 -0700 Subject: [PATCH 6/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 650902b..f3a549e 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Jump to your active Vocab files directly from the Command Palatte. The extension offers a number of settings and configuration options, which are split into three groups: `Vale > Core` (Vale and Vale Server), `Vale > Server` (Vale Server only), and `Vale > Vale CLI` (Vale only). -- `vale.core.useCLI` (default `false`): Use Vale CLI instead of Vale Server. +- `vale.core.useCLI` (default: `false`): Use Vale CLI instead of Vale Server. - `vale.server.serverURL` (default: `http://127.0.0.1:7777`): URL to your running Vale Server instance. From 705748290f49a900e6bf08432f35413581b13bce Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 11 Aug 2020 16:31:01 -0700 Subject: [PATCH 7/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f3a549e..b8d8b20 100644 --- a/README.md +++ b/README.md @@ -68,9 +68,9 @@ Easily add words and phrases to your active Vocab through the in-editor context Jump to your active Vocab files directly from the Command Palatte. -## Settings (_Preferences > Extensions > Vale_) +## Settings -The extension offers a number of settings and configuration options, which are split into three groups: `Vale > Core` (Vale and Vale Server), `Vale > Server` (Vale Server only), and `Vale > Vale CLI` (Vale only). +The extension offers a number of settings and configuration options (_Preferences > Extensions > Vale_), which are split into three groups: `Vale > Core` (Vale and Vale Server), `Vale > Server` (Vale Server only), and `Vale > Vale CLI` (Vale only). - `vale.core.useCLI` (default: `false`): Use Vale CLI instead of Vale Server. From 080793467ec9c398d7dbc6b9a2ffe25695039558 Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 11 Aug 2020 16:44:57 -0700 Subject: [PATCH 8/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b8d8b20..b4bb588 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ As of **v0.10.0**, the extension supports both [Vale](https://github.com/errata- 2. install `vale-vscode` (this extension) via the [Marketplace](https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server); -3. restart VS Code (recommended); and +3. set [`vale.core.useCLI`](#settings) to `true` in the extension settings (_Preferences > Extensions > Vale > Use CLI_); and -4. Set [`vale.core.useCLI`](#settings) to `true` in the extension settings (_Preferences > Extensions > Vale > Use CLI_). +4. restart VS Code (recommended). ## Features