Skip to content

Commit

Permalink
Merge pull request #12249 from jsoref/master-spelling-v0.0.21
Browse files Browse the repository at this point in the history
Upgrade check-spelling to v0.0.21
  • Loading branch information
Habbie authored Mar 8, 2023
2 parents a376060 + 5ac948e commit 2ace8bd
Show file tree
Hide file tree
Showing 39 changed files with 879 additions and 505 deletions.
16 changes: 16 additions & 0 deletions .github/actions/spell-check/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# check-spelling/check-spelling configuration

File | Purpose | Format | Info
-|-|-|-
[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)
[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-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.
22 changes: 11 additions & 11 deletions .github/actions/spell-check/advice.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
<!-- 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>
<details><summary>If the flagged items are :exploding_head: false positives</summary>

If items relate to a ...
* binary file (or some other file you wouldn't want to check at all).

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).

* well-formed pattern.

If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
Expand All @@ -12,14 +22,4 @@ https://www.regexplanet.com/advanced/perl/) yours before committing to verify it

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>
37 changes: 31 additions & 6 deletions .github/actions/spell-check/allow.txt
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ authconfdir
authdir
authdirs
authdomain
authip
authlog
authname
authoritatives
Expand Down Expand Up @@ -415,6 +416,7 @@ cfile
cft
cgit
CHACHA
charset
chartocode
checkbox
checkfunc
Expand All @@ -426,8 +428,11 @@ checkzone
chgrp
childstat
chkconfig
chmod
chown
chr
chrono
cidr
cin
cinttypes
ciphersuites
Expand Down Expand Up @@ -750,6 +755,8 @@ dnsdistrules
dnsdisttcp
dnsdisttests
dnserrors
DNSHEADER
dnsheader
DNSID
DNSIP
dnskeyr
Expand Down Expand Up @@ -1054,7 +1061,6 @@ ETIMEDOUT
Eto
etree
etry
eturn
eui
evah
eventkey
Expand All @@ -1080,7 +1086,6 @@ exitvalue
Expat
expectedlen
expf
explicitely
expr
expungebyname
expungebynameandtype
Expand Down Expand Up @@ -2305,6 +2310,8 @@ Nro
nrr
nsa
nscount
NSD
nsd
nsdname
nsdomain
nseconds
Expand Down Expand Up @@ -2656,14 +2663,16 @@ posix
postdata
POSTFIELDS
POSTFIELDSIZE
postgre
Postgre
postoutquery
postpol
postprepare
postqueries
postun
postvars
potentialsupermasters
powerdn
powerdns
poweroften
powertools
pparent
Expand Down Expand Up @@ -2879,6 +2888,7 @@ realpath
realqps
realreferral
realrr
realtime
realzone
RECCONTROL
reccount
Expand Down Expand Up @@ -3015,6 +3025,7 @@ rmdir
rmtree
RMz
rnameservers
rng
rnow
rollbackmarker
romap
Expand Down Expand Up @@ -3290,11 +3301,10 @@ smokeyjoe
smp
smt
smtarg
smtp
SMTs
smvmlo
SMy
smysql
Smz
sname
snaplen
snd
Expand Down Expand Up @@ -3380,14 +3390,14 @@ sscanf
SSetsockopt
ssh
ssize
ssl
sslctx
SSLECDSADNS
SSLEDDSADNS
SSLRSADNS
sslsock
SSLTLS
SSLTLSIO
SSLv
SSocket
ssql
ssqlite
Expand Down Expand Up @@ -3648,6 +3658,8 @@ timersonly
Timespan
timespec
timespent
timezone
timezones
tinfo
tini
TINYDNSDATA
Expand Down Expand Up @@ -3844,6 +3856,9 @@ UNDOC
unescape
unhexlify
uninstall
unicode
Unicode
UNICODE
uniq
uniquw
UNIREGISTRYMARKET
Expand Down Expand Up @@ -3871,6 +3886,7 @@ uppercasing
upq
upto
urc
url
urljoin
urllib
urlmap
Expand All @@ -3880,8 +3896,10 @@ uroot
useconds
uselessdrc
useradd
useragent
userdata
userfriendly
username
usermsec
userperc
USHRT
Expand Down Expand Up @@ -3991,6 +4009,8 @@ WEBPORT
webrick
webserv
webserveropts
website
websites
wednserrors
weekno
weirdtxt
Expand Down Expand Up @@ -4040,6 +4060,7 @@ wshash
WSIZE
WTERMSIG
wtest
www
wwwds
wwwezdnsit
wwwpowerdnscom
Expand All @@ -4060,10 +4081,14 @@ xffverylongstring
XFRd
XFRM
xfrserver
xhtml
XHTML
xhr
xit
xlabel
xluajit
xml
XML
XMy
xno
Xof
Expand Down
Loading

0 comments on commit 2ace8bd

Please sign in to comment.