From cbd83588dab6a7e42187a242d10ab92d034ab408 Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Fri, 12 Jan 2024 14:55:58 +0100 Subject: [PATCH] Check for v3 compatibility, update dependencies, and update readme --- README.md | 18 ++++++++---------- package.json | 15 +++++++++------ 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 10bfed4..601c1f7 100644 --- a/README.md +++ b/README.md @@ -14,27 +14,25 @@ The Vale extension for VS Code provides customizable spelling, style, and gramma ## Features +At the moment, the extension uses any [configuration](https://vale.sh/docs/topics/config/), [vocabularies](https://vale.sh/docs/topics/vocab/), and [packages](https://vale.sh/docs/topics/packages/) defined in your Vale configuration. If you experience any issues with the extension, check if Vale runs as expected on the command line first. + +_In the future, the extension may provide a UI or other configuration options for configuring Vale_. + ### Detailed problems view -

- -

+![Screenshot of problems view](https://user-images.githubusercontent.com/8785025/89956665-76c9fa80-dbea-11ea-9eba-3f272a5a26e5.png) Browse detailed information for each alert, including the file location, style, and rule ID. ### Go-to rule -

- -

+![Screenshot of go to rule interface](https://user-images.githubusercontent.com/8785025/89956857-d1635680-dbea-11ea-8e50-8e2715721e5d.png) Navigate from an in-editor alert to a rule's implementation on your `StylesPath` by clicking "View Rule". ### Quick fixes -

- -

+![Screenshot of quick fix interface](https://user-images.githubusercontent.com/8785025/89957413-2eabd780-dbec-11ea-97e1-9a04bce950ce.png) Fix 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 + .). The quick fixes feature depends on the underlying rule implementing an action that VS Code can then trigger. @@ -42,7 +40,7 @@ Fix word usage, capitalization, and more using [Quick Fixes](https://code.visual > 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. -**You need a `[spelling](https://vale.sh/docs/topics/styles/#spelling)` style in your Vale configuration to enable spell-checking**. +**You need a [`spelling` style](https://vale.sh/docs/topics/styles/#spelling) in your Vale configuration to enable spell-checking**. 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. diff --git a/package.json b/package.json index 3fa3444..e36e4eb 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "sponsor": { "url": "https://github.com/sponsors/ChrisChinchilla" }, - "version": "0.18.1", + "version": "0.18.3", "engines": { "vscode": "^1.84.1" }, @@ -104,17 +104,20 @@ }, "devDependencies": { "@types/mocha": "^10.0.6", - "@types/node": "^20.10.1", - "@types/vscode": "^1.84.2", - "@types/which": "^3.0.3", + "@types/node": "^20.11.0", "@types/nspell": "^2.1.6", - "copy-webpack-plugin": "^11.0.0", + "@types/vscode": "^1.85.0", + "@types/which": "^3.0.3", + "@typescript-eslint/eslint-plugin": "^6.18.1", + "@typescript-eslint/parser": "^6.18.1", + "copy-webpack-plugin": "^12.0.1", + "eslint": "^8.56.0", "glob": "^10.3.10", "mocha": "^10.2.0", "rxjs": "^7.8.1", "ts-loader": "^9.5.1", "tslint": "^6.1.3", - "typescript": "^5.3.2", + "typescript": "^5.3.3", "vscode-test": "^1.6.1", "webpack": "^5.89.0", "webpack-cli": "^5.1.4"