Skip to content

Commit

Permalink
Add check-spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
@jsoref
jsoref committed May 4, 2022
1 parent 8706d5d commit 5503c5e
Show file tree
Hide file tree
Showing 9 changed files with 1,280 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/actions/spelling/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# check-spelling/check-spelling configuration

File | Purpose | Format | Info
-|-|-|-
[dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary)
[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)
[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
[line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)

Note: you can replace any of these files with a directory by the same name (minus the suffix)
and then include multiple files inside that directory (with that suffix) to merge multiple files together.
25 changes: 25 additions & 0 deletions .github/actions/spelling/advice.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
<details><summary>If the flagged items do not appear to be text</summary>

If items relate to a ...
* well-formed pattern.

If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
try adding it to the `patterns.txt` file.

Patterns are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.

Note that patterns can't match multiline strings.

* binary file.

Please add a file path to the `excludes.txt` file matching the containing file.

File paths are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.

`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
../tree/HEAD/README.md) (on whichever branch you're using).

</details>
Empty file added .github/actions/spelling/allow.txt
View file
Empty file.
64 changes: 64 additions & 0 deletions .github/actions/spelling/excludes.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)go\.sum$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)vendor/
/_vendor/
ignore$
secret.*\.yaml$
\.ai$
\.avi$
\.bmp$
\.bz2$
\.crt$
\.DS_Store$
\.eot$
\.gif$
\.gitattributes$
\.graffle$
\.gz$
\.icns$
\.ico$
\.jar$
\.jpe?g$
\.jwt$
\.key$
\.lock$
\.map$
\.min\..
\.mod$
\.mp[34]$
\.ocf$
\.otf$
\.pdf$
\.pem$
\.png$
\.psd$
\.svg$
\.ttf$
\.wav$
\.woff2?$
\.zip$
^\.github/
^\Qdeployments/helm-chart/values.yaml\E$
^\Qdocs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/assets/css/kube.css\E$
^\Qdocs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/load_jquery.html\E$
^\Qdocs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/post/category-link.html\E$
^\Qdocs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/post/tag-link.html\E$
^\Qexamples/custom-resources/egress-mtls/secure-app.yaml\E$
^\Qexamples/custom-resources/tls-passthrough/secure-app.yaml\E$
^\Qinternal/k8s/secrets/validation_test.go\E$
^\Qperf-tests/requirements.txt\E$
^\Qtests/data/annotations/grpc/annotations-ingress.yaml\E$
^\Qtests/data/ap-waf-grpc/grpc-block-saygoodbye.yaml\E$
^\Qtests/data/ap-waf-grpc/grpc-block-sayhello.yaml\E$
^\Qtests/data/appprotect/grpc/grpc-block-saygoodbye.yaml\E$
^\Qtests/data/appprotect/grpc/grpc-block-sayhello.yaml\E$
^\Qtests/data/common/app/secure/app.yaml\E$
^\Qtests/data/common/app/vsr/secure/single.yaml\E$
^\Qtests/data/hsts/mergeable-tls/hsts-ingress.yaml\E$
^\Qtests/data/hsts/standard-tls/hsts-ingress.yaml\E$
^\Qtests/data/transport-server-tls-passthrough/standard/secure-app.yaml\E$
^\Qtests/data/virtual-server-certmanager/ca-issuer.yaml\E$
^\Qtests/requirements.txt\E$
Loading

1 comment on commit 5503c5e

@github-actions
Copy link

@github-actions github-actions bot commented on 5503c5e May 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

@check-spelling-bot Report

🔴 Please review

See the 📜action log for details.

Unrecognized words (33) 
annotions
Certificat
cofee
Configurationes
configurble
deines
Endponts
Factorry
gprc
implementtion
Ingess
ingredsss
ingres
Interal
Ivalid
kubernets
Mananger
MLTS
Mutlipart
Namepace
namepsace
NIGNX
overide
Passithrough
Passtrhough
Passtrough
Prcesses
Resrouce
rresource
Secrettt
Signinge
Valdate
wildlcard
To accept ✔️ these unrecognized words as correct, run the following commands

... in a clone of the [email protected]:jsoref/kubernetes-ingress.git repository
on the spell-check branch (ℹ️ how do I use this?):

update_files() {
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
-H "Content-Type: application/json" \
"https://api.github.com/repos/jsoref/kubernetes-ingress/comments/72824593" > "$comment_json"
comment_body=$(mktemp)
jq -r ".body // empty" "$comment_json" | tr -d "\\r" > $comment_body
rm $comment_json

patch_add=$(perl -e '$/=undef; $_=<>; if (m{Unrecognized words[^<]*</summary>\n*```\n*([^<]*)```\n*</details>$}m) { print "$1" } elsif (m{Unrecognized words[^<]*\n\n((?:\w.*\n)+)\n}m) { print "$1" };' < "$comment_body")

update_files
rm $comment_body
git add -u
Available dictionaries could cover words not in the dictionary

This includes both expected items (1033) from .github/actions/spelling/expect.txt and unrecognized words (33)

cspell:aws/aws.txt (1485) covers 30 of them
cspell:golang/go.txt (7745) covers 27 of them
cspell:django/django.txt (2342) covers 27 of them
cspell:filetypes/filetypes.txt (337) covers 21 of them
cspell:python/python.txt (364) covers 16 of them

Consider adding them using (in .github/workflows/spelling.yml):

      with:
        extra_dictionaries:
          cspell:aws/aws.txt
          cspell:golang/go.txt
          cspell:django/django.txt
          cspell:filetypes/filetypes.txt
          cspell:python/python.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
Errors (2)

See the 📜action log for details.

❌ Errors Count
❌ forbidden-pattern 23
ℹ️ limited-references 1

See ❌ Event descriptions for more information.

If the flagged items do not appear to be text

If items relate to a ...

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

  • binary file.

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

Please sign in to comment.