Skip to content

Commit

Permalink
ci: spelling: update to 0.0.16a; update advice
Browse files Browse the repository at this point in the history
* rename expect
* prune stale items
* add some patterns
  • Loading branch information
jsoref committed May 14, 2020
1 parent fa7c1ab commit 78df00d
Show file tree
Hide file tree
Showing 11 changed files with 40 additions and 79 deletions.
18 changes: 13 additions & 5 deletions .github/actions/spell-check/advice.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,21 @@
:pencil2: Contributor please read this
</summary>

* If the items listed above are names, please add them to `.github/actions/spell-check/dictionary/names.txt`.
* If they're APIs, you can add them to a file in `.github/actions/spell-check/dictionary/`.
* If they're just things you're using, please add them to an appropriate file in `.github/actions/spell-check/whitelist/`.
* If you need to use a specific token in one place and it shouldn't generally be used, you can
add an item in an appropriate file in `.github/actions/spell-check/patterns/`.
By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

:warning: The command is written for posix shells. You can copy the contents of each `perl` command excluding the outer `'` marks and dropping any `'"`/`"'` quotation mark pairs into a file and then run `perl file.pl` from the root of the repository to run the code. Alternatively, you can manually insert the items...

If the listed items are:
* ... **misspelled**, then please *correct* them instead of using the command.
* ... *names*, please add them to `.github/actions/spell-check/dictionary/names.txt`.
* ... APIs, you can add them to a file in `.github/actions/spell-check/dictionary/`.
* ... just things you're using, please add them to an appropriate file in `.github/actions/spell-check/expect/`.
* ... tokens you only need in one place and shouldn't *generally be used*, you can add an item in an appropriate file in `.github/actions/spell-check/patterns/`.

See the `README.md` in each directory for more information.

