Skip to content

Commit

Permalink
spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
@florelis
florelis committed Jul 31, 2024
1 parent 0a2b190 commit aea570f
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 14 deletions.
1 change: 1 addition & 0 deletions .github/actions/spelling/allow.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ appxsdk
APSTUDIO
ARRAYSIZE
artifactstagingdirectory
Asn
aspirational
AUTOLISTEN
azureedge
Expand Down
14 changes: 0 additions & 14 deletions .github/actions/spelling/expect.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ CLIE
CLOSEAPP
cloudapp
clsctx
clsid
cobertura
CODEOWNERS
COINIT
Expand Down Expand Up @@ -119,15 +118,13 @@ EFGH
EFile
efileresource
EMalicious
endregion
ENDSESSION
EPester
epth
EQU
ERRORONEXIT
ESource
ESRB
ests
etest
etl
execustom
Expand Down Expand Up @@ -227,7 +224,6 @@ learnxinyminutes
libfuzzer
libsolv
libyaml
Linq
liv
liwpx
localizationpriority
Expand Down Expand Up @@ -292,12 +288,10 @@ myinstalldir
mylog
mysilent
mysilentwithprogress
nameof
Nami
nativehandle
NBLGGH
NESTEDINSTALLER
netfx
netlify
NETSDK
Newtonsoft
Expand All @@ -317,7 +311,6 @@ NOSEARCH
NOSEPARATOR
notalostreference
NOTAPROPERTY
notmatch
NOTRACK
NOUPDATE
npmjs
Expand All @@ -328,15 +321,13 @@ objidl
ofile
omus
onefuzz
ools
oop
OPTOUT
OVERLAPPEDWINDOW
packageinuse
packageinusebyapplication
PACL
PARAMETERMAP
paramref
pathparts
Patil
PCCERT
Expand Down Expand Up @@ -398,7 +389,6 @@ roblox
ronomon
rosoft
Roronoa
rowids
roy
runspace
runtimeclass
Expand Down Expand Up @@ -457,7 +447,6 @@ taskhostw
TCpp
tcs
TEMPDIRECTORY
Templating
temppath
testdata
testexampleinstaller
Expand All @@ -474,7 +463,6 @@ TReturn
trimstart
TState
TStatus
typeparam
UCase
ucasemap
UChars
Expand All @@ -486,7 +474,6 @@ uninstallation
uninstaller
uninstallprevious
uninstalls
Unk
unknwn
Unknwnbase
UNMARSHALING
Expand All @@ -511,7 +498,6 @@ vstest
wcex
webpages
Webserver
websites
WERSJA
wesome
wfsopen
Expand Down

1 comment on commit aea570f

@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 for details.

Unrecognized words (14) 
clsid
endregion
ests
Linq
nameof
netfx
notmatch
ools
paramref
rowids
Templating
typeparam
Unk
websites
Previously acknowledged words that are now absent ata bitspace EPester epth hrow issuetitle mapview Mta oop PFM rzkzqaqjwj sfs STARTUPINFOW testdata visualstudiocode :arrow_right:
Some files were automatically ignored

These sample patterns would exclude them:

^\Qsrc/AppInstallerCLIE2ETests/TestData/AppInstallerTestMsiInstallerV2.msi\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 accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the git@github.com:florelis/winget-cli.git repository
on the downloader branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.21/apply.pl' |
perl - 'https://github.com/florelis/winget-cli/actions/runs/10187441093/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary

This includes both expected items (540) from .github/actions/spelling/expect.txt and unrecognized words (14)

Dictionary Entries Covers
cspell:win32/src/win32.txt 53509 20
cspell:python/src/python/python-lib.txt 3873 3
cspell:python/src/python/python.txt 453 2
cspell:python/src/common/extra.txt 741 2
cspell:php/php.txt 2597 2
cspell:npm/npm.txt 288 2
cspell:django/django.txt 859 2
cspell:csharp/csharp.txt 19 2
cspell:sql/src/tsql.txt 455 1
cspell:scala/scala.txt 833 1

Consider adding them using (in .github/workflows/spelling3.yml):

      with:
        extra_dictionaries:
          cspell:win32/src/win32.txt
          cspell:python/src/python/python-lib.txt
          cspell:python/src/python/python.txt
          cspell:python/src/common/extra.txt
          cspell:php/php.txt
          cspell:npm/npm.txt
          cspell:django/django.txt
          cspell:csharp/csharp.txt
          cspell:sql/src/tsql.txt
          cspell:scala/scala.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
Warnings (1)

See the 📜action log for details.

ℹ️ Warnings Count
ℹ️ binary-file 1

See ℹ️ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.