Extend cargo-spellcheck to cover entire repository including .github directory

.cargo/config.toml

@@ -10,7 +10,7 @@ incremental = true
 # TODO(aatifsyed): remove - this can be pushed out to readme
 # In all cases, pass --cfg=tokio_unstable for tokio console integration
 # See (https://github.com/ChainSafe/forest/pull/2245)
-# Note that this may be overriden by user configuration at ~/.cargo/config.toml
+# Note that this may be overridden by user configuration at ~/.cargo/config.toml
 rustflags = ["--cfg=tokio_unstable"]
 
 [net]

.config/forest.dic

@@ -1,19 +1,31 @@
-73
+237
+2k
+env
+HH
+known_blocks
+mm
+WORKFLOW_URL
+yaml
+YY
 Algorand/M
-API/M
 APIs
 args
-arities
 arity
 async
 attoFIL
+autogenerated
+automagically
+backend
+backfilling
 benchmark/GD
+benchmarking
 bitfield
 bitswap
 BLAKE2b
 blockchain/M
 blockstore/SM
 BLS
+bootstrapper/SM
 butterflynet
 calibnet
 calldata
@@ -23,124 +35,206 @@ CAR/SM
 CARv1/SM
 CARv2/SM
 CBOR
-CID/SM
-CIDs
+chain_follower
+ChainNotify
 ChainSafe/M
+changelog
+CID/SM
 CLI
-Cloudflare
 clonable
+Cloudflare
 codebase
 codec
+Composable
+config
 cron
 crypto
+Curio
 CurrentEpoch
 daemon
 daemonize
 Datacap
-devnet
-DB/S
 deserialize/D
 destructuring
+devnet
+DevOps
+Devs
+DHT
+Diataxis
+Diátaxis
+DigitalOcean
 DNS
-durations
+Dockerfile/SM
+Docusaurus
+draggable
+Drand
+Drilldown/SM
+Drilldowns
+eg
 EIP
 EIP155
-enum
-Enum
+entrypoint/SM
+enum/S
 EOF
-Ethereum
 eth
-exa
+Ethereum
 EVM
+exa
+f3
 f4
-F3
 FFI
 FIL
+Filecoin's
 Filecoin/M
+FilecoinEC
 Filops
+FilOz
+FilOz's
 FIP
+FIPs
+followable
+fortnightly
 FVM
 GC
 GiB
+GitHub
+Glif
+Grafana
+GraphQL
 HAMT
+hardcoded
 hasher
 healthcheck
+hide_title
+hotfix
+HttpJsonRpc
+implementer/SM
 implementor/SM
+infeasible
+interop/SM
+io
+IP
 IPFS
-ip
 IPLD
 JSON
-JWT
+jwt
+JWTs
 Kademlia
+keypair/SM
+keystore/SM
 Kubernetes
 libp2p
 liveness
 localhost
+localhost's
+LRU
+M1
+M2
+macOS
 mainnet
 MDNS
+MDX
 mempool
 Merkle
+MessageSeqNo
 MiB
 middleware
 milliGas
 multiaddr/SM
 multihash
+multiline
 multisig
 mutex
-Open
+namespace/SM
+NetworkEvent/SM
+NV22
+NV23
+NV24
+NVMe
+NVXX
+onwards
 OpenRPC
 overallocation
-P2P
+p2p
 param/SM
-ParityDb
 ParityDB
 parsable
+peerstore/SM
 performant
 PoC
 pointer/SM
 PoSt
-precommit
+pre-commit
+preloaded
+ProveCommitSector
+pubsub
+Q4
 R2
+README
+reimplemented
+repo/SM
 RLP
+RocksDB
 RPC
 schema/SM
-schemas
 SECP
 SECP256k1
+SecP256k1
 seekable
 serializable
 serializer/SM
+sharded
+sidebar_position
 skippable
 statediff
 stateful
+stateroot/SM
 stderr
 stdout
 struct/SM
+subcommand/SM
+swappiness
 synchronizer
+SyncStateMachine
 syscall/S
+TabItem/SM
+Tabs
 TCP
+Teardown
 testnet
+theme/SM
 tipset/SM
+TipSetBundle
 tipsetkey/S
 TOML
+toolchain/SM
 trie
 truthy
 TTY
+UI/SM
 uncompress
 unrepresentable
 untrusted
 URL
 UUID
-v0
-v1
-v2
+V0
+V1
 validator/S
 varint
+vendored
 verifier
 verifreg
 VM/SM
+VPS
 VRF
-WebAssembly
+wasm
+Wasm
+wasmtime
+webapp
 WebSocket
+WIP
+WPoStDisputeWindow
 WPoStProvingPeriodDeadlines
+WSL2
+YugabyteDB
 zstd

.config/spellcheck.toml

@@ -6,13 +6,30 @@ lang = "en_US"
 search_dirs = ["."]
 skip_os_lookups = true
 use_builtin = true
-tokenization_splitchars = "\",;:.!?#(){}[]|/_-‒'`&@§¶…<>="
+tokenization_splitchars = "\",;:.!?#()[]|/_-‒'`&@§¶…<>=~"
 extra_dictionaries = ["forest.dic", "en_US.dic"]
 
 [hunspell.quirks]
 transform_regex = [
   # 10.7%
   "^[0-9_]+(?:\\.[0-9]*)?%$",
+  # Template variables like {{ env.WORKFLOW_URL }} or {{ date | date('D/M/YY HH:mm') }}
+  "\\{\\{.*?\\}\\}",
+  # Double braces
+  "^\\{\\{$",
+  "^\\}\\}$",
+  # YAML frontmatter keys like sidebar_position
+  "^(title|description|sidebar_position|author|authors|date|tags?):.*$",
+  # Numbers with underscores like 30_000
+  "^[0-9_]+$",
+  # Plus signs and other operators
+  "^[+\\-*/=]+$",
+  # Tilde symbol
+  "^~+$",
+  # Import statements like @theme/Tabs
+  "@theme/.*",
+  # Emoji sequences (literal emojis)
+  "^[🌲🪷🐳❤️🐋⚠️]+$",
 ]
 allow_concatenation = false
 allow_dashes = false

.github/ISSUE_TEMPLATE/1-bug_report.md

@@ -1,6 +1,6 @@
 ---
 name: Bug report
-about: Provide a report of unexpected behaviour
+about: Provide a report of unexpected behavior
 title: ""
 labels: "Type: Bug"
 assignees: ""
@@ -12,7 +12,7 @@ assignees: ""
 
 ## To reproduce
 
-<!-- Steps to reproduce the behaviour: -->
+<!-- Steps to reproduce the behavior: -->
 
 1. Go to '...'
 2. Run '....'
@@ -29,7 +29,7 @@ assignees: ""
   ```
 </details>
 
-## Expected behaviour
+## Expected behavior
 
 <!-- A clear and concise description of what you expected to happen. -->