Skip to content

v3.0.0

Compare
Choose a tag to compare
@github-actions github-actions released this 10 Jan 03:06
· 187 commits to v3 since this release

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