fix: typos + add spellchecking to CI (#248)

* fix: typos + add spellchecking to CI

* require Node.js 18 because the current cSpell requires at least it

* ignore the ./out/ directory

Author: anton-trunov

.github/workflows/nextjs.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version: "18"
           cache: yarn
 
       - name: Setup Pages

.github/workflows/test-build-nextjs.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version: "18"
           cache: yarn
 
       - name: Setup Pages
@@ -60,4 +60,7 @@ jobs:
         run: yarn install --frozen-lockfile
 
       - name: Build documentation
-        run: yarn build-pages
+        run: yarn build-pages
+
+      - name: Spell check documentation
+        run: yarn spell

cspell.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "basechain",
+    "bounceable",
+    "cheatsheet",
+    "Cheatsheet",
+    "cheatsheets",
+    "Cheatsheets",
+    "comptime",
+    "Comptime",
+    "decompiling",
+    "dnsresolve",
+    "Epva",        // part of a base64 string
+    "Fift",
+    "ipfs",
+    "IPFS",
+    "jetton",
+    "Jetton",
+    "Jettons",
+    "jettons",
+    "masterchain",
+    "Masterchain",
+    "mathrm",
+    "nanotons",
+    "nextra",
+    "Offchain",
+    "RAWRESERVE",
+    "respecifying",
+    "Satoshi",
+    "seamus",
+    "Seamus",
+    "seqno",
+    "stdlibs",
+    "STON.fi",
+    "TIMELOCK",
+    "timeouted",
+    "Timeouted",
+    "Toncoin",
+    "Toncoins",
+    "Uninit",
+    "vogons",     // 42 vogons
+    "workchain",
+    "xtwitter"
+  ],
+  "ignoreRegExpList": [
+    "\\(#.*\\)",
+    "^\\[.+\\]: .+",       // link declarations like [foo]: /ref/stdlib-ownable#bar
+    "\\[.+\\]\\[.+\\]",    // links like [`Resumable{:tact}`][res]
+    "\\[.+\\]\\(.+\\)",    // links like [`self.toCell().asSlice(){:tact}`](/ref/core-cells#cellasslice)
+    "address\\(\".+\"\\)", // Ton addresses
+    "mathrm\\{.+\\}",      // LaTeX subset
+    "\\[#.+\\]",           // [#nativereserve-combining-modes-with-flags]
+    "href=\".+\"",         // href="/cookbook/dexes/stonfi"
+    "\".+\": \".+\"",      // "from": "kQBrSAP2y7QIUw4_1q0qciHfqdFmOYR9CC1oinn7kyWWRuoV",
+    "Urls"
+  ],
+  "flagWords": [],
+  "ignorePaths": [
+    "components/icons",
+    "grammars/grammar-ohm.json",
+    "dist",
+    "grammars/grammar-tact.json",
+    "next.config.js",
+    "node_modules",
+    "out",
+    "package.json",
+    "pages/cookbook/dexes/_meta.js",
+    "pages/ref/spec.mdx"
+  ]
+}

package.json

@@ -15,12 +15,14 @@
     "build": "yarn deps && yarn clean && next build",
     "post-build": "echo 'spell checking, link checking, formatting'",
     "build-pages": "yarn build && node ./scripts/redirects-generate.js",
-    "next": "next"
+    "next": "next",
+    "spell": "cspell \"**\""
   },
   "devDependencies": {
     "@svgr/webpack": "^8.1.0",
     "@types/node": "^18.11.19",
     "@types/react": "18.2.61",
+    "cspell": "^8.8.4",
     "typescript": "^4.9.5"
   },
   "license": "CC-BY-4.0",

pages/book/_meta.js

@@ -26,7 +26,7 @@ export default {
     title: 'Communication',
   },
   // <- NOTE
-  //    potential place for a rather short overview page describing asyncronous & actor-model nature
+  //    potential place for a rather short overview page describing asynchronous & actor-model nature
   //    of TON Blockchain with respect to Tact and exchanging messages with it
   receive: 'Receive messages',
   bounced: 'Bounced messages',

pages/book/constants.mdx

@@ -32,7 +32,7 @@ trait MyTrait {
 }
 
 trait MyAbstractTrait {
-    abstract const MY_DEVFEE: Int;
+    abstract const MY_DEV_FEE: Int;
 }
 ```
 
@@ -44,7 +44,7 @@ contract MyContract with
     MyAbstractTrait, // trailing comma is allowed
 {
     override const MY_FEE: Int = ton("0.5");
-    override const MY_DEVFEE: Int = ton("1000");
+    override const MY_DEV_FEE: Int = ton("1000");
 }
 ```
 

