Skip to content

Commit

Permalink
Add check-spelling
Browse files Browse the repository at this point in the history
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
  • Loading branch information
jsoref committed Jun 7, 2021
1 parent 4690850 commit e2feaf4
Show file tree
Hide file tree
Showing 8 changed files with 266 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/actions/spelling/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 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)
[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.txt](advice.txt) | 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.
27 changes: 27 additions & 0 deletions .github/actions/spelling/advice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
<details><summary>If you see a bunch of garbage</summary>

If it relates to a ...
<details><summary>well-formed pattern</summary>

See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it.

If not, try writing one and 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.
</details>
<details><summary>binary-ish string</summary>

Please add a file path to the `excludes.txt` file instead of just accepting the garbage.

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).
</details>

</details>
Empty file.
17 changes: 17 additions & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)package(?:-lock|)\.json$
(?:^|/)vendor/
ignore$
\.avi$
\.ico$
\.jpe?g$
\.lock$
\.map$
\.min\.
\.mod$
\.mp[34]$
\.png$
\.wav$
^\.github/
150 changes: 150 additions & 0 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
adoc
api
asciidoc
asciidoctor
autolink
autolinking
autorun
backlinks
backtick
bdewey
bintray
bkeepers
bluecloth
boostpro
Bugfixes
changelog
chris
cmake
commonmarker
coverity
cpan
cpanm
cpanmin
cpanminus
creativecommons
daringfireball
divs
docfilesuffix
doctest
docutils
doesntmatter
drwxr
emoji
executables
extname
firstline
garen
gjtorikian
highlighter
hkp
homepage
Icecream
idprefix
idseparator
iidoc
impls
inliner
installdeps
irb
isinstance
jannis
jashkenas
jcp
jgarber
jruby
jsr
kenai
keyserver
kiberpipa
kramdown
larsch
leidel
libicu
libreadline
libssl
linebreak
litcoffee
maruku
MATLAB
matrixy
mdwn
mediawiki
metacpan
minitest
mkdn
nferrier
Nickelback
nmake
noblanks
noedit
notest
nricciar
nxadm
orgfile
orgmode
outfilesuffix
ozmm
perldoc
perlpod
posix
preformatted
pricejones
promptworks
publicdomain
pullv
pycon
pycparser
Rakefile
rakudo
rawr
rawtext
rbenv
rdiscount
readme
readthedocs
redcarpet
redcloth
revyver
rinku
RMarkdown
rmd
ROADMAP
rst
rstrip
rtfd
rubypants
samwhited
sectanchors
sectnum
setdefaultencoding
shellwords
showall
showtitle
Signes
Snarkdown
splitext
starttag
strikethrough
svn
tagfilter
tanoku
testtask
Torikian
ubuntu
uri
valign
Veloso
Vicent
virtualenv
wallyqs
Wanstrath
Whiteknight
wikicloth
wikicreole
WORKDIR
xform
Yacc
zef
zejn
zonyitoo
7 changes: 7 additions & 0 deletions .github/actions/spelling/patterns.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns

# bit.ly
\bbit\.ly/\w+

# ignore long runs of a single character:
\b([A-Za-z])\g{-1}{3,}\b
7 changes: 7 additions & 0 deletions .github/actions/spelling/reject.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
^attache$
benefitting
occurence
Sorce
^[Ss]pae
^untill
^wether
43 changes: 43 additions & 0 deletions .github/workflows/spelling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Spell checking
on:
pull_request_target:
push:
issue_comment:

jobs:
spelling:
name: Spell checking
runs-on: ubuntu-latest
steps:
- name: checkout-merge
if: "contains(github.event_name, 'pull_request')"
uses: actions/checkout@v2
with:
ref: refs/pull/${{github.event.pull_request.number}}/merge
- name: checkout
if: ${{ github.event_name == 'push' ||
(
contains(github.event.comment.body, '@check-spelling-bot apply')
) }}
uses: actions/checkout@v2
- uses: check-spelling/check-spelling@prerelease
id: spelling
if: ${{ github.event_name != 'issue_comment' ||
(
contains(github.event.comment.body, '@check-spelling-bot apply')
) }}
with:
suppress_push_for_open_pull_request: 1
experimental_apply_changes_via_bot: 1
extra_dictionaries:
cspell:cpp/cpp.txt
cspell:node/node.txt
cspell:php/php.txt
cspell:django/django.txt
cspell:java/java.txt
cspell:html/html.txt
cspell:css/css.txt
cspell:npm/npm.txt
cspell:filetypes/filetypes.txt
cspell:ruby/ruby.txt
check_extra_dictionaries: ''

1 comment on commit e2feaf4

@github-actions
Copy link

@github-actions github-actions bot commented on e2feaf4 Jun 7, 2021

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

Unrecognized words (1)
EXLUDE
To accept these unrecognized words as correct, run the following commands

... in a clone of the git@github.com:jsoref/markup.git repository
on the spell-check branch:

update_files() {
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  -H "Content-Type: application/json" \
  "https://api.github.com/repos/jsoref/markup/comments/51803670" > "$comment_json"
comment_body=$(mktemp)
jq -r .body "$comment_json" > $comment_body
rm $comment_json

patch_add=$(perl -e '$/=undef; $_=<>; print "$1" if m{Unrecognized words[^<]*</summary>\n*```\n*([^<]*)```\n*</details>$}m;' < "$comment_body")
  
update_files
rm $comment_body
git add -u
If you see a bunch of garbage

If it relates to a ...

well-formed pattern

See if there's a pattern that would match it.

If not, try writing one and 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.

binary-ish string

Please add a file path to the excludes.txt file instead of just accepting the garbage.

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).

Please sign in to comment.