This project is no longer maintained.

Usage can be simplified by using Textlint directly with problem matchers.

Please see here for an example migration.

---

Orthograph-err

An orthography is a set of conventions for writing a language. It includes norms of spelling, hyphenation, capitalisation, word breaks, emphasis, and punctuation.

A GitHub Action for proofreading content. It provides feedback on documentation, user guides and other text content within your project. Using the wonderfully flexible TextLint any orthographic errors will appear as inline annotations.

Usage

Your repository should contain a TextLint configuration file. This defines the active rules and desired writing style.

With this in place, include this action in any workflows that can need feedback. PR's or commits to master / release branches are a good option for this.

- uses: place-labs/orthograph-err@v1
  with:
    # File path with the content to review.
    # Default: {,!(node_modules)/**/}*.md
    path: ''

    # GitHub personal access token to update check status with. When issues are
    # found the associate commit with be annotate with these. This token MUST
    # have `check_write` access to the target repository. In most cases this can
    # can remain as the default (GitHub Actions).
    # Default: ${{ github.token }}
    token: ''

Issues will appear as inline annotations against their source. Each enabled rules engine will receive it's own check, which may used for branch protection if desired.

For an example of this action in use, see PlaceOS/docs.

Supported Rules Engines

• alex
• common-misspellings
• en-capitalisation
• no-empty-section
• no-exclamation-question-mark
• one-sentence-per-line
• period-in-list-item
• rousseau
• spelling
• terminology
• write-good

Filter Rules

• allowlist

To add rules engines, or filters fork this repository, then npm install <rule>.

If it's a commonly useful rule, PR's are open <3.