https://github.com/wow-actions/spell-checker
Check and Annotate files with spelling suggestions to help you write better.
https://github.com/wow-actions/spell-checker
github-actions spell-check spell-checker spellcheck spellchecker spelling spelling-checker
Last synced: 7 months ago
JSON representation
Check and Annotate files with spelling suggestions to help you write better.
- Host: GitHub
- URL: https://github.com/wow-actions/spell-checker
- Owner: wow-actions
- License: mit
- Created: 2022-12-14T02:11:09.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-16T07:52:04.000Z (almost 3 years ago)
- Last Synced: 2025-02-23T23:47:05.648Z (7 months ago)
- Topics: github-actions, spell-check, spell-checker, spellcheck, spellchecker, spelling, spelling-checker
- Language: TypeScript
- Homepage:
- Size: 2.21 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Spell Checker
Check and Annotate files with spelling suggestions to help you write better.
## Usage
Create a `.github/workflows/spell-checker.yml` file in the repository you want to install this action:
```yml
name: Spell Checker
on: push
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: wow-actions/spell-checker@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
include: |
**/*.md
**/*.txt
```
### What it checks
A non-exhaustive list of the various checks that are run:
- Correct spelling (and provides possible corrections).
- Use of non-inclusive/profane/offensive language.
- Various prose-related checks, find the full list [here](https://github.com/btford/write-good#checks).
### Inputs
Various inputs are defined to let you configure the action:
> Note: [Workflow command and parameter names are not case-sensitive](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#about-workflow-commands).
| Name | Description | Default |
| --- | --- | --- |
| `GITHUB_TOKEN` | The GitHub token for authentication | N/A |
| `include` | File [patterns](https://www.npmjs.com/package/minimatch) to match files to check. | `[]` |
| `exclude` | File [patterns](https://www.npmjs.com/package/minimatch) to ignore files. | `[]` |
| `alex` | The options of [alex](https://www.npmjs.com/package/alex). Set `false` to disable it. | N/A |
| `write-good` | The options of [write-good](https://www.npmjs.com/package/write-good). Set `false` to disable it. | N/A |
| `markdown-spellcheck` | The options of [alex](https://www.npmjs.com/package/markdown-spellcheck). Set `false` to disable it. | N/A |
### Credits
This Action is mostly a wrapper around existing open source libraries. The majority of the work is done by those, and they deserve a ton of thanks:
- [alex](https://github.com/get-alex/alex)
- [write-good](https://github.com/btford/write-good)
- [node-spellchecker](https://github.com/atom/node-spellchecker)
- [node-markdown-spellcheck](https://github.com/lukeapage/node-markdown-spellcheck)
## License
The application code and associated documentation is under the [MIT License](LICENSE)