Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Spellcheck GH action #50

Merged
merged 4 commits into from
Nov 16, 2022
Merged

ci: Spellcheck GH action #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b446d4
ci: Add spellchecker and non-inclusive language checker
serdardalgic Nov 14, 2022
aa9df81
ci: Add spellcheck.yaml for the pyspelling configuration
serdardalgic Nov 14, 2022
b906ef3
ci: Add empty .wordlist-en-custom.txt file, will be filled later.
serdardalgic Nov 14, 2022
9d2b728
ci: Generate custom wordlist
serdardalgic Nov 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/spellcheck.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: spellcheck-woke
on:
push:
workflow_dispatch:

jobs:

# Check code for non-inclusive language
woke:
name: Run woke
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v3

- name: woke
uses: get-woke/woke-action@v0
with:
# Cause the check to fail on any broke rules
fail-on-error: true

# Enforce en-us spell check
spellcheck:
name: Run spellcheck
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Spellcheck
uses: rojopolis/[email protected]
27 changes: 27 additions & 0 deletions .spellcheck.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
matrix:
- name: markdown
sources:
- 'docs/**/*.md'
default_encoding: utf-8
aspell:
lang: en
d: en_US
dictionary:
wordlists:
- .wordlist-en-custom.txt
pipeline:
- pyspelling.filters.context:
context_visible_first: true
delimiters:
# Ignore multiline content between fences (fences can have 3 or more back ticks)
# ```
# content
# ```
- open: '(?s)^(?P<open> *`{3,})'
close: '^(?P=open)$'
# Ignore text between inline back ticks
- open: '(?P<open>`+)'
close: '(?P=open)'
- open: '(?P<open><!--)'
close: '(?P<close>-->)'
- pyspelling.filters.url:
13 changes: 13 additions & 0 deletions .wordlist-en-custom.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
BigAnimal
CIDR
GUC
IOPS
InstanceType
Postgres
biganimal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should Biganimal be capitalized?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, spellchecker is not clever enough to distinguish when a word appears. This biganimal is coming from

terraform {
  required_providers {
    biganimal = {
      source  = "biganimal"
      version = "0.3.1"
    }
  }
}

And, with the current implementation, if we use biganimal in, let's say, README.md, it will accept it. 🤷 not the best implementation, but I don't have any suggestions for fixing it. If you have, I'd love to hear.

And I've only added the words that the spellchecker was complaining about. Biganimal wasn't one of them.

config
ip
nestedatt
nestedblock
terraform
uri