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

Commit

Permalink
Draft
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisChinchilla committed Jul 22, 2022
1 parent feec982 commit 51875bc
Show file tree
Hide file tree
Showing 8 changed files with 276 additions and 349 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 2017 - 2021 Joseph Kato and Chris Ward
Copyright (c) 2017 - 2022 Joseph Kato and Chris Ward

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
28 changes: 5 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,16 @@
# Vale + VS Code

> The official Visual Studio Code extension for [Vale](https://github.com/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).
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).

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).
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.

## Installation

> **NOTE**: While this extension supports both Vale CLI and Vale Server, 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

3. restart VS Code (recommended).

### Using Vale

1. Install [Vale](https://docs.errata.ai/vale/install);

2. install `vale-vscode` (this extension) via the [Marketplace](https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server);

3. set [`vale.core.useCLI`](#settings) to `true` in the extension settings (_Preferences > Extensions > Vale > Use CLI_); and

4. restart VS Code (recommended).
3. restart VS Code (recommended).

## Features

Expand Down Expand Up @@ -74,11 +58,9 @@ Use the `Vale: View Folder Report` command to generate a [report for the active

## Settings

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.
The extension offers a number of settings and configuration options (_Preferences > Extensions > Vale_)..

- `vale.server.serverURL` (default: `http://127.0.0.1:7777`): URL to your running Vale Server instance.
<!-- TODO: Deprecating values and names -->

- `vale.server.provideFixes` (default: `true`): Offer solutions to alerts using the 'Quick Fix' button.

Expand Down
49 changes: 17 additions & 32 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "vale-server",
"name": "vale",
"displayName": "Vale",
"icon": ".vscode/icon.png",
"description": "The official Visual Studio Code extension for Vale and Vale Server.",
"description": "The official Visual Studio Code extension for Vale.",
"bugs": "https://github.com/errata-ai/vale-vscode/issues",
"author": {
"name": "Joseph Kato",
Expand All @@ -15,7 +15,7 @@
"type": "git",
"url": "https://github.com/errata-ai/vale-vscode.git"
},
"version": "0.14.2",
"version": "0.15.0",
"engines": {
"vscode": "^1.43.0"
},
Expand Down Expand Up @@ -106,11 +106,6 @@
"default": false,
"markdownDescription": "Use Vale's CLI instead of Vale Server. (**NOTE**: Some features, such as [Quick Fixes](https://github.com/errata-ai/vale-vscode/pull/4) and [Vocab Management](https://github.com/errata-ai/vale-vscode/pull/4), are only available when using Vale Server.)"
},
"vale.server.serverURL": {
"type": "string",
"default": "http://127.0.0.1:7777",
"description": "URL to your running Vale Server instance."
},
"vale.server.provideFixes": {
"type": "boolean",
"default": true,
Expand Down Expand Up @@ -150,13 +145,6 @@
"Sets `minAlertLevel` to `error`, overriding any configuration files."
],
"markdownDescription": "Defines from which level of errors and above to display in the problems output."
},
"vale-server.serverURL": {
"type": "string",
"default": "http://127.0.0.1:7777",
"description": "URL to your running Vale Server instance.",
"markdownDeprecationMessage": "**Deprecated**: Please use `#vale.server.serverURL#` instead.",
"deprecationMessage": "Deprecated: Please use vale.server.serverURL instead."
}
}
}
Expand All @@ -172,25 +160,22 @@
"test-compile": "tsc -p ./"
},
"devDependencies": {
"@types/glob": "^7.1.1",
"@types/mocha": "^9.0.0",
"@types/node": "^10.12.21",
"@types/vscode": "^1.59.0",
"@types/which": "^1.3",
"glob": "^7.1.4",
"mocha": "^9.1.0",
"ts-loader": "^6.1.2",
"tslint": "^5.12.1",
"typescript": "^4.3.5",
"@types/glob": "^7.2.0",
"@types/mocha": "^9.1.1",
"@types/node": "^18.0.0",
"@types/vscode": "^1.68.1",
"@types/which": "^2.0.1",
"glob": "^8.0.3",
"mocha": "^10.0.0",
"ts-loader": "^9.3.1",
"tslint": "^6.1.3",
"typescript": "^4.7.4",
"vscode-test": "^1.6.1",
"webpack": "^5.51.1",
"webpack-cli": "^4.8.0"
"webpack": "^5.73.0",
"webpack-cli": "^4.10.0"
},
"dependencies": {
"@types/request-promise-native": "^1.0.16",
"fs": "0.0.1-security",
"request": "^2.88.0",
"request-promise-native": "^1.0.7",
"which": "^2.0.1"
"which": "^2.0.2",
"fs": "0.0.1-security"
}
}
4 changes: 2 additions & 2 deletions src/extension.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import * as vscode from "vscode";

import ValeServerProvider from "./features/vsProvider";
import ValeProvider from "./features/vsProvider";

export function activate(context: vscode.ExtensionContext) {
let linter = new ValeServerProvider();
let linter = new ValeProvider();
linter.activate(context.subscriptions);
}
Loading

0 comments on commit 51875bc

Please sign in to comment.