vale 命令

常用示例

说明

Vale is a syntax-aware prose linter that brings code-like linting to documentation and prose. It checks writing against customizable style rules for consistency, grammar, and corporate style guides. Vale supports Markdown, AsciiDoc, reStructuredText, HTML, and other markup formats. It can use community style packages (Microsoft, Google, write-good) or custom rules defined in YAML. Configuration is managed through .vale.ini files that specify which styles to use, file patterns to check, and vocabulary exceptions.

参数

--config _file_

Use specified configuration file (.vale.ini).

--ext _extension_

Assign a file extension to stdin input (e.g., `.md`, `.rst`).

--glob _pattern_

Only lint files matching the glob pattern.

--filter _expr_

Filter rules by a CEL-style expression (e.g. `".Level == 'error'"`).

--minAlertLevel _level_

Minimum alert level: `suggestion`, `warning`, or `error`.

--output _format_

Output format: `CLI` (default), `JSON`, `line`, or path to a template file.

--no-exit

Always exit with status 0 regardless of errors.

--no-wrap

Do not wrap output lines.

--no-global

Skip loading the global configuration.

--relative

Report paths relative to the current directory.

--sort

Sort output by file path and line number.

--ignore-syntax

Treat all input as plain text (skip syntax-aware parsing).

-v, --version

Display version information.

-h, --help

Display help message.