Skip to content

Commit

Permalink
Update spellcheck.yaml
Browse files Browse the repository at this point in the history
* Increase dictionary limit
  • Loading branch information
abraunegg committed Nov 1, 2024
1 parent edb839b commit efde97c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/spellcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ jobs:
warnings: bad-regex,binary-file,deprecated-feature,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration,no-files-to-check
experimental_apply_changes_via_bot: 1
use_sarif: ${{ (!github.event.pull_request || (github.event.pull_request.head.repo.full_name == github.repository)) && 1 }}
extra_dictionary_limit: 20
extra_dictionary_limit: 40
extra_dictionaries:
cspell:software-terms/dict/softwareTerms.txt
cspell:php/dict/php.txt
Expand Down

1 comment on commit efde97c

@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 (946)
AADSTS
aarch
abraunegg
ABSTIME
acaa
ACAWK
acceptex
accrights
accrightslen
ACEOF
aclocal
adaa
adamdruppe
addprefix
addrepo
adr
advaced
aeab
aed
afsws
alex
alpinelinux
annobin
antix
aothmane
apk
Apline
apng
appropriatly
archlinux
ARequest
argopts
armhf
ARMv
arsd
arsdnet
artix
ASBOX
ASCIIHTML
asdfasdf
asdfasdfhashdkfasdf
ASEOF
ASpurious
ASUNAME
Atempts
AThings
atleast
aufxw
aur
authentictaion
AUTHFILES
AUTHRESPONSE
autoclean
autogen
autom
automake
autoprocess
autoreconf
autoupdate
avmkfdiitirnrenzljwc
BADFILES
BARG
bashcompdir
bashism
baus
Bauth
bba
bcdefghi
bindir
binfmt
binutils
bir
bla
blargh
BOJh
Bonedrive
bools
bootblocks
bpozdena
Bresponse
brp
btw
BUGREPORT
bugzilla
bui
builddir
buildfiles
buildroot
buildx
bytecompile
cac
cach
cancelfd
CANTOPEN
CApath
capitalisation
cattr
cbab
cbf
ccc
CDPATH
CECNL
certbot
Changables
checkinterval
chgrpcmd
chgrpprog
chinacloudapi
chkconfig
chmodcmd
chmodprog
chowncmd
chownprog
chpst
CIFS
classinfo
CLEANUPLOCAL
CLICOLOR
cloexec
Closout
Cloudflare
cmpprog
cmptr
cmsghdr
codacy
Codename
collinsdictionary
commandline
completionsdir
concated
confcache
confdefs
confdir
confi
confif
CONNEC
Connectivty
CONNECTTIMEOUT
Consor
constness
consuime
containerised
controllen
Conventsions
coverering
CPPFLAGS
cpprog
Cqe
createiocompletionport
createlink
createuploadsession
crt
ctl
CURLVERSION
customisable
customisation
cuz
CXXFLAGS
cyb
CYs
dashdash
datad
datadi
datadir
datar
dataro
dataroo
dataroot
datarootd
datarootdi
datarootdir
dateext
DBFF
dbn
DCFLAGS
dchar
ddb
dde
DDNS
debian
debu
dechunk
dedocde
Deepin
defun
deimos
dentoed
dessant
DESTDIR
detils
devuan
dff
DFFF
dhparams
dirmask
discussioncomment
distclean
distributon
DJDIR
DJGPP
dlang
dlnow
dltotal
Dlxj
dmd
dnf
dnl
dnotify
docdi
docdir
DOCFILES
Dockerfiles
DOITPROG
dotfile
dotnet
DOWNLOADONLY
dphys
dpldocs
Dradnp
driveid
driveitem
driveone
druntime
drwx
dryrun
dspmsg
dstbase
dstdir
dstdirslash
DSTFILE
dsttmp
dstyle
DTime
DUALCASE
dvi
dvid
dvidi
dvidir
Dynu
eaf
EAFA
EAPI
efbc
eis
ELBl
ele
ELik
enableval
endinaness
enduml
envp
epel
epfd
EPOLLET
EPOLLEXCLUSIVE
EPOLLHUP
EPOLLIN
EPOLLONESHOT
EPOLLOUT
EPREFIX
estr
esyscmd
euo
eventfd
evt
exeext
exlude
expressesed
extention
extrasub
fafdef
fasynchronous
fcdc
fcf
FCFLAGS
fcgid
fcgienv
FCGX
fcontext
fda
fedoraproject
fefefe
fexceptions
ffat
FFFF
FFLAGS
fhandler
FHL
FHLC
filedir
fileread
finalise
finalised
FIRSTHDR
fiv
flto
fnord
fstack
FState
fullchain
FULLMUTEX
fullscan
fullstop
Fwy
gdc
gdk
gerror
GETACCEPTEXSOCKADDRS
getenforce
getent
getnamedpipeserverprocessid
getsol
getsysinfo
gfortran
GFree
ghaction
Gibi
ginstall
GLIBCXX
gmodule
GObject
gosu
gotchas
GPBT
gpg
GPLv
gpo
Gptf
Gqj
grecord
groupinstall
gshared
GVariant
gywl
gzipping
HACKISH
hardenings
havesystemd
hideonindex
hnsecs
hos
hostinfo
howto
hskrieg
htmldi
htmldir
htons
HWE
IARG
idk
idlol
idup
ietf
ifneq
ifrom
ifvaln
INADDR
inclu
includ
includedi
includedir
incomming
ine
infod
infodi
infodir
INFOW
ings
initialising
initscripts
initted
initval
installbsd
INSTALLDIR
intercambio
invalidcharacters
invalidfilefoldernames
iocp
Ioctl
IOERR
ioop
iov
iovec
iovlen
ipresolve
ISPs
issuecomment
isv
itemdb
itemts
itimerspec
itme
IUSE
Jogxp
journalctl
JRD
jsvar
JTIz
kdbx
KDE
keepachangelog
keepass
killproc
kinda
koji
KRN
ksh
Kubuntu
lalen
lbl
lcurl
ldc
ldconfig
ldflags
ldl
ldmd
letsencrypt
lgdk
lgio
lglib
lgobject
libd
libdi
libdir
libe
libex
libexe
libexec
libexecd
libexecdi
libexecdir
libgcc
libgdk
libgio
libglib
libgobject
liblphobos
libm
libnotify
libobj
LIBOBJDIR
libphobos
librar
librari
librarie
libsqlite
Lighttpd
lintian
linuxmint
llclose
llsend
LMDE
lnotify
localedi
localst
localsta
localstat
localstate
localstatedi
localstatedir
logfiles
lol
lpdw
lpfn
LPOVERLAPPED
LPWSABUF
LPWSAOVERLAPPED
LPWSAPROTOCOL
lsb
lsqlite
ltlibobjs
ltmain
Lubuntu
Lyncredible
makedepends
makefiles
MAKEFLAGS
makepkg
malware
mangleof
marcelcoding
maulwuff
mayne
mbr
meh
memtest
MFLAGS
microsoftazure
microsoftgraph
microsoftonline
MINVERSION
missingok
mkdirprog
mline
mountpoint
mozilla
mozram
msghdr
msonenote
mswsock
mtune
mvcmd
mvprog
myapps
mydir
mynasau
myusername
nadded
nadjusted
namelen
nas
Nataional
nativeclient
nbd
nbytes
ncache
nce
ndata
netinet
netsplit
nev
nevent
newfd
newfile
nexisting
nfds
nfields
nfor
nfp
nint
nintegrity
niop
noarch
nobj
nodelay
nolan
nomount
NONINFRINGEMENT
NOREMOTEDELETE
nosignal
nosync
NOTADB
notif
notifu
notreached
NOWRITE
nph
npreining
Nqm
nrecords
nto
NULLCMD
nuntil
nupload
nvia
Nzg
objectsx
objext
occurence
occuring
odata
ODEy
odgroup
odsp
oduser
ofonedrive
OHR
oldi
oldin
oldinc
oldincl
oldinclu
oldinclud
oldinclude
oldincludedi
oldincludedir
Oliveira
omething
Omzy
onbinarymessage
ondrive
onedrive
ONEDRIVEALT
ONLYDIR
onmicrosoft
ontextmessage
opensuse
optarg
optimisation
optins
oslevel
overallocated
OXV
packageinfo
pacman
pamac
parentid
passoff
pastebin
pdfd
pdfdi
pdfdir
pdksh
Permisions
pertinant
pfa
PGID
phlibi
phobos
pidfile
pidx
pixbuf
PKGBUILD
pkgconf
pkgconfig
pkgconfigdir
pkgdesc
pkgdir
pkgname
pkgrel
pkgver
pki
pkolmann
podman
pollfd
POLLIN
popdef
postgre
postun
prefi
prefork
Preining
preinstalled
PREREQ
preun
prioritise
privkey
Privs
prodocol
progr
prolly
prueba
psdi
psdir
Pseudoblocking
PUID
puml
pushdef
pwplus
qdir
qewrqwerwqer
Qim
QMf
qprefix
quickxorhash
quie
QWords
qxor
QYd
raf
ralen
Rasberry
raspberrypi
raspi
raspios
rbtree
RDEPEND
rdn
rdo
readdata
readln
readret
reauth
rech
reche
rechec
recieved
recu
recursi
recursio
Recursivly
Recvd
recvfd
redhat
reexec
relro
remaing
reparse
repology
requesite
requried
restorecon
Restristions
resynchronisation
retu
reumed
revents
RFqjf
rhel
rhstatus
RJKIB
rko
rlc
rmcmd
rmprog
rmtmp
robertschulze
rpcing
rpmbuild
rpmlib
RPMS
Rproj
rrodrigueznt
rsv
rtud
rul
RUNAS
runsvdir
Ruppe
sandboxing
sargs
sbi
sbind
sbindi
sbindir
scgi
scoinst
screenshots
scriptversion
sdlang
segfault
selectivly
semanage
sendfd
serverfault
setsebool
settime
setwaitabletimer
sev
sfn
shannon
shar
shareds
sharedst
sharedsta
sharedstat
sharedstate
sharedstatedi
sharedstatedir
sharedwithme
sharepoint
shitload
shitpache
shorcut
shortnames
shtool
sigaction
sigchldhandler
sigemptyset
signo
sigpipe
SIGSEV
SIlsqj
SIO
skilion
skinparam
sklion
slackbuilds
Slackware
Sockaddrs
somevar
sooooo
sourced
Sourcing
spamming
srcd
srcdi
SRCFILES
SRPMS
SSk
stackoverflow
startuml
STARTUPINFOW
statm
stdc
steming
stringof
Stringz
stripcmd
stripprog
stuc
subobject
substed
subsys
suffi
Supression
svdir
swapfile
swapon
SWAPSIZE
swp
SXc
symcode
syncable
syncdir
synchapi
syncronisation
sysadmin
sysc
sysco
syscon
sysconf
sysconfd
sysconfdi
sysconfdir
systemdsystemunitdir
systemduserunitdir
targ
TARNAME
TBE
tbh
tdcockers
technet
techo
templ
testbuild
TESTFILES
TFD
Thh
thingies
thnk
Thu
tianon
tidx
tilda
timerfd
TION
tium
tlsv
tmppath
tnv
tonistiigi
TQpylvmo
tran
transfo
transfor
travervse
Tting
Tunables
typecons
Tzh
UBB
ucb
uda
ulnow
uload
ultotal
Ultrix
undefiened
uninitialised
uninstallation
unistd
unitdir
unittests
Unsuppressing
unsurpress
unsynced
upgradable
UPLOADONLY
urandom
urlify
urot
userinfo
usermod
userns
useropt
userpass
userunitdir
usl
utilisation
UWIN
valgrind
verbo
vercomp
versi
versio
VGTU
VNET
voidlinux
vpsub
vti
vwvkbubufexgeuaxhqfl
waitable
wal
websites
websockets
webtemplate
weburl
Werror
whp
winbase
withval
WORKDIR
wpath
writefln
wrt
WSABUF
wsaduplicatesocketw
wsagetoverlappedresult
WSAID
WSAOVERLAPPED
wsarecv
wsasend
wtf
WUc
Wyqa
xauto
xca
xcbac
xdeadbeef
xdg
xlaunch
xno
xof
xored
xset
Xubuntu
XXXXXX
XXYYZZ
xyes
xzf
yann
YCk
yourapp
yourdomain
yourfile
yourprogram
Zorin
ZRM
Zro
zugaina
Zuo
Zws
ZXOv
zypper
zzzdeb
Some files were automatically ignored ๐Ÿ™ˆ

