flame
flame copied to clipboard
flame-engine
ci: Include a spell checker in the pipeline
What could be improved
Include a spell checker that automatically checks spelling for us.
This could be done by adding a github action. And a json file to include exceptions.
For example:
name: spell_checker
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: zwaldowski/cspell-action@v1
with:
paths: "**/*.{md,dart}"
config: .github/cspell.json /// This file would include spelling exceptions
exclude: ".gitignore"
Why should this be improved
Guarantee higher quality on our code. And avoid PRs such as #1807 #1246 #1332 #1280, and so on.
Any risks?
No risk involved. If abused, perhaps on the GitHub billing.
More information
- https://github.com/zwaldowski/cspell-action
- https://github.com/actions/javascript-action
Sounds like a good idea.
None of the linked PRs would have been caught by a spellchecker though, not even the tot he one.
None of the linked PRs would have been caught by a spellchecker though, not even the tot he one.
I wonder if there are grammar checkers we can use. I couldn't find any but would be definitely very useful.
I would like to wok on this.
Assigned you to the issue, make sure to join our Discord if you have any questions.
