ci: make flake work with luarocks

Author: jghauser

flake.lock

@@ -1,77 +1,57 @@
 {
-  description = "Papis.nvim development environment";
+  description = "Papis.nvim flake";
 
   inputs = {
-    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
+
+    flake-parts.url = "github:hercules-ci/flake-parts";
   };
 
-  outputs = {
+  outputs = inputs @ {
     self,
     nixpkgs,
+    flake-parts,
     ...
   }: let
-    systems = ["x86_64-linux" "i686-linux" "x86_64-darwin" "aarch64-linux" "aarch64-darwin"];
-    forAllSystems = f:
-      builtins.listToAttrs (map (name: {
-          inherit name;
-          value = f name;
-        })
-        systems);
-  in {
-    packages =
-      forAllSystems
-      (system: let
-        pkgs = import nixpkgs {
-          inherit system;
-        };
-      in {
-        papis-nvim = pkgs.vimUtils.buildVimPlugin {
-          pname = "papis.nvim";
-          version = toString (self.shortRev or self.dirtyShortRev or self.lastModified or "unknown");
-          src = self;
-          dependencies = [
-            pkgs.vimPlugins.telescope-nvim
-            pkgs.vimPlugins.sqlite-lua
-            pkgs.vimPlugins.plenary-nvim
-            pkgs.vimPlugins.nui-nvim
-            pkgs.vimPlugins.nvim-treesitter-parsers.yaml
-          ];
-        };
-      });
+    name = "papis.nvim";
 
-    overlays.default = final: prev: {
-      vimPlugins = prev.vimPlugins.extend (f: p: {
-        papis-nvim = self.packages.${final.system}.papis-nvim;
-      });
+    plugin-overlay = import ./nix/plugin-overlay.nix {
+      inherit name self;
     };
-    devShells =
-      forAllSystems
-      (system: let
+  in
+    flake-parts.lib.mkFlake {inherit inputs;} {
+      systems = [
+        "x86_64-linux"
+        "x86_64-darwin"
+        "aarch64-darwin"
+      ];
+      perSystem = {
+        config,
+        self',
+        inputs',
+        system,
+        ...
+      }: let
+        ci-overlay = import ./nix/ci-overlay.nix {
+          inherit self name;
+        };
+
         pkgs = import nixpkgs {
           inherit system;
+          overlays = [
+            plugin-overlay
+            ci-overlay
+          ];
         };
-      in {
-        default = pkgs.mkShell {
-          buildInputs = let
-            custom-nvim = pkgs.neovim.override {
-              configure = {
-                customRC = ''
-                  luafile ./tests/minimal_init.lua
-                '';
-                packages.myVimPackage.start =
-                  self.packages.${system}.papis-nvim.dependencies
-                  ++ [
-                    pkgs.vimPlugins.nvim-cmp
-                  ];
-              };
-            };
 
+        devShell = pkgs.mkShell {
+          buildInputs = let
             nvim-test = pkgs.writeShellApplication {
               name = "nvim-test";
               text =
                 # bash
                 ''
-                  ${custom-nvim}/bin/nvim -c "lua _Load_papis()" -c "e test.md"
+                  ${pkgs.neovim-with-papis}/bin/nvim -c "lua _Load_papis()" -c "e test.md"
                 '';
             };
           in [
@@ -81,6 +61,20 @@
             nvim-test
           ];
         };
-      });
-  };
+      in {
+        devShells = {
+          default = devShell;
+          inherit devShell;
+        };
+
+        packages = rec {
+          default = papis-nvim;
+          inherit (pkgs.luajitPackages) papis-nvim;
+          inherit (pkgs) neovim-with-papis;
+        };
+      };
+      flake = {
+        overlays.default = plugin-overlay;
+      };
+    };
 }

flake.nix

@@ -0,0 +1,98 @@
+# Add flake.nix test inputs as arguments here
+{
+  self,
+  name,
+}: final: prev: let
+  mkNvimMinimal = nvim:
+    with final; let
+      neovimConfig = neovimUtils.makeNeovimConfig {
+        withPython3 = true;
+        viAlias = true;
+        vimAlias = true;
+        extraLuaPackages = luaPkgs: [
+          luaPkgs.papis-nvim
+        ];
+        plugins = with vimPlugins; [
+          telescope-nvim
+          nvim-cmp
+          (nvim-treesitter.withPlugins (ps:
+            with ps; [
+              tree-sitter-yaml
+            ]))
+        ];
+      };
+      runtimeDeps = [
+        yq-go
+      ];
+    in
+      final.wrapNeovimUnstable nvim (neovimConfig
+        // {
+          wrapperArgs =
+            lib.escapeShellArgs neovimConfig.wrapperArgs
+            + " "
+            + ''--set NVIM_APPNAME "nvim-papis"''
+            + " "
+            + ''--prefix PATH : "${lib.makeBinPath runtimeDeps}"'';
+          wrapRc = true;
+          neovimRcContent =
+            # lua
+            ''
+              lua << EOF
+              local o = vim.o
+              local cmd = vim.cmd
+              local fn = vim.fn
+
+              o.termguicolors = true
+              o.swapfile = false
+
+              vim.opt.runtimepath:prepend(vim.fn.getcwd())
+
+              -- setup dependencies
+              local cmp = require("cmp")
+              cmp.setup({
+                mapping = cmp.mapping.preset.insert({
+                  ["<C-b>"] = cmp.mapping.scroll_docs(-4),
+                  ["<C-f>"] = cmp.mapping.scroll_docs(4),
+                  ["<C-Space>"] = cmp.mapping.complete(),
+                  ["<C-e>"] = cmp.mapping.abort(),
+                  ["<CR>"] = cmp.mapping.confirm({ select = true }), -- Accept currently selected item. Set `select` to `false` to only confirm explicitly selected items.
+                }),
+                sources = cmp.config.sources({
+                  -- your other source
+                  { name = "papis" },
+                }),
+              })
+
+              -- remap leader
+              vim.g.mapleader = " "
+
+              ---Sets up papis
+              ---@param opts table? Custom configuration options
+              ---@param autostart? boolean? Enable autostart (defaults to `true`)
+              ---@param rm_db? boolean? Delete db (defaults to `false`)
+              function _Load_papis(opts, rm_db)
+                local db_path = vim.fn.stdpath("cache") .. "/papis_db/papis-nvim-test.sqlite3"
+                local default_config = {
+                  enable_modules = {
+                    ["debug"] = true,
+                    ["testing"] = true,
+                  },
+                  enable_keymaps = true,
+                  db_path = vim.fn.stdpath("cache") .. "/papis_db/papis-nvim-test.sqlite3",
+                }
+                local new_config = vim.tbl_deep_extend("force", default_config, opts or {})
+                local init_result = require("papis").setup(new_config)
+
+                -- remove previous db
+                if rm_db then
+                  os.remove(db_path)
+                end
+
+                return init_result
+              end
+              EOF
+            '';
+        });
+in {
+  neovim-with-papis = mkNvimMinimal final.neovim-unwrapped;
+}

nix/ci-overlay.nix

@@ -0,0 +1,55 @@
+{
+  name,
+  self,
+}: final: prev: let
+  papis-nvim-luaPackage-override = luaself: luaprev: {
+    papis-nvim = luaself.callPackage ({
+      buildLuarocksPackage,
+      lua,
+      luaOlder,
+      nui-nvim,
+      sqlite,
+      plenary-nvim,
+      pathlib-nvim,
+    }:
+      buildLuarocksPackage {
+        pname = name;
+        version = "scm-1";
+        knownRockspec = "${self}/papis.nvim-scm-1.rockspec";
+        disabled = luaOlder "5.1";
+        propagatedBuildInputs = [
+          nui-nvim
+          sqlite
+          plenary-nvim
+          pathlib-nvim
+        ];
+        src = self;
+      }) {};
+  };
+
+  lua5_1 = prev.lua5_1.override {
+    packageOverrides = papis-nvim-luaPackage-override;
+  };
+  lua51Packages = prev.lua51Packages // final.lua5_1.pkgs;
+  luajit = prev.luajit.override {
+    packageOverrides = papis-nvim-luaPackage-override;
+  };
+  luajitPackages = prev.luajitPackages // final.luajit.pkgs;
+in {
+  inherit
+    lua5_1
+    lua51Packages
+    luajit
+    luajitPackages
+    ;
+
+  vimPlugins =
+    prev.vimPlugins
+    // {
+      papis-nvim = final.neovimUtils.buildNeovimPlugin {
+        pname = name;
+        src = self;
+        version = "dev";
+      };
+    };
+}