https://github.com/sobolevn/misspell-fixer-action
📝Automatically fixes typos and mistakes in your source code and docs!
https://github.com/sobolevn/misspell-fixer-action
github-action github-action-localizstion github-actions localization misspell misspell-fixer
Last synced: 8 days ago
JSON representation
📝Automatically fixes typos and mistakes in your source code and docs!
- Host: GitHub
- URL: https://github.com/sobolevn/misspell-fixer-action
- Owner: sobolevn
- License: mit
- Created: 2020-03-19T21:06:10.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-12T16:47:11.000Z (about 1 year ago)
- Last Synced: 2025-04-04T09:13:04.185Z (11 days ago)
- Topics: github-action, github-action-localizstion, github-actions, localization, misspell, misspell-fixer
- Language: Shell
- Homepage: https://github.com/marketplace/actions/misspell-fixer-action
- Size: 21.5 KB
- Stars: 151
- Watchers: 2
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - Find and automatically fix typos and grammar issues in your code
- fucking-awesome-actions - Find and automatically fix typos and grammar issues in your code
- awesome-workflows - Find and automatically fix typos and grammar issues in your code
- awesome-actions - 自动修正代码中的拼写和语法问题
- awesome-actions - 自动修正代码中的拼写和语法问题
README
# misspell-fixer-action
[](https://wemake.services)
📝Automatically fixes typos and mistakes in your source code and docs!
Based on awesome [misspell-fixer](https://github.com/vlajos/misspell-fixer) tool.
## Usage
We had a typo in our `entrypoint.sh` file to show how this GitHub Action works.
By using a pipeline of three actions we are able to receive [PRs like this one](https://github.com/sobolevn/misspell-fixer-action/pull/3).
Here's how our configuration looks like:
```yml
- uses: actions/checkout@v2
- uses: sobolevn/misspell-fixer-action@master
- uses: peter-evans/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
```
Here's how it works:
1. The first [`actions/checkout@v2`](https://github.com/actions/checkout) action checkouts our code from the repo
2. Our own `sobolevn/misspell-fixer-action` finds misspells and fixes them
3. Then [`peter-evans/create-pull-request`](https://github.com/peter-evans/create-pull-request) creates a PR with the fixes created earlier
4. Done!
Here's how our [workflow looks like](https://github.com/sobolevn/misspell-fixer-action/blob/master/.github/workflows/misspell.yml).
## Options and outputs
You can pass any options that are supported by `misspell-fixer` tool,
to do so you can use `options` key:
```yml
- uses: sobolevn/misspell-fixer-action@master
with:
options: '-rsvn src/'
```
You can also use the output produced by this action by default.
Read more about [outputs](https://help.github.com/en/actions/building-actions/metadata-syntax-for-github-actions#outputs).
## License
MIT.