Skip to content

text-quality.md

Latest commit

 

History

History
32 lines (24 loc) · 994 Bytes

text-quality.md

File metadata and controls

32 lines (24 loc) · 994 Bytes
Raw

Text Quality

Use text-quality.yml when repositories need spelling and documentation checks without mixing them into PHP or JavaScript lint jobs.

jobs:
  text-quality:
    uses: sympress/workflows/.github/workflows/text-quality.yml@v1

Defaults run:

  • typos across the repository;
  • CSpell against PHP, JavaScript, TypeScript, Markdown, JSON, and YAML files.

Add repository-specific vocabulary in cspell.json, cspell.config.yaml, or a Typos config file. The workflow accepts cspell_config and typos_config when the configuration lives outside the default lookup paths.

LanguageTool grammar review is intentionally opt-in because it is slower and noisier for code-heavy repositories:

with:
  run_grammar: true
  grammar_language: en-US

Grammar review only runs for pull request events so reviewdog can attach useful checks to the PR. The grammar review runs in its own job so pull-requests: write is isolated from the default Typos and CSpell checks.