Skip to content

Commit

Permalink
Add spellcheck to this repository
Browse files Browse the repository at this point in the history
Public + readme == spellcheck

Signed-off-by: Tim Smith <[email protected]>
  • Loading branch information
tas50 committed Sep 29, 2023
1 parent 0e5e134 commit 0fee9e4
Show file tree
Hide file tree
Showing 27 changed files with 1,058 additions and 70 deletions.
15 changes: 15 additions & 0 deletions .github/actions/spelling/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 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) |
| [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.
23 changes: 23 additions & 0 deletions .github/actions/spelling/advice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
<details><summary>If the flagged items are 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 (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,
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.

</details>
Empty file.
50 changes: 50 additions & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)go\.sum$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)vendor/
ignore$
\.a$
\.ai$
\.avi$
\.bmp$
\.bz2$
\.crt$
\.dll$
\.DS_Store$
\.eot$
\.exe$
\.gif$
\.gitattributes$
\.graffle$
\.gz$
\.icns$
\.ico$
\.jar$
\.jpe?g$
\.key$
\.lib$
\.lock$
\.map$
\.min\..
\.mod$
\.mp[34]$
\.o$
\.ocf$
\.otf$
\.pdf$
\.pem$
\.png$
\.psd$
\.s$
\.svg$
\.tiff?$
\.ttf$
\.wav$
\.webm$
\.webp$
\.woff2?$
\.zip$
^\.github/actions/spelling/
^\Q.github/workflows/spelling.yml\E$
238 changes: 238 additions & 0 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,238 @@
AAAKCR
AAhkr
ABEBAAGJ
ABKDNK
Abq
Abw
ACgk
ACGw
Acwk
AFi
Agb
Ags
AHjbi
AIgn
AIXu
Ajw
Akc
AKCR
Amngu
AMSn
AOG
AOHEKw
apikey
appleid
appxxxxxxxr
AQACHg
Aqm
ARAQAB
armv
ARzmy
Authenticode
AWz
BAhe
bdt
BEAC
CAc
cer
CHNY
CHV
CJk
COSb
DBQs
DBRUKCQg
DGCc
Dhx
DIQv
DMad
DTlv
Dvj
Dvp
EAAh
EETOk
Eutlu
eventpath
EWJr
Ewl
Fgri
FIUt
Flr
Gegw
GHcmk
GHu
Gjm
Gkmg
GSQ
GUQ
Gyh
Herath
HHkl
IBvvv
IDxz
Ignpjw
Ijgv
Inq
IUp
Iusmg
IVu
IZYA
JAoig
JFg
JMfph
Jov
JYh
KLw
KNf
Kosala
KUBWKG
Kyt
LBRYCAw
LHBJ
linux
lipo
LIu
Ljslr
LKg
Lnuf
LYDWlv
Lzt
LZZVdhxgh
makepkg
mbj
MMEb
Mtver
nch
nyft
OGAo
OGhtt
Oid
onf
OPENSSH
OQM
OVoq
PFN
Pjf
PKGBUILD
ppc
PRODUCTSIGN
QBu
Qfcn
QINBGAF
QJUBBMBCg
Qlk
qmow
Qns
QSjk
QUBl
QVW
Reiv
ROU
Rousnavh
Rst
RYo
SCm
Sfqt
SHx
SNq
Toolset
Ttjr
UBtb
Uobgsk
UXtk
VQxd
Vxs
VYv
Whk
WHN
WIh
WKZ
WPc
WZc
Wzi
Xburw
xct
XCu
Xcwnsnt
XET
XEVZR
XFf
XGf
XGqxw
XHZ
XJCm
xkv
Xmwr
XOa
Xpd
XPE
XPPE
Xqybfs
XRk
XRKIDAZc
Xrlr
XRQg
XSquk
Xthx
XUehsst
Xwa
XXz
XYr
Xzp
YAL
YBAL
YCsr
Ycv
YEJ
Yerws
ygt
Yih
Yiu
Ynoqp
yohl
Yop
Yqo
YREu
Ysn
YUI
yuth
Yvdwq
Yvo
YVsbf
YVthe
YXqn
Yyn
YYX
Yzw
Yzytm
Zaw
ZDy
Zfe
Zhe
ZHr
Zkb
Zkir
Zlg
ZMkx
ZNv
Znx
ZPfx
ZQBHo
ZQm
ZQTk
ZRAOHEK
ZRAOHEKw
ZRkj
Zrnyj
Zsc
ZUgv
ZUGw
ZUY
Zvzgyjbi
Zwh
ZWj
ZWN
Zwwzl
Zxixn
Zycwwpvl
ZYid
ZZXv
Loading

0 comments on commit 0fee9e4

Please sign in to comment.