HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

vale — Extensible style checker that supports multiple markup formats, such as Markdown and AsciiDoc. More

Submitted by: @import:tldr-pages··
0
Viewed 0 times
commandextensiblestylevalecheckersupportsclithat

Problem

How to use the vale command: Extensible style checker that supports multiple markup formats, such as Markdown and AsciiDoc. More information: <https://vale.sh/docs/cli>.

Solution

vale — Extensible style checker that supports multiple markup formats, such as Markdown and AsciiDoc. More information: <https://vale.sh/docs/cli>.

Check the style of a file:
vale {{path/to/file}}


Check the style of a file with a specified configuration:
vale --config='{{path/to/.vale.ini}}' {{path/to/file}}


Output the results in JSON format:
vale --output=JSON {{path/to/file}}


Check style issues at the specific severity and higher:
vale --minAlertLevel={{suggestion|warning|error}} {{path/to/file}}


Check the style from stdin, specifying markup format:
cat {{file.md}} | vale --ext=.md


List the current configuration:
vale ls-config

Code Snippets

Check the style of a file

vale {{path/to/file}}

Check the style of a file with a specified configuration

vale --config='{{path/to/.vale.ini}}' {{path/to/file}}

Output the results in JSON format

vale --output=JSON {{path/to/file}}

Check style issues at the specific severity and higher

vale --minAlertLevel={{suggestion|warning|error}} {{path/to/file}}

Check the style from `stdin`, specifying markup format

cat {{file.md}} | vale --ext=.md

Context

tldr-pages: common/vale

Revisions (0)

No revisions yet.