Skip to content

Commit

Permalink
Merge pull request #455 from jsoref/spell-check
Browse files Browse the repository at this point in the history
Use check-spelling/[email protected]
  • Loading branch information
LeiWang1999 authored Sep 8, 2022
2 parents 324f7a9 + b967fd7 commit 6537a59
Show file tree
Hide file tree
Showing 20 changed files with 359 additions and 112 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/) | 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/) | 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/) | 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.
113 changes: 110 additions & 3 deletions .github/actions/spelling/allow/allow.txt
Original file line number Diff line number Diff line change
@@ -1,29 +1,83 @@
admins
apc
Apc
AVI
AVX
avx
Blt
blt
bsd
breadcrumb
breadcrumbs
calt
CMMI
ccmp
Cdecl
cdecl
CDeclaration
Cfg
cfg
changelog
CJK
cjk
CLSID
clsid
CMMI
csrutil
css
cstdarg
cstddef
cstdio
cstdlib
cstr
cstring
CStyle
cstyle
csv
CSwitch
CTerminal
CText
ctime
Ctor
ctor
CTRLEVENT
CTRLKEYSHORTCUTS
Ctx
ctx
Ctxt
clickable
clig
copyable
cybersecurity
dalet
dcs
Dcs
Debian
debian
Dedupe
dedupe
deduplicate
deduplicated
dialytika
Dirs
dirs
dje
downside
downsides
Dtor
dtor
dze
dzhe
EDDB
EDDC
Enum'd
EOL
eol
EQU
equ
Fallthrough
fallthrough
Finalizer
finalizer
Fitt
formattings
ftp
Expand All @@ -33,14 +87,28 @@ geeksforgeeks
ghe
gje
godbolt
Google
google
GPUs
gpus
grayscale
hostname
hostnames
hyperlink
hyperlinking
hyperlinks
IChar
ichar
IID
iid
IList
ilist
img
inlined
It'd
Interop
interop
IValue
ivalue
kje
libfuzzer
liga
Expand All @@ -52,9 +120,13 @@ locl
lorem
Lorigin
maxed
Mip
mip
mkmk
mnt
mru
Multiline
multiline
noreply
nje
noreply
Expand All @@ -63,34 +135,69 @@ ok'd
overlined
pipeline
postmodern
PPV
ppv
PRECOMP
precomp
PRELOAD
preload
ptys
qof
qps
RASTERIZATION
rasterization
Readline
readline
READONLY
readonly
rclt
Redist
redist
reimplementation
reserialization
reserialize
reserializes
rlig
runtimes
SELECTANY
selectany
shcha
Shl
shl
slnt
Sos
Stri
stri
Swappable
swappable
timeline
timelines
timestamped
TLDR
TLEN
Tlen
tokenizes
tonos
tshe
TStr
tstr
uiatextrange
UIs
ULONG
ulong
und
Unescape
unescape
Unittest
unittest
unregister
versioned
vsdevcmd
We'd
wildcards
XAZ
xaz
YAML
yaml
yeru
zhe
allcolors
14 changes: 14 additions & 0 deletions .github/actions/spelling/allow/microsoft.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,21 @@ DACL
DACLs
defaultlib
diffs
directio
DIRECTX
directx
disposables
dotnetfeed
DTDs
DWINRT
enablewttlogging
HMODULE
hmodule
HRESULT
hresult
HWND
hwnd
HWNDPARENT
Intelli
IVisual
libucrt
Expand Down Expand Up @@ -77,6 +87,10 @@ Virtualization
visualstudio
vscode
VSTHRD
winmm
WINNT
winnt
Winperf
winsdkver
wlk
wslpath
Expand Down
2 changes: 2 additions & 0 deletions .github/actions/spelling/allow/names.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ miniksa
niksa
nvaccess
nvda
NVIDIA
nvidia
oising
oldnewthing
opengl
Expand Down
4 changes: 4 additions & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@ SUMS$
\.mp3$
\.mp4$
\.otf$
\.pb$
\.pbxproj$
\.pdf$
\.pem$
\.psd$
\.pt$
\.runsettings$
\.sig$
\.so$
Expand Down Expand Up @@ -79,4 +81,6 @@ SUMS$
^tools/ReleaseEngineering/ServicingPipeline.ps1$
^\.github/actions/spelling/
^\.gitignore$
^\Qsrc/tools/nnfusion/templates/graphcore/Makefile\E$
^\Qthirdparty/curl\E$
^\XamlStyler.json$
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
avx
blt
Cdecl
cfg
cic
CJK
CLSID
CStyle
Ctor
ctx
debian
dedupe
directx
dirs
Dtor
EOL
equ
Etw
Fallthrough
Finalizer
findall
GDI
google
gpus
Greader
hdiv
HKEY
HMODULE
hmul
HRESULT
hsub
HWND
ichar
IID
ilist
Interop
ivalue
KConfig
keepdim
LNK
LNOp
mega
mip
mul
Multiline
nvidia
PPV
PRECOMP
preload
PROCS
RASTERIZATION
readline
READONLY
Redist
reducel
SELECTANY
sfinae
shl
stri
Swappable
tkey
Tlen
topkconf
topkop
tstr
ULONG
unescape
Unittest
vgpr
wgp
WINNT
XAZ
yaml
Loading

0 comments on commit 6537a59

Please sign in to comment.