Prim

A Vale-compatible prose style for non-native English speakers. Tailored for technical documentation.

Status: alpha

Important

Prim is still in its early stages. It is usable but expect massive and frequent changes before it becomes stable.

Usage

Add https://github.com/Microflash/Prim/releases/latest/download/Prim.zip to the list of Packages in the .vale.ini file.

StylesPath = .github/styles
MinAlertLevel = suggestion

Packages = proselint, \
https://github.com/Microflash/Prim/releases/latest/download/Prim.zip

[README.md]
BasedOnStyles = Vale, Prim, proselint

To sync the latest updates, run vale sync.

Guiding principles

• Use short sentences (< 30 words).
• Use active voice in simple present tense.
• Avoid Latin to prevent a yet another language in the mix. Use English equivalents.
• Use an apostrophe only to indicate a possessive.
• Avoid contractions.

Development

• Rules are written in yml files using the syntax described by Vale docs.
• Every rule has a fixture against which you can run tests.
• Tests are run against the log output snapshots of Vale.

Prerequisites

• Vale
• Node.js
• pnpm

Run pnpm i to download the test dependencies; you would need them to run the tests.

Development workflow

A typical workflow looks like this.

1. Add a new rule by creating a new Prim/<RuleName>.yml file, or modify an existing rule in the existing Prim/<RuleName>.yml file.
2. Add or update the fixtures in the test/fixtures/<RuleName>/test.md file.
3. Generate or update a snapshot with pnpm snapshot:update
4. Run pnpm test to run the tests.

License

MIT