/check-spelling

Spelling checker action to check spelling in repositories / pull requests / commits

Primary LanguageShellMIT LicenseMIT

@check-spelling/check-spelling GitHub Action

Overview

Everyone makes typos. This includes people writing documentation and comments, but it also includes programmers naming variables, functions, APIs, classes, and filenames.

Often, programmers will use InitialCapitalization, camelCase, ALL_CAPS, or IDLCase when naming their things. When they do this, it makes it much harder for naive spelling tools to recognize misspellings, and as such, with a really high false-positive rate, people don't tend to enable spell checking at all.

This repository's tools are capable of tolerating all of those variations. Specifically, w understands enough about how programmers name things that it can split the above conventions into word-like things for checking against a dictionary.

Spell Checker GitHub Actions

Spell checking

Sample output

Comment as seen in a PR

github action comment

Comment as seen in a commit

github action annotation

GitHub Action Run log

github action log

Basic Configuration

Just copy the spell-check-this .github directory into your project.

Running locally

Yes you can!

Running locally with Act

  1. Install Act
  2. act

⚠️ This may break at times as act may be missing support for newer GitHub Actions features.

Prerelease

I do test development on a prerelease branch.

Features and the behavior of this branch are not guaranteed to be stable as they're under semi-active development.

License

MIT