Skip to content

Commit 3079c20

Browse files
chayimrafie
chayim
authored and
rafie
committed
Adding spellcheck to CI, and fixing docs along the way (RedisJSON#805)
* spellcheck * spelling fixes (cherry picked from commit a9b5882)
1 parent e7155e9 commit 3079c20

File tree

6 files changed

+158
-15
lines changed

6 files changed

+158
-15
lines changed

‎.github/spellcheck-settings.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
matrix:
2+
- name: Markdown
3+
expect_match: false
4+
apsell:
5+
lang: en
6+
d: en_US
7+
dictionary:
8+
wordlists:
9+
- .github/wordlist.txt
10+
output: wordlist.dic
11+
pipeline:
12+
- pyspelling.filters.markdown:
13+
markdown_extensions:
14+
- markdown.extensions.extra:
15+
- pyspelling.filters.html:
16+
comments: false
17+
attributes:
18+
- alt
19+
ignores:
20+
- ':matches(code, pre)'
21+
- code
22+
- pre
23+
- blockquote
24+
- img
25+
sources:
26+
- '*.md'
27+
- 'docs/*.md'

‎.github/wordlist.txt

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
AGPLv
2+
allocator
3+
averias
4+
callgrind
5+
Campoy
6+
CMake
7+
configureable
8+
CTO
9+
Dani
10+
danitseitlin
11+
del
12+
dengliming
13+
dotnet
14+
dvirsky's
15+
ECMA
16+
evanhuang
17+
existance
18+
github
19+
gperftools
20+
HEXISTS
21+
http
22+
https
23+
io
24+
ioredis
25+
iorejson
26+
Jedis
27+
JRedisJSON
28+
JS
29+
js
30+
json
31+
JSONPath
32+
JSONTestSuite
33+
KeyRef
34+
KeyRefs
35+
Korkmaz
36+
Krom
37+
KromDaniel
38+
lang
39+
LINDEX
40+
LREM
41+
Malhotra
42+
md
43+
Mehmet
44+
Misspelled words:
45+
mkorkmaz
46+
Nitish
47+
nitishm
48+
npm
49+
NReJSON
50+
nst
51+
nuget
52+
OBJSET
53+
occurances
54+
optimiztions
55+
OSX
56+
Pavan
57+
php
58+
phpredis
59+
py
60+
PyPi
61+
pypi
62+
Rafa
63+
rb
64+
README
65+
RediSearch
66+
RedisJSON
67+
redisjson
68+
RedisJSON's
69+
redislabs
70+
rejonson
71+
ReJSON
72+
rejson
73+
repeatative
74+
repo
75+
RnD
76+
rubygems
77+
Rueian
78+
rueian
79+
rueidis
80+
schulzf
81+
sdk
82+
seriot
83+
SETSCHEMA
84+
!!!Spelling check failed!!!
85+
src
86+
stockholmux
87+
TBD
88+
TODOs
89+
tombatron
90+
trie
91+
Tseitlin
92+
uint
93+
Vachhani
94+
vachhanihpavan
95+
www
96+
YAML
97+
zstd
98+
redis

‎.github/workflows/spellcheck.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Spellcheck
2+
on:
3+
push:
4+
branches: [master]
5+
pull_request:
6+
branches: [master]
7+
jobs:
8+
spellcheck:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Spellcheck
13+
uses: rojopolis/spellcheck-github-actions@0.26.0
14+
with:
15+
config_path: .github/spellcheck-settings.yml
16+
task_name: Markdown

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@
3030
.cproject
3131
.project
3232
.settings/
33+
34+
wordlist.dic

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ Some languages have client libraries that provide support for RedisJSON's comman
188188
[redis-om-dotnet-package]: https://www.nuget.org/packages/Redis.OM/
189189
[redis-om-dotnet-stars]: https://img.shields.io/github/stars/redis/redis-om-dotnet.svg?style=social&label=Star&maxAge=2592000
190190

191-
## Acknowledgements
191+
## Acknowledgments
192192

193193
RedisJSON is developed with <3 at [Redis Labs](https://redislabs.com).
194194

‎TODO.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -85,22 +85,22 @@ Integrate with @dvirsky's `secondary` library.
8585

8686
Support [JSON Schema](http://json-schema.org/).
8787

88-
JSON.SETSCHEMA <key> <json>
88+
JSON.SETSCHEMA <key> <json>
8989

9090
Notes:
9191
1. Could be replaced by a JSON.SET modifier
9292
2. Indexing will be specified in the schema
9393
3. Cluster needs to be taken into account as well
9494

95-
JSON.VALIDATE <schema_key> <json>
95+
JSON.VALIDATE <schema_key> <json>
9696

9797
## Expiry
9898

99-
JSON.EXPIRE <key> <path> <ttl>
99+
JSON.EXPIRE <key> <path> <ttl>
100100

101101
# Cache serialized objects
102102

103-
Manage a cache inside the module for frequently accessed object in order to avoid repeatative
103+
Manage a cache inside the module for frequently accessed object in order to avoid repetitive
104104
serialization.
105105

106106
## KeyRef nodes
@@ -130,23 +130,23 @@ Print statistics about encountered values, parsing performance and such
130130
JSON.OBJSET <key> <path> <value>
131131
An alias for 'JSON.SET'
132132

133-
JSON.COUNT <key> <path> <json-scalar>
134-
P: count JS: ? R: N/A
133+
JSON.COUNT <key> <path> <json-scalar>
134+
P: count JS: ? R: N/A
135135
Counts the number of occurances for scalar in the array
136136

137-
JSON.REMOVE <key> <path> <json-scalar> [count]
138-
P: builtin del JS: ? R: LREM (but also has a count and direction)
137+
JSON.REMOVE <key> <path> <json-scalar> [count]
138+
P: builtin del JS: ? R: LREM (but also has a count and direction)
139139
Removes the first `count` occurances (default 1) of value from array. If index is negative,
140140
traversal is reversed.
141141

142-
JSON.EXISTS <key> <path>
143-
P: in JS: ? R: HEXISTS/LINDEX
142+
JSON.EXISTS <key> <path>
143+
P: in JS: ? R: HEXISTS/LINDEX
144144
Checks if path key or array index exists. Syntactic sugar for JSON.TYPE.
145145

146-
JSON.REVERSE <key> <path>
147-
P: reverse JS: ? R: N/A
146+
JSON.REVERSE <key> <path>
147+
P: reverse JS: ? R: N/A
148148
Reverses the array. Nice to have.
149149

150-
JSON.SORT <key> <path>
151-
P: sort JS: ? R: SORT
150+
JSON.SORT <key> <path>
151+
P: sort JS: ? R: SORT
152152
Sorts the values in an array. Nice to have.

0 commit comments

Comments
 (0)