pages/book/contracts.mdx

@@ -30,7 +30,7 @@ Each contract can contain:
 * [Receiver functions](#receiver-functions)
 * [Internal functions](#internal-functions)
 
-Furthermore, contracts can inherit all the declarations and definitions from [traits](/book/types#traits) and override some of their default behaviours. If declared or defined in a trait, internal functions and constants can be marked as [virtual or abstract](/book/functions#virtual-and-abstract-functions) and overriden in contracts inheriting from the trait.
+Furthermore, contracts can inherit all the declarations and definitions from [traits](/book/types#traits) and override some of their default behaviours. If declared or defined in a trait, internal functions and constants can be marked as [virtual or abstract](/book/functions#virtual-and-abstract-functions) and overridden in contracts inheriting from the trait.
 
 ### Persistent state variables [#variables]
 
@@ -67,7 +67,7 @@ You can read constants both in [receivers](#receiver-functions) and in [getters]
 Unlike [contract variables](#variables), **contract constants don't consume space in persistent state**. Their values are stored directly in the code [`Cell{:tact}`](/book/types#primitive-types) of the contract.
 
 ```tact
-// global constants are calculared in compile-time and cannot change
+// global constants are calculated in compile-time and cannot change
 const GlobalConst1: Int = 1000 + ton("42") + pow(10, 9);
 
 contract Example {
@@ -113,7 +113,7 @@ If a contract doesn't have any persistent state variables, or they all have thei
 The following is an example of a valid empty contract:
 
 ```tact
-contract IamEmptyAndIknowIt {}
+contract IamEmptyAndIKnowIt {}
 ```
 
 For your convenience, parameter list of `init(){:tact}` can have a trailing comma:

pages/book/index.mdx

@@ -20,7 +20,7 @@ Here are its main contents:
   />
 </Cards>
 
-### Cheetsheats
+### Cheatsheets
 
 [Cheatsheets](/book/cs/from-func) are quick rundowns on Tact syntax and idioms with comparison to other blockchain languages, such as FunC (also on TON) and Solidity (Ethereum blockchain). Use those to transition to Tact as swiftly as possible.
 

pages/book/operators.mdx

@@ -82,7 +82,7 @@ Consider the following code:
 5 -5;   // while here it would be viewed as a subtraction operator, despite formatting
 ```
 
-Even though this example may be simple, neglection of precedence rules can often lead to confusing situations with operators. The correct order of operations can be ensured by wrapping every operation in [parentheses](#parentheses), since parentheses have the highest precedence of all expressions and operators there is.
+Even though this example may be simple, neglecting of precedence rules can often lead to confusing situations with operators. The correct order of operations can be ensured by wrapping every operation in [parentheses](#parentheses), since parentheses have the highest precedence of all expressions and operators there is.
 
 ## Parentheses, `()` [#parentheses]
 

pages/book/statements.mdx

@@ -162,7 +162,7 @@ fun niceCatch() {
     try {
         nativeThrow(42); // throwing with exit code 42
     } catch (err) {
-        dump(err);       // this will dump the exit code catched, which is 42
+        dump(err);       // this will dump the exit code caught, which is 42
     }
 }
 ```

pages/book/structs-and-messages.mdx

@@ -155,7 +155,7 @@ fun example() {
     let nicestNumber: Int = 68 + 1;
 
     // You may instantiate the Struct as usual and assign variables to fields,
-    // but that is a bit repetetive and tedious at times
+    // but that is a bit repetitive and tedious at times
     PopQuiz{ vogonsCount: vogonsCount, nicestNumber: nicestNumber };
 
     // Let's use field punning and type less,
@@ -187,7 +187,7 @@ struct Big {
     f6: Int;
 }
 
-fun convertationFun() {
+fun conversionFun() {
     dump(Big{
         f1: 10000000000, f2: 10000000000, f3: 10000000000,
         f4: 10000000000, f5: 10000000000, f6: 10000000000,

pages/cookbook/data-structures.mdx

@@ -135,7 +135,7 @@ contract MapAsArray with Deployable {
 
     // Internal message receiver, which responds to a String message "delete_5h"
     receive("delete_5th") {
-        // Remove the 5th item if it exists and reply back with its value, or raise an erroor
+        // Remove the 5th item if it exists and reply back with its value, or raise an error
         self.reply(self.array.deleteIdx(4).toCoinsString().asComment()); // index offset 0 + 4 gives the 5th item
     }
 

pages/ref/core-base.mdx

@@ -16,7 +16,7 @@ Usage example:
 
 ```tact
 contract AllYourStorageBelongsToUs {
-    // This would change the behaviour of self.forward() function,
+    // This would change the behavior of self.forward() function,
     // causing it to try reserving this amount of nanoToncoins before
     // forwarding a message with SendRemainingBalance mode
     override const storageReserve = ton("0.1");

pages/ref/core-cells.mdx

@@ -53,7 +53,7 @@ Extension function for the [`Builder{:tact}`][p].
 
 Stores an unsigned `bits`-bit `value` into the copy of the [`Builder{:tact}`][p] for $0 ≤$ `bits` $≤ 256$. Returns that copy.
 
-Attempts to store a negative `value` or provide an unsufficient or out-of-bounds `bits` number throw an exception with [exit code 5](/book/exit-codes#5): `Integer out of expected range`.
+Attempts to store a negative `value` or provide an insufficient or out-of-bounds `bits` number throw an exception with [exit code 5](/book/exit-codes#5): `Integer out of expected range`.
 
 Usage example:
 
@@ -72,7 +72,7 @@ Extension function for the [`Builder{:tact}`][p].
 
 Stores a signed `bits`-bit `value` into the copy of the [`Builder{:tact}`][p] for $0 ≤$ `bits` $≤ 257$. Returns that copy.
 
-Attempts to provide an unsufficient or out-of-bounds `bits` number throw an exception with [exit code 5](/book/exit-codes#5): `Integer out of expected range`.
+Attempts to provide an insufficient or out-of-bounds `bits` number throw an exception with [exit code 5](/book/exit-codes#5): `Integer out of expected range`.
 
 Usage example:
 

pages/ref/core-common.mdx

@@ -72,7 +72,7 @@ receive() {
 
 <Callout type="warning" emoji="⚠️">
 
-  Behaviour is undefined for [getter functions](/book/contracts#getter-functions), as they cannot have a sender nor they can send messages.
+  Behavior is undefined for [getter functions](/book/contracts#getter-functions), as they cannot have a sender nor they can send messages.
 
 </Callout>
 

pages/ref/core-debug.mdx

@@ -134,7 +134,7 @@ fun thisWillTerminate() {
     nativeThrow(42); // throwing with exit code 42
 }
 
-fun butThisDoesnt() {
+fun butThisDoesNot() {
     try {
         nativeThrow(42); // throwing with exit code 42
     }
@@ -158,7 +158,7 @@ fun thisWillTerminate() {
     nativeThrowWhen(42, true); // throwing with exit code 42
 }
 
-fun butThisDoesnt() {
+fun butThisDoesNot() {
     try {
         nativeThrow(42, true); // throwing with exit code 42
     }
@@ -181,7 +181,7 @@ fun thisWillTerminate() {
     nativeThrowUnless(42, false); // throwing with exit code 42
 }
 
-fun butThisDoesnt() {
+fun butThisDoesNot() {
     try {
         nativeThrowUnless(42, false); // throwing with exit code 42
     }

pages/ref/evolution/overview.mdx

@@ -3,7 +3,7 @@
 import { Cards } from 'nextra/components'
 
 This sub-section contains all standards that are defined by the Tact Foundation and are used in the evolution process of the Tact and TON ecosystem.
-Additionaly, it features TEPs (TON Enhancement Proposals) and the up-to-date changelog of Tact updates.
+Additionally, it features TEPs (TON Enhancement Proposals) and the up-to-date changelog of Tact updates.
 
 ## Open Tact Proposals (OTPs)
 

pages/ref/stdlib-config.mdx

@@ -16,7 +16,7 @@ import "@stdlib/config";
 fun getConfigAddress(): Address;
 ```
 
-Retrives config parameter $0$ as an [`Address{:tact}`][p].
+Retrieves config parameter $0$ as an [`Address{:tact}`][p].
 
 Source code:
 
@@ -34,7 +34,7 @@ fun getConfigAddress(): Address {
 fun getElectorAddress(): Address;
 ```
 
-Retrives config parameter $1$ as an [`Address{:tact}`][p].
+Retrieves config parameter $1$ as an [`Address{:tact}`][p].
 
 Source code: