Skip to content

Commit

Permalink
check-spelling: allow unrecognized words and remove some acknowledged
Browse files Browse the repository at this point in the history
  • Loading branch information
@Payne-X6
Payne-X6 committed Aug 27, 2024
1 parent d2e84e6 commit e2bb6cb
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 24 deletions.
35 changes: 20 additions & 15 deletions .github/actions/spelling/excludes.txt
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Knot specific
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)package(?:-lock|)\.json$
(?:^|/)vendor/
ignore$
[^/]\.mdb$
\.avi$
\.ico$
\.jpe?g$
Expand All @@ -15,7 +16,10 @@ ignore$
\.png$
\.wav$
^\.github/
# Knot specific
^\Qsrc/libzscanner/scanner.c.g2\E$
^\Qtests/knot/test_digest.c\E$
^\Qtests/knot/test_kasp_db.c\E$
^\Qtests/libdnssec/sample_keys.h\E$
^distro/pkg/deb/docs$
^distro/pkg/deb/knot-dnsutils\.install$
^distro/pkg/deb/knot\.install$
Expand All @@ -26,15 +30,15 @@ ignore$
^doc/doxygen/DoxygenLayout\.xml$
^scripts/docker/centos:latest/Dockerfile$
^scripts/docker/fedora:latest/Dockerfile$
^src/Makefile\.am$
^src/knot/modules/dnsproxy/Makefile\.inc$
^src/knot/modules/dnstap/Makefile\.inc$
^src/knot/modules/geoip/Makefile\.inc$
^src/knot/modules/synthrecord/Makefile\.inc$
^src/libdnssec\.pc\.in$
^src/libknot\.pc\.in$
^src/libknot/Makefile\.inc$
^src/libknot/xdp/bpf-kernel-obj\.c$
^src/libknot\.pc\.in$
^src/Makefile\.am$
^src/utils/Makefile\.inc$
^tests-extra/data/\.zone$
^tests-extra/requirements\.txt$
Expand All @@ -61,34 +65,34 @@ ignore$
^tests-extra/tests/dnssec/no_resign2/data/example\.com\.zone$
^tests-extra/tests/dnssec/nsec3_up_adjust/data/example\.com\.zone$
^tests-extra/tests/dnssec/nsec_update/data/dk\.zone$
^tests-extra/tests/dnssec/validate/data/bitmap\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/bitmap\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/bitmap\.nsec3\.zone$
^tests-extra/tests/dnssec/validate/data/bitmap\.nsec3\.zone\.2$
^tests-extra/tests/dnssec/validate/data/chain\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/chain\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/bitmap\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/bitmap\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/chain\.nsec3\.zone$
^tests-extra/tests/dnssec/validate/data/chain\.nsec3\.zone\.2$
^tests-extra/tests/dnssec/validate/data/missing\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/missing\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/chain\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/chain\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/missing\.nsec3\.zone$
^tests-extra/tests/dnssec/validate/data/missing\.nsec3\.zone\.2$
^tests-extra/tests/dnssec/validate/data/missing\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/missing\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/ok\.2nsec3\.zone$
^tests-extra/tests/dnssec/validate/data/ok\.2nsec3\.zone\.2$
^tests-extra/tests/dnssec/validate/data/ok\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/ok\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/ok\.nsec3\.zone$
^tests-extra/tests/dnssec/validate/data/ok\.nsec3\.zone\.2$
^tests-extra/tests/dnssec/validate/data/ok\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/ok\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/optout\.ent\.zone$
^tests-extra/tests/dnssec/validate/data/optout\.ent\.zone\.2$
^tests-extra/tests/dnssec/validate/data/redundant\.invalid\.rrsig\.zone$
^tests-extra/tests/dnssec/validate/data/redundant\.invalid\.rrsig\.zone\.2$
^tests-extra/tests/dnssec/validate/data/rrsig\.a\.zone$
^tests-extra/tests/dnssec/validate/data/rrsig\.a\.zone\.2$
^tests-extra/tests/dnssec/validate/data/rrsig\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/rrsig\.nsec\.zone\.2$
^tests-extra/tests/dnssec/validate/data/rrsig\.nsec3\.zone$
^tests-extra/tests/dnssec/validate/data/rrsig\.nsec3\.zone\.2$
^tests-extra/tests/dnssec/validate/data/rrsig\.nsec\.zone$
^tests-extra/tests/dnssec/validate/data/rrsig\.nsec\.zone\.2$
^tests-extra/tests/ixfr/axfr_style/data/xfr\.zone$
^tests-extra/tests/ixfr/from_differences/07_none_nsec_nsec3_none/example\.com\.zone\.1$
^tests-extra/tests/ixfr/from_differences/07_none_nsec_nsec3_none/example\.com\.zone\.2$
Expand Down Expand Up @@ -145,7 +149,6 @@ ignore$
^tests/knot/semantic_check_data/rrsig_rdata_ttl\.signed$
^tests/knot/semantic_check_data/rrsig_signed\.signed$
^tests/knot/semantic_check_data/rrsig_ttl\.signed$
^tests/libzscanner/TESTS$
^tests/libzscanner/data/00-3_general\.out$
^tests/libzscanner/data/06-0_INCLUDE\.out$
^tests/libzscanner/data/06-8_INCLUDE\.out$
Expand All @@ -160,3 +163,5 @@ ignore$
^tests/libzscanner/data/32_APL\.out$
^tests/libzscanner/data/42_LOC\.out$
^tests/libzscanner/data/54_OPENPGPKEY\.out$
^tests/libzscanner/TESTS$
ignore$
16 changes: 7 additions & 9 deletions .github/actions/spelling/expect.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -750,7 +750,6 @@ datetime
datsize
dbase
dbdir
dbe
DBG
dbi
dbid
Expand Down Expand Up @@ -964,7 +963,6 @@ EALREADY
EAPROG
eatype
eax
eba
EBADF
EBADKEY
EBADSIG
Expand Down Expand Up @@ -1164,8 +1162,6 @@ ETIMEOUT
ETRAIL
ETter
ETTL
eturn
etval
etx
eui
EUPTODATE
Expand Down Expand Up @@ -2369,6 +2365,7 @@ ndalpn
NDEBUG
ndisc
neccassary
necho
nelems
nestedness
netblk
Expand Down Expand Up @@ -2409,6 +2406,7 @@ nftw
nfwxa
nghttp
NGINX
ngot
ngx
nhoff
nic
Expand Down Expand Up @@ -2533,6 +2531,7 @@ NOSIGNAL
NOSIGPIPE
nostats
nosub
nosubgrouping
nosubnet
nosuffix
NOSYNC
Expand Down Expand Up @@ -2569,6 +2568,7 @@ nozonefile
NPROCESSORS
NREACH
nrecord
nreference
nrels
nsap
nscount
Expand All @@ -2579,7 +2579,6 @@ NSPACES
NSs
nstack
nsupdate
nths
ntohl
ntohs
ntok
Expand All @@ -2589,7 +2588,6 @@ nullbyte
numa
NUMERICHOST
numfiles
nutes
NVI
nvxxezjnmz
nxd
Expand All @@ -2602,7 +2600,6 @@ objectstore
occured
ocsp
odl
odo
oerrno
Ofbq
offsetof
Expand Down Expand Up @@ -2667,9 +2664,7 @@ ORIGTTL
ortw
osc
oss
osubgrouping
OSX
ote
OTHERHOST
otput
otype
Expand Down Expand Up @@ -3564,6 +3559,7 @@ tgraf
TGRP
tgz
THEX
thmac
thoff
thr
threadsafe
Expand Down Expand Up @@ -3684,6 +3680,8 @@ typeid
typename
typeof
tzset
u'nths
u'nutes
uapi
ubsan
ubuntu
Expand Down

1 comment on commit e2bb6cb

@github-actions
Copy link

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 or 📝 job summary for details.

Unrecognized words (2)

u'nths
u'nutes

Previously acknowledged words that are now absent u'nths u'nutes 🫥
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the git@github.com:CZ-NIC/knot.git repository
on the check-spelling branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/CZ-NIC/knot/actions/runs/10577490278/attempts/1'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

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

Dictionary Entries Covers Uniquely
cspell:software-terms/dict/softwareTerms.txt 1288 147 50
cspell:php/dict/php.txt 1689 150 25
cspell:python/src/python/python-lib.txt 2417 149 25
cspell:node/dict/node.txt 891 109 19
cspell:python/src/common/extra.txt 741 33 18

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

      with:
        extra_dictionaries:
          cspell:software-terms/dict/softwareTerms.txt
          cspell:php/dict/php.txt
          cspell:python/src/python/python-lib.txt
          cspell:node/dict/node.txt
          cspell:python/src/common/extra.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml):

check_extra_dictionaries: ''
If you see a bunch of garbage

If it relates to a ...

well-formed pattern

See if there's a pattern that would match it.

If not, try writing one and 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-ish string

Please add a file path to the excludes.txt file instead of just accepting the garbage.

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.