Skip to content

Vale style

Vale package for sharing spelling rules and vocabularies across projects. Ship one zip, consume it everywhere.

Archive layout

The release archive nolte-styles.zip unpacks to:

.
└── nolte-styles
    ├── styles
    │   ├── config
    │   │   └── vocabularies
    │   │       ├── esphome
    │   │       │   └── accept.txt
    │   │       └── technical
    │   │           └── accept.txt
    │   └── nolte-styles
    │       └── .keep
    └── .vale.ini

Usage

Add the package to your project's .vale.ini. The releases/latest URL always points at the newest release, so you do not need to bump it manually:

StylesPath = styles

Packages = https://github.com/nolte/vale-style/releases/latest/download/nolte-styles.zip

Vocab = technical

[*.md]
BasedOnStyles = Vale, nolte-styles

Pin a specific version if you prefer reproducible builds — the current tag is shown by the badge GitHub LatestRelease:

Packages = https://github.com/nolte/vale-style/releases/download/v0.1.7/nolte-styles.zip

Then sync and lint:

vale sync
vale .

Next steps

  • Vocabularies — what ships in each group and how accept.txt regex matching works.
  • Contributing — add terms, test locally, cut a release.
  • Specifications — the curation spec every change in this repo conforms to.