Add spell check

This patch adds spell check to the project based on
https://github.com/crate-ci/typos. It's also used within the annotations
and integrated into CI.

Adding this check required to apply some of the minor fixes to the
EmmyLua annotations.

Author: georgiy-belyanin

.github/workflows/build.yml

@@ -9,9 +9,27 @@ on:
   pull_request:
 
 jobs:
-  build:
+  lint:
+    name: Lint
     runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Spell Check Repo
+      uses: crate-ci/typos@master
+    - name: Setup node 20.x
+      uses: actions/setup-node@v3
+      with:
+          node-version: 20.x
+    - name: Install dependencies
+      run: npm ci
+    - name: Lint
+      run: npm run lint
 
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    needs: [lint]
     steps:
     - uses: actions/checkout@v4
       with:
@@ -21,10 +39,8 @@ jobs:
       uses: actions/setup-node@v3
       with:
           node-version: 20.x
-    - name: Build
-      run: npm i
-    - name: Lint
-      run: npm run lint
+    - name: Install dependencies
+      run: npm ci
     - name: Package
       run: npx vsce package -o tarantool-vscode.vsix
     - name: Upload
@@ -34,6 +50,7 @@ jobs:
         path: ${{ github.workspace }}/tarantool-vscode.vsix
 
   publish:
+    name: Publish
     runs-on: ubuntu-latest
     needs: [build]
     if: success() && startsWith(github.ref, 'refs/tags/')

CHANGELOG.md

@@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- Fixed a few typos in various Tarantool builtin modules caught up by automatic
+  spell checking.
+
 ## [0.1.2] - 08.04.2025
 
 ### Changed

README.md

@@ -16,7 +16,7 @@ This extension offers the following features.
 
 * Static type checks and documentation for the most popular Lua and Tarantool builtin modules.
 * Cluster configuration schema validation for Tarantool 3.0+.
