Merge pull request #2181 from o1-labs/boray/ci-typo-check

Add typo check workflow

Author: boray

.github/workflows/checks.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Build
         uses: ./.github/actions/build
 
-  Lint-and-format:
+  Lint-Format-and-TypoCheck:
     strategy:
       matrix:
         node: [20]
@@ -68,6 +68,16 @@ jobs:
       - name: Run Oxlint
         if: steps.get_changed_files.outputs.files_changed == 'true'
         run: xargs npm run lint:strict < changed_files.txt
+      
+      - name: Run codespell
+        if: steps.get_changed_files.outputs.files_changed == 'true' && github.event.pull_request.labels.*.name != 'no-typo-check'
+        uses: codespell-project/actions-codespell@master
+        with:
+          check_filenames: true
+          path: ${{ steps.get_changed_files.outputs.files }}
+          skip: "*.json,./node_modules,./dist,./.husky,./.git,./src/mina/**/*,./src/bindings/compiled/**/*"
+          check_hidden: false
+          ignore_words_list: "tHi,modul,optin,deriver,PRing,toWords,iSelf"
 
   Upload-bindings:
     name: upload bindings artifact

README-dev.md

@@ -41,7 +41,7 @@ These files only have to be regenerated if there are changes to the OCaml or Rus
 
 ### External contributors
 
-Unfortunatel you generally won't be able to run `npm run build:bindings-download` on your own commits
+Unfortunately you generally won't be able to run `npm run build:bindings-download` on your own commits
 because the artifacts won't have been built for them, so make sure to run it on main before you start making changes.
 In a fresh git repo `npm run build` also works.
 

flake.nix

@@ -315,7 +315,7 @@
             buildCommand = ''
                 cp -R $src/* .
                 rm env-vars
-                #restore write permisions removed by nix store
+                #restore write permissions removed by nix store
                 chmod +w -R .
                 tar czf $out .
             '';

src/bindings/crypto/bindings/bigint256.ts

@@ -102,7 +102,7 @@ function caml_bytes_unsafe_set(s: MlBytes, i: number, c: number) {
   if (s.t != 4 /* ARRAY */) {
     if (i == s.c.length) {
       s.c += String.fromCharCode(c);
-      if (i + 1 == s.l) s.t = 0; /*BYTES | UNKOWN*/
+      if (i + 1 == s.l) s.t = 0; /*BYTES | UNKNOWN*/
       return 0;
     }
     caml_convert_bytes_to_array(s);

src/bindings/crypto/elliptic-curve-endomorphism.ts

@@ -140,11 +140,11 @@ function endomorphismProjective(
 }
 
 /**
- * Faster scalar muliplication leveraging the GLV decomposition (see {@link decompose}).
+ * Faster scalar multiplication leveraging the GLV decomposition (see {@link decompose}).
  *
  * This method to speed up plain, non-provable scalar multiplication was the original application of GLV
  *
- * Instead of scaling a single point, we apply the decomposition to scale two points, with two scalars of half the orginal length:
+ * Instead of scaling a single point, we apply the decomposition to scale two points, with two scalars of half the original length:
  *
  * `s*G = s0*G + s1*lambda*G = s0*G + s1*endo(G)`, where endo(G) is cheap to compute
  *
@@ -251,7 +251,7 @@ function computeGlvData(q: bigint, lambda: bigint) {
 type GlvData = ReturnType<typeof computeGlvData>;
 
 /**
- * Extended Euclidian algorithm which stops when r1 < sqrt(p)
+ * Extended Euclidean algorithm which stops when r1 < sqrt(p)
  *
  * Input: positive integers l, p
  *