add(nix): treefmt / alejandra (#1201)

* add(nix): treefmt / alejandra

* fmt the nix tree

* add fmt check for nix to ci

* switch `nixpkgs-fmt` -> `alejandra`

.github/workflows/nix.yml

@@ -9,26 +9,28 @@ on:
       - main
 
 jobs:
-  #check:
+  check:
-    #runs-on: ubuntu-latest
+    runs-on: ubuntu-latest
-    #name: "flake check"
+    name: "flake check"
-    #environment: cachix
+    environment: cachix
-    #timeout-minutes: 5
+    timeout-minutes: 5
-    #steps:
+    steps:
-      #- uses: actions/checkout@v3
+      - uses: actions/checkout@v3
-        #with:
+        with:
-          ## Nix Flakes doesn't work on shallow clones
+          # Nix Flakes doesn't work on shallow clones
-          #fetch-depth: 0
+          fetch-depth: 0
-      #- uses: cachix/install-nix-action@v16
+      - uses: cachix/install-nix-action@v16
-        #with:
+        with:
-          #extra_nix_config: |
+          extra_nix_config: |
-            #experimental-features = nix-command flakes
+            experimental-features = nix-command flakes
-          #fetch-depth: 0
+          fetch-depth: 0
-      #- uses: cachix/cachix-action@v10
+      - uses: cachix/cachix-action@v10
-        #with:
+        with:
-          #name: zellij
+          name: zellij
-          ## If you chose API tokens for write access OR if you have a private cache
+          # If you chose API tokens for write access OR if you have a private cache
-          #authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+      - run: nix develop .#fmtShell --command treefmt --fail-on-change
+      ## nix flake check still fails on IFD
       #- run: nix flake check --print-build-logs --show-trace
 
   build:

default.nix

@@ -10,4 +10,5 @@
 )
 {
   src = ./.;
-  }).defaultNix
+})
+.defaultNix

nix/crate2nix.nix

@@ -1,16 +1,17 @@
-{ pkgs
+{
-, crate2nix
+  pkgs,
-, name
+  crate2nix,
-, src
+  name,
-, postInstall
+  src,
-, nativeBuildInputs
+  postInstall,
-, desktopItems
+  nativeBuildInputs,
-, meta
+  desktopItems,
-}:
+  meta,
-
+}: let
-let
+  inherit
-  inherit (import "${crate2nix}/tools.nix" { inherit pkgs; })
+    (import "${crate2nix}/tools.nix" {inherit pkgs;})
-    generatedCargoNix;
+    generatedCargoNix
+    ;
 
   project = import
   (generatedCargoNix {
@@ -20,15 +21,15 @@ let
     inherit pkgs;
     buildRustCrateForPkgs = pkgs:
       pkgs.buildRustCrate.override {
-          defaultCrateOverrides = pkgs.defaultCrateOverrides // {
+        defaultCrateOverrides =
+          pkgs.defaultCrateOverrides
+          // {
             # Crate dependency overrides go here
             zellij = attrs: {
               inherit postInstall desktopItems meta name nativeBuildInputs;
-
             };
           };
       };
   };
-
 in
   project.workspaceMembers.zellij.build

nix/default.nix