-* [tt cluster management utility](https://github.com/tarantool/tt) inside the command pallete.
+* [tt cluster management utility](https://github.com/tarantool/tt) inside the command palette.
 * Other auxiliary commands, e.g. install Tarantool of a specific version right from VS Code.
 
 ---

_typos.toml

@@ -0,0 +1,2 @@
+[default.extend-words]
+fpr = "fpr"

examples/basic-types.lua

@@ -86,7 +86,7 @@ local b_new = b
 local b_name = b[1] -- Inferred as `string`.
 local b_age = b[2] -- Inferred as `number`.
 
--- Aliases might be mutiline. E.g. they can be used for enumerations.
+-- Aliases might be multiline. E.g. they can be used for enumerations.
 
 ---@alias crud_operation
 ---| 'create' # Create an element. Note that `#` is required for a comment.

tarantool-annotations/Library/box/cfg.lua

@@ -100,7 +100,7 @@
 ---@field replication_skip_conflict? boolean (Default: false) By default, if a replica adds a unique key that another replica has added, replication stops with error = ER_TUPLE_FOUND
 ---@field replication_sync_lag? number (Default: 10) The maximum lag allowed for a replica
 ---@field replication_sync_timeout? number (Default: 300) The number of seconds that a replica will wait when trying to sync with a master in a cluster, or a quorum of masters, after connecting or during configuration update
----@field replication_timeout? number (Defailt: 1) If the master has no updates to send to the replicas, it sends heartbeat messages every replication_timeout seconds, and each replica sends an ACK packet back. Both master and replicas are programmed to drop the connection if they get no response in four replication_timeout periods. If the connection is dropped, a replica tries to reconnect to the master
+---@field replication_timeout? number (Default: 1) If the master has no updates to send to the replicas, it sends heartbeat messages every replication_timeout seconds, and each replica sends an ACK packet back. Both master and replicas are programmed to drop the connection if they get no response in four replication_timeout periods. If the connection is dropped, a replica tries to reconnect to the master
 ---@field slab_alloc_factor? number (Default: 1.05) The multiplier for computing the sizes of memory chunks that tuples are stored in. A lower value may result in less wasted memory depending on the total amount of memory available and the distribution of item sizes. Allowed values range from 1 to 2
 ---@field snap_io_rate_limit? number (Default: nil) Reduce the throttling effect of box.snapshot() on INSERT/UPDATE/DELETE performance by setting a limit on how many megabytes per second it can write to disk. The same can be achieved by splitting wal_dir and memtx_dir locations and moving snapshots to a separate disk
 ---@field sql_cache_size? number (Default: 5242880) The maximum number of bytes in the cache for SQL prepared statements

tarantool-annotations/Library/box/schema.lua

@@ -126,14 +126,14 @@ function box.schema.downgrade(version) end
 ---To learn how to downgrade a database to the specified Tarantool version, see [`box.schema.downgrade()`](lua://box.schema.downgrade).
 ---
 ---@see box.schema.downgrade
-function box.schmea.downgrade_versions() end
+function box.schema.downgrade_versions() end
 
 ---Return a list of downgrade issues for the specified Tarantool version.
 ---
 ---To learn how to downgrade a database to the specified Tarantool version, see [`box.schema.downgrade()`](lua://box.schema.downgrade).
 ---
 ---@param version string
-function box.schmea.downgrade_issues(version) end
+function box.schema.downgrade_issues(version) end
 
 ---User privileges management.
 ---

tarantool-annotations/Library/config.lua

@@ -190,6 +190,6 @@ function config:info(version) end
 ---@param uri_type 'peer' | 'sharding'
 ---@param opts { instance?: string }
 ---@return uri
-function config:instace_uri(uri_type, opts) end
+function config:instance_uri(uri_type, opts) end
 
 return config

tarantool-annotations/Library/datetime.lua

@@ -402,7 +402,7 @@ function datetime_obj:add(input) end
 
 ---Modify an existing datetime object by subtracting values of the input argument.
 ---
----See also: `interval_arithm`. The substraction is performed taking `tzdata` into account, when `tzoffset` or `tz` fields are set, see the `timezone`.
+---See also: `interval_arithm`. The subtraction is performed taking `tzdata` into account, when `tzoffset` or `tz` fields are set, see the `timezone`.
 ---
 ---**Example:**
 ---

tarantool-annotations/Library/fiber.lua

@@ -144,7 +144,7 @@ function fiber.yield() end
 --- ```
 ---
 ---@param fiber_object? fiber
----@return "running" | "dead" | "supspected"
+---@return "running" | "dead" | "suspected"
 function fiber.status(fiber_object) end
 
 ---@class fiber.info

tarantool-annotations/Library/json.lua

@@ -5,7 +5,7 @@ local json = {}
 ---@class json.cfg
 ---@field encode_max_depth? number (default: 128) Max recursion depth for encoding
 ---@field encode_deep_as_nil? boolean (default: false) A flag saying whether to crop tables with nesting level deeper than cfg.encode_max_depth. Not-encoded fields are replaced with one null. If not set, too deep nesting is considered an error.
----@field encode_invalid_numbers? boolean (deafult: true) A flag saying whether to enable encoding of NaN and Inf numbers
+---@field encode_invalid_numbers? boolean (default: true) A flag saying whether to enable encoding of NaN and Inf numbers
 ---@field encode_number_precision? number (default: 14) Precision of floating point numbers
 ---@field encode_load_metatables? boolean (default: true) A flag saying whether the serializer will follow __serialize metatable field
 ---@field encode_use_tostring? boolean (default: false) A flag saying whether to use tostring() for unknown types

tarantool-annotations/Library/uuid.lua

@@ -65,17 +65,17 @@ function uuid.bin(byte_order) end
 ---@return string uuid 16-byte string
 function uuid_obj:bin(byte_order) end
 
----Get UUID as 36-byte hexademical string.
+---Get UUID as 36-byte hexadecimal string.
 ---
 ---@return string uuid 36-byte binary string
 function uuid.str() end
 
----Convert UUID to a 36-byte hexademical string.
+---Convert UUID to a 36-byte hexadecimal string.
 ---
 ---@return string uuid 36-byte binary string
 function uuid_obj:str() end
 
----Convert hexademical 36-byte string to an UUID object.
+---Convert hexadecimal 36-byte string to an UUID object.
 ---
 ---@param uuid_str string UUID in 36-byte hexadecimal string
 ---@return uuid uuid converted UUID

tarantool-annotations/Library/yaml.lua

@@ -48,7 +48,7 @@ local yaml = {}
 ---@class yaml.cfg
 ---@field encode_max_depth? number (default: 128) Max recursion depth for encoding
 ---@field encode_deep_as_nil? boolean (default: false) A flag saying whether to crop tables with nesting level deeper than cfg.encode_max_depth. Not-encoded fields are replaced with one null. If not set, too deep nesting is considered an error.
----@field encode_invalid_numbers? boolean (deafult: true) A flag saying whether to enable encoding of NaN and Inf numbers
+---@field encode_invalid_numbers? boolean (default: true) A flag saying whether to enable encoding of NaN and Inf numbers
 ---@field encode_number_precision? number (default: 14) Precision of floating point numbers
 ---@field encode_load_metatables? boolean (default: true) A flag saying whether the serializer will follow __serialize metatable field
 ---@field encode_use_tostring? boolean (default: false) A flag saying whether to use tostring() for unknown types

tarantool-annotations/README.md

@@ -192,7 +192,7 @@ local function process_tuple(t)
     return {t[1], t[2], t[3] + 1000}
 end
 
--- Warning: wrong arument type.
+-- Warning: wrong argument type.
 local tuple_1 = process_tuple({1, 2, 3})
 -- Ok.
 local tuple_2 = process_tuple({1, 'Stan', 1000})