feat: add typo check in ci

LagrangeDev · Feb 6, 2025 · fb75f74 · fb75f74
1 parent 42a7082
commit fb75f74
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -136,3 +136,21 @@ jobs:
       - name: Check test
         run: |
           nix build .#checks.x86_64-linux.audit 2>&1
+  check-typo:
+    runs-on: ubuntu-latest
+    needs: build-nixpkg
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Nix
+        uses: nixbuild/nix-quick-install-action@v27
+
+      - name: Restore Nix Cache
+        uses: nix-community/cache-nix-action@v5
+        with:
+          primary-key: nix-${{ runner.os }}-${{ hashFiles('flake.nix') }}
+
+      - name: Check test
+        run: |
+          nix build .#checks.x86_64-linux.typo 2>&1
diff --git a/.ignore b/.ignore
@@ -0,0 +1 @@
+/.git
diff --git a/flake.nix b/flake.nix
@@ -102,6 +102,17 @@
           };
         };
         cargoArtifacts = craneLib.buildDepsOnly commonArgs;
+        checkTypo =
+          pkgs.runCommandNoCCLocal "check-typo"
+            {
+              src = ./.;
+              nativeBuildInputs = with pkgs; [ typos ];
+            }
+            ''
+              mkdir -p $out
+
+              cd $src && typos -c $src/typos.toml
+            '';
       in
       {
         packages = {
@@ -123,6 +134,7 @@
         };
         checks = {
           inherit (self.packages."${system}") mania;
+          typo = checkTypo;
           audit = craneLib.cargoAudit (
             commonArgs
             // {

diff --git a/typos.toml b/typos.toml
@@ -0,0 +1,5 @@
+[files]
+ignore-hidden = false
+[default]
+check-filename = true
+check-file = true