chore(deps,tooling,ci): replace pyspelling with codespell in tox (#1715)

* chore(deps): add `codespell` to the `docs` extras group

* feat(tooling,tox,ci): use `codespell` instead of `pyspelling`

* docs(tooling,ci): update docs for `codespell`

* chore(tooling): run spellecheck in precommit for python

* chore(ci): update ci flow for `codespell` -> `pyspelling`

* chore(all): fix the typos

* chore(tests): fix typo in function name

* docs: update changelog

Author: danceratopz

.github/workflows/coverage.yaml

@@ -43,7 +43,7 @@ jobs:
           echo "No python files were changed in ./tests/ - no action necessary"
           exit 0
 
-      - name: Report changed python test moudules
+      - name: Report changed python test modules
         if: steps.changed-tests.outputs.tests_any_changed == 'true'
         run: |
           echo "${{ toJson(steps.changed-tests.outputs) }}"

.github/workflows/tox_verify.yaml

@@ -36,7 +36,7 @@ jobs:
         run: uvx --with=tox-uv tox -e typecheck
 
   spellcheck:
-    name: Spellcheck sources with pyspelling
+    name: Spellcheck sources with codespell
     runs-on: ubuntu-latest
     steps:
       - name: Checkout ethereum/execution-spec-tests
@@ -48,11 +48,10 @@ jobs:
           cache-dependency-glob: "uv.lock"
           version: ${{ vars.UV_VERSION }}
           python-version: ${{ vars.DEFAULT_PYTHON_VERSION }}
-      - name: Install dependencies (aspell, aspell-en)
-        run: |
-          sudo apt-get update && sudo apt-get install -y aspell aspell-en
-      - name: Run spellcheck with pyspelling via tox
+      - name: Run spellcheck with codespell via tox
         run: uvx --with=tox-uv tox -e spellcheck
+        env:
+          GITHUB_STEP_SUMMARY: ${{ env.GITHUB_STEP_SUMMARY }}
 
   markdownlint:
     name: Lint markdown files with markdownlint

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     hooks:
       - id: tox
         name: tox
-        entry: uvx --with=tox-uv tox --parallel -e lint,typecheck
+        entry: uvx --with=tox-uv tox --parallel -e lint,typecheck,spellcheck
         language: system
         types: [python]
         pass_filenames: false

docs/CHANGELOG.md

@@ -49,6 +49,7 @@ Users can select any of the artifacts depending on their testing needs for their
 - ✨ Added [Post-Mortems of Missed Test Scenarios](https://eest.ethereum.org/main/writing_tests/post_mortems/) to the documentation that serves as a reference list of all cases that were missed during the test implementation phase of a new EIP, and includes the steps taken in order to prevent similar test cases to be missed in the future ([#1327](https://github.com/ethereum/execution-spec-tests/pull/1327)).
 - ✨ Added a new `eest` sub-command, `eest info`, to easily print a cloned EEST repository's version and the versions of relevant tools, e.g., `python`, `uv` ([#1621](https://github.com/ethereum/execution-spec-tests/pull/1621)).
 - ✨ Add `CONTRIBUTING.md` for execution-spec-tests and improve coding standards documentation ([#1604](https://github.com/ethereum/execution-spec-tests/pull/1604)).
+- ✨ Use `codespell` instead of `pyspelling` to spell-check python and markdown sources ([#1715](https://github.com/ethereum/execution-spec-tests/pull/1715)).
 - 🔀 Updated from pytest 7 to [pytest 8](https://docs.pytest.org/en/stable/changelog.html#features-and-improvements), benefits include improved type hinting and hook typing, stricter mark handling, and clearer error messages for plugin and metadata development ([#1433](https://github.com/ethereum/execution-spec-tests/pull/1433)).
 - 🐞 Fix bug in ported-from plugin and coverage script that made PRs fail with modified tests that contained no ported tests ([#1661](https://github.com/ethereum/execution-spec-tests/pull/1661)).
 - 🔀 Refactor the `click`-based CLI interface used for pytest-based commands (`fill`, `execute`, `consume`) to make them more extensible ([#1654](https://github.com/ethereum/execution-spec-tests/pull/1654)).

docs/executing_tests/index.md

@@ -106,7 +106,7 @@ uv run execute remote --fork=Prague --rpc-endpoint=https://rpc.endpoint.io --rpc
 
 ## `execute` Command Test Execution
 
-After executing wither `execute hive` or `execute remote`, the command will first create a random sender account from which all required test accounts will be deployed and funded, and this account is funded by sweeping (by default) the seed account.
+After executing `execute hive` or `execute remote` the command will first create a random sender account from which all required test accounts will be deployed and funded, and this account is funded by sweeping (by default) the seed account.
 
 The sweep amount can be configured by setting the `--seed-account-sweep-amount` flag:
 

docs/getting_started/code_standards.md

@@ -14,7 +14,7 @@ Code pushed to @ethereum/execution-spec-tests must fulfill the following checks
 | EL Client test cases   | `uvx --with=tox-uv tox -e tests-deployed`       | All client test cases for deployed forks can be generated.                                                  |
 | zkEVM EL Test cases    | `uvx --with=tox-uv tox -e tests-deployed-zkevm` | All client test cases specific to zkEVMs for deployed forks can be generated.                               |
 | HTML doc build         | `uvx --with=tox-uv tox -e mkdocs`               | Documentation generated without warnings.                                                                   |
-| Spellcheck             | `uvx --with=tox-uv tox -e spellcheck`           | Markdown spell-check (requires [additional dependency](code_standards_details.md#additional-dependencies)). |
+| Spellcheck             | `uvx --with=tox-uv tox -e spellcheck`           | Code and documentation spell-check using codespell. |
 | Markdown lint          | `uvx --with=tox-uv tox -e markdownlint`         | Markdown lint (requires [additional dependency](code_standards_details.md#additional-dependencies)).        |
 
 !!! tip "Running checks easily"

docs/getting_started/code_standards_details.md

@@ -59,10 +59,17 @@ Some checks require external (non-Python) packages:
 
 #### For `spellcheck`
 
+The spellcheck environment uses **codespell**, which is automatically installed via Python dependencies and checks for common spelling mistakes in code and documentation.
+
+To fix spelling errors found by codespell:
+
 ```console
-sudo apt-get install aspell aspell-en
+uv run codespell *.md *.ini .github/ src/ tests/ docs/ --write-changes
 ```
 
+!!! note "VS Code Integration"
+    The `whitelist.txt` file is still maintained for the VS Code cSpell extension, which provides real-time spell checking in the editor.
+
 #### For `markdownlint`
 
 ```console

pyproject.toml

@@ -61,13 +61,10 @@ Changelog = "https://eest.ethereum.org/main/CHANGELOG/"
 
 [project.optional-dependencies]
 test = ["pytest-cov>=4.1.0,<5"]
-lint = [
-    "ruff==0.11.8",
-    "mypy>=1.15.0,<1.16",
-    "types-requests>=2.31,<2.33",
-]
+lint = ["ruff==0.11.8", "mypy>=1.15.0,<1.16", "types-requests>=2.31,<2.33"]
 docs = [
     "cairosvg>=2.7.0,<3",
+    "codespell>=2.4.1,<3",
     "mike>=1.1.2,<2",
     "mkdocs>=1.4.3,<2",
     "mkdocs-click>=0.8,<1",
@@ -124,10 +121,14 @@ select = ["E", "F", "B", "W", "I", "A", "N", "D", "C"]
 fixable = ["I", "B", "E", "F", "W", "D", "C"]
 ignore = ["D205", "D203", "D212", "D415", "C901", "A005", "C420"]
 
-
 [tool.mypy]
 mypy_path = ["src", "$MYPY_CONFIG_FILE_DIR/stubs"]
 plugins = ["pydantic.mypy"]
 
+[tool.codespell]
+skip = ".venv,__pycache__,.git,build,dist,*.pyc,*.lock"
+check-filenames = true
+ignore-words-list = "ingenuous"
+
 [tool.uv.sources]
 ethereum-spec-evm-resolver = { git = "https://github.com/petertdavies/ethereum-spec-evm-resolver", rev = "623ac4565025e72b65f45b926da2a3552041b469" }

src/cli/tox_helpers.py

@@ -13,6 +13,41 @@
 
 import click
 from pyspelling import __main__ as pyspelling_main  # type: ignore
+from rich.console import Console
+
+
+def write_github_summary(title: str, tox_env: str, error_message: str, fix_commands: list[str]):
+    """
+    Write a summary to GitHub Actions when a check fails.
+
+    Args:
+        title: The title of the check that failed
+        tox_env: The tox environment name (e.g., "spellcheck")
+        error_message: Description of what went wrong
+        fix_commands: List of commands to fix the issue locally
+
+    """
+    if not os.environ.get("GITHUB_ACTIONS"):
+        return
+
+    summary_file = os.environ.get("GITHUB_STEP_SUMMARY")
+    if not summary_file:
+        return
+
+    with open(summary_file, "a") as f:
+        f.write(f"## ❌ {title}\n\n")
+        f.write(f"{error_message}\n\n")
+        f.write("### To reproduce this check locally:\n")
+        f.write("```bash\n")
+        f.write(f"uvx --with=tox-uv tox -e {tox_env}\n")
+        f.write("```\n\n")
+
+        if fix_commands:
+            f.write("### To verify and fix the issues:\n")
+            f.write("```bash\n")
+            for cmd in fix_commands:
+                f.write(f"{cmd}\n")
+            f.write("```\n")
 
 
 @click.command(
@@ -57,11 +92,97 @@ def pyspelling():
     if not shutil.which("aspell"):
         click.echo("aspell not installed, skipping spellcheck.")
         if os.environ.get("GITHUB_ACTIONS"):
+            write_github_summary(
+                title="Pyspelling Check Failed",
+                tox_env="spellcheck",
+                error_message=(
+                    "aspell is not installed. This tool is required for spell checking "
+                    " documentation."
+                ),
+                fix_commands=[
+                    "# Install aspell on Ubuntu/Debian",
+                    "sudo apt-get install aspell aspell-en",
+                    "",
+                    "# Install aspell on macOS",
+                    "brew install aspell",
+                ],
+            )
             sys.exit(1)
         else:
             click.echo(
                 "*********  Install 'aspell' and 'aspell-en' to enable spellcheck *********"
             )
             sys.exit(0)
 
-    sys.exit(pyspelling_main.main())
+    result = pyspelling_main.main()
+    if result != 0:
+        write_github_summary(
+            title="Pyspelling Check Failed",
+            tox_env="spellcheck",
+            error_message="Pyspelling found spelling errors in the documentation.",
+            fix_commands=[
+                "# Check the pyspelling configuration",
+                "cat .pyspelling.yml",
+                "",
+                "# Review and fix spelling errors manually",
+                "# Pyspelling doesn't have an auto-fix option",
+            ],
+        )
+    sys.exit(result)
+
+
+@click.command()
+def codespell():
+    """
+    Run codespell on the codebase and provide helpful error messages.
+
+    Checks spelling in .github/, src/, tests/, and docs/ directories.
+    """
+    console = Console()
+
+    # Define the paths to check
+    paths_to_check = ["*.md", "*.ini", ".github/", "src/", "tests/", "docs/"]
+    paths_str = " ".join(paths_to_check)
+
+    # Run codespell
+    result = subprocess.run(
+        ["codespell"] + paths_to_check,
+        capture_output=True,
+        text=True,
+    )
+
+    # Print the output
+    if result.stdout:
+        console.print(result.stdout)
+    if result.stderr:
+        console.print(result.stderr, style="red")
+
+    # If there were spelling errors, show a helpful message
+    if result.returncode != 0:
+        console.print("\n[bold red]❌ Spellcheck Failed[/bold red]")
+        console.print(
+            "[yellow]Please review the errors above. For single-suggestion fixes, you can "
+            "automatically apply them with:[/yellow]"
+        )
+        console.print(f"[cyan]uv run codespell {paths_str} --write-changes[/cyan]\n")
+
+        # Write to GitHub Actions summary
+        write_github_summary(
+            title="Spellcheck Failed",
+            tox_env="spellcheck",
+            error_message="Codespell found spelling errors in the code.",
+            fix_commands=[
+                "# Ensure codespell is installed (part of docs extras)",
+                "uv sync --all-extras",
+                "",
+                "# Check for spelling errors",
+                f"uv run codespell {paths_str}",
+                "",
+                "# Automatically fix single-suggestion errors",
+                f"uv run codespell {paths_str} --write-changes",
+            ],
+        )
+
+        sys.exit(1)
+
+    sys.exit(0)

src/ethereum_clis/clis/besu.py

@@ -61,7 +61,7 @@ def __init__(
     def start_server(self):
         """
         Start the t8n-server process, extract the port, and leave it running
-        for future re-use.
+        for future reuse.
         """
         args = [
             str(self.binary),