@@ -1,9 +1,10 @@
-{ self
+{
-, nixpkgs
+  self,
-, rust-overlay
+  nixpkgs,
-, flake-utils
+  rust-overlay,
-, flake-compat
+  flake-utils,
-, crate2nix
+  flake-compat,
+  crate2nix,
 }:
 flake-utils.lib.eachSystem [
   "aarch64-linux"
@@ -12,20 +13,20 @@ flake-utils.lib.eachSystem [
   "x86_64-darwin"
   "x86_64-linux"
 ]
-  (system:
+(system: let
-    let
   overlays = [(import rust-overlay)];
 
   pkgs = import nixpkgs {inherit system overlays;};
 
-      crate2nixPkgs = import nixpkgs { inherit system;
+  crate2nixPkgs = import nixpkgs {
+    inherit system;
     overlays = [
       (self: _: {
         rustc = rustToolchainToml;
         cargo = rustToolchainToml;
       })
-
+    ];
-      ];};
+  };
 
   name = "zellij";
   pname = name;
@@ -37,7 +38,10 @@ flake-utils.lib.eachSystem [
 
   rustToolchainToml = pkgs.rust-bin.fromRustupToolchainFile ../rust-toolchain;
   cargoLock = {
-        lockFile = (builtins.path { path = ../Cargo.lock; name = "Cargo.lock"; });
+    lockFile = (builtins.path {
+      path = ../Cargo.lock;
+      name = "Cargo.lock";
+    });
   };
   cargo = rustToolchainToml;
   rustc = rustToolchainToml;
@@ -63,7 +67,6 @@ flake-utils.lib.eachSystem [
   devInputs = [
     pkgs.cargo-make
     pkgs.rust-analyzer
-        pkgs.nixpkgs-fmt
 
     # optimizes wasm binaries
     pkgs.binaryen
@@ -72,6 +75,11 @@ flake-utils.lib.eachSystem [
     pkgs.cargo-insta
   ];
 
+  fmtInputs = [
+    pkgs.alejandra
+    pkgs.treefmt
+  ];
+
   postInstall = ''
     mandown ./docs/MANPAGE.md > ./zellij.1
     installManPage ./zellij.1
@@ -107,21 +115,33 @@ flake-utils.lib.eachSystem [
     description = "A terminal workspace with batteries included";
     license = [licenses.mit];
   };
-    in
+in rec {
-    rec {
-
   # crate2nix - better incremental builds, but uses ifd
   packages.zellij = crate2nixPkgs.callPackage ./crate2nix.nix {
-          inherit crate2nix name src desktopItems postInstall
+    inherit
-          meta nativeBuildInputs;
+      name
+      src
+      nativeBuildInputs
+      crate2nix
+      desktopItems
+      postInstall
+      meta
+      ;
   };
 
   # native nixpkgs support - keep supported
   packages.zellij-native =
     (pkgs.makeRustPlatform {inherit cargo rustc;}).buildRustPackage {
-            inherit src name cargoLock
+      inherit
-            buildInputs nativeBuildInputs
+        src
-            postInstall desktopItems meta;
+        name
+        cargoLock
+        buildInputs
+        nativeBuildInputs
+        postInstall
+        desktopItems
+        meta
+        ;
     };
 
   defaultPackage = packages.zellij;
@@ -130,10 +150,16 @@ flake-utils.lib.eachSystem [
   apps.zellij = flake-utils.lib.mkApp {drv = packages.zellij;};
   defaultApp = apps.zellij;
 
-
+  devShells = {
-      devShell = pkgs.callPackage ./devShell.nix {
+    zellij = pkgs.callPackage ./devShell.nix {
       inherit buildInputs;
-        nativeBuildInputs = nativeBuildInputs ++ devInputs;
+      nativeBuildInputs = nativeBuildInputs ++ devInputs ++ fmtInputs;
+    };
+    fmtShell = pkgs.mkShell {
+      name = "fmt-shell";
+      nativeBuildInputs = fmtInputs;
+    };
   };
 
+  devShell = devShells.zellij;
 })

nix/devShell.nix

@@ -1,8 +1,8 @@
-{ mkShell
+{
-, buildInputs
+  mkShell,
-, nativeBuildInputs
+  buildInputs,
+  nativeBuildInputs,
 }:
-
 mkShell {
   name = "zj-dev-env";
   inherit buildInputs nativeBuildInputs;

shell.nix

@@ -10,4 +10,5 @@
 )
 {
   src = ./.;
-  }).shellNix
+})
+.shellNix

treefmt.toml

@@ -0,0 +1,3 @@
+[formatter.nix]
+command = "alejandra"
+includes = ["*.nix"]