tldr/pages/common/vale.md

29 lines
672 B
Markdown
Raw Normal View History

2022-10-10 16:12:14 +01:00
# vale
> Extensible style checker that supports multiple markup formats, such as Markdown and AsciiDoc.
> More information: <https://vale.sh>.
- Check the style of a file:
2022-12-04 09:12:49 +00:00
`vale {{path/to/file}}`
2022-10-10 16:12:14 +01:00
- Check the style of a file with a specified configuration:
2022-12-04 09:12:49 +00:00
`vale --config='{{path/to/.vale.ini}}' {{path/to/file}}`
2022-10-10 16:12:14 +01:00
- Output the results in JSON format:
2022-12-04 09:12:49 +00:00
`vale --output=JSON {{path/to/file}}`
2022-10-10 16:12:14 +01:00
- Check style issues at the specific severity and higher:
`vale --minAlertLevel={{suggestion|warning|error}} {{path/to/file}}`
2022-10-10 16:12:14 +01:00
- Check the style from `stdin`, specifying markup format:
2022-10-10 16:12:14 +01:00
`cat {{file.md}} | vale --ext=.md`
- List the current configuration:
`vale ls-config`