What is the Vale CLI style checker

Vale CLI is a free open-source style linter you can use to improve the quality of your writing. It’s somewhat like (but different from) the grammar and spell-checkers you find in Google Docs, Microsoft Word, or Grammarly.

Unlike those tools, Vale is designed to work with simple text files that contain a variety of common markup formats. These formats, such as HTML, markdown, and asciidoc, are widely used by developers and technical writers to document software.

You can use Vale CLI from the command line to check individual files or whole directories of files.

Vale CLI output on the command line.

You can also use it in editors that have plug-ins for Vale, such as Microsoft Visual Studio Code, Atom, or Sublime Text.

Vale output in Microsoft Visual Studio Code.

In Vale, you can choose to use one or more styles to check your content. A style is a collection of rules that Vale uses. You can download any of the seven officially supported styles, including Microsoft, based on the Microsoft Writing Style Guide, and Google, based on the Google Developer Documentation Style Guide.

You can also get community-maintained styles such as these on GitHub. Most importantly, you can customize the styles you download or create one from scratch. For example, at Red Hat, the technical documentation group I’m part of has created a style called Vale at Red Hat, that contains rules from a variety of style guides our organization uses.


Leave a Comment

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s