Skip to content

Commit

Permalink
Updates to the spellcheck patterns (#1153)
Browse files Browse the repository at this point in the history
Minor updates to push out

Signed-off-by: Tim Smith <tsmith84@gmail.com>
  • Loading branch information
tas50 authored Mar 6, 2024
1 parent b70240e commit e436f0d
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 24 deletions.
35 changes: 34 additions & 1 deletion .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
@@ -1,50 +1,83 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)3rdparty/
(?:^|/)go\.sum$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)Pipfile$
(?:^|/)pyproject.toml
(?:^|/)requirements(?:-dev|-doc|-test|)\.txt$
(?:^|/)vendor/
ignore$
\.a$
\.ai$
\.all-contributorsrc$
\.avi$
\.bmp$
\.bz2$
\.cer$
\.class$
\.coveragerc$
\.crl$
\.crt$
\.csr$
\.dll$
\.docx?$
\.drawio$
\.DS_Store$
\.eot$
\.eps$
\.exe$
\.gif$
\.git-blame-ignore-revs$
\.gitattributes$
\.gitkeep$
\.graffle$
\.gz$
\.icns$
\.ico$
\.ipynb$
\.jar$
\.jks$
\.jpe?g$
\.key$
\.lib$
\.lock$
\.map$
\.min\..
\.mo$
\.mod$
\.mp[34]$
\.o$
\.ocf$
\.otf$
\.p12$
\.parquet$
\.pdf$
\.pem$
\.pfx$
\.png$
\.psd$
\.pyc$
\.pylintrc$
\.qm$
\.s$
\.svg$
\.sig$
\.so$
\.svgz?$
\.sys$
\.tar$
\.tgz$
\.tiff?$
\.ttf$
\.wav$
\.webm$
\.webp$
\.woff2?$
\.xcf$
\.xlsx?$
\.xpm$
\.xz$
\.zip$
^\.github/actions/spelling/
^\Q.github/workflows/spelling.yml\E$
67 changes: 44 additions & 23 deletions .github/actions/spelling/line_forbidden.patterns
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
# Detect common combinations of valid words that are in fact invalid.
# Useful for brand capitalizations

#
# Catch placeholder text
#

\b[Lo]orem [Ii]psum\

#
# Terms to avoid
#

# s.b. Allow list
\swhitelist\b
\swhitelisting\b
\swhitelisted\b
\swhite list\b
\swhite listing\b
\swhite listed\b
\s[Ww]hitelist\b
\s[Ww]hitelisting\b
\s[Ww]hitelisted\b
\s[Ww]hite list\b
\s[Ww]hite listing\b
\s[Ww]hite listed\b

# s.b. Block list
\sblacklist\b
\sblacklisting\b
\sblacklisted\b
\sblack list\b
\sblack listing\b
\sblack listed\b
\s[Bb]lacklist\b
\s[Bb]lacklisting\b
\s[Bb]lacklisted\b
\s[Bb]lack list\b
\s[Bb]lack listing\b
\s[Bb]lack listed\b

#
# Our Terms
Expand All @@ -30,36 +36,31 @@
\sMondoo platform\b

# s.b. Compliance Hub
\scompliance hub\b
\sCompliance hubplatform\b
\s[Cc]ompliance hub\b

#
# Industry Terms
#

# s.b. Side scanning
\bSidescanning\b
\bsidescanning\b
\b[Ss]idescanning\b

# s.b. DevOps
\bDev Ops\b
\bDevops\b

# s.b. SaaS
\bSaas\b
\bsaas\b
\b[Ss]aas\b

# s.b. Docker Hub
\bDockerHub\b
\bDockerhub\b
\bDocker[Hh]ub\b

# s.b. REST API
\bRest API\b
\brest API\b
\b[Rr]est API\b
\brest api\b

# s.b. DevSecOps
\bDevsecops\b
\bDevsec[Oo]ps\b

# s.b. on-premises
\bon-premise\b
Expand Down Expand Up @@ -174,6 +175,19 @@
# s.b. System76
\bSystem 76\b

# s.b. VirtualBox
\bvirtualbox\b
\bVirtualbox\b
\bVirtual Box\b

# s.b. SentinelOne
\bSentinalOne\b
\bSentinal One\b

# s.b. CrowdStrike
\bCrowd Strike\b
\bCrowdstrike\b

#
# HashiCorp Products
#
Expand All @@ -184,6 +198,10 @@
# s.b. Terraform
\bTerraForm\b

# s.b. Vagrantfile
\bVagrant file\b
\bVagrantFile\b

#
# Microsoft Products
#
Expand Down Expand Up @@ -315,6 +333,9 @@
# s.b. CodeStar
\bCodestar\b

# s.b. AWS Config
\bAWS config\b

# s.b. Copilot
\bCoPilot\b

Expand Down
1 change: 1 addition & 0 deletions .github/actions/spelling/patterns.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,4 @@ aws_secret_access_key\s+\=(\s+)?.+

# score score is valid in MQL docs
score score

1 change: 1 addition & 0 deletions .github/actions/spelling/reject.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
ad-hoc
^attache$
^bellow$
benefitting
occurences?
^dependan.*
Expand Down

0 comments on commit e436f0d

Please sign in to comment.