vale

Check the style of a file

$ vale [path/to/file]

$ vale --config='[path/to/.vale.ini]' [path/to/file]

$ vale --output=JSON [path/to/file]

$ vale --minAlertLevel=[suggestion|warning|error] [path/to/file]

$ cat [file.md] | vale --ext=.md

$ vale ls-config

vale [OPTIONS] [FILES...]

--config string
    Path to the configuration file (default is .vale.ini or _vale.ini).

--ext string
    A comma-separated list of file extensions to lint.

--format string
    Output format: text (default), JSON, or line.

--glob string
    A glob pattern to match files to lint.

--help
    Show help message and exit.

--in-place
    Apply Vale's suggestions automatically.

--minAlertLevel string
    Minimum alert level to display: suggestion, warning, error.

--no-exit
    Always exit with status code 0 (success).

--output string
    Output path for the linter's results.

--sort
    Sort results by file name.

--version
    Print the version number and exit.

FILES...
    List of files or directories to lint.

Vale is a command-line linter for prose, designed to bring code-style linting to natural language.
It checks your writing against user-defined style guides, identifying potential issues with grammar, tone, consistency, and more.
Unlike traditional grammar checkers, Vale operates on a rule-based system, allowing for highly customizable and context-aware analysis.
Vale supports various input formats, including Markdown, reStructuredText, HTML, and plain text. It's designed to be easily integrated into existing workflows and development pipelines, providing real-time feedback as you write.
Vale is often used to enforce style guides in technical documentation, blog posts, and other written content.

Vale is configured via a configuration file (typically named `.vale.ini` or `_vale.ini`).
This file defines the style guides to use, the file extensions to lint, and other settings.
Style guides are collections of rules written in YAML that specify patterns to match and actions to take when those patterns are found.
Rules can be simple regular expressions or more complex logic implemented in Go.

Vale exits with a status code of 0 if no errors were found, and a non-zero status code if any errors were found, unless the `--no-exit` flag is used.

grep(1), sed(1), awk(1)