Skip to content

Commit

Permalink
chore: added setup for spell checker
Browse files Browse the repository at this point in the history
  • Loading branch information
Maciej Makowski committed Oct 29, 2024
1 parent a427c3d commit b53ef38
Show file tree
Hide file tree
Showing 10 changed files with 1,098 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/actions/spelling/README.md
View file
Original file line number Diff line number Diff line change
@@ -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.
29 changes: 29 additions & 0 deletions .github/actions/spelling/advice.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
<details><summary>If the flagged items are :exploding_head: false positives</summary>

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.

</details>

<!-- adoption information-->
: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.
5 changes: 5 additions & 0 deletions .github/actions/spelling/allow.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
github
https
ssh
ubuntu
workarounds
Loading

1 comment on commit b53ef38

@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 (99) 
alloc
allpass
apps
audioapi
audiocontext
biquad
bpm
chrono
cmath
constexpr
cstddef
cxx
efefef
elif
emmintrin
fabricexample
facebook
fbjni
FFFFFFF
highpass
highshelf
idx
ifdef
ifndef
IIR
img
instancetype
INTRINSICS
iostream
IRR
javaobject
jhybriddata
jhybridobject
jint
jlong
JMessage
jni
JNICALL
JNIEXPORT
jsbundle
jsi
kbd
keyof
Lcom
loadu
lowpass
lowshelf
maxmgv
memset
mozilla
mul
nativemodules
noopener
noreferrer
NSURL
nullopt
nullptr
NYQUIST
objc
ptr
QParam
rbegin
reactnative
regularbeat
rgba
Runtimes
setzero
soloader
stdexcept
stereopanner
storeu
swm
swmansion
tada
tolower
tsx
typedef
uimanager
uintptr
utf
utm
vabsq
vadd
vaddq
vdupq
vget
vld
vmax
vmaxq
vmul
vmulq
vsadd
vsmul
vst
vsub
vsubq
webaudio
Website
Worklet
To accept these unrecognized words as correct, you could run the following commands

... in a clone of the [email protected]:software-mansion-labs/react-native-audio-api.git repository
on the chore/add-spell-checker 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/software-mansion-labs/react-native-audio-api/actions/runs/11571617920/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary
Dictionary Entries Covers Uniquely
cspell:typescript/dict/typescript.txt 1098 10 7
cspell:cpp/src/stdlib-cpp.txt 252 7 5
cspell:fullstack/dict/fullstack.txt 419 8
cspell:cpp/src/lang-keywords.txt 44 6 1
cspell:css/dict/css.txt 263 5 1

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

      with:
        extra_dictionaries: |
          cspell:typescript/dict/typescript.txt
          cspell:cpp/src/stdlib-cpp.txt
          cspell:fullstack/dict/fullstack.txt
          cspell:cpp/src/lang-keywords.txt
          cspell:css/dict/css.txt

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

check_extra_dictionaries: ''
Pattern suggestions ✂️ (4)

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

# Automatically suggested patterns

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

# hit-count: 2 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: 2 file-count: 1
# w3
\bw3\.org/[-0-9a-zA-Z/#.]+

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

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

❌ Errors Count
ℹ️ candidate-pattern 7
❌ check-file-path 70

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.