Glossary
Vale command-line tool
The vale command-line tool brings code-like linting to prose. Use it to validate language on your local environment or in continuous integration services.
Vale configuration file
The Vale configuration file .vale.ini defines:
-
File names patterns to match files to validate
-
Active styles and vocabulary
-
Custom content patterns to change scoping behavior
Vale rule
A Vale rule is a YAML file defining:
-
a language issue, including spelling issues
-
a proposed solution
-
a link to more information.
Vale vocabulary
In a project, a Vale vocabulary is an optional additional directory containing lists of accepted and rejected words, applying to all styles.
Consider Creating a vocabulary for a project when:
-
Missing words in the Vale dictionary are causing Spelling errors
-
The word is too specific to benefit to other projects.
Consider Extending the Spelling rule when:
-
Missing words in the Vale dictionary are causing Spelling errors
-
Adding the word will benefit to other projects. For example: product and tool names, common terms specific to the software industry.