https://github.com/timkam/vscode-vale
Run vale in Visual Studio Code
https://github.com/timkam/vscode-vale
Last synced: about 1 year ago
JSON representation
Run vale in Visual Studio Code
- Host: GitHub
- URL: https://github.com/timkam/vscode-vale
- Owner: TimKam
- License: mit
- Created: 2018-02-26T20:01:26.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-02-10T13:32:28.000Z (over 6 years ago)
- Last Synced: 2025-03-26T09:11:08.810Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=lunaryorn.vale
- Size: 109 KB
- Stars: 1
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# VSCode vale
[](https://travis-ci.org/lunaryorn/vscode-vale)
Lint documents with [Vale][] in [Visual Studio Code][code].
[vale]: https://valelint.github.io/docs/
[code]: https://code.visualstudio.com
## Prerequisites
[Install vale][1] **0.7.2 or newer** and make sure that the `vale` executable is in `$PATH`.
If your setup does not let you to add `vale` to `$PATH`, please [open an issue][issue].
If vale is too old the extension fails to activate. In this case please update Vale; the error message will tell you the required version.
[1]: https://valelint.github.io/docs/#installation
[issue]: https://github.com/lunaryorn/vscode-value/issues/new
## Usage
Vale automatically checks a document when you open or save it. Use the `Vale: Lint workspace` command to check the entire workspace.
Vale always runs from the workspace directory in either case, so if you put a [Vale configuration][config] in the workspace directory it will automatically pick it up.
Currently this extension only supports **Markdown documents**; please [open an issue][issue] or a pull request if you need support for **more document formats**, provided that [Vale][] supports them.
[config]: https://valelint.github.io/docs/config/