Use Alejandra to format Nix modules.

Author: jcollie

.github/workflows/test.yml

@@ -147,3 +147,13 @@ jobs:
           nix_path: nixpkgs=channel:nixos-unstable
       - name: prettier check
         run: nix develop -c prettier --check .
+
+  alejandra:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4 # Check out repo so we can lint it
+      - uses: cachix/install-nix-action@v24
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+      - name: alejandra check
+        run: nix develop -c alejandra --check .

README.md

@@ -492,6 +492,8 @@ on vastly improving this experience over time.
 
 ### Linting
 
+#### Prettier
+
 Ghostty's docs and resources (not including Zig code) are linted using
 [Prettier](https://prettier.io) with out-of-the-box settings. A Prettier CI
 check will fail builds with improper formatting. Therefore, if you are
@@ -502,7 +504,32 @@ run this from the repo root before you commit:
 prettier --write .
 ```
 
-Make sure your Prettier version matches the version of in [devShell.nix](https://github.com/mitchellh/ghostty/blob/main/nix/devShell.nix).
+Make sure your Prettier version matches the version of Prettier in [devShell.nix](https://github.com/mitchellh/ghostty/blob/main/nix/devShell.nix).
+
+Nix users can use the following command to format with Prettier:
+
+```
+nix develop -c prettier --write .
+```
+
+#### Alejandra
+
+Nix modules are formatted with [Alejandra](https://github.com/kamadorueda/alejandra/). An Alejandra CI check
+will fail builds with improper formatting.
+
+Nix users can use the following command to format with Alejanda:
+
+```
+nix develop -c alejandra .
+```
+
+Non-Nix users should install Alejandra and use the follwing command to format with Alejanda:
+
+```
+alejandra .
+```
+
+Make sure your Alejandra version matches the version of Alejandra in [devShell.nix](https://github.com/mitchellh/ghostty/blob/main/nix/devShell.nix).
 
 ### Nix Package
 

flake.nix

@@ -31,32 +31,33 @@
   };
 
   outputs = {
-    nixpkgs-unstable
-  , nixpkgs-stable
-  , nixpkgs-zig-0-12
-  , zig
-  , zls
-  , ...
-  }: builtins.foldl' nixpkgs-stable.lib.recursiveUpdate {} (builtins.map (system: let
-    pkgs-stable = nixpkgs-stable.legacyPackages.${system};
-    pkgs-unstable = nixpkgs-unstable.legacyPackages.${system};
-    pkgs-zig-0-12 = nixpkgs-zig-0-12.legacyPackages.${system};
-  in {
-    devShell.${system} = pkgs-stable.callPackage ./nix/devShell.nix {
-      inherit (pkgs-unstable) tracy;
-      inherit (zls.packages.${system}) zls;
-
-      zig = zig.packages.${system}.master;
-      wraptest = pkgs-stable.callPackage ./nix/wraptest.nix {};
-    };
+    nixpkgs-unstable,
+    nixpkgs-stable,
+    nixpkgs-zig-0-12,
+    zig,
+    zls,
+    ...
+  }:
+    builtins.foldl' nixpkgs-stable.lib.recursiveUpdate {} (builtins.map (system: let
+      pkgs-stable = nixpkgs-stable.legacyPackages.${system};
+      pkgs-unstable = nixpkgs-unstable.legacyPackages.${system};
+      pkgs-zig-0-12 = nixpkgs-zig-0-12.legacyPackages.${system};
+    in {
+      devShell.${system} = pkgs-stable.callPackage ./nix/devShell.nix {
+        inherit (pkgs-unstable) tracy;
+        inherit (zls.packages.${system}) zls;
+
+        zig = zig.packages.${system}.master;
+        wraptest = pkgs-stable.callPackage ./nix/wraptest.nix {};
+      };
 
-    packages.${system} = rec {
-      ghostty = pkgs-stable.callPackage ./nix/package.nix {
-        inherit (pkgs-zig-0-12) zig_0_12;
+      packages.${system} = rec {
+        ghostty = pkgs-stable.callPackage ./nix/package.nix {
+          inherit (pkgs-zig-0-12) zig_0_12;
+        };
+        default = ghostty;
       };
-      default = ghostty;
-    };
 
-  # Our supported systems are the same supported systems as the Zig binaries.
-  }) (builtins.attrNames zig.packages));
+      # Our supported systems are the same supported systems as the Zig binaries.
+    }) (builtins.attrNames zig.packages));
 }

nix/devShell.nix

@@ -1,139 +1,145 @@
 {
-  mkShell
-, lib
-, stdenv
-
-, bashInteractive
-, gdb
-#, glxinfo # unused
-, ncurses
-, nodejs
-, nodePackages
-, oniguruma
-, parallel
-, pkg-config
-, python3
-, scdoc
-, tracy
-, valgrind
-#, vulkan-loader # unused
-, vttest
-, wabt
-, wasmtime
-, wraptest
-, zig
-, zip
-, zls
-, llvmPackages_latest
-
-, bzip2
-, expat
-, fontconfig
-, freetype
-, glib
-, gtk4
-, libadwaita
-, harfbuzz
-, libpng
-, libGL
-, libX11
-, libXcursor
-, libXext
-, libXi
-, libXinerama
-, libXrandr
-, pixman
-, zlib
-}:
-let
+  mkShell,
+  lib,
+  stdenv,
+  bashInteractive,
+  gdb,
+  #, glxinfo # unused
+  ncurses,
+  nodejs,
+  nodePackages,
+  oniguruma,
+  parallel,
+  pkg-config,
+  python3,
+  scdoc,
+  tracy,
+  valgrind,
+  #, vulkan-loader # unused
+  vttest,
+  wabt,
+  wasmtime,
+  wraptest,
+  zig,
+  zip,
+  zls,
+  llvmPackages_latest,
+  bzip2,
+  expat,
+  fontconfig,
+  freetype,
+  glib,
+  gtk4,
+  libadwaita,
+  harfbuzz,
+  libpng,
+  libGL,
+  libX11,
+  libXcursor,
+  libXext,
+  libXi,
+  libXinerama,
+  libXrandr,
+  pixman,
+  zlib,
+  alejandra,
+}: let
   # See package.nix. Keep in sync.
-  rpathLibs = [
-    libGL
-  ] ++ lib.optionals stdenv.isLinux [
-    bzip2
-    expat
-    fontconfig
-    freetype
-    harfbuzz
-    libpng
-    oniguruma
-    pixman
-    zlib
+  rpathLibs =
+    [
+      libGL
+    ]
+    ++ lib.optionals stdenv.isLinux [
+      bzip2
+      expat
+      fontconfig
+      freetype
+      harfbuzz
+      libpng
+      oniguruma
+      pixman
+      zlib
 
-    libX11
-    libXcursor
-    libXi
-    libXrandr
+      libX11
+      libXcursor
+      libXi
+      libXrandr
 
-    libadwaita
-    gtk4
-    glib
-  ];
-in mkShell {
-  name = "ghostty";
+      libadwaita
+      gtk4
+      glib
+    ];
+in
+  mkShell {
+    name = "ghostty";
 
-  nativeBuildInputs = [
-    # For builds
-    llvmPackages_latest.llvm
-    ncurses
-    pkg-config
-    scdoc
-    zig
-    zip
-    zls
+    nativeBuildInputs =
+      [
+        # For builds
+        llvmPackages_latest.llvm
+        ncurses
+        pkg-config
+        scdoc
+        zig
+        zip
+        zls
 
-    # For web and wasm stuff
-    nodejs
+        # For web and wasm stuff
+        nodejs
 
-    # Linting
-    nodePackages.prettier
+        # Linting
+        nodePackages.prettier
+        alejandra
 
-    # Testing
-    parallel
-    python3
-    tracy
-    vttest
+        # Testing
+        parallel
+        python3
+        tracy
+        vttest
 
-    # wasm
-    wabt
-    wasmtime
-  ] ++ lib.optionals stdenv.isLinux [
-    # My nix shell environment installs the non-interactive version
-    # by default so we have to include this.
-    bashInteractive
+        # wasm
+        wabt
+        wasmtime
+      ]
+      ++ lib.optionals stdenv.isLinux [
+        # My nix shell environment installs the non-interactive version
+        # by default so we have to include this.
+        bashInteractive
 
-    gdb
-    valgrind
-    wraptest
-  ];
+        gdb
+        valgrind
+        wraptest
+      ];
 
-  buildInputs = [
-    # TODO: non-linux
-  ] ++ lib.optionals stdenv.isLinux [
-    bzip2
-    expat
-    fontconfig
-    freetype
-    harfbuzz
-    libpng
-    oniguruma
-    pixman
-    zlib
+    buildInputs =
+      [
+        # TODO: non-linux
+      ]
+      ++ lib.optionals stdenv.isLinux [
+        bzip2
+        expat
+        fontconfig
+        freetype
+        harfbuzz
+        libpng
+        oniguruma
+        pixman
+        zlib
 
-    libX11
-    libXcursor
-    libXext
-    libXi
-    libXinerama
-    libXrandr
+        libX11
+        libXcursor
+        libXext
+        libXi
+        libXinerama
+        libXrandr
 
-    # Only needed for GTK builds
-    libadwaita
-    gtk4
-    glib
-  ];
+        # Only needed for GTK builds
+        libadwaita
+        gtk4
+        glib
+      ];
 
-  # This should be set onto the rpath of the ghostty binary if you want
-  # it to be "portable" across the system.
-  LD_LIBRARY_PATH = lib.makeLibraryPath rpathLibs;
-}
+    # This should be set onto the rpath of the ghostty binary if you want
+    # it to be "portable" across the system.
+    LD_LIBRARY_PATH = lib.makeLibraryPath rpathLibs;
+  }