feat: added spellcheck workflow for checking spelling (main) (#6955)

* feat: added spellcheck workflow for checking spelling

* chore: fix spelling mistakes

* chore: update cspell.yml

* chore: bring back buidler

* chore: bring back buidler (v2)

* chore: fix a few more cspell issues

* chore: prettier

* chore: renames

* chore: rename fixture projects

* chore: update ignition test fixtures

Author: galargh

.github/workflows/spellcheck.yml

@@ -0,0 +1,23 @@
+name: Check Spelling
+
+on:
+  push:
+    branches:
+      - main
+      - v-next
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      # TODO: Replace with https://github.com/streetsidesoftware/cspell-action
+      # once it supports the `report` input
+      - uses: galargh/cspell-action@report
+        with:
+          incremental_files_only: ${{ github.event_name == 'pull_request' }}
+          config: cspell.yaml
+          report: typos

cspell.yaml

@@ -0,0 +1,5 @@
+ignorePaths:
+  - pnpm-lock.yaml
+ignoreWords:
+  - buidler
+  - Saty248

e2e/fixture-projects/clean/test.sh

@@ -20,6 +20,6 @@ echo "it should run the command clean successfully"
 run_test_and_handle_failure "npx hardhat clean" 0
 
 echo "it should have deleted the artifacts directory and emptied the cache directory"
-assert_directory_doesnt_exist "artifacts"
+assert_directory_does_not_exist "artifacts"
 assert_directory_exists "cache"
 assert_directory_empty "cache"

e2e/fixture-projects/vars/test.sh

@@ -22,5 +22,5 @@ echo "it should fail because the key does not exist"
 run_test_and_handle_failure "npx hardhat vars get HH_KEY_DO_NOT_EXIST_3468267" 1
 
 #
-# Do not DELETE or SET keys to avoid modifing the configuration variables of the user running these tests
+# Do not DELETE or SET keys to avoid modifying the configuration variables of the user running these tests
 #

e2e/helpers.sh

@@ -38,7 +38,7 @@ assert_directory_exists() {
   fi
 }
 
-assert_directory_doesnt_exist() {
+assert_directory_does_not_exist() {
   if [ -d "$1" ]; then
     echo "Expected directory $1 to not exist, but it does"
     exit 1

packages/hardhat-chai-matchers/src/utils.ts

@@ -49,7 +49,7 @@ function buildNormal(ssfi: Ssfi) {
  * this value should be captured at the beginning of the matcher's
  * implementation, before any async code is executed. Otherwise things like
  * `.to.emit().and.not.to.emit()` won't work, because by the time the async part
- * of the first emit is executd, the `.not` (executed synchronously) has already
+ * of the first emit is executed, the `.not` (executed synchronously) has already
  * modified the flag.
  *
  * The second parameter is what Chai calls the "start stack function indicator",

packages/hardhat-core/CHANGELOG.md

@@ -159,7 +159,7 @@
 - cdf0160: Upgrade bundled solcjs
 - 3c66da2: Add support for Node v22
 - 9fadc22: Bump EDR to [v0.4.1](https://github.com/NomicFoundation/edr/releases/tag/%40nomicfoundation%2Fedr%400.4.1).
-- 095faa4: Added hardfork histories for Optimim and Arbitrum chains
+- 095faa4: Added hardfork histories for Optimism and Arbitrum chains
 
 ## 2.22.5
 
@@ -482,7 +482,7 @@
 - c9809e182: Trim leading and trailing spaces in mnemonics.
 - a1d43109a: Pending blocks now include the `bloom` field.
 - 818107821: Added a new `hardhat_metadata` RPC method
-- 937d15e51: A better error is show if a Solidity file makes an import throug its own package name.
+- 937d15e51: A better error is show if a Solidity file makes an import through its own package name.
 - 4cf9a6d58: Added a `getBuildInfoSync` function to the `hre.artifacts` object (thanks @emretepedev!)
 
 ## 2.12.2
@@ -713,7 +713,7 @@
 ### Patch Changes
 
 - 99c17f43: Bump uuid package to remove a deprecation warning (thanks @yhuard!)
-- 8076c43b: Fixed how the cummulative gas is computed for receipts and added a missing field (Thanks @ngotchac!)
+- 8076c43b: Fixed how the cumulative gas is computed for receipts and added a missing field (Thanks @ngotchac!)
 - e6362902: Display similar artifact names in error output if given name is not found (#201)
 - e087bd0b: Improve validation of private keys in the Hardhat config
 - aa1a0080: Fix an issue with new versions of Node.js that prevented clients from connecting to Hardhat's node using 127.0.0.1

packages/hardhat-core/src/builtin-tasks/compile.ts

@@ -1113,7 +1113,7 @@ subtask(TASK_COMPILE_SOLIDITY_GET_COMPILATION_JOBS_FAILURE_REASONS)
       compilationJobsCreationErrors: CompilationJobCreationError[];
     }): Promise<string> => {
       const noCompatibleSolc: CompilationJobCreationError[] = [];
-      const incompatibleOverridenSolc: CompilationJobCreationError[] = [];
+      const incompatibleOverriddenSolc: CompilationJobCreationError[] = [];
       const directlyImportsIncompatibleFile: CompilationJobCreationError[] = [];
       const indirectlyImportsIncompatibleFile: CompilationJobCreationError[] =
         [];
@@ -1127,9 +1127,9 @@ subtask(TASK_COMPILE_SOLIDITY_GET_COMPILATION_JOBS_FAILURE_REASONS)
           noCompatibleSolc.push(error);
         } else if (
           error.reason ===
-          CompilationJobCreationErrorReason.INCOMPATIBLE_OVERRIDEN_SOLC_VERSION
+          CompilationJobCreationErrorReason.INCOMPATIBLE_OVERRIDDEN_SOLC_VERSION
         ) {
-          incompatibleOverridenSolc.push(error);
+          incompatibleOverriddenSolc.push(error);
         } else if (
           error.reason ===
           CompilationJobCreationErrorReason.DIRECTLY_IMPORTS_INCOMPATIBLE_FILE
@@ -1151,12 +1151,12 @@ subtask(TASK_COMPILE_SOLIDITY_GET_COMPILATION_JOBS_FAILURE_REASONS)
       }
 
       let errorMessage = "";
-      if (incompatibleOverridenSolc.length > 0) {
+      if (incompatibleOverriddenSolc.length > 0) {
         errorMessage += `The compiler version for the following files is fixed through an override in your config file to a version that is incompatible with their Solidity version pragmas.
 
 `;
 
-        for (const error of incompatibleOverridenSolc) {
+        for (const error of incompatibleOverriddenSolc) {
           const { sourceName } = error.file;
           const { versionPragmas } = error.file.content;
           const versionsRange = versionPragmas.join(" ");

packages/hardhat-core/src/builtin-tasks/test.ts

@@ -13,7 +13,7 @@ import {
   isTypescriptFile,
 } from "../internal/core/typescript-support";
 import { getForkCacheDirPath } from "../internal/hardhat-network/provider/utils/disk-cache";
-import { showForkRecommendationsBannerIfNecessary } from "../internal/hardhat-network/provider/utils/fork-recomendations-banner";
+import { showForkRecommendationsBannerIfNecessary } from "../internal/hardhat-network/provider/utils/fork-recommendations-banner";
 import { pluralize } from "../internal/util/strings";
 import { getAllFilesMatching } from "../internal/util/fs-utils";
 import { getProjectPackageJson } from "../internal/util/packageInfo";

packages/hardhat-core/src/internal/core/providers/errors.ts

@@ -17,7 +17,7 @@ import { CustomError } from "../errors";
 //
 // Non standard:
 
-// -32999 Invalid response      The server returned a JSON-RPC      hardhat-sepecific
+// -32999 Invalid response      The server returned a JSON-RPC      hardhat-specific
 //                              response, but the result is not
 //                              in the expected format
 //