Giter Club home page Giter Club logo

vscode-vale's Introduction

VSCode vale

Thanks to all the work previous work from lunaryorn, this is a new maintained fork, with more features to come soon.

Lint documents with Vale in Visual Studio Code.

Prerequisites

Install vale 0.7.2 or newer.

If Vale is too old the extension fails to activate. In this case please update Vale; the error message tells you the required version.

By default the extension will use the global installed binary vale. In case you have the binary installed on a local project you can configure the extension to use the local path. See configuration options below.

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 in the workspace directory it will automatically pick it up.

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

Configuration

  • vscode-vale.configPath: Absolute path to Vale config file. If not specified, uses normal Vale config scoping rules.
  • vscode-vale.path: (default vale). Absolute path to the vale binary, useful if you don't want to use the global binary.

Example

{
  // You can use ${workspaceFolder} it will be replaced by workspace folder path
  "vscode-vale.path": "${workspaceFolder}/node_modules/.bin/vale"

  // or use some absolute path
  "vscode-vale.path": "/some/path/to/vale"
}
  • vscode-vale.fileExtensions: (default md, markdown, txt, rst, tex, adoc, asciidoc).

File extensions to lint.

Note, these also need to be in your Vale config file.

vscode-vale's People

Contributors

swsnr avatar chrischinchilla avatar emmenko avatar timkam avatar svx avatar polarweasel avatar gaurav-nelson avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.