Defame1297
d1afdbeff7
Covers Vale install and .vale.ini setup — StylesPath, built-in/ third-party/custom styles, BasedOnStyles activation. Setup half of Vale support; vale-run (running/interpreting) is a separate skill. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FxG5T8EJDgkABXxuneuFfn
1.2 KiB
1.2 KiB
topic, source_keys
| topic | source_keys | |
|---|---|---|
| examples |
|
Project Initialization Walkthrough
$ cd some-project
# create .vale.ini with StylesPath + BasedOnStyles
$ vale sync # downloads declared packages/styles into StylesPath
$ ls styles # confirms styles were installed
$ vale README.md # lint a file
The .vale.ini file must exist before vale sync — it declares which packages to fetch.
Typical Project Config
StylesPath = styles
MinAlertLevel = error
[*.md]
BasedOnStyles = ProjectStyle
pre-commit Integration
Vale ships a pre-commit hook definition. A typical setup runs vale sync once (with pass_filenames: false) plus the actual lint pass with CI-appropriate flags:
repos:
- repo: https://github.com/errata-ai/vale
rev: 16d3a7f
hooks:
- id: vale
name: vale sync
pass_filenames: false
args: [sync]
- id: vale
args: [--output=line, --minAlertLevel=error]
CI Output for Machine Parsing
$ vale --output=JSON README.md
Use --output=JSON when a CI step needs to parse results programmatically rather than read the default CLI-formatted output.