https://github.com/datpmt/typocop

GitHub Action automatically checks for typos.
https://github.com/datpmt/typocop

github-action github-actions typos typos-check

Last synced: 19 days ago
JSON representation

GitHub Action automatically checks for typos.

• Host: GitHub
• URL: https://github.com/datpmt/typocop
• Owner: datpmt
• License: mit
• Created: 2024-11-28T03:36:47.000Z (26 days ago)
• Default Branch: main
• Last Pushed: 2024-12-03T06:55:22.000Z (21 days ago)
• Last Synced: 2024-12-03T07:37:08.205Z (21 days ago)
• Topics: github-action, github-actions, typos, typos-check
• Language: JavaScript
• Homepage:
• Size: 69.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Check Typos in Pull Request

![image](https://github.com/user-attachments/assets/bbcdcedb-cf0b-4cc0-959a-fe5caa71f833)

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.

- Supports all programing languages.

## Usage

- Copy content `.github/workflows/typos-check.yml` and `typos-check.js` into your project.

- Create new PR.

## Contributors

- [datpmt](https://github.com/datpmt)

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](LICENSE).