StylesPath

Learn about Vale's resource directory.

You can override the default StylesPath by manually defining a VALE_STYLES_PATH environment variable.

The StylesPath specifies where Vale should look for its external resources (e.g., styles and ignore files). The path value may be absolute or relative to the location of the parent .vale.ini file.

# Here's an example of a relative path:
#
# .vale.ini
# ci/
# ├── vale/
# │   ├── styles/
StylesPath = ci/vale/styles

[*.md]
# `MyStyle` is a directory within
# `ci/vale/styles`.
BasedOnStyles = MyStyle

If you don’t specify a StylesPath in your .vale.ini file, Vale will use its default location:

OS	Search Locations
Windows	%LOCALAPPDATA%\vale\styles
macOS	$HOME/Library/Application Support/vale/styles
Unix	$XDG_DATA_HOME/vale/styles

(Run the vale ls-dirs command to see the exact locations on your system.)

Structure

A StylesPath contains two types of entries: styles and the special config directory.

$ tree styles
├───config     <-- Special directory
└───write-good <-- A style

The config directory is used internally by Vale and contains the following:

Directory	Description
vocabularies	Project-specific terminology lists.
dictionaries	Hunspell-compatible spelling dictionaries.
templates	Output format templates.
actions	Solutions to your custom rules.
filters	Configuration filters.
scripts	Tengo scripts.

Views Packages