Vocabularies

The package ships two vocabulary groups. Consumers opt in per group via the Vocab directive in their own .vale.ini:

Vocab = technical

or, for repos that also document ESPHome:

Vocab = technical, esphome

Vale loads each listed group from styles/config/vocabularies/<name>/accept.txt inside the unpacked package. The shipped .vale.ini inside the archive sets Vocab = technical as a minimal baseline; anything beyond that is opt-in.

technical

The default vocabulary for most repos. Covers four loose families:

• Tool and product names — Ansible, ESPHome, MkDocs, Taskfile, Renovate, Trivy, Probot, gh-plumbing, Claude, zsh, asdf, nolte, Ulanzi.
• Software-engineering and CI/CD terms — CI, CLIs, PRs, MRs, Dockerfiles, docstrings, frontmatter, runbooks, hotfixes, automerge, rebase, rebasing, cron, formatters, YAMLs.
• Naming, lifecycle, and workflow words — namespace, namespaced, dogfood, dogfooding, onboarding, rollout, vendoring, toolchain, subprojects, subfolders, triages, routable, dispatchable, invocable, auditable, browsable, overridable, operationalize.
• Words plain English dictionaries flag as typos — dotfile, untrusted, env, config, repo, gitignored, untracked, unversioned, lowercased, deduplicated, stylers, READMEs, PDFs, NFRs.

esphome

ESPHome-specific terms. Opt-in: activate alongside technical when your docs cover ESPHome device configuration.

• Hardware identifiers — ESP8285, HLW8012, SP111, NOUS, A1T, Gosund.
• GPIO pins — the regex GPIO(0[0-9]|[1-3][0-9]) accepts any zero-padded two-digit pin name from GPIO00 through GPIO39, so ESP8266 and ESP32 pin references both lint clean. Bare GPIO is accepted separately.
• YAML config keys — baud_rate, status_led, restore_mode, restore_from_flash, early_pin_init, turn_on_action, turn_off_action.
• Domain words — automations, Datetime, dBm, hostname, hostnames, LED, LEDs.

How entries are matched

Each line in accept.txt is a regex, not a literal string. This is a Vale convention — take advantage of it to collapse related forms into one entry instead of listing every variant.

Entry	Matches
ESPHome	ESPHome
[Aa]llowlist	allowlist, Allowlist
[hH]ostnames?	hostname, hostnames, Hostname, Hostnames
LEDs?	LED, LEDs
GPIO(0[0-9]|[1-3][0-9])	GPIO00–GPIO39

Keep entries case-sensitive by default: write [Aa]llowlist rather than (?i)allowlist, so the vocabulary still flags unintended cross-case variants. For product or brand names, do not use a bracket-class entry at all — use the canonical casing the upstream publishes (MkDocs, Probot, Claude, npm, mypy, Vitest, Pyright) so off-brand casings in prose stay flagged.

See the Vocabulary and Style Curation spec for the full maintenance rules this package follows.