refactor(docs): exit codes page overhaul (#978)

tact-lang · Oct 24, 2024 · 458f996 · 458f996
1 parent a90b7af
commit 458f996
Show file tree

Hide file tree

Showing 10 changed files with 566 additions and 225 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - The `parseImports` function now returns AST import nodes instead of raw strings: PR [#966](https://github.com/tact-lang/tact/pull/966)
 - Optional types for `self` argument in `extends mutates` functions are now allowed: PR [#854](https://github.com/tact-lang/tact/pull/854)
+- Docs: complete overhaul of the exit codes page: PR [#978](https://github.com/tact-lang/tact/pull/978)
 
 ### Fixed
 

diff --git a/cspell-fift-words-adjusted.txt b/cspell-fift-words-adjusted.txt
@@ -29,6 +29,7 @@ Pos
 Split
 abort
 abs
+addop
 allot
 and
 anon

diff --git a/cspell.json b/cspell.json
@@ -106,6 +106,8 @@
     "Tarjan",
     "testdata",
     "Topup",
+    "Toncoin",
+    "Toncoins",
     "Trunov",
     "typechecker",
     "uintptr",

diff --git a/docs/README.md b/docs/README.md
@@ -101,6 +101,10 @@ All commands are run from the root of the project, from a terminal:
 | `yarn astro ...`          | Run CLI commands like `astro add`, `astro check`, etc.
 | `yarn astro -- --help`    | Get help using the Astro CLI.
 
+### ⚠️ Gotchas
+
+- When updating TextMate grammars in `grammars/` (for example, `grammar-tact.json`), make sure that the value for the `"name"` property is written all lowercase, otherwise highlighting will break.
+
 ### 👀 Want to learn more about the framework behind Tact docs?
 
 Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -33,7 +33,8 @@ export default defineConfig({
 				behavior: "append",
 				properties: {
 					class: "autolink-header",
-					ariaHidden: true,
+					ariaHidden: "true",
+					ariaLabel: "Link to this header",
 					tabIndex: -1,
 				},
 			}],

diff --git a/docs/cspell.json b/docs/cspell.json
@@ -2,55 +2,39 @@
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
   "language": "en",
+  "dictionaryDefinitions": [
+    {
+      "name": "fift-words",
+      "path": "../cspell-fift-words-adjusted.txt"
+    },
+    {
+      "name": "tvm-instructions",
+      "path": "../cspell-tvm-instructions.txt"
+    }
+  ],
+  "dictionaries": ["fift-words", "tvm-instructions"],
   "words": [
     "ADDRAND",
     "BBITS",
     "BREFS",
     "Brujin",
-    "CHKSIGNS",
-    "CHKSIGNU",
-    "CONFIGOPTPARAM",
-    "CTOS",
     "Cheatsheet",
     "Cheatsheets",
     "Comptime",
-    "DEBUGSTR",
-    "DUEPAYMENT",
     "Daniil",
     "Decompilation",
     "Decompiled",
     "Descr",
     "Domínguez",
-    "ENDC",
     "Epva",
-    "Fift",
-    "Fift",
-    "GASCONSUMED",
-    "GETFORWARDFEE",
-    "GETFORWARDFEESIMPLE",
-    "GETGASFEE",
-    "GETGASFEESIMPLE",
-    "GETORIGINALFWDFEE",
-    "GETSTORAGEFEE",
     "Georgiy",
-    "HASHCU",
-    "HASHEXT",
-    "HASHSU",
     "Héctor",
     "IPFS",
     "Jesús",
     "Jetton",
     "Jettons",
-    "KECCAK",
     "Komarov",
     "Korshakov",
-    "LDDICT",
-    "LDIX",
-    "LDREF",
-    "LDSLICEX",
-    "LDUX",
-    "LDVARUINT",
-    "LTIME",
     "Laika",
     "MYADDR",
     "Masterchain",

diff --git a/docs/src/content/docs/book/exit-codes.mdx b/docs/src/content/docs/book/exit-codes.mdx
diff --git a/src/generator/createABI.ts b/src/generator/createABI.ts
@@ -158,8 +158,8 @@ export function createABI(ctx: CompilerContext, name: string): ContractABI {
     errors["36"] = {
         message: "Invalid destination address in outbound message",
     };
-    errors["37"] = { message: "Not enough TON" };
-    errors["38"] = { message: "Not enough extra-currencies" };
+    errors["37"] = { message: "Not enough Toncoin" };
+    errors["38"] = { message: "Not enough extra currencies" };
     errors["39"] = {
         message: "Outbound message does not fit into a cell after rewriting",
     };

diff --git a/src/test/e2e-emulated/__snapshots__/local-type-inference.spec.ts.snap b/src/test/e2e-emulated/__snapshots__/local-type-inference.spec.ts.snap
@@ -70,10 +70,10 @@ exports[`local-type-inference should automatically set types for let statements
       "message": "Invalid destination address in outbound message",
     },
     "37": {
-      "message": "Not enough TON",
+      "message": "Not enough Toncoin",
     },
     "38": {
-      "message": "Not enough extra-currencies",
+      "message": "Not enough extra currencies",
     },
     "39": {
       "message": "Outbound message does not fit into a cell after rewriting",

diff --git a/src/test/exit-codes/contracts/compute-phase-errors.tact b/src/test/exit-codes/contracts/compute-phase-errors.tact
@@ -204,7 +204,7 @@ contract ComputePhaseErrorsTester {
     /// Exit code 11
     receive("11") {
         // Unlike nativeSendMessage which uses SENDRAWMSG, this one uses SENDMSG,
-        // and therefore fails in Compute time when the message is ill-formed
+        // and therefore fails in Compute phase when the message is ill-formed
         nativeSendMessageReturnForwardFee(emptyCell(), 0);
     }
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,6 +29,7 @@ Pos @@
     Split
     abort
     abs
+    addop
     allot
     and
     anon
@@ Expand Down @@