Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
check-circle

GitHub Action

typocop

v1.0.1

typocop

check-circle

typocop

Github action comments on PRs with typos or approvals

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: typocop

              
  uses: datpmt/[email protected]
Learn more about this action in datpmt/typocop

Choose a version

Check Typos in Pull Request

image

This GitHub Action automatically checks for typos in the files changed in a pull request. It comments on the pull request with any detected typos and provides suggestions for corrections.

Features

  • Detects typos in files that are part of the pull request.
  • Provides a brief output of typos found in each file.
  • Comments on the pull request with the results.
  • Approve the PR if no typos.
  • Supports all programing languages.

Usage

  • Copy file .github/workflows/typocop.yml into your project.
  • Create new PR.

Contributors

I welcome contributions to this project.

  1. Fork it.
  2. Create your feature branch (git checkout -b your-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin your-feature).
  5. Create a new pull request.

References

  1. https://github.com/crate-ci/typos
  2. https://github.com/prontolabs/pronto

License

The gem is available as open source under the terms of the MIT License.