These sample patterns would exclude them:

^\Qdocs/images/shared_with_me.JPG\E$

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To use the spell-check-this repository, accept these unrecognized words as correct, and update file exclusions, you could run the following commands

... in a clone of the git@github.com:abraunegg/onedrive.git repository
on the master 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/abraunegg/onedrive/actions/runs/11637706021/attempts/1'
Available ๐Ÿ“š dictionaries could cover words not in the ๐Ÿ“˜ dictionary
Dictionary Entries Covers Uniquely
cspell:docker/src/docker-words.txt 27 1 1
cspell:csharp/csharp.txt 32 1 1
cspell:cpp/src/compiler-clang-attributes.txt 46 1 1
cspell:clojure/src/clojure.txt 89 1 1
cspell:lisp/lisp.txt 200 1 1

Consider adding them (in .github/workflows/spellcheck.yaml) in jobs:/spelling: for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries: |
          cspell:docker/src/docker-words.txt
          cspell:csharp/csharp.txt
          cspell:cpp/src/compiler-clang-attributes.txt
          cspell:clojure/src/clojure.txt
          cspell:lisp/lisp.txt

To stop checking additional dictionaries, add (in .github/workflows/spellcheck.yaml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Forbidden patterns ๐Ÿ™… (18)

In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.

These forbidden patterns matched content:

In English, duplicated words are generally mistakes

There are a few exceptions (e.g. "that that").
If the highlighted doubled word pair is in:

  • code, write a pattern to mask it.
  • prose, have someone read the English before you dismiss this error.
\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s

Should be ID

\bId\b

Should be URI or uri unless it refers to a person named Uri

(?<!\.)\bUri\b(?![(])

Do not use (click) here links

For more information, see:

(?i)(?:>|\[)(?:(?:click |)here|(?:read |)more)(?:</|\]\()

Should be case-(in)sensitive

\bcase (?:in|)sensitive\b

Should only be one of a, an, or the

\b(?:(?:an?|the)\s+){2,}\b

Should be nonexistent

\b[Nn]o[nt][- ]existent\b

Should be workaround

(?:(?:[Aa]|[Tt]he|ugly)\swork[- ]around\b|\swork[- ]around\s+for)

Should be GitHub

(?<![&*.]|// |\b(?:from|import|type) )\bGithub\b(?![{()])

Should be JavaScript

\bJavascript\b

Should be deprecation warning(s)

\b[Dd]epreciation [Ww]arnings?\b

Should be into

when not phrasal and when in order to would be wrong:
https://thewritepractice.com/into-vs-in-to/

\sin to\s(?!if\b)

Should be its

\bit's(?= own\b)

Should be nonexistent

\bnon existing\b

Should be preexisting

[Pp]re[- ]existing

Should be prerequisite

[Pp]re[- ]requisite

Should be (coarse|fine)-grained

\b(?:coarse|fine) grained\b

Should be neither/nor -- or reword

(?!<do )\bnot\b([^.?!"/(](?!neither|,.*?,))+\bnor\b
Pattern suggestions โœ‚๏ธ (34)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns

# hit-count: 388 file-count: 45
# https/http/file urls
(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/*%?=~_|!:,.;]+[-A-Za-z0-9+&@#/*%=~_|]

# hit-count: 148 file-count: 17
# libraries
(?:\b|_)lib(?:re(?=office)|)(?!era[lt]|ero|erty|rar(?:i(?:an|es)|y))(?=[a-z])

# hit-count: 110 file-count: 1
# https://www.gnu.org/software/groff/manual/groff.html
# man troff content
\\f[BCIPR]

# hit-count: 103 file-count: 26
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)

# hit-count: 51 file-count: 6
# Compiler flags (Unix, Java/Scala)
# Use if you have things like `-Pdocker` and want to treat them as `docker`
(?:^|[\t ,>"'`=(])-(?:(?:J-|)[DPWXY]|[Llf])(?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})

# hit-count: 51 file-count: 6
# Compiler flags (Windows / PowerShell)
# This is a subset of the more general compiler flags pattern.
# It avoids matching `-Path` to prevent it from being treated as `ath`
(?:^|[\t ,"'`=(])-(?:[DPL](?=[A-Z]{2,})|[WXYlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}))

# hit-count: 41 file-count: 4
# Markdown anchor links
\(#\S*?[a-zA-Z]\S*?\)

# hit-count: 38 file-count: 6
# microsoft
\b(?:https?://|)(?:(?:download\.visualstudio|docs|msdn2?|research)\.microsoft|blogs\.msdn)\.com/[-_a-zA-Z0-9()=./%]*

# hit-count: 28 file-count: 13
# in check-spelling@v0.0.22+, printf markers aren't automatically consumed
# printf markers
(?<!\\)\\[nrt](?=[a-z]{2,})

# hit-count: 27 file-count: 9
# version suffix <word>v#
(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))

# hit-count: 24 file-count: 11
# scala imports
^import (?:[\w.]|\{\w*?(?:,\s*(?:\w*|\*))+\})+

# hit-count: 19 file-count: 2
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|[iu]\d+)\b

# hit-count: 18 file-count: 8
# uuid:
\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b

# hit-count: 14 file-count: 1
# data url
\bdata:[-a-zA-Z=;:/0-9+]*,\S*

# hit-count: 10 file-count: 7
# shields.io
\bshields\.io/[-\w/%?=&.:+;,]*

# hit-count: 9 file-count: 5
# alternate printf markers if you run into latex and friends
(?<!\\)\\[nrt](?=[a-z]{2,})(?=.*['"`])

# hit-count: 8 file-count: 7
# githubusercontent
/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*

# hit-count: 6 file-count: 4
# base64 encoded content, possibly wrapped in mime
(?:^|[\s=;:?])[-a-zA-Z=;:/0-9+]{50,}(?:[\s=;:?]|$)

# hit-count: 6 file-count: 3
# Docker images
^\s*FROM\s+\S+:\S+(?:\s+AS\s+\S+|)

# hit-count: 5 file-count: 2
# assign regex
= /[^*].*?(?:[a-z]{3,}|[A-Z]{3,}|[A-Z][a-z]{2,}).*/[gi]?(?=\W|$)

# hit-count: 4 file-count: 3
# stackexchange -- https://stackexchange.com/feeds/sites
\b(?:askubuntu|serverfault|stack(?:exchange|overflow)|superuser).com/(?:questions/\w+/[-\w]+|a/)

# hit-count: 4 file-count: 3
# hex runs
\b[0-9a-fA-F]{16,}\b

# hit-count: 4 file-count: 3
# container images
image: [-\w./:@]+

# hit-count: 4 file-count: 1
# curl arguments
\b(?:\\n|)curl(?:\.exe|)(?:\s+-[a-zA-Z]{1,2}\b)*(?:\s+-[a-zA-Z]{3,})(?:\s+-[a-zA-Z]+)*

# hit-count: 3 file-count: 3
# tar arguments
\b(?:\\n|)g?tar(?:\.exe|)(?:(?:\s+--[-a-zA-Z]+|\s+-[a-zA-Z]+|\s[ABGJMOPRSUWZacdfh-pr-xz]+\b)(?:=[^ ]*|))+

# hit-count: 3 file-count: 2
# GitHub actions
\buses:\s+[-\w.]+/[-\w./]+@[-\w.]+

# hit-count: 2 file-count: 2
# file permissions
['"`\s][-bcdLlpsw](?:[-r][-w][-Ssx]){2}[-r][-w][-SsTtx]\+?['"`\s]

# hit-count: 2 file-count: 1
# URL escaped characters
%[0-9A-F][A-F](?=[A-Za-z])

# hit-count: 2 file-count: 1
# IPv6
\b(?:[0-9a-fA-F]{0,4}:){3,7}[0-9a-fA-F]{0,4}\b

# hit-count: 2 file-count: 1
# machine learning (?)
\b(?i)ml(?=[a-z]{2,})

# hit-count: 2 file-count: 1
# C network byte conversions
(?:\d|\bh)to(?!ken)(?=[a-z])|to(?=[adhiklpun]\()

# hit-count: 2 file-count: 1
# highlighted letters
\[[A-Z]\][a-z]+

# hit-count: 1 file-count: 1
# sha
sha\d+:[0-9a-f]*?[a-f]{3,}[0-9a-f]*

# hit-count: 1 file-count: 1
# base64 encoded content
([`'"])[-a-zA-Z=;:/0-9+]{3,}=\g{-1}

Errors (4)

See the ๐Ÿ“œaction log or ๐Ÿ“ job summary for details.

โŒ Errors Count
โš ๏ธ binary-file 1
โ„น๏ธ candidate-pattern 78
โŒ check-file-path 68
โŒ forbidden-pattern 54

See โŒ Event descriptions for more information.

Please sign in to comment.