Skip to content

Commit

Permalink
Ignore go.mod in spellcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric-Warehime committed Aug 15, 2024
1 parent 6ec0c43 commit 4adc686
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
(?:^|/)expect\.txt$
(?:^|/)go\.mod$
(?:^|/)go\.sum$
(?:|$^ 92.86% - excluded 13/14)^docs/img/
[^/]\.png$
Expand Down

1 comment on commit 4adc686

@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 or 📝 job summary for details.

Unrecognized words (2)

Feegrant
IAVL

These words are not needed and should be removed abbf acfcdf aec afe afero basen bbfbd bbolt bdcce beorn bgentry bigfft bip btcd btcec btcsuite btcutil btcutilecc cbf ceb ced cenkalti cespare chzyer cleanhttp cockroachdb daec danieljoos datadog davecgh dbus dcrd dcrec deckarep decred desertbit dgraph dgryski difflib dustin dvsekhvalnov dyno eaf emicklei Factom fatih feegrant felixge flatbuffers fsnotify gax getsentry glog godbus goid goleveldb gotenv gotest grocksdb groupcache gsterjov gtank hashicorp hclog hdevalence highwayhash holiman httpsnoop huandu iancoleman iavl icza inconshreveable ipfs jmespath jmhodges keychain levigo libp libsecret linx locafero logfmt logr logtags lukechampine magiconair manifoldco mathutil mattn mimoo minio misko modernc mtibben multiaddr multibase multicodec multierr multiformats multihash namecase ncruces netrc nhooyr npipe oasisprotocol oklog opencensus opentelemetry orderedcode otel otelgrpc otelhttp petermattis pgregory pierrec pmezard promptui rcrowley regen remyoudompheng ristretto rogpeppe safetemp sagikazarmark sasha schnorrkel skiplist sourcegraph spaolacci stdr strcase strutil subkey subosito syndtr tidwall tokenbucket ulikunitz vedhavyas voi wincred winio xxhash yamux zerolog zondax

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:skip-mev/slinky.git repository
on the eric/move-simapp branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' |
perl - 'https://github.com/skip-mev/slinky/actions/runs/10412249650/attempts/1'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

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

Dictionary Entries Covers Uniquely
cspell:python/src/python/python-lib.txt 2417 9 5
cspell:fullstack/dict/fullstack.txt 419 5 4
cspell:java/src/java.txt 2464 5 3
cspell:filetypes/filetypes.txt 264 4 3
cspell:java/src/java-terms.txt 920 4 1

Consider adding them (in .github/workflows/spell.yml) in jobs:/build: to extra_dictionaries:

          cspell:python/src/python/python-lib.txt
          cspell:fullstack/dict/fullstack.txt
          cspell:java/src/java.txt
          cspell:filetypes/filetypes.txt
          cspell:java/src/java-terms.txt

To stop checking additional dictionaries, add (in .github/workflows/spell.yml):

check_extra_dictionaries: ''
Warnings (1)

See the 📜action log or 📝 job summary for details.

⚠️ Warnings Count
⚠️ no-newline-at-eof 3

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.

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

Please sign in to comment.