https://github.com/shemnei/reviewdog-action-typos
Reviewdog action to run typos
https://github.com/shemnei/reviewdog-action-typos
reviewdog reviewdog-action spell spellcheck spellchecker spelling typos
Last synced: about 1 month ago
JSON representation
Reviewdog action to run typos
- Host: GitHub
- URL: https://github.com/shemnei/reviewdog-action-typos
- Owner: Shemnei
- License: mit
- Created: 2024-01-16T19:05:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-25T14:31:49.000Z (6 months ago)
- Last Synced: 2024-10-25T18:25:37.706Z (6 months ago)
- Topics: reviewdog, reviewdog-action, spell, spellcheck, spellchecker, spelling, typos
- Language: Shell
- Homepage:
- Size: 66.4 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shemnei/reviewdog-action-typos
[](https://github.com/Shemnei/reviewdog-action-typos/actions?query=workflow%3Areviewdog)
[](https://github.com/Shemnei/reviewdog-action-typos/actions?query=workflow%3Adepup)
[](https://github.com/Shemnei/reviewdog-action-typos/actions?query=workflow%3Arelease)
[](https://github.com/Shemnei/reviewdog-action-typos/releases)
[](https://github.com/haya14busa/action-bumpr)
This action runs [typos](https://github.com/crate-ci/typos) with
[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve
code review experience.
## Usage
```yaml
name: Reviewdog
on: [pull_request]
jobs:
typos:
name: runner / typos
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: Shemnei/reviewdog-action-typos@v0
with:
reporter: github-check
level: error
fail_on_error: true
```
## Input
For a complete list of accepted input values see [action.yaml](./action.yaml).
### `files`
Specify files to check.
__Default__: `.`
__Example__
```yaml
files: |
./testdir
myfile.txt
```
### `exclude`
Specify glob patterns of files to ignore.
__NOTE__: This will also ignore any files explicitly defined with `files`.
__Default__: ``
__Example__
```yaml
exclude: |
*.yaml
*.json
```
### `config`
Explicitly set the configuration file to use. If not set, `typos` will figure out the correct config to use.
__Default__: ``
__Example__
```yaml
config: ./config/.typos.yaml
```
### `isolated`
Tells `typos` to ignore any implicitly defined configuration files (ignore config files not set by `config`).
__Default__: `false`
__Example__
```yaml
isolated: true
```
### `write_changes`
Tells `typos` to update __ALL__ found spell mistakes. This doesn't not commit or push anything to the branch. It only writes the changes locally to disk.
__NOTE__: This will update __ALL__ mistakes, not only files/changes from the current PR or commit (e.g. this acts like `reviewdog`s `-filter-mode=nofilter`).
__Default__: `false`
__Example__
```yaml
write_changes: true
```
### `locale`
Language locale to suggest corrections for. Possible values are `[en, en-us, en-gb, en-ca, en-au]`.
__Default__: ``
__Example__
```yaml
locale: en-gb
```
### `debug`
Runs the action in debug mode. This enables various outputs which might be useful for debugging like:
- Dump the used `typos` config
- Dump all files to be checked
- Enable `typos` verbose mode
__NOTE__: This is also enabled when an action is run with `Enable debug logging` active (Github UI).
__Default__: ``
__Example__
```yaml
debug: true
```
### Deprecated inputs
The original `typos` action also has the following inputs which are declared but not used at all (i might be missing something):
- `extend_identifiers`
- `extend_words`
To allow easy porting (copy-paste) and have feature parity the inputs where included but will print a deprecated warning on usage.
__NOTE__: The value of these inputs will be ignored and are not used.