From 104099d4c82c8b5ad702d2f9c78f09fb138bf9d1 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Thu, 31 Aug 2023 11:54:03 -0400 Subject: [PATCH] Upgrade check-spelling to v0.0.22 Refresh metadata based on https://github.com/check-spelling/spell-check-this/tree/b968ca32e0e5961a85c7fe3e9431f81553c3f434/.github/actions/spelling --- .../actions/spell-check/candidate.patterns | 188 ++++++++++++++---- .github/actions/spell-check/expect.txt | 74 +------ .../spell-check/line_forbidden.patterns | 73 ++++++- .github/actions/spell-check/patterns.txt | 11 +- .github/actions/spell-check/reject.txt | 1 + .github/workflows/spelling3.yml | 26 ++- 6 files changed, 250 insertions(+), 123 deletions(-) diff --git a/.github/actions/spell-check/candidate.patterns b/.github/actions/spell-check/candidate.patterns index 5dcfee8b08..bf9dce0b12 100644 --- a/.github/actions/spell-check/candidate.patterns +++ b/.github/actions/spell-check/candidate.patterns @@ -1,23 +1,36 @@ # marker to ignore all code on line ^.*/\* #no-spell-check-line \*/.*$ -# marker for ignoring a comment to the end of the line -// #no-spell-check.*$ +# marker to ignore all code on line +^.*\bno-spell-check(?:-line|)(?:\s.*|)$ + +# https://cspell.org/configuration/document-settings/ +# cspell inline +^.*\b[Cc][Ss][Pp][Ee][Ll]{2}:\s*[Dd][Ii][Ss][Aa][Bb][Ll][Ee]-[Ll][Ii][Nn][Ee]\b # patch hunk comments ^\@\@ -\d+(?:,\d+|) \+\d+(?:,\d+|) \@\@ .* # git index header -index [0-9a-z]{7,40}\.\.[0-9a-z]{7,40} +index (?:[0-9a-z]{7,40},|)[0-9a-z]{7,40}\.\.[0-9a-z]{7,40} + +# file permissions +['"`\s][-bcdLlpsw](?:[-r][-w][-Ssx]){2}[-r][-w][-SsTtx]\+?['"`\s] + +# css url wrappings +#\burl\([^)]+\) # cid urls (['"])cid:.*?\g{-1} # data url in parens -\(data:[^)]*?(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})[^)]*\) +\(data:(?:[^) ][^)]*?|)(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})[^)]*\) # data url in quotes -([`'"])data:.*?(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,}).*\g{-1} +([`'"])data:(?:[^ `'"].*?|)(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,}).*\g{-1} # data url data:[-a-zA-Z=;:/0-9+]*,\S* +# https/http/file urls +#(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|] + # mailto urls mailto:[-a-zA-Z=;:/?%&0-9+@.]{3,} @@ -35,6 +48,9 @@ magnet:[?=:\w]+ # asciinema \basciinema\.org/a/[0-9a-zA-Z]+ +# asciinema v2 +^\[\d+\.\d+, "[io]", ".*"\]$ + # apple \bdeveloper\.apple\.com/[-\w?=/]+ # Apple music @@ -89,7 +105,7 @@ vpc-\w+ # Google Drive \bdrive\.google\.com/(?:file/d/|open)[-0-9a-zA-Z_?=]* # Google Groups -\bgroups\.google\.com/(?:(?:forum/#!|d/)(?:msg|topics?|searchin)|a)/[^/\s"]+/[-a-zA-Z0-9$]+(?:/[-a-zA-Z0-9]+)* +\bgroups\.google\.com(?:/[a-z]+/(?:#!|)[^/\s"]+)* # Google Maps \bmaps\.google\.com/maps\?[\w&;=]* # Google themes @@ -117,6 +133,8 @@ themes\.googleusercontent\.com/static/fonts/[^/\s"]+/v\d+/[^.]+. (?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|) # GitHub SHAs \bgithub\.com(?:/[^/\s"]+){2}[@#][0-9a-f]+\b +# GitHub SHA refs +\[([0-9a-f]+)\]\(https://(?:www\.|)github.com/[-\w]+/[-\w]+/commit/\g{-1}[0-9a-f]* # GitHub wiki \bgithub\.com/(?:[^/]+/){2}wiki/(?:(?:[^/]+/|)_history|[^/]+(?:/_compare|)/[0-9a-f.]{40,})\b # githubusercontent @@ -128,9 +146,9 @@ themes\.googleusercontent\.com/static/fonts/[^/\s"]+/v\d+/[^.]+. # git.io \bgit\.io/[0-9a-zA-Z]+ # GitHub JSON -"node_id": "[-a-zA-Z=;:/0-9+]*" +"node_id": "[-a-zA-Z=;:/0-9+_]*" # Contributor -\[[^\]]+\]\(https://github\.com/[^/\s"]+\) +\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\) # GHSA GHSA(?:-[0-9a-z]{4}){3} @@ -143,8 +161,8 @@ GHSA(?:-[0-9a-z]{4}){3} # GitLab commits \bgitlab\.[^/\s"]*/(?:[^/\s"]+/){2}commits?/[0-9a-f]+\b -# binanace -accounts.binance.com/[a-z/]*oauth/authorize\?[-0-9a-zA-Z&%]* +# binance +accounts\.binance\.com/[a-z/]*oauth/authorize\?[-0-9a-zA-Z&%]* # bitbucket diff \bapi\.bitbucket\.org/\d+\.\d+/repositories/(?:[^/\s"]+/){2}diff(?:stat|)(?:/[^/\s"]+){2}:[0-9a-f]+ @@ -280,9 +298,9 @@ slack://[a-zA-Z0-9?&=]+ \bdropbox\.com/sh?/[^/\s"]+/[-0-9A-Za-z_.%?=&;]+ # ipfs protocol -ipfs://[0-9a-z]* +ipfs://[0-9a-zA-Z]{3,} # ipfs url -/ipfs/[0-9a-z]* +/ipfs/[0-9a-zA-Z]{3,} # w3 \bw3\.org/[-0-9a-zA-Z/#.]+ @@ -308,6 +326,12 @@ ipfs://[0-9a-z]* # Wikipedia \ben\.wikipedia\.org/wiki/[-\w%.#]+ +# Contributors with non-ascii characters in their name +Hoffst[^[:ascii:]]+tte +Gri[^[:ascii:]] +Lundstr[^[:ascii:]]+m +Joaqu[^[:ascii:]]n + # gitweb [^"\s]+/gitweb/\S+;h=[0-9a-f]+ @@ -359,14 +383,22 @@ ipfs://[0-9a-z]* # tinyurl \btinyurl\.com/\w+ +# codepen +\bcodepen\.io/[\w/]+ + +# registry.npmjs.org +\bregistry\.npmjs\.org/(?:@[^/"']+/|)[^/"']+/-/[-\w@.]+ + # getopts \bgetopts\s+(?:"[^"]+"|'[^']+') # ANSI color codes -(?:\\(?:u00|x)1b|\x1b)\[\d+(?:;\d+|)m +(?:\\(?:u00|x)1[Bb]|\x1b|\\u\{1[Bb]\})\[\d+(?:;\d+|)m # URL escaped characters \%[0-9A-F][A-F] +# lower URL escaped characters +\%[0-9a-f][a-f](?=[a-z]{2,}) # IPv6 \b(?:[0-9a-fA-F]{0,4}:){3,7}[0-9a-fA-F]{0,4}\b # c99 hex digits (not the full format, just one I've seen) @@ -376,7 +408,7 @@ ipfs://[0-9a-z]* # sha sha\d+:[0-9]*[a-f]{3,}[0-9a-f]* # sha-... -- uses a fancy capture -(['"]|")[0-9a-f]{40,}\g{-1} +(\\?['"]|")[0-9a-f]{40,}\g{-1} # hex runs \b[0-9a-fA-F]{16,}\b # hex in url queries @@ -391,18 +423,21 @@ sha\d+:[0-9]*[a-f]{3,}[0-9a-f]* # Well known gpg keys .well-known/openpgpkey/[\w./]+ +# pki +-----BEGIN.*-----END + # uuid: \b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b # 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}|u\d+)\b +(?:[\\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 # integrity -integrity="sha\d+-[-a-zA-Z=;:/0-9+]{40,}" +integrity=(['"])(?:\s*sha\d+-[-a-zA-Z=;:/0-9+]{40,})+\g{-1} # https://www.gnu.org/software/groff/manual/groff.html # man troff content \\f[BCIPR] -# ' -\\\(aq +# '/" +\\\([ad]q # .desktop mime types ^MimeTypes?=.*$ @@ -411,21 +446,33 @@ integrity="sha\d+-[-a-zA-Z=;:/0-9+]{40,}" # Localized .desktop content Name\[[^\]]+\]=.* -# IServiceProvider -#\bI(?=(?:[A-Z][a-z]{2,})+\b) +# IServiceProvider / isAThing +#\b(?:I|isA)(?=(?:[A-Z][a-z]{2,})+\b) # crypt -"\$2[ayb]\$.{56}" +(['"])\$2[ayb]\$.{56}\g{-1} # scrypt / argon \$(?:scrypt|argon\d+[di]*)\$\S+ +# go.sum +#\bh1:\S+ + +# scala modules +("[^"]+"\s*%%?\s*){2,3}"[^"]+" + # Input to GitHub JSON -content: "[-a-zA-Z=;:/0-9+]*=" +content: (['"])[-a-zA-Z=;:/0-9+]*=\g{-1} -# Python stringprefix / binaryprefix +# This does not cover multiline strings, if your repository has them, +# you'll want to remove the `(?=.*?")` suffix. +# The `(?=.*?")` suffix should limit the false positives rate +# printf +%(?:(?:(?:hh?|ll?|[jzt])?[diuoxn]|l?[cs]|L?[fega]|p)(?=[a-z]{2,})|(?:X|L?[FEGA]|p)(?=[a-zA-Z]{2,}))(?=[_a-zA-Z]+\b)(?!%)(?=.*?['"]) + +# Python string prefix / binary prefix # Note that there's a high false positive rate, remove the `?=` and search for the regex to see if the matches seem like reasonable strings -(?|m([|!/@#,;']).*?\g{-1}) + +# perl qr regex +(?|\(.*?\)|([|!/@#,;']).*?\g{-1}) # Go regular expressions regexp?\.MustCompile\(`[^`]*`\) +# regex choice +\(\?:[^)]+\|[^)]+\) + +# proto +^\s*(\w+)\s\g{-1} = + # sed regular expressions sed 's/(?:[^/]*?[a-zA-Z]{3,}[^/]*?/){2} +# node packages +(["'])\@[^/'" ]+/[^/'" ]+\g{-1} + # go install go install(?:\s+[a-z]+\.[-@\w/.]+)+ @@ -462,19 +525,47 @@ go install(?:\s+[a-z]+\.[-@\w/.]+)+ -[0-9a-f]{10}-\w{5}\s # posthog secrets -posthog\.init\((['"])phc_[^"',]+\g{-1}, +([`'"])phc_[^"',]+\g{-1} # xcode # xcodeproject scenes -(?:Controller|ID|id)="\w{3}-\w{2}-\w{3}" +(?:Controller|destination|ID|id)="\w{3}-\w{2}-\w{3}" # xcode api botches customObjectInstantitationMethod +# configure flags +.* \| --\w{2,}.*?(?=\w+\s\w+) + # font awesome classes \.fa-[-a-z0-9]+ +# bearer auth +(['"])Bear[e][r] .*?\g{-1} + +# basic auth +(['"])Basic [-a-zA-Z=;:/0-9+]{3,}\g{-1} + +# base64 encoded content +([`'"])[-a-zA-Z=;:/0-9+]+==\g{-1} +# base64 encoded content in xml/sgml +>[-a-zA-Z=;:/0-9+]+== 0.0.22) +\\\w{2,}\{ + +# eslint +"varsIgnorePattern": ".+" + +# Windows short paths +[/\\][^/\\]{5,6}~\d{1,2}[/\\] + +# in a version of check-spelling after @0.0.21 printf markers won't be automatically consumed +# printf markers +(?v# (?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_])) -# Compiler flags (Scala) -(?:^|[\t ,>"'`=(])-J-[DPWXY](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) -# Compiler flags -#(?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) + +# Compiler flags (Unix, Java/Scala) +# Use if you have things like `-Pdocker` and want to treat them as `docker` +#(?:^|[\t ,>"'`=(])-(?:(?:J-|)[DPWXY]|[Llf])(?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) + +# Compiler flags (Windows / PowerShell) +# This is a subset of the more general compiler flags pattern. +# It avoids matching `-Path` to prevent it from being treated as `ath` +#(?:^|[\t ,"'`=(])-(?:[DPL](?=[A-Z]{2,})|[WXYlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})) # Compiler flags (linker) ,-B + # curl arguments \b(?:\\n|)curl(?:\s+-[a-zA-Z]{1,2}\b)*(?:\s+-[a-zA-Z]{3,})(?:\s+-[a-zA-Z]+)* # set arguments diff --git a/.github/actions/spell-check/expect.txt b/.github/actions/spell-check/expect.txt index fd2ba46eee..84780bfea2 100644 --- a/.github/actions/spell-check/expect.txt +++ b/.github/actions/spell-check/expect.txt @@ -1,6 +1,5 @@ aaaarecord aaldering -abi aborttransaction Abraitis ACLTo @@ -26,7 +25,6 @@ alexa algoroll allocs Altpeter -amd Anderton anewid anid @@ -53,8 +51,6 @@ Ascio Asenov ASEP Ashish -asnum -aspx associateddomain asyncresolve Atlassian @@ -175,7 +171,6 @@ cds Cegetel Cerb certusage -CFLAGS CGNAT changeme changetype @@ -191,13 +186,13 @@ Cloos closesocket clusions cmouse -cmsg cmsghdr -cname +cmsgs cnamechainresolution CNAMEd CNAMEDNS cnamerecord +cnames cnf cnn cockroachlabs @@ -215,12 +210,10 @@ conaxis configfile configname configsetting -configurability confs conntrack Conntracking Consolas -constexpr controllen controlsocket coprocess @@ -231,7 +224,6 @@ corpit costypetrisor coverity cppcheck -createdb createslavedomain Cremers criteo @@ -266,7 +258,6 @@ dbfile dblfilename dbpf dbr -DBX dcobject ddns deactivatedomainkey @@ -279,7 +270,6 @@ defpol defttl Dehaine DENIC -deref descclassname descname Dessel @@ -299,7 +289,6 @@ dilinger Dimitrios Directi Disqus -distro djbdns dlerror dlg @@ -321,7 +310,6 @@ dnsdomain dnsext dnsgram dnskey -dnsmessage dnsname dnsnameset dnsop @@ -348,9 +336,7 @@ dnszone Dobrawy docdefault docnamecachelookup -documentclass documentwrapper -dofile Dohmen domaininfo domainmetadata @@ -386,7 +372,6 @@ ech econds ECSDA ecswho -EDE editline edns ednsbufsiz @@ -398,7 +383,6 @@ edu ejones Ekkelenkamp elgoog -Emph Enden ent envoutput @@ -421,7 +405,6 @@ ezdns Faerch failedservers farsightsec -fcgi fcontext fedoraproject feedents @@ -436,7 +419,6 @@ firewalled firewalls fixednow Florus -fontname footerbgcolor footertextcolor forfun @@ -463,7 +445,6 @@ gaba gacogne gatech Gavarret -gcc gdpr Geijn genindex @@ -482,7 +463,6 @@ getcarbonhostname getdomaininfo getdomainkeys getdomainmetadata -gethostname getifaddrs getlocaladdress getn @@ -490,7 +470,6 @@ getrandom getregisteredname gettag gettime -gettimeofday gettsigkey Geuze GFm @@ -522,7 +501,6 @@ gsql gsqlite gss gssapi -gsub gtld guilabel Gyselinck @@ -559,7 +537,6 @@ Houtworm howto hpecorp hpiers -hpp htbp htmlescape htmlhelp @@ -568,17 +545,14 @@ httpdomain hubert iana icann -ico ict idprotect -idx iers ietf ifportup ifurlextup ifurlup ihsinme -illumos Imhard incbin includeboilerplate @@ -602,11 +576,11 @@ ipencrypt ipfilter IPSECKEY iputils +irc isane ismaster isoc -isp -ispell +ISPs isql ixfr ixfrdist @@ -622,7 +596,6 @@ Jelte Jermar Jeroen jessie -Joaqu jonathaneen Jong Jorn @@ -642,7 +615,6 @@ Kerkhof KEYBITS keyblock keydir -keyfile keyname keypair keypairgen @@ -704,7 +676,6 @@ letterpaper libatomic libcrypto libcryptopp -libcurl libdecaf libdir libedit @@ -779,7 +750,6 @@ malcrafted mallocs malware Mamane -manpages mapasync Mapbox mariadb @@ -815,7 +785,6 @@ Milas Mimimization minbody mindex -MINFO minipatch Mischan mjt @@ -861,7 +830,6 @@ mysqld myuser mywebapp namedroppers -nameserver nameserving naptr Nauck @@ -898,7 +866,6 @@ noaction noad noall nocookie -NODELAY noedns noerrors NOLOCK @@ -912,7 +879,6 @@ noout noping noport norve -nosniff nostrip NOSUBDIR nosync @@ -950,7 +916,6 @@ obidos objectclass Obser obspm -odbc odbcbackend odbcinst Oddy @@ -966,6 +931,7 @@ opendbx openpgpkey openports opensc +opensuse openwall Opmeer OPNUM @@ -992,8 +958,6 @@ packethandler papersize paramater PARAMKEYWORDS -passthrough -passthru PATC patchlevels pathconfig @@ -1023,7 +987,6 @@ pgmysql pgmysqlbackend pgp pgpsql -pgsql phishing phonedph pickclosest @@ -1071,9 +1034,7 @@ PRId primetime princ prioritization -privatekey privs -progid protobuf protozero providername @@ -1084,7 +1045,6 @@ pseudonymize pseudorecord pthread ptrrecord -ptrs Publieke publishdomainkey pullreq @@ -1097,7 +1057,6 @@ qlen Qlim qname qperq -qps QPSIP qpslimits QRate @@ -1161,7 +1120,7 @@ removedomainkey replacerrset requery resolv -respawn +respawned respawning respout respsizes @@ -1170,6 +1129,7 @@ retransfering reuseds reuseport RFCs +rhel Rietz rightsidebar Rijsdijk @@ -1181,13 +1141,11 @@ rocommunity Roel Rosmalen roundrobin -RPATH rping rpms rpz rpzstatistics rrcontent -rrd rrdata rrdtool rrname @@ -1250,7 +1208,6 @@ shnya showdetails showflags Shukla -sid sidebarbgcolor sidebarbtncolor sidebarbutton @@ -1267,7 +1224,6 @@ Signingpiper signpipe signttl signzone -sigs singlethreaded Sipek siphash @@ -1282,8 +1238,6 @@ smn Smurthwaite Snarked sndbuf -snmp -snmpd snprintf soa soadata @@ -1317,7 +1271,6 @@ srandom srcname SRecord Srule -srv sshfp ssi SSQ @@ -1342,12 +1295,10 @@ Storesund stou strcasestr stringmatch -strpos stubquery stubresolver Stussy stutiredboy -subdomain subkey submitters subnetmask @@ -1390,7 +1341,6 @@ tds teeaction Telenet testsdir -textcolor Tful thel thelog @@ -1418,7 +1368,6 @@ toctree todos toint tokenuser -tolower Tolstov Toosarani Toshifumi @@ -1429,7 +1378,6 @@ trusteer trx trxid TSAN -tsc tsig tsigalgo tsigkey @@ -1446,7 +1394,6 @@ Tushuizen Tuxis TVJRU tylerneylon -typedefs typenames ualberta udpqueryresponse @@ -1457,7 +1404,6 @@ UIDs Uisms unauth unbreak -uncached unescaping unfresh unhash @@ -1480,10 +1426,8 @@ upgradeable upperalpha upperroman urandom -usec usecase userbase -userspace uwaterloo Valentei Valentini @@ -1532,7 +1476,6 @@ Wielicki Wijk Wijnand Wijngaards -wikipedia wil wildcarded Willcott @@ -1543,7 +1486,7 @@ wirelength Wisiol wmem Wojas -workaround +workarounds Worldnic would've wouter @@ -1571,7 +1514,6 @@ Yehuda yeswehack Yiu Ylitalo -yml YMMV Yogesh yourcompany diff --git a/.github/actions/spell-check/line_forbidden.patterns b/.github/actions/spell-check/line_forbidden.patterns index 9050d6614c..df82a713d0 100644 --- a/.github/actions/spell-check/line_forbidden.patterns +++ b/.github/actions/spell-check/line_forbidden.patterns @@ -1,4 +1,6 @@ -# reject `m_data` as there's a certain OS which has evil defines that break things if it's used elsewhere +# reject `m_data` as VxWorks defined it and that breaks things if it's used elsewhere +# see [fprime](https://github.com/nasa/fprime/commit/d589f0a25c59ea9a800d851ea84c2f5df02fb529) +# and [Qt](https://github.com/qtproject/qt-solutions/blame/fb7bc42bfcc578ff3fa3b9ca21a41e96eb37c1c7/qtscriptclassic/src/qscriptbuffer_p.h#L46) # \bm_data\b # If you have a framework that uses `it()` for testing and `fit()` for debugging a specific test, @@ -6,40 +8,72 @@ # to use this: #\bfit\( +# s.b. anymore +\bany more[,.] + # s.b. GitHub -\bGithub\b +(?