From 3745a78d7b6b357fd5958b465a4a95912a101b3e Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 22 Nov 2023 11:00:08 -0500 Subject: [PATCH] Add check-spelling --- .github/actions/spelling/README.md | 17 + .github/actions/spelling/advice.md | 31 + .github/actions/spelling/allow.txt | 5 + .github/actions/spelling/candidate.patterns | 642 +++++++++ .github/actions/spelling/excludes.txt | 100 ++ .github/actions/spelling/expect.txt | 1146 +++++++++++++++++ .../actions/spelling/line_forbidden.patterns | 134 ++ .github/actions/spelling/patterns.txt | 94 ++ .github/actions/spelling/reject.txt | 11 + .github/workflows/spelling.yml | 155 +++ 10 files changed, 2335 insertions(+) create mode 100644 .github/actions/spelling/README.md create mode 100644 .github/actions/spelling/advice.md create mode 100644 .github/actions/spelling/allow.txt create mode 100644 .github/actions/spelling/candidate.patterns create mode 100644 .github/actions/spelling/excludes.txt create mode 100644 .github/actions/spelling/expect.txt create mode 100644 .github/actions/spelling/line_forbidden.patterns create mode 100644 .github/actions/spelling/patterns.txt create mode 100644 .github/actions/spelling/reject.txt create mode 100644 .github/workflows/spelling.yml diff --git a/.github/actions/spelling/README.md b/.github/actions/spelling/README.md new file mode 100644 index 00000000000..1f699f3de3d --- /dev/null +++ b/.github/actions/spelling/README.md @@ -0,0 +1,17 @@ +# check-spelling/check-spelling configuration + +File | Purpose | Format | Info +-|-|-|- +[dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary) +[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow) +[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject) +[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) +[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only) +[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) +[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns) +[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) + +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 together. diff --git a/.github/actions/spelling/advice.md b/.github/actions/spelling/advice.md new file mode 100644 index 00000000000..a32d1090aaf --- /dev/null +++ b/.github/actions/spelling/advice.md @@ -0,0 +1,31 @@ + +
If the flagged items are :exploding_head: 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]( +https://www.regexplanet.com/advanced/perl/) 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]( +../tree/HEAD/README.md) (on whichever branch you're using). + +* well-formed pattern. + + If you can write a [pattern]( +https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns +) that would match it, + try adding it to the `patterns.txt` file. + + Patterns are Perl 5 Regular Expressions - you can [test]( +https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. + + Note that patterns can't match multiline strings. + +
+ + +:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling, +please merge to your PR's base branch to get the version configured for your repository. diff --git a/.github/actions/spelling/allow.txt b/.github/actions/spelling/allow.txt new file mode 100644 index 00000000000..61567618d82 --- /dev/null +++ b/.github/actions/spelling/allow.txt @@ -0,0 +1,5 @@ +github +https +ssh +ubuntu +workarounds diff --git a/.github/actions/spelling/candidate.patterns b/.github/actions/spelling/candidate.patterns new file mode 100644 index 00000000000..46c151ed6d3 --- /dev/null +++ b/.github/actions/spelling/candidate.patterns @@ -0,0 +1,642 @@ +# marker to ignore all code on line +^.*/\* #no-spell-check-line \*/.*$ +# 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}\.\.[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 url in quotes +([`'"])data:(?:[^ `'"].*?|)(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,}).*\g{-1} +# data url +\bdata:[-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,} + +# magnet urls +magnet:[?=:\w]+ + +# magnet urls +"magnet:[^"]+" + +# obs: +"obs:[^"]*" + +# The `\b` here means a break, it's the fancy way to handle urls, but it makes things harder to read +# In this examples content, I'm using a number of different ways to match things to show various approaches +# asciinema +\basciinema\.org/a/[0-9a-zA-Z]+ + +# asciinema v2 +^\[\d+\.\d+, "[io]", ".*"\]$ + +# apple +\bdeveloper\.apple\.com/[-\w?=/]+ +# Apple music +\bembed\.music\.apple\.com/fr/playlist/usr-share/[-\w.]+ + +# appveyor api +\bci\.appveyor\.com/api/projects/status/[0-9a-z]+ +# appveyor project +\bci\.appveyor\.com/project/(?:[^/\s"]*/){2}builds?/\d+/job/[0-9a-z]+ + +# Amazon + +# Amazon +\bamazon\.com/[-\w]+/(?:dp/[0-9A-Z]+|) +# AWS S3 +\b\w*\.s3[^.]*\.amazonaws\.com/[-\w/&#%_?:=]* +# AWS execute-api +\b[0-9a-z]{10}\.execute-api\.[-0-9a-z]+\.amazonaws\.com\b +# AWS ELB +\b\w+\.[-0-9a-z]+\.elb\.amazonaws\.com\b +# AWS SNS +\bsns\.[-0-9a-z]+.amazonaws\.com/[-\w/&#%_?:=]* +# AWS VPC +vpc-\w+ + +# While you could try to match `http://` and `https://` by using `s?` in `https?://`, sometimes there +# YouTube url +\b(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|user/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_%]* +# YouTube music +\bmusic\.youtube\.com/youtubei/v1/browse(?:[?&]\w+=[-a-zA-Z0-9?&=_]*) +# YouTube tag +<\s*youtube\s+id=['"][-a-zA-Z0-9?_]*['"] +# YouTube image +\bimg\.youtube\.com/vi/[-a-zA-Z0-9?&=_]* +# Google Accounts +\baccounts.google.com/[-_/?=.:;+%&0-9a-zA-Z]* +# Google Analytics +\bgoogle-analytics\.com/collect.[-0-9a-zA-Z?%=&_.~]* +# Google APIs +\bgoogleapis\.(?:com|dev)/[a-z]+/(?:v\d+/|)[a-z]+/[-@:./?=\w+|&]+ +# Google Storage +\b[-a-zA-Z0-9.]*\bstorage\d*\.googleapis\.com(?:/\S*|) +# Google Calendar +\bcalendar\.google\.com/calendar(?:/u/\d+|)/embed\?src=[@./?=\w&%]+ +\w+\@group\.calendar\.google\.com\b +# Google DataStudio +\bdatastudio\.google\.com/(?:(?:c/|)u/\d+/|)(?:embed/|)(?:open|reporting|datasources|s)/[-0-9a-zA-Z]+(?:/page/[-0-9a-zA-Z]+|) +# The leading `/` here is as opposed to the `\b` above +# ... a short way to match `https://` or `http://` since most urls have one of those prefixes +# Google Docs +/docs\.google\.com/[a-z]+/(?:ccc\?key=\w+|(?:u/\d+|d/(?:e/|)[0-9a-zA-Z_-]+/)?(?:edit\?[-\w=#.]*|/\?[\w=&]*|)) +# Google Drive +\bdrive\.google\.com/(?:file/d/|open)[-0-9a-zA-Z_?=]* +# Google Groups +\bgroups\.google\.com(?:/[a-z]+/(?:#!|)[^/\s"]+)* +# Google Maps +\bmaps\.google\.com/maps\?[\w&;=]* +# Google themes +themes\.googleusercontent\.com/static/fonts/[^/\s"]+/v\d+/[^.]+. +# Google CDN +\bclients2\.google(?:usercontent|)\.com[-0-9a-zA-Z/.]* +# Goo.gl +/goo\.gl/[a-zA-Z0-9]+ +# Google Chrome Store +\bchrome\.google\.com/webstore/detail/[-\w]*(?:/\w*|) +# Google Books +\bgoogle\.(?:\w{2,4})/books(?:/\w+)*\?[-\w\d=&#.]* +# Google Fonts +\bfonts\.(?:googleapis|gstatic)\.com/[-/?=:;+&0-9a-zA-Z]* +# Google Forms +\bforms\.gle/\w+ +# Google Scholar +\bscholar\.google\.com/citations\?user=[A-Za-z0-9_]+ +# Google Colab Research Drive +\bcolab\.research\.google\.com/drive/[-0-9a-zA-Z_?=]* + +# GitHub SHAs (api) +\bapi.github\.com/repos(?:/[^/\s"]+){3}/[0-9a-f]+\b +# GitHub SHAs (markdown) +#(?:\[`?[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 +/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]* +# githubassets +\bgithubassets.com/[0-9a-f]+(?:[-/\w.]+) +# gist github +\bgist\.github\.com/[^/\s"]+/[0-9a-f]+ +# git.io +\bgit\.io/[0-9a-zA-Z]+ +# GitHub JSON +"node_id": "[-a-zA-Z=;:/0-9+_]*" +# Contributor +\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\) +# GHSA +GHSA(?:-[0-9a-z]{4}){3} + +# GitLab commit +\bgitlab\.[^/\s"]*/\S+/\S+/commit/[0-9a-f]{7,16}#[0-9a-f]{40}\b +# GitLab merge requests +\bgitlab\.[^/\s"]*/\S+/\S+/-/merge_requests/\d+/diffs#[0-9a-f]{40}\b +# GitLab uploads +\bgitlab\.[^/\s"]*/uploads/[-a-zA-Z=;:/0-9+]* +# GitLab commits +\bgitlab\.[^/\s"]*/(?:[^/\s"]+/){2}commits?/[0-9a-f]+\b + +# 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]+ +# bitbucket repositories commits +\bapi\.bitbucket\.org/\d+\.\d+/repositories/(?:[^/\s"]+/){2}commits?/[0-9a-f]+ +# bitbucket commits +\bbitbucket\.org/(?:[^/\s"]+/){2}commits?/[0-9a-f]+ + +# bit.ly +\bbit\.ly/\w+ + +# bitrise +\bapp\.bitrise\.io/app/[0-9a-f]*/[\w.?=&]* + +# bootstrapcdn.com +\bbootstrapcdn\.com/[-./\w]+ + +# cdn.cloudflare.com +\bcdnjs\.cloudflare\.com/[./\w]+ + +# circleci +\bcircleci\.com/gh(?:/[^/\s"]+){1,5}.[a-z]+\?[-0-9a-zA-Z=&]+ + +# gitter +\bgitter\.im(?:/[^/\s"]+){2}\?at=[0-9a-f]+ + +# gravatar +\bgravatar\.com/avatar/[0-9a-f]+ + +# ibm +[a-z.]*ibm\.com/[-_#=:%!?~.\\/\d\w]* + +# imgur +\bimgur\.com/[^.]+ + +# Internet Archive +\barchive\.org/web/\d+/(?:[-\w.?,'/\\+&%$#_:]*) + +# discord +/discord(?:app\.com|\.gg)/(?:invite/)?[a-zA-Z0-9]{7,} + +# Disqus +\bdisqus\.com/[-\w/%.()!?&=_]* + +# medium link +\blink\.medium\.com/[a-zA-Z0-9]+ +# medium +\bmedium\.com/\@?[^/\s"]+/[-\w]+ + +# microsoft +\b(?:https?://|)(?:(?:download\.visualstudio|docs|msdn2?|research)\.microsoft|blogs\.msdn)\.com/[-_a-zA-Z0-9()=./%]* +# powerbi +\bapp\.powerbi\.com/reportEmbed/[^"' ]* +# vs devops +\bvisualstudio.com(?::443|)/[-\w/?=%&.]* +# microsoft store +\bmicrosoft\.com/store/apps/\w+ + +# mvnrepository.com +\bmvnrepository\.com/[-0-9a-z./]+ + +# now.sh +/[0-9a-z-.]+\.now\.sh\b + +# oracle +\bdocs\.oracle\.com/[-0-9a-zA-Z./_?#&=]* + +# chromatic.com +/\S+.chromatic.com\S*[")] + +# codacy +\bapi\.codacy\.com/project/badge/Grade/[0-9a-f]+ + +# compai +\bcompai\.pub/v1/png/[0-9a-f]+ + +# mailgun api +\.api\.mailgun\.net/v3/domains/[0-9a-z]+\.mailgun.org/messages/[0-9a-zA-Z=@]* +# mailgun +\b[0-9a-z]+.mailgun.org + +# /message-id/ +/message-id/[-\w@./%]+ + +# Reddit +\breddit\.com/r/[/\w_]* + +# requestb.in +\brequestb\.in/[0-9a-z]+ + +# sched +\b[a-z0-9]+\.sched\.com\b + +# Slack url +slack://[a-zA-Z0-9?&=]+ +# Slack +\bslack\.com/[-0-9a-zA-Z/_~?&=.]* +# Slack edge +\bslack-edge\.com/[-a-zA-Z0-9?&=%./]+ +# Slack images +\bslack-imgs\.com/[-a-zA-Z0-9?&=%.]+ + +# shields.io +\bshields\.io/[-\w/%?=&.:+;,]* + +# stackexchange -- https://stackexchange.com/feeds/sites +#\b(?:askubuntu|serverfault|stack(?:exchange|overflow)|superuser).com/(?:questions/\w+/[-\w]+|a/) + +# Sentry +[0-9a-f]{32}\@o\d+\.ingest\.sentry\.io\b + +# Twitter markdown +\[\@[^[/\]:]*?\]\(https://twitter.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|)\) +# Twitter hashtag +\btwitter\.com/hashtag/[\w?_=&]* +# Twitter status +\btwitter\.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|) +# Twitter profile images +\btwimg\.com/profile_images/[_\w./]* +# Twitter media +\btwimg\.com/media/[-_\w./?=]* +# Twitter link shortened +\bt\.co/\w+ + +# facebook +\bfburl\.com/[0-9a-z_]+ +# facebook CDN +\bfbcdn\.net/[\w/.,]* +# facebook watch +\bfb\.watch/[0-9A-Za-z]+ + +# dropbox +\bdropbox\.com/sh?/[^/\s"]+/[-0-9A-Za-z_.%?=&;]+ + +# ipfs protocol +ipfs://[0-9a-zA-Z]{3,} +# ipfs url +/ipfs/[0-9a-zA-Z]{3,} + +# w3 +\bw3\.org/[-0-9a-zA-Z/#.]+ + +# loom +\bloom\.com/embed/[0-9a-f]+ + +# regex101 +\bregex101\.com/r/[^/\s"]+/\d+ + +# figma +\bfigma\.com/file(?:/[0-9a-zA-Z]+/)+ + +# freecodecamp.org +\bfreecodecamp\.org/[-\w/.]+ + +# image.tmdb.org +\bimage\.tmdb\.org/[/\w.]+ + +# mermaid +\bmermaid\.ink/img/[-\w]+|\bmermaid-js\.github\.io/mermaid-live-editor/#/edit/[-\w]+ + +# Wikipedia +\ben\.wikipedia\.org/wiki/[-\w%.#]+ + +# gitweb +[^"\s]+/gitweb/\S+;h=[0-9a-f]+ + +# HyperKitty lists +/archives/list/[^@/]+\@[^/\s"]*/message/[^/\s"]*/ + +# lists +/thread\.html/[^"\s]+ + +# list-management +\blist-manage\.com/subscribe(?:[?&](?:u|id)=[0-9a-f]+)+ + +# kubectl.kubernetes.io/last-applied-configuration +"kubectl.kubernetes.io/last-applied-configuration": ".*" + +# pgp +\bgnupg\.net/pks/lookup[?&=0-9a-zA-Z]* + +# Spotify +\bopen\.spotify\.com/embed/playlist/\w+ + +# Mastodon +\bmastodon\.[-a-z.]*/(?:media/|\@)[?&=0-9a-zA-Z_]* + +# scastie +\bscastie\.scala-lang\.org/[^/]+/\w+ + +# images.unsplash.com +\bimages\.unsplash\.com/(?:(?:flagged|reserve)/|)[-\w./%?=%&.;]+ + +# pastebin +\bpastebin\.com/[\w/]+ + +# heroku +\b\w+\.heroku\.com/source/archive/\w+ + +# quip +\b\w+\.quip\.com/\w+(?:(?:#|/issues/)\w+)? + +# badgen.net +\bbadgen\.net/badge/[^")\]'\s]+ + +# statuspage.io +\w+\.statuspage\.io\b + +# media.giphy.com +\bmedia\.giphy\.com/media/[^/]+/[\w.?&=]+ + +# tinyurl +\btinyurl\.com/\w+ + +# codepen +\bcodepen\.io/[\w/]+ + +# registry.npmjs.org +\bregistry\.npmjs\.org/(?:@[^/"']+/|)[^/"']+/-/[-\w@.]+ + +# getopts +\bgetopts\s+(?:"[^"]+"|'[^']+') + +# ANSI color codes +(?:\\(?:u00|x)1[Bb]|\x1b|\\u\{1[Bb]\})\[\d+(?:;\d+|)m + +# URL escaped characters +#\%[0-9A-F][A-F](?=[A-Za-z]) +# 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) +0x[0-9a-fA-F](?:\.[0-9a-fA-F]*|)[pP] +# Punycode +\bxn--[-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} +# hex runs +\b[0-9a-fA-F]{16,}\b +# hex in url queries +=[0-9a-fA-F]*?(?:[A-F]{3,}|[a-f]{3,})[0-9a-fA-F]*?& +# ssh +(?:ssh-\S+|-nistp256) [-a-zA-Z=;:/0-9+]{12,} + +# PGP +\b(?:[0-9A-F]{4} ){9}[0-9A-F]{4}\b +# GPG keys +\b(?:[0-9A-F]{4} ){5}(?: [0-9A-F]{4}){5}\b +# 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}|[iu]\d+)\b +# integrity +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] +# '/" +\\\([ad]q + +# .desktop mime types +^MimeTypes?=.*$ +# .desktop localized entries +^[A-Z][a-z]+\[[a-z]+\]=.*$ +# Localized .desktop content +Name\[[^\]]+\]=.* + +# IServiceProvider / isAThing +\b(?:I|isA)(?=(?:[A-Z][a-z]{2,})+(?:[A-Z]|\b)) + +# crypt +(['"])\$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+]*=\g{-1} + +# 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}) + +# perl run +perl(?:\s+-[a-zA-Z]\w*)+ + +# 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/.]+)+ + +# jetbrains schema https://youtrack.jetbrains.com/issue/RSRP-489571 +urn:shemas-jetbrains-com + +# kubernetes pod status lists +# https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase +\w+(?:-\w+)+\s+\d+/\d+\s+(?:Running|Pending|Succeeded|Failed|Unknown)\s+ + +# kubectl - pods in CrashLoopBackOff +\w+-[0-9a-f]+-\w+\s+\d+/\d+\s+CrashLoopBackOff\s+ + +# kubernetes object suffix +-[0-9a-f]{10}-\w{5}\s + +# posthog secrets +([`'"])phc_[^"',]+\g{-1} + +# xcode + +# xcodeproject scenes +(?: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 check-spelling@v0.0.22+, printf markers aren't automatically consumed +# printf markers +(?v# +(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_])) + +# 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 +\bset(?:\s+-[abefimouxE]{1,2})*\s+-[abefimouxE]{3,}(?:\s+-[abefimouxE]+)* +# tar arguments +\b(?:\\n|)g?tar(?:\.exe|)(?:(?:\s+--[-a-zA-Z]+|\s+-[a-zA-Z]+|\s[ABGJMOPRSUWZacdfh-pr-xz]+\b)(?:=[^ ]*|))+ +# tput arguments -- https://man7.org/linux/man-pages/man5/terminfo.5.html -- technically they can be more than 5 chars long... +\btput\s+(?:(?:-[SV]|-T\s*\w+)\s+)*\w{3,5}\b +# macOS temp folders +/var/folders/\w\w/[+\w]+/(?:T|-Caches-)/ diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt new file mode 100644 index 00000000000..d22caa23b47 --- /dev/null +++ b/.github/actions/spelling/excludes.txt @@ -0,0 +1,100 @@ +# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes +(?:^|/)(?i)COPYRIGHT +(?:^|/)(?i)LICEN[CS]E +(?:^|/)3rdparty/ +(?:^|/)go\.sum$ +(?:^|/)package(?:-lock|)\.json$ +(?:^|/)Pipfile$ +(?:^|/)pnpm-lock\.yaml$ +(?:^|/)pyproject.toml +(?:^|/)requirements(?:-dev|-doc|-test|)\.txt$ +(?:^|/)vendor/ +(?:|$^ 93.33% - excluded 14/15)(?:^|/)__init__\.py$ +[^/]\.bfbs$ +[^/]\.bin$ +[^/]\.mon$ +\.a$ +\.afb$ +\.ai$ +\.all-contributorsrc$ +\.avi$ +\.bmp$ +\.bz2$ +\.cer$ +\.class$ +\.coveragerc$ +\.crl$ +\.crt$ +\.csr$ +\.dll$ +\.docx?$ +\.drawio$ +\.DS_Store$ +\.eot$ +\.eps$ +\.exe$ +\.gif$ +\.git-blame-ignore-revs$ +\.gitattributes$ +\.gitkeep$ +\.graffle$ +\.gz$ +\.icns$ +\.ico$ +\.ipynb$ +\.jar$ +\.jks$ +\.jpe?g$ +\.key$ +\.lib$ +\.lock$ +\.map$ +\.min\.. +\.mo$ +\.mod$ +\.mp[34]$ +\.o$ +\.ocf$ +\.otf$ +\.p12$ +\.parquet$ +\.pdf$ +\.pem$ +\.pfx$ +\.png$ +\.psd$ +\.pyc$ +\.pylintrc$ +\.qm$ +\.s$ +\.sig$ +\.so$ +\.svgz?$ +\.sys$ +\.tar$ +\.tgz$ +\.tiff?$ +\.ttf$ +\.wav$ +\.webm$ +\.webp$ +\.woff2?$ +\.xcf$ +\.xlsx?$ +\.xpm$ +\.xz$ +\.zip$ +^\.github/actions/spelling/ +^\Q.github/workflows/spelling.yml\E$ +^\Qbazel/BUILD.bazel\E$ +^\Qgrpc/BUILD.bazel\E$ +^\Qkotlin/flatbuffers-kotlin/src/jvmTest/resources/utf8_sample.txt\E$ +^\Qnet/FlatBuffers/flatbuffers.snk\E$ +^\Qpython/py.typed\E$ +^\Qswift/Sources/FlatBuffers/Documentation.docc/Resources/code/fbs/monster_step_1.fbs\E$ +^\Qtests/arrays_test.golden\E$ +^\Qtests/docker/TODO.Dockerfile.testing.python.cpython_with_conda\E$ +^\Qtests/docker/TODO.Dockerfile.testing.python.cpython_with_numpy\E$ +^\Qtests/monsterdata_go_wire.mon.sp\E$ +^\Qtests/unicode_test.json\E$ +ignore$ diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt new file mode 100644 index 00000000000..2c702efe96c --- /dev/null +++ b/.github/actions/spelling/expect.txt @@ -0,0 +1,1146 @@ +aaabbbbccccddddeeeeffffgggghhh +AAdd +Aaddb +aapt +aard +aardappel +AArgs +abcdefghijklmnopqrstuvwyz +abcs +abctest +absl +ABuilder +AClass +adb +additionalparam +addtogroup +ADirect +adr +aend +afterbasic +afterptr +alignsize +allargs +ALLEXTERNALS +allmemberslink +allocs +allopen +allprojects +ANamespace +androidx +Antipattern +anydpi +anyofallof +AObject +AOffset +apk +appcompat +appname +ARDUINO +ARDUINOSTL +AReader +argi +ARGN +argname +armeabi +arraysegment +ARRAYSIZES +ARRT +ASAN +ASingle +Asinternal +Asstatic +AStruct +atot +AType +authorsection +AUTOBRIEF +autobuild +autocrlf +AUTOGEN +Autorelease +AVector +AVerify +badbuf +Badda +BArgs +barrr +BASEVALUE +batchmode +bazel +bazelci +bazelignore +bazelrc +bazs +bazzzzzz +bbb +bbgetter +bbsetter +BBuilder +bcmp +bcopy +BDirect +beforeptr +benchtime +bfbs +bfbsfile +bfloat +bibtex +bigendian +binaryarray +bindir +bitcode +bitfields +bitflag +bitmaps +bitwidth +Bla +blackbox +BLength +blockcopying +BObject +BOffset +bookfan +bools +boringssl +bpack +BReader +briefdescription +bssl +Bstart +bswap +BType +bufferpointer +bufprt +BUGLIST +bugprone +buildifier +buildscript +buildtype +bundlepath +bunpack +bvec +bytebuffer +byteorder +bytesize +byteslice +bytewidth +bytewise +bzero +bzl +CAdd +callergraph +callgraph +CArgs +caspern +CBuilder +ccc +CDirect +CGenerics +checkerframework +cifuzz +cint +citm +CKBr +classcode +classindex +classmembers +CLength +CLibrary +closingparen +cneo +Cntbl +CObject +Cocoapods +CODEFILE +codegeneration +codehaus +codeql +COffset +collaborationgraph +collsion +COLORSTYLE +colorwheel +commandline +commasep +commonprojectlogo +compats +conanbuildinfo +conanfile +conans +concats +configflags +constantgroups +consts +coption +copts +copyable +corpuses +counterintuitively +countup +coverpkg +cpack +cplusplus +CProperty +CReader +crossinline +crt +crtdbg +CStart +cstest +cstrings +cstyle +ctest +ctypename +CUnderscore +Curlies +currentdir +CUsage +Customise +CVerify +cvf +CWE +CXXFLAGS +Cyberdemon +Cyg +cygpath +CYGPATTERN +dasherize +dbaileychess +dbls +DBuilder +DDirect +ddl +deadcode +Deallocator +debian +Debianization +debugbreak +declcode +deduped +dedupes +defaultval +defgroup +defname +defref +defval +defvec +denamespace +deprec +DEPRECATEDLIST +derefed +derekbailey +destmatch +detaileddescription +Diagnoser +directorygraph +discriminants +dkovalev +DLength +dmg +dnfield +docbook +docc +docset +documentative +dontinclude +dotfile +DOTFONTPATH +dotnet +dox +doxtable +doxyfile +doxygen +doxygenlayout +doxygenversion +doxyindexer +doxypypy +doxyrules +doxysearch +Doxywizard +dsl +dtoken +dtype +dvec +DVI +dynsections +eabi +EArray +ebw +ECHECK +ECLIPSEHELP +eek +Eilemann +eit +elemobjectdef +elemsize +endcond +endfunction +endhtmlonly +endiantest +endptr +endtable +enumcode +enumdef +enumval +enumvalues +eob +epfl +evanw +evb +evit +execpath +expval +Extactor +extrabuild +extrastylesheet +facepalm +fallingtub +fbb +fbc +fbfile +fbit +fbs +FBT +FCCCCCCCCCCCCCCCn +fch +FEEDNAME +fext +ffi +fielddef +fieldloc +FIELDMETHOD +fieldn +fieldout +FIELDVAR +fiid +fiils +filebase +filegroups +Fileset +filesuffix +Firefox +FIs +flagc +flatbenchmark +flatbuf +flatbuffer +flatc +flatcc +flathash +FLATLIB +flatsample +flatsamplebfbs +flatsamplebinary +flatsampletext +flattests +FLength +flexbuffer +flexbuild +flexverifier +flgs +floathelper +flx +fns +FONTPATH +foobarbaz +foobarcontainer +foobars +foobarvec +footgun +forcopy +fortytwo +FORWARDSLASH +fpl +fqcn +freelocale +Frodo +frombuffer +Frominternal +Fromstatic +fsanitize +fsec +ftest +ftv +FTy +funcattributes +functionname +fusesource +fuzzer +fvec +fxb +GDC +GENDIR +genericize +genrule +getptr +getpw +getrootas +githash +gmock +GNUCXX +GNUG +godoc +gofmt +gofmt'ed +goldens +googlebenchmark +googletest +Gotchas +gpg +gpr +gprc +gradlew +Graphviz +grayscales +groupgraph +groupheader +grpcio +grpcpp +grpctest +gson +gtags +gtest +GUnix +gver +gwvo +GXX +handfan +hashset +Havok +hdrs +hhc +hhk +hhp +hhvm +hicpp +hideinitializer +hlp +hppa +htags +HTMLHELP +htmlonly +hyperlinks +ibb +ICCARM +iceboy +icns +idl +IDLTYPE +ieeetr +iloc +impldep +importgrouping +importns +importpath +inclass +includedbygraph +includedir +includegraph +indentcase +inheritancegraph +initializable +inlineclasses +INLINESIZE +inp +inputpath +intarray +integerize +interoperation +inthelper +intoto +intrin +intvalue +invsum +ious +ipk +ipp +Isaev +ISay +isextend +isnot +ISPUBLIC +ISREQUIRED +iss +issigned +itcl +itemsize +Itests +ith +itr +Ivars +iwidth +ixx +JAll +javac +JAVACMD +javadocs +javatest +Jax +jbuf +jdk +JEquipment +jetbrains +jiro +jmap +jmh +jmhreport +jmonster +jni +JNICALL +JNIEXPORT +jobject +jonsimantov +jre +jroot +jsonback +jsonfiles +jsongen +jsons +jsontest +jsontext +JTYPE +jvec +jverifier +jvmargs +jvmstatic +JWeapon +Jython +JYTHONDONTWRITEBYTECODE +JYTHONPATH +kbw +keepattributes +keepclassmembers +kenton +Keychain +keyfield +KEYFIELDSAMPLE +keywordtype +kfield +khhn +kmp +kotlin +kotlinc +kotlinx +krojew +Krull +ksh +kts +KTYPE +lasterror +lch +LDFLAGS +lenstr +lhrv +LIBCXX +libdir +libexpat +libiconv +libmagic +libmpdec +libreadline +lifecycles +linkopts +linkstatic +LINUXCLANG +LINUXGCC +linuxmain +LITTLEENDIAN +lld +lng +lobstertest +localizability +lol +longbig +longone +longtwo +losslessly +lto +luajit +luatest +luk +luwa +lvl +MACINTEL +Makefiles +MAKEFLAGS +makeindex +MAKEVAR +MARKVALUE +mathjax +maxburke +maxdepth +maxv +mbb +Mby +mcs +MDFILE +megatest +MEMB +memberdecl +memberdef +membergroups +memdoc +memitem +memproto +memtemplate +metacharacter +metamethod +Metaprogramming +metatable +METHODID +michaeltle +mik +mikkelfj +minalign +mindepth +minimalistic +minireflect +minv +minvalue +MIRIFLAGS +mitems +mlabel +mloc +mmk +MML +mmukhi +mnode +mockbutler +monsterdata +MONSTEREXTRA +monsterobj +monsteroff +MONSTERTEST +moredefaults +morethan +moshi +mosterdata +movector +MOVI +movsb +mpi +mpp +MSAN +MSASN +msc +mscfile +mscgen +MSearch +msgpack +muahaha +muahahahahaha +mulan +multidex +multiplatform +multitargeting +mustii +mustiikhalil +mutatingbool +mvn +mycompany +mydata +mydefinitions +MYFI +mygame +mymap +myschema +mystr +mystruct +mytable +myvector +mzaks +nameprefix +NAMESPACEA +NAMESPACEB +NAMESPACETEST +namesuffix +nathanmittler +NATIVEINLINETABLETEST +NATIVETYPETEST +navindex +navrow +nbb +nbreak +nbytes +ndarray +ndim +ndk +nestedclasses +nestedgroups +nestednamespaces +netcoreapp +netstandard +newbuf +newbyteorder +newelems +newlen +newlocale +newoff +newsize +Newtonsoft +newvtables +nfe +nfn +nimcache +ninf +nio +NIOHTTP +nmittler +nmloc +noext +NOMINMAX +nondefault +nonfuzz +Nonnil +nonpresent +nonroot +nonscalars +notvalid +nowarn +nservices +nsobject +NSOr +NSPACES +nstring +NTYPE +nullptrs +NUMBEROFFIELDS +nupkg +objectdef +OBJECTTYPE +objtype +odl +offsetloc +offsetval +ofs +okio +oldbuf +olist +OMG +onefile +oneof +onetwo +oob +Oortmerssen +optimisation +optin +optionalness +OPTIONALSCALARS +oss +ossf +ossrh +osubgrouping +osx +otw +OTY +OURCYGPATTERN +outdir +outp +ovalue +overlongs +packageattributes +packagemethods +packagestaticattributes +packagestaticmethods +packagetypes +packee +pagedocs +pageview +pakfile +PARAMDOC +paramname +paramref +parentnamespacetest +parseable +paulovap +pch +pdflatex +PERLMOD +philsc +pinentry +pkgconfig +plainnat +PNGs +pnode +podspec +postptr +Prealigns +predecl +PREDEF +prerendered +presorted +privateattributes +privatemethods +privateslots +privatestaticattributes +privatestaticmethods +privatetypes +PROGRAMLISTING +proguard +projectbrief +projectlogo +projectname +projectnumber +propget +propput +protectedattributes +protectedmethods +protectedslots +protectedstaticattributes +protectedstaticmethods +protectedtypes +protobufs +prototest +psr +pthread +ptws +publicattributes +publicmethods +publicslots +publicstaticattributes +publicstaticmethods +publictypes +pubspec +pugixml +Push'able +Pushable +PYTHONDONTWRITEBYTECODE +PYTHONPATH +pytypes +qch +qhelpgenerator +QHG +qhp +qnan +QNXNTO +qsf +quickcheck +quicktest +raii +rapunzel +rawbuf +RAWKEY +rawr +RAWVALUENAME +rcv +reallocs +redhat +refcounted +referrables +Referrableslist +reflec +reflist +rehasher +releaseraw +reloff +renamesourcefileattribute +reqtype +rereverse +reserialized +resizingbuf +resptype +revloc +revpos +RHUB +rinventory +rlocation +roboto +rootdir +ROOTDIRSRAW +rootidr +roundings +rpccall +rpcmethod +rpcs +rroot +rtestarrayofstring +rtti +rtype +runcmd +runfiles +RUnion +rustc +rustfmt +rustlang +rustup +rwinslow +rwyw +samplebinary +sampledir +Scheglov +schemafile +schemaless +schematext +scm +scorecards +searchdata +seekp +serdes +servicecall +SFINAE +sfixed +SHAREDLIB +showinitializer +sideeffect +signedness +sively +SIZEPREFIX +slb +sln +sloc +slotnum +slotoff +slsa +smap +smartpointer +smartptr +Smath +snapcraft +snapcraftctl +snk +snupkg +SOffet +soffset +softprops +sonatype +sortbysize +sortedness +sourcelink +SOVERSION +specialisations +SPM +SQLi +squareup +srcs +srv +Ssymbols +stackoverflow +Startabcs +Startbools +Startflex +Startfloats +Startgalaxies +Startints +Startinventory +startptr +Startscalar +starttable +Starttest +Starttestarrayofbools +Starttestarrayofsortedstruct +Starttestarrayofstring +Starttestarrayoftables +Starttestnestedflatbuffer +Starttestrequirednestedflatbuffer +Startvector +Startvf +stddef +stdint +stdlibc +stl +strb +STREQUAL +stringfbb +Stringification +stringop +stringview +strn +strongified +strtoi +strtoui +strtoval +STRUCTNAME +structobj +structptr +STRUCTTYPE +STYPE +subgrouping +subobjectdef +subobjects +subprefix +subslice +sumtest +svec +swappable +swiftc +swiftformat +swiftlint +swiftpackageindex +swiftversion +swiftwasm +swl +tableinnestedns +tableloc +tableo +TABLEOFFSET +Tableslist +tagfile +targetdir +tbl +tbw +templated +temurin +tes +testarrayofbools +testarrayofsortedstruct +testarrayofstring +testarrayofstringlist +testarrayoftables +testarrayoftableslist +testbool +testempty +testest +testf +testfn +testhashes +testhashs +testhashu +TESTLIST +testnestedflatbuffer +testng +testnim +testonly +testrequirednestedflatbuffer +testresults +testsimpletablewithenum +testtype +testv +testvector +TFlags +TFrom +TGZ +thequickbrownfox +threshould +tion +titlearea +tobytes +TODOLIST +todos +TOffset +toolsets +trailingclosures +treeview +TRelative +trimwhitespace +TSGRPC +TSlot +TTable +tval +tvec +tvecb +typealiases +typeattributes +typechecked +typedef'ed +typefield +typenames +typeparam +typesafe +typname +UBits +UBSAN +ucast +ucc +ucf +uin +UInteger +uints +undercouch +uninstrumented +unionfield +UNIONUNDERLYINGTYPE +UNIONUNDERLYINGTYPETEST +UNIONVECTOR +uniqueptr +unistd +Unpackable +unparseable +uoffset +uraimo +usedfiles +usergroup +usizes +utype +uut +uvalue +uvt +uwidth +valdef +valist +vararg +vbw +vdelimited +vecend +vecofcolors +vecofstrings +vecofstructs +vecoftables +vecpos +vecs +vectorelem +vectorof +vectorofdoubles +vectoroflongs +vectorstart +vectortype +vectortypename +Verifer +vfork +vhd +vhdl +Vitaly +vitalyisae +vloc +voff +Voidify +VRel +vsize +vtableloc +vtableo +vtableoffset +vtables +vtest +vtfw +VTOFFSET +vtsize +vtype +vulnz +wasmer +wasmerio +weap +wep +wilma +winbase +wor +WORKDIR +workflows +Wouter +wraparguments +wrapparameters +writersize +wrt +wvo +Xapian +xbyte +xcodebuild +XCT +xdigits +XDirect +Xes +Xest +xmlstarlet +XOPEN +xsi +XSS +XSTR +xuint +xxxx +xxxxx +XXXXXX +XXXXXXX +YLength +YYx +ZFlat +Zmiri +zzz diff --git a/.github/actions/spelling/line_forbidden.patterns b/.github/actions/spelling/line_forbidden.patterns new file mode 100644 index 00000000000..5a46f103f4f --- /dev/null +++ b/.github/actions/spelling/line_forbidden.patterns @@ -0,0 +1,134 @@ +# 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, +# you might not want to check in code where you were debugging w/ `fit()`, in which case, you might want +# to use this: +#\bfit\( + +# s.b. anymore +\bany more[,.] + +# s.b. cannot +\b[Cc]an not\b + +# s.b. GitHub +(?v# +(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_])) + +# hit-count: 394 file-count: 129 +# https/http/file urls +(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|] + +# hit-count: 261 file-count: 138 +# IServiceProvider / isAThing +\b(?:I|isA)(?=(?:[A-Z][a-z]{2,})+(?:[A-Z]|\b)) + +# hit-count: 213 file-count: 35 +# Compiler flags (Unix, Java/Scala) +# Use if you have things like `-Pdocker` and want to treat them as `docker` +(?:^|[\t ,>"'`=(\[])-(?:(?:J-|)[DPWXY]|f(?!lat)|[Ll])(?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) + +# hit-count: 157 file-count: 17 +# in check-spelling@v0.0.22+, printf markers aren't automatically consumed +# printf markers +(?]*>|[^<]*)\s*$ + +# Autogenerated revert commit message +^This reverts commit [0-9a-f]{40}\.$ + +# ignore long runs of a single character: +\b([A-Za-z])\g{-1}{3,}\b diff --git a/.github/actions/spelling/reject.txt b/.github/actions/spelling/reject.txt new file mode 100644 index 00000000000..e5e4c3eef82 --- /dev/null +++ b/.github/actions/spelling/reject.txt @@ -0,0 +1,11 @@ +^attache$ +^bellow$ +benefitting +occurences? +^dependan.* +^oer$ +Sorce +^[Ss]pae.* +^untill$ +^untilling$ +^wether.* diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml new file mode 100644 index 00000000000..c85a9102a6c --- /dev/null +++ b/.github/workflows/spelling.yml @@ -0,0 +1,155 @@ +name: Check Spelling + +# Comment management is handled through a secondary job, for details see: +# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions +# +# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment +# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare) +# it needs `contents: write` in order to add a comment. +# +# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment +# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment) +# it needs `pull-requests: write` in order to manipulate those comments. + +# Updating pull request branches is managed via comment handling. +# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list +# +# These elements work together to make it happen: +# +# `on.issue_comment` +# This event listens to comments by users asking to update the metadata. +# +# `jobs.update` +# This job runs in response to an issue_comment and will push a new commit +# to update the spelling metadata. +# +# `with.experimental_apply_changes_via_bot` +# Tells the action to support and generate messages that enable it +# to make a commit to update the spelling metadata. +# +# `with.ssh_key` +# In order to trigger workflows when the commit is made, you can provide a +# secret (typically, a write-enabled github deploy key). +# +# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key + +# Sarif reporting +# +# Access to Sarif reports is generally restricted (by GitHub) to members of the repository. +# +# Requires enabling `security-events: write` +# and configuring the action with `use_sarif: 1` +# +# For information on the feature, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Sarif-output + +# Minimal workflow structure: +# +# on: +# push: +# ... +# pull_request_target: +# ... +# jobs: +# # you only want the spelling job, all others should be omitted +# spelling: +# # remove `security-events: write` and `use_sarif: 1` +# # remove `experimental_apply_changes_via_bot: 1` +# ... otherwise adjust the `with:` as you wish + +on: + push: + branches: + - "**" + tags-ignore: + - "**" + pull_request_target: + branches: + - "**" + types: + - 'opened' + - 'reopened' + - 'synchronize' + issue_comment: + types: + - 'created' + +jobs: + spelling: + name: Check Spelling + permissions: + contents: read + pull-requests: read + actions: read + security-events: write + outputs: + followup: ${{ steps.spelling.outputs.followup }} + runs-on: ubuntu-latest + if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }} + concurrency: + group: spelling-${{ github.event.pull_request.number || github.ref }} + # note: If you use only_check_changed_files, you do not want cancel-in-progress + cancel-in-progress: true + steps: + - name: check-spelling + id: spelling + uses: check-spelling/check-spelling@prerelease + with: + suppress_push_for_open_pull_request: ${{ github.actor != 'dependabot[bot]' && 1 }} + checkout: true + check_file_names: 1 + spell_check_this: check-spelling/spell-check-this@prerelease + post_comment: 0 + use_magic_file: 1 + report-timing: 1 + warnings: bad-regex,binary-file,deprecated-feature,ignored-expect-variant,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration,no-files-to-check + experimental_apply_changes_via_bot: 1 + use_sarif: ${{ (!github.event.pull_request || (github.event.pull_request.head.repo.full_name == github.repository)) && 1 }} + extra_dictionary_limit: 20 + extra_dictionaries: + cspell:software-terms/dict/softwareTerms.txt + cspell:cpp/src/stdlib-cpp.txt + cspell:python/src/python/python-lib.txt + cspell:filetypes/filetypes.txt + cspell:python/src/common/extra.txt + cspell:cpp/src/stdlib-c.txt + cspell:php/dict/php.txt + cspell:node/dict/node.txt + cspell:java/src/java.txt + cspell:fullstack/dict/fullstack.txt + cspell:golang/dict/go.txt + cspell:lua/dict/lua.txt + cspell:python/src/python/python.txt + cspell:swift/src/swift.txt + cspell:cpp/src/ecosystem.txt + cspell:typescript/dict/typescript.txt + cspell:dotnet/dict/dotnet.txt + cspell:html/dict/html.txt + cspell:cpp/src/lang-keywords.txt + cspell:npm/dict/npm.txt + cspell:rust/dict/rust.txt + cspell:shell/dict/shell-all-words.txt + cspell:java/src/java-terms.txt + cspell:cpp/src/compiler-clang-attributes.txt + + update: + name: Update PR + permissions: + contents: write + pull-requests: write + actions: read + runs-on: ubuntu-latest + if: ${{ + github.event_name == 'issue_comment' && + github.event.issue.pull_request && + contains(github.event.comment.body, '@check-spelling-bot apply') + }} + concurrency: + group: spelling-update-${{ github.event.issue.number }} + cancel-in-progress: false + steps: + - name: apply spelling updates + uses: check-spelling/check-spelling@prerelease + with: + experimental_apply_changes_via_bot: 1 + checkout: true + ssh_key: "${{ secrets.CHECK_SPELLING }}"