Merge pull request #1 from formalco/eric/refactor-add-mac-support

FEATREQ-19: Add MacOS support to Nix overlays

Author: thatliuser

.github/workflows/test-build.yml

@@ -15,6 +15,10 @@ jobs:
             runner: ubuntu-24.04
           - os: Linux arm64
             runner: ubuntu-24.04-arm
+          - os: macOS arm64
+            runner: macos-latest
+          - os: macOS x86_64
+            runner: macos-latest
     runs-on: ${{ matrix.target.runner }}
     steps:
       - uses: actions/checkout@v4

README.md

@@ -56,6 +56,39 @@ add the overlay as shown below:
 }
 ```
 
+## Use with nix-darwin flake (recommended)
+If you're using a flake for your nix-darwin configuration, you can
+add the overlay as shown below:
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    nix-darwin = {
+      url = "github:nix-darwin/nix-darwin/master";
+      inputs.nixpkgs.follows = "nixpkgs";
+    }
+    formal-overlay = {
+      url = "github:formalco/formal-overlay";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+
+  outputs = { self, nix-darwin, nixpkgs, formal-overlay }:
+  {
+    # Build darwin flake using:
+    # $ darwin-rebuild build --flake .#yourHost
+    darwinConfigurations.yourHost = nix-darwin.lib.darwinSystem {
+      modules = [
+        ./configuration.nix
+        {
+          nixpkgs.overlays = [ formal-overlay.overlays.default ];
+        }
+      ];
+    };
+  };
+}
+```
+
 ## With fetchTarball
 If you're using a `configuration.nix` file, this approach is recommended. A
 sample configuration is shown below:

flake.nix

@@ -12,6 +12,7 @@
       systems = [
         "x86_64-linux"
         "aarch64-linux"
+        "aarch64-darwin"
       ];
 
       eachSystem =

pkgs/darwin.nix

@@ -0,0 +1,51 @@
+{
+  stdenv,
+  fetchurl,
+  pname,
+  version,
+  meta,
+  cpio,
+  xar,
+}:
+
+let
+  inherit (stdenv.hostPlatform) system;
+  fetch = hash: fetchurl {
+    url = "https://static-assets.formalcloud.net/desktop-app/darwin/formal-${version}.pkg";
+    inherit hash;
+  };
+
+  platforms = [ "aarch64-darwin" "x86_64-darwin" ];
+in
+stdenv.mkDerivation {
+  inherit pname version meta;
+
+  src = fetch "sha256-OnR3t+/Et9CWuomWZl+KyL/vdO+MOZyhJnyM6WkIVZY=";
+
+  nativeBuildInputs = [
+    cpio
+    xar
+  ];
+
+  unpackPhase = ''
+    runHook preUnpack
+
+    xar -xf $src
+    gunzip -c Payload | cpio -i
+    gunzip -c Scripts | cpio -i
+
+    runHook postUnpack
+  '';
+
+  installPhase = ''
+    runHook preInstall
+
+    mkdir -p "$out"/Applications/Formal.app
+    cp -r Contents "$out"/Applications/Formal.app
+
+    mkdir -p "$out"/bin
+    cp Contents/MacOS/formal "$out"/bin/formal
+
+    runHook postInstall
+  '';
+}

pkgs/formal.nix

@@ -2,60 +2,40 @@
   lib,
   stdenv,
   fetchurl,
+  callPackage,
   dpkg,
   autoPatchelfHook,
   gtk3,
+  cpio,
+  xar,
   libayatana-appindicator,
 }:
 
 let
