flake: formatter: adopt alejandra

Because formatters may wrap long lines with comments, I have replaced `LOAD-BEARING COMMENT` on the package's `version` attribute with `@VERSION@`. This was done so that `sed` can still match the line, because it is short enough to not wrap at 80 columns.
MercuryTechnologies · Sep 13, 2023 · f75461c · f75461c
1 parent d9553bc
commit f75461c
Show file tree

Hide file tree

Showing 5 changed files with 166 additions and 91 deletions.
diff --git a/.github/workflows/version.yaml b/.github/workflows/version.yaml
@@ -108,7 +108,7 @@ jobs:
       - name: Increment `flake.nix` version
         run: |
           sed -i \
-              -e "s/version = \"[^\"]*\"; # LOAD-BEARING COMMENT/version = \"${{ steps.new_cargo_metadata.outputs.version }}\"; # LOAD-BEARING COMMENT/" \
+              -e "s/version = \"[^\"]*\"; # @VERSION@/version = \"${{ steps.new_cargo_metadata.outputs.version }}\"; # @VERSION@/" \
               flake.nix
 
           # Commit the new changes

diff --git a/default.nix b/default.nix
@@ -1,14 +1,8 @@
-(
-  import
-  (
-    let
-      lock = builtins.fromJSON (builtins.readFile ./flake.lock);
-    in
-      fetchTarball {
-        url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
-        sha256 = lock.nodes.flake-compat.locked.narHash;
-      }
-  )
-  {src = ./.;}
-)
+(import (let
+  lock = builtins.fromJSON (builtins.readFile ./flake.lock);
+in
+  fetchTarball {
+    url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
+    sha256 = lock.nodes.flake-compat.locked.narHash;
+  }) {src = ./.;})
 .defaultNix
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -8,87 +8,82 @@
       url = "github:edolstra/flake-compat";
       flake = false;
     };
+    alejandra.url = "github:kamadorueda/alejandra";
   };
 
   outputs = {
     self,
     nixpkgs,
     systems,
+    alejandra,
     ...
-  }:
-    let
-      inherit (nixpkgs) lib;
-      eachSystem = fn: lib.genAttrs (import systems) (system:
-        let
-          pkgs = import nixpkgs {
-            localSystem = system;
-            overlays = [self.overlays.default];
-          };
-        in
-          fn pkgs system
-      );
-    in {
-      packages = eachSystem (pkgs: system: {
-        nix-your-shell = pkgs.nix-your-shell;
-        default = self.packages.${system}.nix-your-shell;
-      });
+  }: let
+    inherit (nixpkgs) lib;
+    eachSystem = fn:
+      lib.genAttrs (import systems) (system: let
+        pkgs = import nixpkgs {
+          localSystem = system;
+          overlays = [self.overlays.default];
+        };
+      in
+        fn pkgs system);
+  in {
+    packages = eachSystem (pkgs: system: {
+      nix-your-shell = pkgs.nix-your-shell;
+      default = self.packages.${system}.nix-your-shell;
+    });
 
-      checks = eachSystem (_: system: self.packages.${system});
+    checks = eachSystem (_: system: self.packages.${system});
 
-        # for debugging
-        # inherit pkgs;
+    # for debugging
+    # inherit pkgs;
 
-        devShells = eachSystem (pkgs: system: {
-          default = pkgs.nix-your-shell.overrideAttrs (
-            old: {
-              # Make rust-analyzer work
-              RUST_SRC_PATH = pkgs.rustPlatform.rustLibSrc;
+    devShells = eachSystem (pkgs: system: {
+      default = pkgs.nix-your-shell.overrideAttrs (old: {
+        # Make rust-analyzer work
+        RUST_SRC_PATH = pkgs.rustPlatform.rustLibSrc;
 
-              # Any dev tools you use in excess of the rust ones
-              nativeBuildInputs =
-                old.nativeBuildInputs;
-            }
-          );
-        });
+        # Any dev tools you use in excess of the rust ones
+        nativeBuildInputs = old.nativeBuildInputs;
+      });
+    });
 
-      overlays.default = (
-        final: prev: {
-          nix-your-shell = final.rustPlatform.buildRustPackage {
-            pname = "nix-your-shell";
-            version = "1.3.0"; # LOAD-BEARING COMMENT. See: `.github/workflows/version.yaml`
+    overlays.default = final: prev: {
+      nix-your-shell = final.rustPlatform.buildRustPackage {
+        pname = "nix-your-shell";
+        # The comment below is a target for `sed` to match. Do not remove.
+        # See `.github/workflows/version.yaml`.
+        version = "1.3.0"; # @VERSION@
 
-            cargoLock = {
-              lockFile = ./Cargo.lock;
-            };
+        cargoLock = {lockFile = ./Cargo.lock;};
 
-            src = ./.;
+        src = ./.;
 
-            # Tools on the builder machine needed to build; e.g. pkg-config
-            nativeBuildInputs = [
-              final.rustfmt
-              final.clippy
-            ];
+        # Tools on the builder machine needed to build; e.g. pkg-config
+        nativeBuildInputs = [final.rustfmt final.clippy];
 
-            # Native libs
-            buildInputs = [];
+        # Native libs
+        buildInputs = [];
 
-            postCheck = ''
-              cargo fmt --check && echo "\`cargo fmt\` is OK"
-              cargo clippy -- --deny warnings && echo "\`cargo clippy\` is OK"
-            '';
+        postCheck = ''
+          cargo fmt --check && echo "\`cargo fmt\` is OK"
+          cargo clippy -- --deny warnings && echo "\`cargo clippy\` is OK"
+        '';
 
-            passthru.generate-config = shell: final.runCommand "nix-your-shell-config" { } ''
-              ${final.nix-your-shell}/bin/nix-your-shell ${shell} >> $out
-            '';
+        passthru.generate-config = shell:
+          final.runCommand "nix-your-shell-config" {} ''
+            ${final.nix-your-shell}/bin/nix-your-shell ${shell} >> $out
+          '';
 
-            meta = {
-              homepage = "https://github.com/MercuryTechnologies/nix-your-shell";
-              license = lib.licenses.mit;
-              platforms = import systems;
-              mainProgram = "nix-your-shell";
-            };
-          };
-        }
-      );
+        meta = {
+          homepage = "https://github.com/MercuryTechnologies/nix-your-shell";
+          license = lib.licenses.mit;
+          platforms = import systems;
+          mainProgram = "nix-your-shell";
+        };
+      };
     };
+
+    formatter = eachSystem (_: system: alejandra.packages.${system}.default);
+  };
 }
diff --git a/shell.nix b/shell.nix
@@ -1,14 +1,8 @@
-(
-  import
-  (
-    let
-      lock = builtins.fromJSON (builtins.readFile ./flake.lock);
-    in
-      fetchTarball {
-        url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
-        sha256 = lock.nodes.flake-compat.locked.narHash;
-      }
-  )
-  {src = ./.;}
-)
+(import (let
+  lock = builtins.fromJSON (builtins.readFile ./flake.lock);
+in
+  fetchTarball {
+    url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
+    sha256 = lock.nodes.flake-compat.locked.narHash;
+  }) {src = ./.;})
 .defaultNix