From 35b1af822292e759033e9dc5818653cd36e3dce1 Mon Sep 17 00:00:00 2001
From: Aaron Adams <fidgetingbits@users.noreply.github.com>
Date: Fri, 28 Jun 2024 22:15:21 +0800
Subject: [PATCH] Add nix flake (#1908)

Adds a flake I have been using for development on a Nix box, which I've
confirmed works to run pre-commit linting, correctly installs plugins,
can debug extension, etc.

## Checklist

- [-] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [-] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [-] I have not broken the cheatsheet

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
---
 .envrc     |  1 +
 .gitignore |  3 +++
 flake.lock | 27 ++++++++++++++++++++++++++
 flake.nix  | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 87 insertions(+)
 create mode 100644 .envrc
 create mode 100644 flake.lock
 create mode 100644 flake.nix

diff --git a/.envrc b/.envrc
new file mode 100644
index 0000000000..3550a30f2d
--- /dev/null
+++ b/.envrc
@@ -0,0 +1 @@
+use flake
diff --git a/.gitignore b/.gitignore
index 90e5d79bb0..b12c598ac0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -42,3 +42,6 @@ next-env.d.ts
 
 # test subset config
 packages/test-harness/testSubsetGrep.properties
+
+# nix
+.direnv/
diff --git a/flake.lock b/flake.lock
new file mode 100644
index 0000000000..a1271a0ba5
--- /dev/null
+++ b/flake.lock
@@ -0,0 +1,27 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1709675310,
+        "narHash": "sha256-w61tqFEmuJ+/1rAwU7nkYZ+dN6sLwyobfLwX2Yn42FE=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "43d259f8d726113fac056e8bb17d5ac2dea3e0a8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}
diff --git a/flake.nix b/flake.nix
new file mode 100644
index 0000000000..e67220cfc5
--- /dev/null
+++ b/flake.nix
@@ -0,0 +1,56 @@
+{
+  description = "A Nix-flake-based development environment for Cursorless";
+
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+
+  outputs =
+    { self, nixpkgs }:
+    let
+      supportedSystems = [
+        "x86_64-linux"
+        "aarch64-linux"
+        "x86_64-darwin"
+        "aarch64-darwin"
+      ];
+      forEachSupportedSystem =
+        f: nixpkgs.lib.genAttrs supportedSystems (system: f { pkgs = import nixpkgs { inherit system; }; });
+      pythonVersion = builtins.replaceStrings [ "py" ] [
+        "python"
+      ] (nixpkgs.lib.importTOML ./pyproject.toml).tool.ruff.target-version;
+    in
+    {
+      devShells = forEachSupportedSystem (
+        { pkgs }:
+        {
+          default = pkgs.mkShell {
+            packages =
+              let
+                python = pkgs.${pythonVersion};
+                pythonPackages = pkgs."${pythonVersion}Packages";
+              in
+              [
+                pkgs.corepack
+                pkgs.vsce
+                # https://github.com/NixOS/nixpkgs/pull/251418
+                (pkgs.pre-commit.overrideAttrs (previousAttrs: {
+                  makeWrapperArgs = ''
+                    --set PYTHONPATH $PYTHONPATH
+                  '';
+                }))
+
+                python
+              ];
+            # To prevent weird broken non-interactive bash terminal
+            buildInputs = [ pkgs.bashInteractive ];
+            shellHook = ''
+              if [ ! -f .git/hooks/pre-commit ]; then
+                pre-commit install
+              fi
+
+              pnpm install
+            '';
+          };
+        }
+      );
+    };
+}