-  inherit (stdenv.hostPlatform) system;
-  version = "0.1.4";
-  fetch = arch: hash: fetchurl {
-    url = "https://static-assets.formalcloud.net/desktop-app/linux/formal-desktop_${version}_${arch}.deb";
-    inherit hash;
-  };
-  sources = rec {
-    aarch64-linux = fetch "arm64" "sha256-yidonBngXgYO6r1JA3i938ZBBg0JTEjVxS9jyDSSWGY=";
-    x86_64-linux = fetch "amd64" "sha256-RiDafFAGewcydJguR57kzhoYahojR/oLj2AFiWxehvM=";
-  };
-  platforms = builtins.attrNames sources;
-in
-stdenv.mkDerivation rec {
   pname = "formal";
-  inherit version;
-
-  src = if (builtins.elem system platforms) then
-    sources.${system}
-  else
-    throw "Unsupported system: ${system}";
-
-  nativeBuildInputs = [
-    dpkg
-    autoPatchelfHook
-  ];
-
-  buildInputs = [
-    gtk3
-    libayatana-appindicator
-  ];
-
-  installPhase = ''
-    runHook preInstall
-    install -D -m755 usr/bin/formal $out/bin/formal
-    install -D usr/share/pixmaps/formal.png $out/share/pixmaps/formal.png
-    substituteInPlace usr/share/applications/formal.desktop \
-      --replace-fail /usr/bin/formal $out/bin/formal
-    install -D -m644 usr/share/applications/formal.desktop $out/share/applications/formal.desktop
-
-    runHook postInstall
-  '';
-
+  version = "0.3.1";
   meta = {
     description = "Formal Desktop";
     homepage = "https://joinformal.com";
     mainProgram = "formal";
     license = lib.licenses.unfree;
-    platforms = lib.platforms.linux;
+    platforms = lib.platforms.linux ++ lib.platforms.darwin;
   };
-}
+in
+# Referenced from https://github.com/NixOS/nixpkgs/blob/590a11b096aed29944ecb4ee32b746155117f85c/pkgs/by-name/_1/_1password-gui/package.nix
+if stdenv.hostPlatform.isDarwin then
+  callPackage ./darwin.nix {
+    inherit
+      pname
+      version
+      meta
+      ;
+  }
+else
+  callPackage ./linux.nix {
+    inherit
+      pname
+      version
+      meta
+      ;
+  }

pkgs/linux.nix

@@ -0,0 +1,53 @@
+{
+  stdenv,
+  fetchurl,
+  pname,
+  version,
+  meta,
+  dpkg,
+  autoPatchelfHook,
+  gtk3,
+  libayatana-appindicator,
+}:
+
+let
+  inherit (stdenv.hostPlatform) system;
+  fetch = arch: hash: fetchurl {
+    url = "https://static-assets.formalcloud.net/desktop-app/linux/formal-desktop_${version}_${arch}.deb";
+    inherit hash;
+  };
+
+  sources = rec {
+    aarch64-linux = fetch "arm64" "sha256-GrHTSo0uIx6KzB3xO8tXKLNdBRVf71Awkgniwbvag1w=";
+    x86_64-linux = fetch "amd64" "sha256-9FwakjTp1MJDl7ioyobgf38ycdwmOYi+KThcD5ZOOhY=";
+  };
+  platforms = builtins.attrNames sources;
+in
+stdenv.mkDerivation {
+  inherit pname version meta;
+
+  src = if (builtins.elem system platforms) then
+    sources.${system}
+  else
+    throw "Unsupported system: ${system}";
+
+  nativeBuildInputs = [
+      dpkg
+      autoPatchelfHook
+  ];
+
+  buildInputs = [
+      gtk3
+      libayatana-appindicator
+  ];
+
+  installPhase = ''
+      runHook preInstall
+      install -D -m755 usr/bin/formal $out/bin/formal
+      install -D usr/share/pixmaps/formal.png $out/share/pixmaps/formal.png
+      substituteInPlace usr/share/applications/formal.desktop \
+      --replace-fail /usr/bin/formal $out/bin/formal
+      install -D -m644 usr/share/applications/formal.desktop $out/share/applications/formal.desktop
+      runHook postInstall
+  '';
+}