:microscope: You can test your commits **without** *appending* to a PR by creating a new branch with that extra change and pushing it to your fork. The [:check-spelling](https://github.com/marketplace/actions/check-spelling) action will run in response to your **push** -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:

</details>

#### :warning: Reviewers
Expand Down
4 changes: 4 additions & 0 deletions .github/actions/spell-check/dictionary/apis.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
ACCEPTFILES
ACCESSDENIED
bitfield
bitfields
href
IBox
ICustom
IMap
IObject
IStorage
LCID
NCHITTEST
NCLBUTTONDBLCLK
Expand All @@ -15,3 +18,4 @@ ocidl
rfind
roundf
SIZENS
tmp
3 changes: 3 additions & 0 deletions .github/actions/spell-check/dictionary/names.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ austdi
Ballmer
bhoj
Bhojwani
carlos
dhowett
Diviness
dsafa
Expand Down Expand Up @@ -53,6 +54,8 @@ Wirt
Wojciech
zadjii
Zamor
Zamora
zamora
Zoey
zorio
Zverovich
1 change: 1 addition & 0 deletions .github/actions/spell-check/excludes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ SUMS$
\.xpm$
\.yml$
\.zip$
^consolegit2gitfilters\.json$
^dep/
^oss/
^doc/reference/UTF8-torture-test\.txt$
Expand Down
13 changes: 13 additions & 0 deletions .github/actions/spell-check/expect/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
The contents of each `.txt` file in this directory are merged together.

* [alphabet](alphabet.txt) is a sample for alphabet related items
* [web](web.txt) is a sample for web/html related items
* [expect](expect.txt) is the main list of expected items -- there is nothing
particularly special about the file name (beyond the extension which is
important).

These terms are things which temporarily exist in the project, but which
aren't necessarily words.

If something is a word that could come and go, it probably belongs in a
[dictionary](../dictionary/README.md).
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
abcd
abcde
abcdef
ABCDEFG
Expand All @@ -8,6 +7,7 @@ abcdefghijk
abcdefghijklmnop
ABCDEFGHIJKLMNOPQRST
abcdefghijklmnopqrstuvwxyz
ABE
BBBBBBBBBBBBBBDDDD
QQQQQQQQQQABCDEFGHIJ
QQQQQQQQQQABCDEFGHIJKLMNOPQRSTQQQQQQQQQ
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,11 @@ AAAAAABBBBBBCCC
AAAAABBBBBBBCCC
AAAAABCCCCCCCCC
AAAAADCCCCCCCCC
AAD
ABANDONFONT
ABCDEFGHIJKLMNO
ABCG
abe
abec
abf
abi
acb
accd
ACCEPTFILES
ACCESSDENIED
acec
acf
acidev
Expand All @@ -29,10 +22,7 @@ ADDREF
addressof
ADDSTRING
ADDTOOL
aeed
AEnd
afae
afceeeaa
AFew
AFill
AFX
Expand Down Expand Up @@ -131,7 +121,6 @@ awch
azuredevopspodcast
azurewebsites
azzle
baac
backend
backgrounded
Backgrounder
Expand All @@ -142,23 +131,15 @@ Batang
baz
Bazz
BBBBCCCCC
bbc
bbd
BBDM
bbe
bbwe
bc
bca
bcb
bcc
bcount
bcrypt
bcx
bcz
bda
BEFOREPARENT
beginthread
bfb
bgcolor
bgfx
bgidx
Expand All @@ -172,7 +153,6 @@ binplace
binplaced
bitcoin
bitcrazed
bitfield
bitflag
bitmask
BITOPERATION
Expand Down Expand Up @@ -215,7 +195,6 @@ BValue
byref
bytearray
bytebuffer
caa
Cac
callee
cang
Expand All @@ -224,11 +203,8 @@ CARETBLINKINGENABLED
CARRIAGERETURN
cascadia
catid
carlos
zamora
cazamor
CBash
cbb
cbegin
cbiex
CBN
Expand All @@ -249,12 +225,9 @@ CConversion
CCRT
cctype
CDATA
CDBA
cdd
CDE
cdecl
CDeclaration
cebb
CEdit
CELLSIZE
cend
Expand Down Expand Up @@ -502,14 +475,10 @@ dai
DATABLOCK
DATAVIEW
DATAW
dba
DBatch
dbb
dbcs
DBCSCHAR
DBCSFONT
dbd
DBDCF
dbg
DBGALL
DBGCHARS
Expand All @@ -520,13 +489,11 @@ dblclk
DBlob
dbproj
DBUILD
dcf
DColor
DCOLORVALUE
dcommon
DCompile
dcompiler
ddb
dde
DDESHARE
DDevice
Expand Down Expand Up @@ -616,7 +583,6 @@ devicefamily
devops
Dext
df
dfa
DFactory
dh
dialogbox
Expand Down Expand Up @@ -684,14 +650,9 @@ dxgidwm
dxinterop
dxttbmp
eachother
EAEC
eaf
EASTEUROPE
eb
eba
ebce
EBFB
ECFB
ECH
echokey
ecount
Expand All @@ -701,8 +662,6 @@ EDITTEXT
EDITUPDATE
edputil
edu
eeb
eee
Efast
EHsc
EJO
Expand All @@ -712,8 +671,6 @@ Elems
elif
elseif
emacs
Emoji
Emojis
emptybox
enabledelayedexpansion
endian
Expand Down Expand Up @@ -771,26 +728,17 @@ failfast
FAILIFTHERE
fallthrough
FARPROC
fba
fbb
fbd
fbdc
FBE
fcb
fcc
fcharset
fclose
fcntl
fd
fdb
fdc
fdd
FDD
fde
fdopen
fdw
fea
fesb
ffc
FFDE
FFF
FFrom
Expand Down Expand Up @@ -936,7 +884,6 @@ Gfun
gfx
gh
github
githubusercontent
gitlab
gle
globals
Expand Down Expand Up @@ -1029,7 +976,6 @@ hpp
HPR
HPROPSHEETPAGE
HREDRAW
HREF
hresult
HRSRC
hscroll
Expand Down Expand Up @@ -1397,7 +1343,6 @@ memallocator
memcmp
memcopy
memcpy
memcpying
memmove
memset
MENUCHAR
Expand Down Expand Up @@ -1671,7 +1616,6 @@ Outof
OUTOFCONTEXT
OUTOFMEMORY
outout
OUTPATHROOT
Outptr
Ov
OVERLAPPEDWINDOW
Expand Down Expand Up @@ -2231,7 +2175,6 @@ stgm
stl
stoi
stol
storageitems
storelogo
stoul
stoutapot
Expand Down Expand Up @@ -2337,7 +2280,6 @@ TEXCOORD
texel
textattribute
TEXTATTRIBUTEID
textblock
Textbox
textboxes
textbuffer
Expand Down Expand Up @@ -2365,7 +2307,6 @@ TLEN
Tlg
Tlgdata
TMAE
tmp
TMPF
TMult
tmultiple
Expand Down Expand Up @@ -2398,7 +2339,6 @@ TRACKCOMPOSITION
trackpad
transcoder
transitioning
trc
Trd
TREX
triaged
Expand Down Expand Up @@ -2519,7 +2459,6 @@ USESHOWWINDOW
USESIZE
USESTDHANDLES
ushort
usr
USRDLL
utf
utils
Expand Down Expand Up @@ -2561,7 +2500,6 @@ vkey
VKKEYSCAN
VMs
VPA
vpack
VPATH
VPR
VPrintf
Expand Down Expand Up @@ -2742,7 +2680,6 @@ WRITECONSOLEINPUT
WRITECONSOLEOUTPUT
WRITECONSOLEOUTPUTSTRING
wrl
wrn
wrp
WRunoff
WScript
Expand Down
File renamed without changes.
4 changes: 3 additions & 1 deletion .github/actions/spell-check/patterns/patterns.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ https://(?:(?:[-a-zA-Z0-9?&=]*\.|)microsoft\.com)/[-a-zA-Z0-9?&=_\/.]*
https://aka\.ms/[-a-zA-Z0-9?&=\/_]*
https://www.w3.org/[-a-zA-Z0-9?&=\/_#]*
https://(?:(?:www\.|)youtube\.com|youtu.be)/[-a-zA-Z0-9?&=]*
https://[a-z-]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*
[Pp]ublicKeyToken="?[0-9a-fA-F]{16}"?
(?:[{"]|UniqueIdentifier>)[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}(?:[}"]|</UniqueIdentifier)
(?:0[Xx]|U\+|#)[a-f0-9A-FGgRr]{2,}[Uu]?[Ll]?\b
\{[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\}
microsoft/cascadia-code\@[0-9a-fA-F]{40}
\d+x\d+Logo
Scro\&ll
Expand Down
Loading

0 comments on commit 78df00d

Please sign in to comment.