Creating a vocabulary for a project

Consider adding a vocabulary to your project when:

  • Missing words in the Vale dictionary cause spelling errors.

  • The word is too specific for other projects.

When adding the word will benefit to other projects, consider Extending the Spelling rule.

Prerequisites
Procedure

  • Create or edit the vocabulary for your project: create or edit the .vale/styles/Vocab/<Project>/accept.txt file and add the missing word. Ensure the entry is not case-sensitive.

    Entry in the vocabulary, not case-sensitive
    [Pp]odman

  • Register the vocabulary in the .vale.ini file

    Vocab = <Project>
Verification

  • Run the vale command on a content file containing the word that is missing.

    $ cd <project_directory>
$ vale <filename>
Additional resources