Skip to content

Commit da248ad

Browse files
author
Maciej Makowski
committed
chore: added spell checker
1 parent 57055d8 commit da248ad

File tree

10 files changed

+1196
-0
lines changed

10 files changed

+1196
-0
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# check-spelling/check-spelling configuration
2+
3+
File | Purpose | Format | Info
4+
-|-|-|-
5+
[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)
6+
[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)
7+
[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)
8+
[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
9+
[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)
10+
[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)
11+
[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)
12+
[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)
13+
[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)
14+
[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)
15+
16+
Note: you can replace any of these files with a directory by the same name (minus the suffix)
17+
and then include multiple files inside that directory (with that suffix) to merge multiple files together.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
2+
<details><summary>If the flagged items are :exploding_head: false positives</summary>
3+
4+
If items relate to a ...
5+
* binary file (or some other file you wouldn't want to check at all).
6+
7+
Please add a file path to the `excludes.txt` file matching the containing file.
8+
9+
File paths are Perl 5 Regular Expressions - you can [test](
10+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
11+
12+
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
13+
../tree/HEAD/README.md) (on whichever branch you're using).
14+
15+
* well-formed pattern.
16+
17+
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
18+
try adding it to the `patterns.txt` file.
19+
20+
Patterns are Perl 5 Regular Expressions - you can [test](
21+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
22+
23+
Note that patterns can't match multiline strings.
24+
25+
</details>
26+
27+
<!-- adoption information-->
28+
:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling,
29+
please merge to your PR's base branch to get the version configured for your repository.
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
github
2+
https
3+
ssh
4+
ubuntu
5+
workarounds
6+
alloc
7+
allpass
8+
apps
9+
audioapi
10+
audiocontext
11+
biquad
12+
bpm
13+
chrono
14+
cmath
15+
constexpr
16+
cstddef
17+
cxx
18+
efefef
19+
elif
20+
emmintrin
21+
fabricexample
22+
facebook
23+
fbjni
24+
FFFFFFF
25+
highpass
26+
highshelf
27+
idx
28+
ifdef
29+
ifndef
30+
IIR
31+
img
32+
instancetype
33+
INTRINSICS
34+
iostream
35+
IRR
36+
javaobject
37+
jhybriddata
38+
jhybridobject
39+
jint
40+
jlong
41+
JMessage
42+
jni
43+
JNICALL
44+
JNIEXPORT
45+
jsbundle
46+
jsi
47+
kbd
48+
keyof
49+
Lcom
50+
loadu
51+
lowpass
52+
lowshelf
53+
maxmgv
54+
memset
55+
mozilla
56+
mul
57+
nativemodules
58+
noopener
59+
noreferrer
60+
NSURL
61+
nullopt
62+
nullptr
63+
NYQUIST
64+
objc
65+
ptr
66+
QParam
67+
rbegin
68+
reactnative
69+
regularbeat
70+
rgba
71+
Runtimes
72+
setzero
73+
soloader
74+
stdexcept
75+
stereopanner
76+
storeu
77+
swm
78+
swmansion
79+
tada
80+
tolower
81+
tsx
82+
typedef
83+
uimanager
84+
uintptr
85+
utf
86+
utm
87+
vabsq
88+
vadd
89+
vaddq
90+
vdupq
91+
vget
92+
vld
93+
vmax
94+
vmaxq
95+
vmul
96+
vmulq
97+
vsadd
98+
vsmul
99+
vst
100+
vsub
101+
vsubq
102+
webaudio
103+
Website
104+
Worklet

0 commit comments

Comments
 (0)