Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add spellcheck workflow #32

Closed
wants to merge 1 commit into from
Closed

Add spellcheck workflow #32

wants to merge 1 commit into from

Conversation

bobbyiliev
Copy link
Contributor

No description provided.

@bobbyiliev bobbyiliev force-pushed the spellcheck-workflow branch from e7001ab to 8988693 Compare June 7, 2024 18:14
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@@ -0,0 +1,74 @@
name: Check Spelling

Check failure

Code scanning / check-spelling

Check File Path Error

spellcheck is not a recognized word. (check-file-path)
@@ -0,0 +1,74 @@
name: Check Spelling

Check failure

Code scanning / check-spelling

Check File Path Error

workflows is not a recognized word. (check-file-path)
@@ -0,0 +1,74 @@
name: Check Spelling

Check failure

Code scanning / check-spelling

Check File Path Error

yml is not a recognized word. (check-file-path)
Copy link

github-actions bot commented Jun 7, 2024

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (145)
authenticaiton
autofocus
autoload
autoprefixer
BBCFDA
bezier
bitbucket
blockquote
bugzilla
calebporzio
ccircle
cdn
cdnjs
cgi
checkbox
clickable
cloudflare
codeat
codemirror
Consolas
cpath
csrf
cssremedy
csvg
ctype
datetime
dbal
devdojo
devdojoauth
Dispatchable
documenation
eacd
Emoji
enderror
endfor
endforeach
endphp
endvolt
evenodd
evt
facebook
fafafa
FBBC
FFBA
fff
fieldset
Firefox
floatval
focusring
fullscreen
gitlab
google
grayscale
helloworld
hexdec
iframe
Imagick
img
Inisde
isntalled
isset
issuecomment
jensimmons
kbd
keydown
keyframes
larastan
laravel
linecap
linejoin
linkedin
linted
livewire
Longtoken
maxlength
mbstring
microsoft
minmax
moz
mozdevs
mozilla
mysql
Noto
nowrap
nunomaduro
onclick
opensource
optgroup
osx
OTP
packagist
pathinfo
pestphp
phpstan
phpunit
pickr
pinterest
plug'n
popperjs
postcss
pragmarx
Provder
psr
qrcode
reddit
rgb
rgba
rollup
rtl
scm
Segoe
shivammathur
skillsets
sourced
spellcheck
sqlite
stefanzweifel
strlen
strtoupper
styleci
stylesheet
subheadline
substr
svg
Symfony
tailwindcss
tailwindlabs
testbench
testsuite
textareas
thedevdojo
Tik
tiktok
timestamped
Tok
tonylea
ucwords
uniqid
unpkg
utf
utm
workflows
xsd
xsi
yml
Some files were automatically ignored 🙈

These sample patterns would exclude them:

^\Q.phpunit.cache/test-results\E$
^\Qpublic/build/assets/scripts.js\E$
^\Qresources/views/components/setup/button.blade.php\E$
^resources/views/includes/setup/icons/

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 update file exclusions, you could run the following commands

... in a clone of the [email protected]:thedevdojo/auth.git repository
on the spellcheck-workflow branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/thedevdojo/auth/actions/runs/9421372425/attempts/1'

OR

To have the bot accept them for you, reply quoting the following line:
@check-spelling-bot apply updates.

Available 📚 dictionaries could cover words not in the 📘 dictionary
Dictionary Entries Covers Uniquely
cspell:php/dict/php.txt 1689 25 8
cspell:css/dict/css.txt 263 23 3
cspell:typescript/dict/typescript.txt 1098 18 1
cspell:html/dict/html.txt 2060 16
cspell:fullstack/dict/fullstack.txt 419 11 1

Consider adding them (in .github/workflows/spellcheck.yml) for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries:
          cspell:php/dict/php.txt
          cspell:css/dict/css.txt
          cspell:typescript/dict/typescript.txt
          cspell:html/dict/html.txt
          cspell:fullstack/dict/fullstack.txt

To stop checking additional dictionaries, add (in .github/workflows/spellcheck.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Pattern suggestions ✂️ (17)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns
# hit-count: 77 file-count: 22
# https/http/file urls
(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]

# hit-count: 41 file-count: 2
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|[iu]\d+)\b

# hit-count: 32 file-count: 14
# w3
\bw3\.org/[-0-9a-zA-Z/#.]+

# hit-count: 14 file-count: 8
# css url wrappings
\burl\([^)]+\)

# hit-count: 9 file-count: 2
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)

# hit-count: 8 file-count: 1
# lower URL escaped characters
%[0-9a-f][a-f](?=[a-z]{2,})

# hit-count: 5 file-count: 2
# data url in quotes
([`'"])data:(?:[^ `'"].*?|)(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,}).*\g{-1}

# hit-count: 5 file-count: 2
# data url
\bdata:[-a-zA-Z=;:/0-9+]*,\S*

# hit-count: 5 file-count: 2
# libraries
\blib(?!rar(?:i(?:an|es)|y))(?=[a-z])

# hit-count: 4 file-count: 3
# GitHub actions
\buses:\s+[-\w.]+/[-\w./]+@[-\w.]+

# hit-count: 4 file-count: 1
# cdn.cloudflare.com
\bcdnjs\.cloudflare\.com/[./\w]+

# hit-count: 3 file-count: 3
# in [email protected]+, printf markers aren't automatically consumed
# printf markers
(?<!\\)\\[nrt](?=[a-z]{2,})

# hit-count: 3 file-count: 2
# scala imports
^import (?:[\w.]|\{\w*?(?:,\s*(?:\w*|\*))+\})+

# hit-count: 3 file-count: 1
# shields.io
\bshields\.io/[-\w/%?=&.:+;,]*

# hit-count: 1 file-count: 1
# hex runs
\b[0-9a-fA-F]{16,}\b

# hit-count: 1 file-count: 1
# C network byte conversions
(?:\d|\bh)to(?!ken)(?=[a-z])|to(?=[adhiklpun]\()

# hit-count: 1 file-count: 1
# node packages
(["'])@[^/'" ]+/[^/'" ]+\g{-1}

Errors (6)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors Count
ℹ️ binary-file 1
ℹ️ candidate-pattern 33
❌ check-file-path 35
❌ forbidden-pattern 4
ℹ️ minified-file 5
❌ slow-file 2

See ❌ Event descriptions for more information.

@bobbyiliev bobbyiliev closed this Jun 7, 2024
@bobbyiliev bobbyiliev deleted the spellcheck-workflow branch June 7, 2024 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant