| 1 |
name: Spellcheck |
| 2 |
on: |
| 3 |
push: |
| 4 |
# branches: [main] |
| 5 |
pull_request: |
| 6 |
jobs: |
| 7 |
spell-check: |
| 8 |
name: Language tool & Misspell check |
| 9 |
runs-on: ubuntu-latest |
| 10 |
steps: |
| 11 |
- name: check out code |
| 12 |
uses: actions/checkout@v4 |
| 13 |
- name: running language tool |
| 14 |
uses: reviewdog/action-languagetool@v1 |
| 15 |
with: |
| 16 |
github_token: ${{ secrets.github_token }} |
| 17 |
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. |
| 18 |
reporter: github-check |
| 19 |
# Change reporter level if you need. |
| 20 |
level: warning |
| 21 |
language: en-US |
| 22 |
disabled_categories: 'TYPOS,TYPOGRAPHY,CASING' |
| 23 |
disabled_rules: 'WHITESPACE_RULE,EN_QUOTES,DASH_RULE,WORD_CONTAINS_UNDERSCORE,UPPERCASE_SENTENCE_START,ARROWS,COMMA_PARENTHESIS_WHITESPACE,UNLIKELY_OPENING_PUNCTUATION,SENTENCE_WHITESPACE,CURRENCY,EN_UNPAIRED_BRACKETS,PHRASE_REPETITION,PUNCTUATION_PARAGRAPH_END,METRIC_UNITS_EN_US,ENGLISH_WORD_REPEAT_BEGINNING_RULE,DOUBLE_PUNCTUATION,' |
| 24 |
enabled_only: 'false' |
| 25 |
enabled_rules: '' |
| 26 |
enabled_categories: '' |
| 27 |
patterns: "**.md" |
| 28 |
|
| 29 |
|
| 30 |
|
| 31 |
- name: running misspell |
| 32 |
# To perform misspell check even after the language tool test fails |
| 33 |
if: success() || failure() |
| 34 |
uses: reviewdog/action-misspell@v1 |
| 35 |
with: |
| 36 |
github_token: ${{ secrets.github_token }} |
| 37 |
locale: "US" |
| 38 |
reporter: github-check |
| 39 |
level: info |
| 40 |
pattern: "**.md" |
| 41 |
exclude: | |
| 42 |
./.git/* |
| 43 |
./.cache/* |