Fix spell checking workflow#8028
Conversation
🦋 Changeset detectedLatest commit: 9d410ca The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
hardhatTotal size of the bundle: List of dependencies (sorted by size) |
There was a problem hiding this comment.
Pull request overview
This PR aims to make spell checking reproducible locally and more comprehensive in CI by switching the GitHub Actions workflow to run a repo-level pnpm spellcheck script backed by a dedicated cspell configuration, and by fixing/annotating typos uncovered across the codebase.
Changes:
- Add
cspellas a dev dependency, plus a rootspellcheckscript and new cspell config + project dictionary. - Replace the existing spellcheck GitHub Action with a workflow that installs deps and runs
pnpm spellcheck. - Fix a large set of typos across source, tests, docs, and workflows; add targeted
cspell:disable-next-line/cSpell:ignoreannotations where appropriate.
Reviewed changes
Copilot reviewed 84 out of 87 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| v-next/ignition-core/test/types/deployment-loader.ts | Fix comment typo. |
| v-next/ignition-core/test/send.ts | Add cspell ignore comment for intentionally invalid address. |
| v-next/ignition-core/test/reconciliation/reconciler.ts | Fix test description typos (“unreconcilable”). |
| v-next/ignition-core/test/reconciliation/helpers.ts | Fix error message typo (“Unreconciled”). |
| v-next/ignition-core/test/readEventArgument.ts | Fix typos in identifiers/text; add cspell ignores for test strings. |
| v-next/ignition-core/test/execution/reducers/running-send-data.ts | Add cspell ignores for hex-like strings in fixtures. |
| v-next/ignition-core/test/execution/reducers/running-a-named-library-deploy.ts | Add cspell ignore for hex-like string in fixture. |
| v-next/ignition-core/test/execution/reducers/running-a-named-contract-deploy.ts | Add cspell ignores for hex-like strings in fixtures. |
| v-next/ignition-core/test/execution/reducers/running-a-call.ts | Add cspell ignores for hex-like strings in fixtures. |
| v-next/ignition-core/test/execution/libraries.ts | Fix typo in test description. |
| v-next/ignition-core/test/execution/future-processor/utils.ts | Add cspell ignore for generated hash format. |
| v-next/ignition-core/test/execution/future-processor/named-contract-deploy.ts | Add cspell ignore for hex-like string. |
| v-next/ignition-core/test/execution/future-processor/helpers/network-interaction-execution.ts | Add cspell ignores for hex-like strings; minor formatting. |
| v-next/ignition-core/test/execution/future-processor/helpers/build-initialize-message-for.ts | Add cspell ignore for hex-like string. |
| v-next/ignition-core/test/execution/abi.ts | Fix typo in test description (“incorrectly”). |
| v-next/ignition-core/test-integrations/internal/execution/jsonrpc-client.ts | Add cspell ignore for fixture/project name. |
| v-next/ignition-core/src/types/artifact.ts | Fix index signature parameter name typo. |
| v-next/ignition-core/src/internal/reconciliation/reconciler.ts | Fix method name typo (“Topological”). |
| v-next/ignition-core/src/internal/module-builder.ts | Fix parameter name typo (argsOrOptions). |
| v-next/ignition-core/src/internal/execution/execution-engine.ts | Fix doc comment typo. |
| v-next/ignition-core/src/internal/execution/deployment-state-helpers.ts | Fix doc comment typo. |
| v-next/ignition-core/src/internal/execution/abi.ts | Fix doc comment typo. |
| v-next/hardhat/test/internal/hre-initialization.ts | Fix typo in test description (“normalize”). |
| v-next/hardhat/test/internal/cli/telemetry/sentry/anonymizer.ts | Add cspell ignore for multi-line error string fixture. |
| v-next/hardhat/test/internal/cli/main.ts | Fix “behaviour” → “behavior” in test descriptions. |
| v-next/hardhat/test/internal/cli/init/init.ts | Fix typo in test description (“initialized”). |
| v-next/hardhat/test/internal/builtin-plugins/solidity/build-system/resolver/remapped-npm-packages-graph.ts | Add cSpell ignore directive for test-only words. |
| v-next/hardhat/test/internal/builtin-plugins/solidity/build-system/resolver/dependency-resolver.ts | Fix typos in test name and fixture name. |
| v-next/hardhat/test/internal/builtin-plugins/solidity/build-system/partial-compilation/helpers.ts | Fix error message typo (“Couldn't”). |
| v-next/hardhat/test/internal/builtin-plugins/network-manager/request-handlers/handlers/accounts/local-accounts.ts | Add cspell ignore for intentionally invalid JSON string. |
| v-next/hardhat/test/internal/builtin-plugins/network-manager/network-manager.ts | Add cspell ignores for intentionally invalid private keys. |
| v-next/hardhat/test/internal/builtin-plugins/network-manager/hook-handlers/config.ts | Add cspell ignores for intentionally invalid private keys. |
| v-next/hardhat/test/internal/builtin-plugins/network-manager/edr/edr-provider.ts | Fix comment typo (“hardfork”). |
| v-next/hardhat/test/internal/builtin-plugins/flatten/task-action.ts | Fix typo in description (“don't”). |
| v-next/hardhat/test/internal/builtin-plugins/coverage/coverage-manager.ts | Fix typo in variable name (testScenario). |
| v-next/hardhat/src/types/solidity/resolved-file.ts | Fix doc comment typos. |
| v-next/hardhat/src/types/solidity/build-system.ts | Fix doc comment typo (“forces”). |
| v-next/hardhat/src/types/network.ts | Fix doc comment typo (“chain”). |
| v-next/hardhat/src/types/hre.ts | Fix doc comment typo (“augmentation”). |
| v-next/hardhat/src/types/artifacts.ts | Fix index signature parameter name typo. |
| v-next/hardhat/src/internal/core/user-interruptions.ts | Fix error message typo (“Expected”). |
| v-next/hardhat/src/internal/cli/telemetry/sentry/vendor/integrations/contextlines.ts | Reformat + fix typos in vendored file; normalize quotes/formatting. |
| v-next/hardhat/src/internal/cli/telemetry/sentry/anonymize-paths.ts | Fix comment typo (“disambiguate”). |
| v-next/hardhat/src/internal/cli/telemetry/analytics/subprocess.ts | Add cspell ignores for secrets/IDs in comments. |
| v-next/hardhat/src/internal/builtin-plugins/solidity/config.ts | Fix variable name typos (solidityUserConfigType). |
| v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/solc-config-selection.ts | Fix typos in docs/variable names (Pragmas). |
| v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/resolver/types.ts | Fix typos in docs (“project”, “remappings”). |
| v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/resolver/remapped-npm-packages-graph.ts | Fix comment typo (“unnecessarily”). |
| v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/dependency-graph.ts | Fix doc comment typo (“dependency”). |
| v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/compiler/compiler.ts | Fix comment typo (“stderr”). |
| v-next/hardhat/src/internal/builtin-plugins/solidity-test/task-action.ts | Fix typo in variable naming (edrArtifact). |
| v-next/hardhat/src/internal/builtin-plugins/solidity-test/runner.ts | Fix doc comment spelling (“finalized”). |
| v-next/hardhat/src/internal/builtin-plugins/solidity-test/edr-artifacts.ts | Fix typo in return shape (edrArtifact). |
| v-next/hardhat/src/internal/builtin-plugins/network-manager/edr/edr-provider.ts | Fix comment typo (“non-Hardhat”). |
| v-next/hardhat-zod-utils/src/index.ts | Fix typos in variable names/docs; improve default error message. |
| v-next/hardhat-viem/src/internal/contracts.ts | Fix comment typo (“legacy”). |
| v-next/hardhat-verify/test/utils.ts | Fix typo in variable naming (encodeConstructorArgsResult). |
| v-next/hardhat-verify/test/libraries.ts | Add cspell ignores for embedded bytecode test strings. |
| v-next/hardhat-verify/test/etherscan.ts | Add cspell ignore for guid-like test fixture string. |
| v-next/hardhat-verify/test/bytecode.ts | Add cspell ignores for embedded bytecode test strings. |
| v-next/hardhat-verify/test/blockscout.ts | Add cspell ignore for guid-like test fixture string. |
| v-next/hardhat-utils/test/bytecode.ts | Add cSpell ignore directive for test-only tokens. |
| v-next/hardhat-node-test-reporter/src/error-formatting.ts | Fix doc comment typo (“normalizes”). |
| v-next/hardhat-node-test-reporter/src/diagnostics.ts | Fix comment typo (“aligned”). |
| v-next/hardhat-node-test-reporter/integration-tests/index.ts | Fix comment typo (“output”). |
| v-next/hardhat-node-test-reporter/integration-tests/fixture-tests/example-test/test.ts | Add cspell ignores; fix test name typos (“nested”). |
| v-next/hardhat-node-test-reporter/integration-tests/fixture-tests/example-test/result.txt | Update expected output text to match corrected test names. |
| v-next/hardhat-node-test-reporter/README.md | “behaviour” → “behavior”. |
| v-next/hardhat-keystore/test/keystores/encryption.ts | Fix constant name typo (KEY_DERIVATION_ALGORITHM). |
| v-next/hardhat-keystore/src/internal/types.ts | Fix doc comment typo (“responsibility”). |
| v-next/hardhat-keystore/src/internal/keystores/encryption.ts | Fix constant name typo; fix doc comment typo (“without”). |
| v-next/hardhat-ethers/test/plugin-functionalities.ts | Add cspell ignore; fix assertion message typos. |
| v-next/hardhat-ethers/test/no-accounts.ts | Fix assertion message typos. |
| v-next/hardhat-ethers-chai-matchers/test/matchers/reverted/revertedWithCustomError.ts | Fix typo in custom error name string. |
| v-next/hardhat-ethers-chai-matchers/test/matchers/properHex.ts | Add cspell ignore for invalid hex literal. |
| v-next/hardhat-ethers-chai-matchers/test/matchers/events.ts | Fix typo in test description (“passed”). |
| v-next/hardhat-errors/test/errors.ts | Fix exported type name typo; add cSpell ignore for nonsense tokens. |
| v-next/hardhat-errors/src/errors.ts | Fix type alias name typo (MessageTemplateArguments). |
| v-next/config/eslint.config.js | Fix comment typo (“effort”). |
| pnpm-lock.yaml | Add cspell dependency + transitive updates. |
| package.json | Add cspell devDependency + root spellcheck script. |
| cspell.yaml | Remove old cspell config file. |
| cspell.dictionary.txt | Add project dictionary words list. |
| cspell.config.mts | Add new cspell configuration. |
| .github/workflows/spellcheck.yml | Switch workflow to install deps and run pnpm spellcheck. |
| .github/workflows/release.yml | Fix variable naming typo in github-script snippet. |
| .cspell.json | Remove old cspell config file. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 88 out of 91 changed files in this pull request and generated no new comments.
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This PR fixes the spell checking workflow, as it had two problems:
To fix it, I switch the github action from a cspell one, to use a new
pnpm spellcheckroot script, and properly configuredcspell. This PR also fixes all the typos that uncovered.