From 4b67ad2ece903a0440afe1222dec558c7b87fa0c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 11 Aug 2025 14:53:55 +0000 Subject: [PATCH 1/3] Initial plan From aea0e096bb1d2a61c6ed5d88f31004e14e449f49 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 11 Aug 2025 15:04:45 +0000 Subject: [PATCH 2/3] Add spellcheck workflow with typos and fix existing typos Co-authored-by: emhane <58548332+emhane@users.noreply.github.com> --- .github/workflows/lint.yml | 8 ++++ CHANGELOG.md | 4 +- book/custom.css | 2 +- typos.toml | 88 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 99 insertions(+), 3 deletions(-) create mode 100644 typos.toml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index d97aa5dd2..f8d35d7a7 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -20,3 +20,11 @@ jobs: cargo install zepter zepter --version time zepter run check + + # Check spelling across all files + typos: + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - uses: actions/checkout@v4 + - uses: crate-ci/typos@v1 diff --git a/CHANGELOG.md b/CHANGELOG.md index 2010f196b..c10c700a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -516,7 +516,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Testing -- Fix flaky bincode compat rountrip test ([#453](https://github.com/alloy-rs/op-alloy/issues/453)) +- Fix flaky bincode compat roundtrip test ([#453](https://github.com/alloy-rs/op-alloy/issues/453)) ## [0.10.5](https://github.com/alloy-rs/op-alloy /releases/tag/v0.10.5) - 2025-02-19 @@ -540,7 +540,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Std leakage ([#432](https://github.com/alloy-rs/op-alloy/issues/432)) - [consensus] Ecotone Upgrade Txs ([#412](https://github.com/alloy-rs/op-alloy/issues/412)) -- [consensus] L1BlockInfo datas ([#408](https://github.com/alloy-rs/op-alloy/issues/408)) +- [consensus] L1BlockInfo data ([#408](https://github.com/alloy-rs/op-alloy/issues/408)) ### Features diff --git a/book/custom.css b/book/custom.css index 9c7d35a41..85ca91df8 100644 --- a/book/custom.css +++ b/book/custom.css @@ -44,7 +44,7 @@ table tbody tr:nth-child(2n) { --sidebar-bg: #383539; --sidebar-fg: #fecdb2; - --sidebar-non-existant: #feceb454; + --sidebar-non-existent: #feceb454; --sidebar-active: #ffa07a; --scrollbar: var(--sidebar-fg); diff --git a/typos.toml b/typos.toml new file mode 100644 index 000000000..c4f530a2e --- /dev/null +++ b/typos.toml @@ -0,0 +1,88 @@ +[files] +extend-exclude = [ + ".git", + "target", + "Cargo.lock", + "book/mermaid.min.js", # Generated JS file + "book/dist/", # Built documentation + "book/theme/", # Theme files may have intentional spellings +] + +[default] +extend-ignore-re = [ + # Hex strings of various lengths (common in blockchain projects) + "(?i)0x[0-9a-f]{8,}", # 8+ hex chars with 0x prefix + "(?i)[0-9a-f]{32,}", # 32+ hex chars without 0x (hashes, addresses) + "(?i)[0-9a-f]{8,}", # 8+ hex chars without 0x (shorter hex values) + # Ordinals in identifiers + "[0-9]+nd", + "[0-9]+th", + "[0-9]+st", + "[0-9]+rd", + # Base64 encoded strings (common in tests and configs) + "[A-Za-z0-9+/]{20,}={0,2}", +] + +[default.extend-words] +# Valid Rust/Cargo terms +crate = "crate" +crates = "crates" + +# Blockchain/Ethereum specific terms +alloy = "alloy" +asterisc = "asterisc" # Valid project name in Optimism ecosystem +bedrock = "bedrock" # Optimism upgrade name +batcher = "batcher" # OP Stack component +bootnode = "bootnode" +chainid = "chainid" +codegen = "codegen" +derivation = "derivation" +enr = "enr" +ethereum = "ethereum" +fpvm = "fpvm" # Fault Proof Virtual Machine +geth = "geth" +interop = "interop" +libmdbx = "libmdbx" +merkle = "merkle" +mips = "mips" +mpsc = "mpsc" +optimism = "optimism" +preimage = "preimage" +revm = "revm" +risc = "risc" +rollup = "rollup" +rpc = "rpc" +sequencer = "sequencer" +ser = "ser" # Serialization abbreviation +serde = "serde" +superchain = "superchain" # Optimism Superchain +trie = "trie" +txs = "txs" # Transactions abbreviation +usize = "usize" +workspaces = "workspaces" + +# Technical abbreviations and acronyms +api = "api" +cli = "cli" +cfg = "cfg" +const = "const" +env = "env" +impl = "impl" +io = "io" +lru = "lru" +mpt = "mpt" # Merkle Patricia Trie +msg = "msg" +mut = "mut" +nums = "nums" +num = "num" +ok = "ok" +std = "std" +structs = "structs" +ty = "ty" # Type abbreviation +vec = "vec" + +# Additional project-specific terms that might be flagged as typos +jsonrpsee = "jsonrpsee" # JSON-RPC library +tokio = "tokio" +async = "async" +await = "await" \ No newline at end of file From 9258bf35a7b41b2e49b3d553a7a05e95b6bb4851 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 11 Aug 2025 15:07:23 +0000 Subject: [PATCH 3/3] Improve typos.toml exclusions for minified files Co-authored-by: emhane <58548332+emhane@users.noreply.github.com> --- typos.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/typos.toml b/typos.toml index c4f530a2e..f8165f95d 100644 --- a/typos.toml +++ b/typos.toml @@ -3,9 +3,10 @@ extend-exclude = [ ".git", "target", "Cargo.lock", - "book/mermaid.min.js", # Generated JS file + "book/mermaid*.js", # Minified JS files "book/dist/", # Built documentation "book/theme/", # Theme files may have intentional spellings + "*.min.js", # All minified JS files ] [default]