Conversation
Contributor
Author
|
@emhane 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: emhane <58548332+emhane@users.noreply.github.com>
Co-authored-by: emhane <58548332+emhane@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add spellcheck workflow
Add spellcheck workflow with typos
Aug 11, 2025
emhane
approved these changes
Aug 11, 2025
mattsse
approved these changes
Aug 18, 2025
theochap
pushed a commit
to ethereum-optimism/optimism
that referenced
this pull request
Jan 21, 2026
This PR adds a spellcheck job to the lint workflow using the `typos` tool, following the same approach as [Reth](paradigmxyz/reth#17501) and [Kona](op-rs/kona#2605). ## Changes - **Added `typos` job to `.github/workflows/lint.yml`**: Uses `crate-ci/typos@v1` action to check spelling across all files in PRs - **Created `typos.toml` configuration**: Includes blockchain/Ethereum-specific terms and exclusions for: - Generated files (minified JS, build artifacts) - Hex strings and addresses common in blockchain projects - Technical terms like `asterisc`, `optimism`, `alloy`, `superchain`, etc. - **Fixed existing typos** found during implementation: - `existant` → `existent` in CSS - `rountrip` → `roundtrip` in changelog - `datas` → `data` in changelog ## Why typos? The `typos` tool is written in Rust and provides faster execution than `codespell` while offering better configuration options through regex patterns and word lists. It's specifically well-suited for Rust projects with blockchain terminology. ## Testing The configuration has been tested to ensure: - ✅ Catches actual spelling errors - ✅ Allows legitimate technical terms - ✅ Excludes generated/minified files - ✅ Integrates cleanly with existing lint workflow Fixes #584. <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/alloy-rs/op-alloy/issues/new?title=✨Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: emhane <58548332+emhane@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a spellcheck job to the lint workflow using the
typostool, following the same approach as Reth and Kona.Changes
typosjob to.github/workflows/lint.yml: Usescrate-ci/typos@v1action to check spelling across all files in PRstypos.tomlconfiguration: Includes blockchain/Ethereum-specific terms and exclusions for:asterisc,optimism,alloy,superchain, etc.existant→existentin CSSrountrip→roundtripin changelogdatas→datain changelogWhy typos?
The
typostool is written in Rust and provides faster execution thancodespellwhile offering better configuration options through regex patterns and word lists. It's specifically well-suited for Rust projects with blockchain terminology.Testing
The configuration has been tested to ensure:
Fixes #584.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.