From 2008c3ed0d2e531e25010b0e70cd55c7b48f0246 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Thu, 28 Nov 2024 21:59:06 -0500 Subject: [PATCH] Add check-spelling --- .github/actions/spelling/README.md | 3 +- .github/actions/spelling/allow.txt | 429 +---------- .../actions/spelling/block-delimiters.list | 27 + .github/actions/spelling/candidate.patterns | 82 ++- .github/actions/spelling/excludes.txt | 50 +- .github/actions/spelling/expect.txt | 669 ------------------ .../actions/spelling/line_forbidden.patterns | 100 ++- .github/actions/spelling/patterns.txt | 208 ++---- .github/actions/spelling/reject.txt | 1 + .github/workflows/spelling3.yml | 41 +- 10 files changed, 313 insertions(+), 1297 deletions(-) create mode 100644 .github/actions/spelling/block-delimiters.list diff --git a/.github/actions/spelling/README.md b/.github/actions/spelling/README.md index 01bb8c2e1e0..da6f2e9d9b5 100644 --- a/.github/actions/spelling/README.md +++ b/.github/actions/spelling/README.md @@ -12,6 +12,7 @@ File | Purpose | Format | Info [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) +[block-delimiters.list](block-delimiters.list) | Define block begin/end markers to ignore lines of text | line with _literal string_ for **start** followed by line with _literal string_ for **end** | [block ignore](https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Block-Ignore#status) 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. +and then include multiple files inside that directory (with that suffix) to merge multiple files together. diff --git a/.github/actions/spelling/allow.txt b/.github/actions/spelling/allow.txt index 0776f0427dd..61567618d82 100644 --- a/.github/actions/spelling/allow.txt +++ b/.github/actions/spelling/allow.txt @@ -1,424 +1,5 @@ -ACTIONDATA -ACTIONSTART -activatable -addfile -addmanifest -addpin -addportablefile -addstore -admins -AFX -appinstaller -appmodel -appxbundle -appxbundles -appxrecipe -appxsdk -APSTUDIO -ARRAYSIZE -artifactstagingdirectory -Asn -aspirational -Authenticode -AUTOLISTEN -azureedge -binlog -binver -bstr -BUILDNUMBER -bytearray -cdn -cer -certutil -cfr -cguid -checkbox -cla -CLASSNOTAVAILABLE -clsids -cmake -CNG -COMMANDBARFLYOUT -COMMONDATA -comparand -conemu -contoso -COSTDEFERRED -cotaskmem -cpprest -cpprestsdk -cppwinrt -createnew -createpintable -createportabletable -createtables -CRTDECL -CTLs -curated -CURSORPOSITON -CUSTOMHEADER -cvd -datatelemetry -datetime -dbconn -DBId -debugbreak -defaultlocale -delstore -Demitrius -denelon -depersist -differentpath -DIRECTONLY -DISMAPI -distro -dllmain -dotnet -downloaders -dsx -DWORDLONG -emoji -ENDDIALOG -ensureandinsert -ensurepathexists -entra -ENU -EOAC -errorlevel -ESRP -etstandard -ETW -EULA -EVENTTAG -EWX -exeenus -exeinteractive -exelog -exesilent -exeswp -EXTRADEBUG -EXTRAFLAGS -FAILIFTHERE -fakeswitch -FATALEXIT -FIELDTAG -FILEFLAGS -FILEFLAGSMASK -FILEOS -FILESINUSE -FILESUBTYPE -FILEVERSION -florelis -FLUSHEACHLINE -forcerestart -gdi -HCCE -hcertstore -HCRYPTMSG -HGlobal -HGLOBAL -HIDECANCEL -hinternet -HKCU -HKLM -hresult -HRSRC -hstring -IAppx -ICheckpoint -IConfiguration -IFACEMETHOD -ifspec -IInspectable -inapplicabilities -inheritdoc -inno -Inq -installertype -Installeruniqueness -installlocation -INSTALLLOGATTRIBUTES -INSTALLLOGMODE -INSTALLPATH -INSTALLUILEVEL -INVALIDARG -INVALIDSID -iot -IPinning -ipmo -IPortable -ISAPPROVEDFOROUTPUT -IUnknown -langutil -lastwritetime -LCIDTo -lnk -LOGONLYONERROR -LOGPATH -LOGPERFORMANCE -logsql -logto -LPCGUID -LPCSTR -Luid -makeappx -MAKEINTRESOURCE -makemsix -MANIFESTSCHEMA -MANIFESTVERSION -meme -metadatas -Minimatch -Moq -motw -mrm -msdata -MSHCTX -MSHLFLAGS -msiexec -msix -msixbundle -msixinfo -msixsdk -msixsdkx -msixtest -msrc -Multifile -Multimatch -ncacn -Nelon -netstandard -newid -NOCASE -NOCLOSEPROCESS -nodiscard -NOMINMAX -nonexistentsetting -norestart -normalizednameandpublisher -normalizedpackagenameandpublisher -notcontains -NTAPI -NTSTATUS -nullsoft -nunit -nupkg -OAuth -ODR -opencode -openxmlformats -OSVERSIONINFOEXW -OUTOFDISKSPACE -OUTOFPROC -packagefamilyname -packageidentifier -packagename -PACKAGESSCHEMA -paket -Params -params -parentidx -pathpart -Pathto -PBYTE -pch -PCWSTR -PEVENT -pfns -pfp -PII -pinnable -pinningindex -pipssource -Pkcs -portableindex -powertoys -pplx -ppv -PRECONFIG -preindexed -prepareforpackaging -prepopulate -prepopulated -prioritization -processthreadsapi -PRODUCTNAME -PRODUCTVERSION -PROGRESSONLY -promptrestart -PROPERTYDUMP -protseq -PTOKEN -publiccontainer -PUCHAR -pwa -QCol -Qspectre -rclsid -REBOOTPROMPT -Redistributable -REFCLSID -removemanifest -removepin -removeportablefile -repolibtest -requeue -rescap -resetpins -resheader -resmimetype -RESOLVESOURCE -RESTAPI -RESTARTAPPS -resw -resx -rethrowing -roadmap -robuffer -rowcount -rubengustorage -ruleset -runas -runsettings -SANITIZERS -Screenshot -screenshots -SCROLLVIEWER -seinfo -SERVICEPACKMAJOR -SERVICEPACKMINOR -setschemaversion -setupexitcodes -setvariable -shcore -SHELLEXEC -SHELLEXECUTEINFOW -shlobj -Shlwapi -SHTDN -shtypes -signtool -silentwithprogress -Silverlight -simplesave -simpletest -sixel -sixels -sln -sqlbuilder -sqliteicu -sqliteindex -sqliteindexsource -sqlitewrapper -srwlock -STARTUPINFO -STATEACTION -STATFLAG -STATSTG -STDAPI -STGM -storeedgefd -stpkgmanvalwestustest -STRINGID -STRINGIZE -STRSAFE -subcontext -SUBLANG -subresource -subselect -substr -SUPPRESSMSGBOXES -SWIPECONTROL -SYMED -symlinktarget -TARGETDIR -targetentrypoint -targetnametoken -tdbuild -tdd -tempdb -terabyte -testcontainer -testmoniker -TESTPORTABLEFILE -Testrun -testsettingname -TEXTFORMAT -TEXTINCLUDE -threadpool -tpl -TRACELOGGING -triaged -TRUSTEDPEOPLE -UAC -UACONLY -uap -UBool -UBreak -ubrk -ucol -UCollation -UCollator -UError -UIF -ULARGE -und -UNICODESTRING -uninstalling -Unmarshal -unskipped -untimes -updatefile -updatemanifest -updatepin -updateportablefile -UPLEVEL -uregex -URegular -urlmon -USEREXIT -userguide -usersources -utext -valijson -vcpkg -vcvars -vcxitems -VERYSILENT -VFT -visualstudio -VOS -vso -wapproj -wcsicmp -webpage -WHOLECHAIN -wil -windbg -wincrypt -WINEVENT -winget -winhttp -wininet -winmd -winmeta -winres -winrt -winsqlite -WINTRUST -wix -wmain -WNS -woah -workflows -wpfn -wrl -WTD -wtypesbase -Xamarin -Xbox -XElement -Xlang -XResource -XTOKEN -xunit +github +https +ssh +ubuntu +workarounds diff --git a/.github/actions/spelling/block-delimiters.list b/.github/actions/spelling/block-delimiters.list new file mode 100644 index 00000000000..e6f7a1e6672 --- /dev/null +++ b/.github/actions/spelling/block-delimiters.list @@ -0,0 +1,27 @@ +# Public Keys +-----BEGIN PUBLIC KEY----- +-----END PUBLIC KEY----- + +# Private Keys +-----BEGIN PRIVATE KEY----- +-----END PRIVATE KEY----- + +# RSA Private Key +-----BEGIN RSA PRIVATE KEY----- +-----END RSA PRIVATE KEY----- + +# GPG Public Key +-----BEGIN PGP PUBLIC KEY BLOCK----- +-----END PGP PUBLIC KEY BLOCK----- + +# GPG Signature +-----BEGIN PGP SIGNATURE----- +-----END PGP SIGNATURE----- + +# Certificates +-----BEGIN CERTIFICATE----- +-----END CERTIFICATE----- + +# All Contributors +