ci: spelling: update to 0.0.16a; update advice (#5922)

<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
## Summary of the Pull Request

Updates the check spelling action to [0.0.16-a](https://github.com/check-spelling/check-spelling/releases/tag/0.0.16-alpha)
* update advice -- [sample](57fc13f6c6 (commitcomment-39489723)) -- I really do encourage others to adjust it as desired
* rename `expect` (there are consumers who were not a fan of the `whitelist` nomenclature)
* prune stale items
* some `patterns` improvements to reduce the number of items in `expect`


<!-- Other than the issue solved, is this relevant to any other issues/existing PRs? --> 
⚠️ Anyone with an inflight addition of a new file to the `whitelist` directory will be moderately unhappy as the action would only use items from there if it didn't find `expect` (and this PR includes the rename).

## References

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
* [ ] Closes #xxx
* [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Requires documentation to be updated
* [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments
Runs should be ~30s faster.

I was hoping to be able to offer the ability to talk to the bot, but sadly that feature is still not quite ready -- and I suspect that I may want to let projects opt in/out of that feature.

<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed

* I added a commit with misspellings: 57fc13f6c6   and ran the command it suggested (in bash). 
* The commit [itself passes its own testing](78df00dcf6) ✔️ 

The commands were never `cmd`/`psh` friendly. This iteration is designed to make it easier for a bot to parse and eventually do the work in response to a GitHub request, sadly that feature is behind schedule.
This commit is contained in:
Josh Soref 2020-05-28 09:01:52 -04:00 committed by GitHub
parent fa7c1abdf8
commit cc472c267b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 40 additions and 79 deletions

View File

@ -3,13 +3,21 @@
:pencil2: Contributor please read this :pencil2: Contributor please read this
</summary> </summary>
* If the items listed above are names, please add them to `.github/actions/spell-check/dictionary/names.txt`. 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.
* 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/`. :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 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/`. 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. 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> </details>
#### :warning: Reviewers #### :warning: Reviewers

View File

@ -1,3 +1,5 @@
ACCEPTFILES
ACCESSDENIED
bitfield bitfield
bitfields bitfields
href href
@ -5,6 +7,7 @@ IBox
ICustom ICustom
IMap IMap
IObject IObject
IStorage
LCID LCID
NCHITTEST NCHITTEST
NCLBUTTONDBLCLK NCLBUTTONDBLCLK
@ -15,3 +18,4 @@ ocidl
rfind rfind
roundf roundf
SIZENS SIZENS
tmp

View File

@ -3,6 +3,7 @@ austdi
Ballmer Ballmer
bhoj bhoj
Bhojwani Bhojwani
carlos
dhowett dhowett
Diviness Diviness
dsafa dsafa
@ -53,6 +54,8 @@ Wirt
Wojciech Wojciech
zadjii zadjii
Zamor Zamor
Zamora
zamora
Zoey Zoey
zorio zorio
Zverovich Zverovich

View File

@ -51,6 +51,7 @@ SUMS$
\.xpm$ \.xpm$
\.yml$ \.yml$
\.zip$ \.zip$
^consolegit2gitfilters\.json$
^dep/ ^dep/
^oss/ ^oss/
^doc/reference/UTF8-torture-test\.txt$ ^doc/reference/UTF8-torture-test\.txt$

View File

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

View File

@ -1,4 +1,3 @@
abcd
abcde abcde
abcdef abcdef
ABCDEFG ABCDEFG
@ -8,6 +7,7 @@ abcdefghijk
abcdefghijklmnop abcdefghijklmnop
ABCDEFGHIJKLMNOPQRST ABCDEFGHIJKLMNOPQRST
abcdefghijklmnopqrstuvwxyz abcdefghijklmnopqrstuvwxyz
ABE
BBBBBBBBBBBBBBDDDD BBBBBBBBBBBBBBDDDD
QQQQQQQQQQABCDEFGHIJ QQQQQQQQQQABCDEFGHIJ
QQQQQQQQQQABCDEFGHIJKLMNOPQRSTQQQQQQQQQ QQQQQQQQQQABCDEFGHIJKLMNOPQRSTQQQQQQQQQ

View File

@ -2,18 +2,11 @@ AAAAAABBBBBBCCC
AAAAABBBBBBBCCC AAAAABBBBBBBCCC
AAAAABCCCCCCCCC AAAAABCCCCCCCCC
AAAAADCCCCCCCCC AAAAADCCCCCCCCC
AAD
ABANDONFONT ABANDONFONT
ABCDEFGHIJKLMNO ABCDEFGHIJKLMNO
ABCG ABCG
abe
abec
abf abf
abi abi
acb
accd
ACCEPTFILES
ACCESSDENIED
acec acec
acf acf
acidev acidev
@ -29,10 +22,7 @@ ADDREF
addressof addressof
ADDSTRING ADDSTRING
ADDTOOL ADDTOOL
aeed
AEnd AEnd
afae
afceeeaa
AFew AFew
AFill AFill
AFX AFX
@ -131,7 +121,6 @@ awch
azuredevopspodcast azuredevopspodcast
azurewebsites azurewebsites
azzle azzle
baac
backend backend
backgrounded backgrounded
Backgrounder Backgrounder
@ -142,23 +131,15 @@ Batang
baz baz
Bazz Bazz
BBBBCCCCC BBBBCCCCC
bbc
bbd
BBDM BBDM
bbe
bbwe bbwe
bc bc
bca
bcb
bcc
bcount bcount
bcrypt bcrypt
bcx bcx
bcz bcz
bda
BEFOREPARENT BEFOREPARENT
beginthread beginthread
bfb
bgcolor bgcolor
bgfx bgfx
bgidx bgidx
@ -172,7 +153,6 @@ binplace
binplaced binplaced
bitcoin bitcoin
bitcrazed bitcrazed
bitfield
bitflag bitflag
bitmask bitmask
BITOPERATION BITOPERATION
@ -215,7 +195,6 @@ BValue
byref byref
bytearray bytearray
bytebuffer bytebuffer
caa
Cac Cac
callee callee
cang cang
@ -224,11 +203,8 @@ CARETBLINKINGENABLED
CARRIAGERETURN CARRIAGERETURN
cascadia cascadia
catid catid
carlos
zamora
cazamor cazamor
CBash CBash
cbb
cbegin cbegin
cbiex cbiex
CBN CBN
@ -249,12 +225,9 @@ CConversion
CCRT CCRT
cctype cctype
CDATA CDATA
CDBA
cdd cdd
CDE
cdecl cdecl
CDeclaration CDeclaration
cebb
CEdit CEdit
CELLSIZE CELLSIZE
cend cend
@ -502,14 +475,10 @@ dai
DATABLOCK DATABLOCK
DATAVIEW DATAVIEW
DATAW DATAW
dba
DBatch DBatch
dbb
dbcs dbcs
DBCSCHAR DBCSCHAR
DBCSFONT DBCSFONT
dbd
DBDCF
dbg dbg
DBGALL DBGALL
DBGCHARS DBGCHARS
@ -520,13 +489,11 @@ dblclk
DBlob DBlob
dbproj dbproj
DBUILD DBUILD
dcf
DColor DColor
DCOLORVALUE DCOLORVALUE
dcommon dcommon
DCompile DCompile
dcompiler dcompiler
ddb
dde dde
DDESHARE DDESHARE
DDevice DDevice
@ -616,7 +583,6 @@ devicefamily
devops devops
Dext Dext
df df
dfa
DFactory DFactory
dh dh
dialogbox dialogbox
@ -684,14 +650,9 @@ dxgidwm
dxinterop dxinterop
dxttbmp dxttbmp
eachother eachother
EAEC
eaf eaf
EASTEUROPE EASTEUROPE
eb eb
eba
ebce
EBFB
ECFB
ECH ECH
echokey echokey
ecount ecount
@ -701,8 +662,6 @@ EDITTEXT
EDITUPDATE EDITUPDATE
edputil edputil
edu edu
eeb
eee
Efast Efast
EHsc EHsc
EJO EJO
@ -712,8 +671,6 @@ Elems
elif elif
elseif elseif
emacs emacs
Emoji
Emojis
emptybox emptybox
enabledelayedexpansion enabledelayedexpansion
endian endian
@ -771,26 +728,17 @@ failfast
FAILIFTHERE FAILIFTHERE
fallthrough fallthrough
FARPROC FARPROC
fba
fbb
fbd
fbdc
FBE
fcb fcb
fcc
fcharset fcharset
fclose fclose
fcntl fcntl
fd
fdb
fdc fdc
fdd FDD
fde fde
fdopen fdopen
fdw fdw
fea fea
fesb fesb
ffc
FFDE FFDE
FFF FFF
FFrom FFrom
@ -936,7 +884,6 @@ Gfun
gfx gfx
gh gh
github github
githubusercontent
gitlab gitlab
gle gle
globals globals
@ -1029,7 +976,6 @@ hpp
HPR HPR
HPROPSHEETPAGE HPROPSHEETPAGE
HREDRAW HREDRAW
HREF
hresult hresult
HRSRC HRSRC
hscroll hscroll
@ -1397,7 +1343,6 @@ memallocator
memcmp memcmp
memcopy memcopy
memcpy memcpy
memcpying
memmove memmove
memset memset
MENUCHAR MENUCHAR
@ -1671,7 +1616,6 @@ Outof
OUTOFCONTEXT OUTOFCONTEXT
OUTOFMEMORY OUTOFMEMORY
outout outout
OUTPATHROOT
Outptr Outptr
Ov Ov
OVERLAPPEDWINDOW OVERLAPPEDWINDOW
@ -2231,7 +2175,6 @@ stgm
stl stl
stoi stoi
stol stol
storageitems
storelogo storelogo
stoul stoul
stoutapot stoutapot
@ -2337,7 +2280,6 @@ TEXCOORD
texel texel
textattribute textattribute
TEXTATTRIBUTEID TEXTATTRIBUTEID
textblock
Textbox Textbox
textboxes textboxes
textbuffer textbuffer
@ -2365,7 +2307,6 @@ TLEN
Tlg Tlg
Tlgdata Tlgdata
TMAE TMAE
tmp
TMPF TMPF
TMult TMult
tmultiple tmultiple
@ -2398,7 +2339,6 @@ TRACKCOMPOSITION
trackpad trackpad
transcoder transcoder
transitioning transitioning
trc
Trd Trd
TREX TREX
triaged triaged
@ -2519,7 +2459,6 @@ USESHOWWINDOW
USESIZE USESIZE
USESTDHANDLES USESTDHANDLES
ushort ushort
usr
USRDLL USRDLL
utf utf
utils utils
@ -2561,7 +2500,6 @@ vkey
VKKEYSCAN VKKEYSCAN
VMs VMs
VPA VPA
vpack
VPATH VPATH
VPR VPR
VPrintf VPrintf
@ -2742,7 +2680,6 @@ WRITECONSOLEINPUT
WRITECONSOLEOUTPUT WRITECONSOLEOUTPUT
WRITECONSOLEOUTPUTSTRING WRITECONSOLEOUTPUTSTRING
wrl wrl
wrn
wrp wrp
WRunoff WRunoff
WScript WScript

View File

@ -2,8 +2,10 @@ https://(?:(?:[-a-zA-Z0-9?&=]*\.|)microsoft\.com)/[-a-zA-Z0-9?&=_\/.]*
https://aka\.ms/[-a-zA-Z0-9?&=\/_]* https://aka\.ms/[-a-zA-Z0-9?&=\/_]*
https://www.w3.org/[-a-zA-Z0-9?&=\/_#]* https://www.w3.org/[-a-zA-Z0-9?&=\/_#]*
https://(?:(?:www\.|)youtube\.com|youtu.be)/[-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[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} microsoft/cascadia-code\@[0-9a-fA-F]{40}
\d+x\d+Logo \d+x\d+Logo
Scro\&ll Scro\&ll

View File

@ -1,7 +0,0 @@
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
* [whitelist](whitelist.txt) is the main whitelist -- there is nothing
particularly special about the file name (beyond the extension which is
important).

View File

@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v2.0.0 - uses: actions/checkout@v2.0.0
with: with:
fetch-depth: 5 fetch-depth: 5
- uses: check-spelling/check-spelling@0.0.15-alpha - uses: check-spelling/check-spelling@0.0.16-alpha
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
bucket: .github/actions bucket: .github/actions