v3.1.0

Vale now has support for a VALE_STYLES_PATH environment variable to set the default StylesPath. You can also use the new vale ls-vars command to inspect the supported environment variables from the command line.

Changelog

• 9c7238d feat: add ls-vars command
• 2139c41 feat: add support for VALE_STYLES_PATH (#755)
• f0041a5 docs: update contributing instructions (#767)

v3.0.7

Changelog

• d9d5119 refactor: "Location" -> "Default Location"
• 0f936aa chore: pterm requires Go v1.21
• 28132f7 chore: upgrade pterm
• 27fa9a0 fix: handle sync with relative --config

v3.0.6

Changelog

• b58b8b8 fix: remove -q from asciidoctor args (#759)
• a45cc80 feat: support fragments in .ps1 and .jl files (#736)

v3.0.5

Changelog

• 08b2c42 refactor: don't load Vale if it's not needed
• 5e502a0 fix: ensure applyPatterns respects formats (#754)

v3.0.4

Changelog

• 341348c fix: better support for phrases in vocabularies (#726)
• 37dcbc5 fix: use file paths when applying ignore patterns (#732)

v3.0.3

See v3.0.0 for more detailed release notes.

Changelog

• 3c13689 fix: don't error on missing default files (vale-cli/vale-action#114)

v3.0.2

See v3.0.0 for more detailed release notes.

Changelog

• e00ffbd refactor: better error message for default styles

v3.0.1

See v3.0.0 for more detailed release notes.

Changelog

• d77b95b test: add more package cases
• 1a565fe fix: respect alternative ways to set a base (#750)
• 2a4450f test: add more source tests

v3.0.0

The third major release of Vale introduces an updated StylesPath layout and support for a default configuration.

Updated StylesPath

The StylesPath now has a special config directory:

config
├── dictionaries
├── templates
├── ignore
└── vocabularies

• dictionaries: Hunspell-compatible dictionaries to be loaded by Vale.Spelling. This offers an alternative means of customizing the spell-checking experience in Vale: instead of creating a new rule (e.g., YourStyle.Spelling), you extend the built-in Vale.Spelling with custom dictionaries. This will have the benefit of allowing multiple styles to all contribute to the same spelling rule (#628).
• templates: Output templates.
• ignore: Ignore files to be loaded by Vale.Spelling.
• vocabularies: The same as the current Vocab folder; moved to match the new global configuration directories.

All of these directories will support being distributed as part of a package.

Default StylesPath + .vale.ini

Vale now supports a default StylesPath and a default .vale.ini file. See the vale ls-dirs command for the exact locations on your system.

The default .vale.ini file is loaded in addition to any other config files -- allowing for local changes to project configurations.

Breaking changes

When upgrading to v3.0.0, you'll need to move your vocabularies from $StylesPath/Vocab to $StylesPath/config/vocabularies.

Changelog

• 48763c6 refactor: use xdg lib for config and styles
• 3095655 refactor: make sync root-relative
• 61bbee7 feat: sync with multiple config files
• eb63940 feat: default StylesPath
• 8919342 feat: fallback to global when no config is found
• a61c1d2 fix: handle relative StylePaths
• 29a4450 fix: ensure all matching sections are applied
• 4e7d95c refactor: load default config last
• c5e8345 feat: add default config
• ecfe037 feat: sync supports new config dir
• 5bdb7f9 fix: NOSUGGEST may be more than 1 char
• 2c68f5c fix: ensure meta characters are escaped
• 83d4d9e test: add case for vocab
• e40b0f5 refactor: new config/ignore directory
• ceaf267 refactor: load files from config/dictionaries
• 4ec4c80 feat: new StylesPath/config directory

v2.30.0

Changelog

• 4cadab1 test: add Julia tests
• baebd27 Julia Support (#731)