docs: configure spell-check (#1484)

.changeset/polite-dragons-study.md

@@ -0,0 +1,2 @@
+---
+---

.github/workflows/test.yaml

@@ -15,6 +15,7 @@ jobs:
     uses: FuelLabs/github-actions/.github/workflows/vp-docs.yml@master
     with:
       doc-folder-path: "apps/docs/src"
+      spellcheck-config-path: "apps/docs/.spellcheck.yml"
 
   test:
     runs-on: ubuntu-latest

apps/docs/.spellcheck.yml

@@ -0,0 +1,33 @@
+matrix:
+    - name: SPCheck
+      aspell:
+        lang: en
+      dictionary:
+        encoding: utf-8
+        wordlists:
+          - apps/docs/spell-check-custom-words.txt
+      pipeline:
+        - pyspelling.filters.context:
+            context_visible_first: true
+            escapes: \\[\\`~]
+            delimiters:
+            # Ignore all code blocks
+            - open: '(?s)^(?P<open> *`{3,}\s*(\w+\s*,?\s*)+.*?)$'
+              close: '^( *`{3,})$'
+            # Ignore lines starting with <<< @
+            - open: '^(<<<.*)'
+              close: '$'
+        - pyspelling.filters.markdown:
+            markdown_extensions:
+              - pymdownx.superfences:
+        - pyspelling.filters.html:
+            comments: false
+            ignores:
+              - code
+              - pre
+      sources:
+        - 'apps/docs/src/*.md'
+        - 'apps/docs/src/**/*.md'
+        - 'apps/docs/src/**/**/*.md'
+      default_encoding: utf-8
+

apps/docs/spell-check-custom-words.txt

@@ -0,0 +1,290 @@
+ABI
+ABIs
+ASM
+IDE
+IDEs
+LSP
+namespace
+ALU
+APIs
+JSON
+BrowserStack
+CLI
+Deserialization
+deserializing
+DApp
+subcurrency
+Subcurrency
+intrinsics
+Intrinsics
+workspace
+workspaces
+Workspaces
+neovim
+EVM
+EVM's
+EOA
+ERC
+Ethereum
+Ethereum's
+FVM
+FuelVM
+Fuelup
+Github
+GraphQL
+Infura
+JSON
+LSP
+Merkle
+PoA
+PoS
+PoW
+RPC
+SDK
+SDK's
+SDKs
+SauceLabs
+Sepolia
+Structs
+Sway
+TAI
+TODO
+TypeScript
+UTF
+UTXO
+UTXOs
+Utils
+VM
+VSCode
+abigen
+args
+async
+backend
+backtraces
+blockchain
+blockchain's
+bytecode
+codespace
+codespaces
+config
+cryptographic
+customizable
+customizations
+dapp
+dev
+dropdown
+enum
+enums
+env
+forc
+frontend
+fuelup
+fullstack
+graphQL
+graphql
+http
+https
+js
+localhost
+mainnet
+mempool
+merkle
+monorepo
+monorepos
+natively
+npm
+nvm
+onboarding
+params
+pnpm
+prerelease
+queryable
+quickstart
+relayer
+relayers
+repo
+repos
+runnable
+stateful
+struct
+structs
+struct's
+testnet
+testnets
+toolchain
+toolchains
+urql
+validator
+validators
+superABI
+superABIs
+SuperABIs
+supertraits
+compositional
+typeclass
+turbofish
+DSL
+TOML
+IPFS
+Bitwise
+Bitwise
+runtime
+runtimes
+formatter
+deployable
+Utils
+ETH
+initializer
+initializers
+destructuring
+instantiation
+VMs
+superset
+CEI
+pre
+entrancy
+interoperable
+blockchains
+keccak
+SHA
+UI
+backtrace
+Collateralized
+collateralized
+submodule
+DEX
+TypeChain
+inlines
+inlining
+MiB
+FuelVM's
+deterministically
+CLI
+VS
+GraphViz
+DOT
+DCA
+AST
+GitHub
+decrypt
+decrypted
+Decrypted
+Decrypting
+decrypting
+subcommand
+subcommands
+Subcommands
+supertrait
+supertraits
+Supertraits
+incrementor
+monomorphization
+Booleans
+boolean
+Orchestrator
+orchestrator
+growable
+arity
+tuple's
+unary
+SRC
+DEX
+FuelLabs
+PRs
+codebase
+PostgreSQL
+Postgres
+MacOS
+macOS
+backends
+hoc
+semver
+SQLx
+Homebrew
+Changelog
+lookups
+namespaces
+YAML
+WASM
+WebAssembly
+dApp
+dApps
+JWT
+Schemas
+schemas
+AssemblyScript
+indexable
+Macbook
+Dockerized
+TLDR
+IaaS
+Updatable
+coinbase
+Coinbase
+postcondition
+Postcondition
+Cryptocurrency
+cryptocurrency
+ECDSA
+EcDSA
+secp
+Secp
+Bitfield
+SMT
+SMTs
+subtrees
+subtree
+prepended
+unhashed
+preimage
+FIPS
+EdDSA
+curve25519
+blazingly
+pseudocode
+Pseudocode
+endian
+KiB
+SUT
+Celestia
+encodings
+callee
+inlined
+parsable
+underflows
+bitmask
+XORs
+XOR
+ORs
+ANDs
+rhs
+lhs
+scalable
+Scalable
+Exponentiate
+exponentiate
+Executablity
+executablity
+Unwritable
+unwritable
+untrusted
+intra
+OOB
+INSTRs
+INSTR
+unspendable
+HRP
+Typegen
+typegen
+Autoloading
+decrypts
+hexlified
+reaccessing
+Reaccessing
+integrations
+keystore
+Keystore
+cryptographically
+Config
+config
+configs

apps/docs/src/guide/abi-typegen/index.md

@@ -22,7 +22,7 @@ It tells the SDK about the <a :href="abiUrl" target="_blank" rel="noreferrer">AB
 
 Given the following Sway smart contract:
 
-<!-- TODO: stop using hardcoded snippets -->
+<!-- TODO: stop using hard-coded snippets -->
 
 ```rust:line-numbers
 contract;

apps/docs/src/guide/abi-typegen/using-generated-types.md

@@ -10,7 +10,7 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types
 
 We can use these files like so:
 
-<!-- TODO: stop using hardcoded snippets -->
+<!-- TODO: stop using hard-coded snippets -->
 
 ```ts
 import { Wallet } from "fuels";
@@ -64,7 +64,7 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script
 
 We can use these files like so:
 
-<!-- TODO: stop using hardcoded snippets -->
+<!-- TODO: stop using hard-coded snippets -->
 
 ```ts
 import { Wallet } from "fuels";
@@ -92,7 +92,7 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate
 
 We can use these files like so:
 
-<!-- TODO: stop using hardcoded snippets -->
+<!-- TODO: stop using hard-coded snippets -->
 
 ```ts
 import { Wallet } from "fuels";