Spellchecker action (#1980)

Author: slorello89

.github/workflows/spellcheck.yml

@@ -0,0 +1,18 @@
+name: Spellcheck
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Spellcheck
+        uses: redis-stack/github-actions/spellcheck@main
+        env:
+          DICTIONARY: wordlist
+          DOCS_DIRECTORY: .
+          CONFIGURATION_FILE: .spellcheck.yml
+          COMMANDS_FILES: commands.json

.spellcheck.yml

@@ -0,0 +1,10 @@
+files:
+  - '**/*.md'  
+  - '!docs/clients/index.md'
+  - '!docs/libraries/index.md'
+  - '!docs/modules/index.md'
+  - '!docs/tools/index.md'
+dictionaries:
+  - wordlist
+no-suggestions: true
+quiet: true

README.md

@@ -2,7 +2,7 @@
 
 ## Clients
 
-All clients are listed under language specific subfolders of [clients](./clients)
+All clients are listed under language specific sub-folders of [clients](./clients)
 
 The path follows the pattern: ``clients/{language}/github.com/{owner}/{repository}.json``.
 The ``{language}`` component of the path is the path-safe representation
@@ -65,23 +65,16 @@ Please use the following formatting rules (aiming for smaller diffs that are eas
 
 ## Checking your work
 
-You should check your changes using Make:
+After making changes to the documentation, you can use the [spellchecker-cli package](https://www.npmjs.com/package/spellchecker-cli) to validate your spelling as well as some minor grammatical errors. You can install the spellchecker locally by running:
 
+```bash
+npm install --global spellchecker-cli
 ```
-$ make
-```
-
-This will make sure that JSON and Markdown files compile and that all
-text files have no typos.
 
-You need to install a few Ruby gems and [Aspell][aspell] to run these checks.
-The gems are listed in the `.gems` file. Install them with the
-following command:
+You can than validate your spelling by running the following
 
 ```
-$ gem install $(sed -e 's/ -v /:/' .gems)
+spellchecker --no-suggestions -f '**/*.md' -l en-US -q -d wordlist
 ```
 
-The spell checking exceptions should be added to `./wordlist`.
-
-[aspell]: http://aspell.net/
+Any exceptions you need for spelling can be added to the `wordlist` file.

commands/acl-genpass.md

@@ -17,7 +17,7 @@ create more random bytes as needed. This means that the application developer
 should be feel free to abuse `ACL GENPASS` to create as many secure
 pseudorandom strings as needed.
 
-The command output is an hexadecimal representation of a binary string.
+The command output is a hexadecimal representation of a binary string.
 By default it emits 256 bits (so 64 hex characters). The user can provide
 an argument in form of number of bits to emit from 1 to 1024 to change
 the output length. Note that the number of bits provided is always

commands/acl-setuser.md

@@ -29,13 +29,13 @@ The root user permissions only allows executing the get command, but can be exec
 The selector then grants a secondary set of permissions: access to the `SET` command to be executed on any key that starts with "app1".
 Using multiple selectors allows you to grant permissions that are different depending on what keys are being accessed.
 
-When we want to be sure to define an user from scratch, without caring if
+When we want to be sure to define a user from scratch, without caring if
 it had previously defined rules associated, we can use the special rule
 `reset` as first rule, in order to flush all the other existing rules:
 
     ACL SETUSER antirez reset [... other rules ...]
 
-After resetting an user, it returns back to the status it has when it
+After resetting a user, it returns back to the status it has when it
 was just created: non active (off rule), can't execute any command, can't
 access any key:
 
@@ -79,7 +79,7 @@ This is a list of all the supported Redis ACL rules:
 * `on`: set the user as active, it will be possible to authenticate as this user using `AUTH <username> <password>`.
 * `off`: set user as not active, it will be impossible to log as this user. Please note that if a user gets disabled (set to off) after there are connections already authenticated with such a user, the connections will continue to work as expected. To also kill the old connections you can use `CLIENT KILL` with the user option. An alternative is to delete the user with `ACL DELUSER`, that will result in all the connections authenticated as the deleted user to be disconnected.
 * `nopass`: the user is set as a "no password" user. It means that it will be possible to authenticate as such user with any password. By default, the `default` special user is set as "nopass". The `nopass` rule will also reset all the configured passwords for the user.
-* `>password`: Add the specified clear text password as an hashed password in the list of the users passwords. Every user can have many active passwords, so that password rotation will be simpler. The specified password is not stored as clear text inside the server. Example: `>mypassword`.
+* `>password`: Add the specified clear text password as a hashed password in the list of the users passwords. Every user can have many active passwords, so that password rotation will be simpler. The specified password is not stored as clear text inside the server. Example: `>mypassword`.
 * `#<hashedpassword>`: Add the specified hashed password to the list of user passwords. A Redis hashed password is hashed with SHA256 and translated into a hexadecimal string. Example: `#c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2`.
 * `<password`: Like `>password` but removes the password instead of adding it.
 * `!<hashedpassword>`: Like `#<hashedpassword>` but removes the password instead of adding it.

commands/bgrewriteaof.md

@@ -11,7 +11,7 @@ process doing persistence.
 
 Specifically:
 
-* If a Redis child is creating a snapshot on disk, the AOF rewrite is _scheduled_ but not started until the saving child producing the RDB file terminates. In this case the `BGREWRITEAOF` will still return an positive status reply, but with an appropriate message.  You can check if an AOF rewrite is scheduled looking at the `INFO` command as of Redis 2.6 or successive versions.
+* If a Redis child is creating a snapshot on disk, the AOF rewrite is _scheduled_ but not started until the saving child producing the RDB file terminates. In this case the `BGREWRITEAOF` will still return a positive status reply, but with an appropriate message.  You can check if an AOF rewrite is scheduled looking at the `INFO` command as of Redis 2.6 or successive versions.
 * If an AOF rewrite is already in progress the command returns an error and no
   AOF rewrite will be scheduled for a later time.
 * If the AOF rewrite could start, but the attempt at starting it fails (for instance because of an error in creating the child process), an error is returned to the caller.

commands/bitfield.md

@@ -1,8 +1,8 @@
-The command treats a Redis string as a array of bits, and is capable of addressing specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset. In practical terms using this command you can set, for example, a signed 5 bits integer at bit offset 1234 to a specific value, retrieve a 31 bit unsigned integer from offset 4567. Similarly the command handles increments and decrements of the specified integers, providing guaranteed and well specified overflow and underflow behavior that the user can configure.
+The command treats a Redis string as an array of bits, and is capable of addressing specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset. In practical terms using this command you can set, for example, a signed 5 bits integer at bit offset 1234 to a specific value, retrieve a 31 bit unsigned integer from offset 4567. Similarly the command handles increments and decrements of the specified integers, providing guaranteed and well specified overflow and underflow behavior that the user can configure.
 
 `BITFIELD` is able to operate with multiple bit fields in the same command call. It takes a list of operations to perform, and returns an array of replies, where each array matches the corresponding operation in the list of arguments.
 
-For example the following command increments an 5 bit signed integer at bit offset 100, and gets the value of the 4 bit unsigned integer at bit offset 0:
+For example the following command increments a 5 bit signed integer at bit offset 100, and gets the value of the 4 bit unsigned integer at bit offset 0:
 
     > BITFIELD mykey INCRBY i5 100 1 GET u4 0
     1) (integer) 1

commands/bitop.md

@@ -11,7 +11,7 @@ and **NOT**, thus the valid forms to call the command are:
 * `BITOP NOT destkey srckey`
 
 As you can see **NOT** is special as it only takes an input key, because it
-performs inversion of bits so it only makes sense as an unary operator.
+performs inversion of bits so it only makes sense as a unary operator.
 
 The result of the operation is always stored at `destkey`.
 
@@ -48,7 +48,7 @@ Different bitmaps can be combined in order to obtain a target bitmap where
 the population counting operation is performed.
 
 See the article called "[Fast easy realtime metrics using Redis
-bitmaps][hbgc212fermurb]" for a interesting use cases.
+bitmaps][hbgc212fermurb]" for an interesting use cases.
 
 [hbgc212fermurb]: http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps
 

commands/bzpopmin.md

@@ -5,7 +5,7 @@ members to pop from any of the given sorted sets.
 A member with the lowest score is popped from first sorted set that is
 non-empty, with the given keys being checked in the order that they are given.
 
-The `timeout` argument is interpreted as an double value specifying the maximum
+The `timeout` argument is interpreted as a double value specifying the maximum
 number of seconds to block. A timeout of zero can be used to block indefinitely.
 
 See the [BLPOP documentation][cl] for the exact semantics, since `BZPOPMIN` is

commands/cluster-forget.md

@@ -27,7 +27,7 @@ end with just a three nodes cluster A, B, C we may follow these steps:
 2. D is now empty, but still listed in the nodes table of A, B and C.
 3. We contact A, and send `CLUSTER FORGET D`.
 4. B sends node A a heartbeat packet, where node D is listed.
-5. A does no longer known node D (see step 3), so it starts an handshake with D.
+5. A does no longer known node D (see step 3), so it starts a handshake with D.
 6. D ends re-added in the nodes table of A.
 
 As you can see in this way removing a node is fragile, we need to send