Merge pull request #131 from Uzaaft/feat/nix-ci

build(nix): add alejandra and formatting nix code to CI
ghostty-org · Jan 17, 2025 · 0ca7da9 · 0ca7da9
2 parents 406912f + 8e278a2
commit 0ca7da9
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 64 deletions.
diff --git a/.github/workflows/ruff.yml b/.github/workflows/ruff.yml
@@ -20,3 +20,4 @@ jobs:
         run: |
           nix develop -c ruff check
           nix develop -c ruff format --check
+          nix develop -c alejandra --check .
diff --git a/flake.nix b/flake.nix
@@ -17,25 +17,35 @@
     };
 
     # Used for shell.nix
-    flake-compat = { url = github:edolstra/flake-compat; flake = false; };
+    flake-compat = {
+      url = github:edolstra/flake-compat;
+      flake = false;
+    };
   };
 
-  outputs = { self, nixpkgs, flake-utils, ... }@inputs:
-    let
-      overlays = [
-        # Our repo overlay
-        (import ./nix/overlay.nix)
-
-        # poetry2nix overlay
-        inputs.poetry2nix.overlays.default
-      ];
-
-      # Our supported systems are the same supported systems as the Zig binaries
-      systems = builtins.attrNames inputs.zig.packages;
-    in flake-utils.lib.eachSystem systems (system:
-      let pkgs = import nixpkgs { inherit overlays system; };
+  outputs = {
+    self,
+    nixpkgs,
+    flake-utils,
+    ...
+  } @ inputs: let
+    overlays = [
+      # Our repo overlay
+      (import ./nix/overlay.nix)
+
+      # poetry2nix overlay
+      inputs.poetry2nix.overlays.default
+    ];
+
+    # Our supported systems are the same supported systems as the Zig binaries
+    systems = builtins.attrNames inputs.zig.packages;
+  in
+    flake-utils.lib.eachSystem systems (
+      system: let
+        pkgs = import nixpkgs {inherit overlays system;};
       in rec {
         devShell = pkgs.devShell;
+        formatter = pkgs.alejandra;
 
         packages.app = pkgs.app;
         defaultPackage = packages.app;

diff --git a/nix/devshell.nix b/nix/devshell.nix
@@ -1,34 +1,45 @@
-{ mkShell, lib, stdenv
+{
+  mkShell,
+  lib,
+  stdenv,
+  # Deps
+  poetry,
+  python3,
+  # Our app
+  pythonApp,
+  # Deps for ci
+  alejandra,
+}: let
+  rpathLibs =
+    [
+      # None yet
+    ]
+    ++ lib.optionals stdenv.isLinux [
+      # None yet
+    ];
+in
+  mkShell rec {
+    name = "ghostty-discord-bot";
 
-# Deps
-, poetry
-, python3
+    nativeBuildInputs =
+      [
+        # Python lib
+        python3
+        poetry
+      ]
+      ++ lib.optionals stdenv.isLinux [
+        # None yet
+      ];
 
-# Our app
-, pythonApp
-}:
-let
-  rpathLibs = [
-    # None yet
-  ] ++ lib.optionals stdenv.isLinux [
-    # None yet
-  ];
+    packages = [
+      # Required for CI for format checking.
+      alejandra
+    ];
 
-in mkShell rec {
-  name = "ghostty-discord-bot";
+    buildInputs = rpathLibs ++ [pythonApp.devEnv];
 
-  nativeBuildInputs = [
-    # Python lib
-    python3
-    poetry
-  ] ++ lib.optionals stdenv.isLinux [
-    # None yet
-  ];
-
-  buildInputs = rpathLibs ++ [ pythonApp.devEnv ];
-
-  # 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;
-  DYLD_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;
+    DYLD_LIBRARY_PATH = lib.makeLibraryPath rpathLibs;
+  }
diff --git a/nix/overlay.nix b/nix/overlay.nix
@@ -8,7 +8,7 @@ final: prev: rec {
   #
 
   # Our custom packages related directly to our application
-  devShell = prev.callPackage ./devshell.nix { };
-  pythonApp = prev.callPackage ./python-app.nix { };
-  app = prev.callPackage ./package.nix { };
+  devShell = prev.callPackage ./devshell.nix {};
+  pythonApp = prev.callPackage ./python-app.nix {};
+  app = prev.callPackage ./package.nix {};
 }
diff --git a/nix/package.nix b/nix/package.nix
@@ -1,9 +1,8 @@
-{ stdenv
-, writeShellScriptBin
-, pythonApp
-}:
-
-let
+{
+  stdenv,
+  writeShellScriptBin,
+  pythonApp,
+}: let
   # The main script to run the app
   app = writeShellScriptBin "app" ''
     ${pythonApp.app.dependencyEnv}/bin/uvicorn 'app.main:app' \
@@ -15,13 +14,14 @@ let
   shell = writeShellScriptBin "shell" ''
     ${pythonApp.app.dependencyEnv}/bin/python
   '';
-in stdenv.mkDerivation {
-  name = "ghostty-discord-bot";
-  version = "0.1.0";
-  phases = "installPhase fixupPhase";
-  installPhase = ''
-    mkdir -p $out/bin
-    ln -s ${app}/bin/app $out/bin/app
-    ln -s ${shell}/bin/shell $out/bin/shell
-  '';
-}
+in
+  stdenv.mkDerivation {
+    name = "ghostty-discord-bot";
+    version = "0.1.0";
+    phases = "installPhase fixupPhase";
+    installPhase = ''
+      mkdir -p $out/bin
+      ln -s ${app}/bin/app $out/bin/app
+      ln -s ${shell}/bin/shell $out/bin/shell
+    '';
+  }