flake: move packages to a by-name overlay

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I6a6a69642d9409f7d32e01a140cb62c2173b5226

flake/packages.nix

@@ -9,84 +9,114 @@
     lib,
     ...
   }: let
+    inherit (lib.customisation) makeScope;
+    inherit (lib.attrsets) isDerivation isAttrs concatMapAttrs;
+    inherit (lib.strings) concatStringsSep;
+    inherit (lib.filesystem) packagesFromDirectoryRecursive;
+
+    # Entrypoint for nvf documentation and relevant packages.
     docs = import ../docs {inherit pkgs inputs lib;};
+
+    # Helper function for creating demo configurations for nvf
+    # TODO: make this more generic.
     buildPkg = maximal:
       (args.config.flake.lib.nvim.neovimConfiguration {
         inherit pkgs;
         modules = [(import ../configuration.nix maximal)];
       }).neovim;
+
+    # This constructs a by-name overlay similar to the one found in Nixpkgs.
+    # The goal is to automatically discover and packages found in pkgs/by-name
+    # as long as they have a 'package.nix' in the package directory. We also
+    # pass 'inputs' and 'pins' to all packages in the 'callPackage' scope, therefore
+    # they are always available in the relevant 'package.nix' files.
+    # ---
+    # The logic is borrowed from drupol/pkgs-by-name-for-flake-parts, available
+    # under the MIT license.
+    flattenPkgs = separator: path: value:
+      if isDerivation value
+      then {
+        ${concatStringsSep separator path} = value;
+      }
+      else if isAttrs value
+      then concatMapAttrs (name: flattenPkgs separator (path ++ [name])) value
+      else
+        # Ignore the functions which makeScope returns
+        {};
+
+    inputsScope = makeScope pkgs.newScope (_: {
+      inherit inputs;
+      inherit (self) pins;
+    });
+
+    scopeFromDirectory = directory:
+      packagesFromDirectoryRecursive {
+        inherit directory;
+        inherit (inputsScope) newScope callPackage;
+      };
+
+    legacyPackages = scopeFromDirectory ./pkgs/by-name;
   in {
-    packages = {
+    packages =
-      blink-cmp = pkgs.callPackage ./blink {};
+      (flattenPkgs "/" [] legacyPackages)
-      avante-nvim = let
+      // {
-        pin = self.pins.avante-nvim;
+        inherit (docs.manual) htmlOpenTool;
-      in
-        pkgs.callPackage ./avante-nvim {
-          version = pin.branch;
-          src = pkgs.fetchFromGitHub {
-            inherit (pin.repository) owner repo;
-            rev = pin.revision;
-            sha256 = pin.hash;
-          };
-          pins = self.pins;
-        };
 
-      inherit (docs.manual) htmlOpenTool;
+        # Documentation
-      # Documentation
+        docs = docs.manual.html;
-      docs = docs.manual.html;
+        docs-html = docs.manual.html;
-      docs-html = docs.manual.html;
+        docs-manpages = docs.manPages;
-      docs-manpages = docs.manPages;
+        docs-json = docs.options.json;
-      docs-json = docs.options.json;
+        docs-linkcheck = let
-      docs-linkcheck = let
+          site = config.packages.docs;
-        site = config.packages.docs;
+        in
-      in
+          pkgs.testers.lycheeLinkCheck {
-        pkgs.testers.lycheeLinkCheck {
+            inherit site;
-          inherit site;
 
-          remap = {
+            remap = {
-            "https://notashelf.github.io/nvf/" = site;
+              "https://notashelf.github.io/nvf/" = site;
+            };
+
+            extraConfig = {
+              exclude = [];
+              include_mail = true;
+              include_verbatim = true;
+            };
           };
 
-          extraConfig = {
+        # Helper utility for building the HTML manual and opening it in the
-            exclude = [];
+        # browser with $BROWSER or using xdg-open as a fallback tool.
-            include_mail = true;
+        # Adapted from Home-Manager, available under the MIT license.
-            include_verbatim = true;
+        docs-html-wrapped = let
-          };
+          xdg-open = lib.getExe' pkgs.xdg-utils "xdg-open";
-        };
+          docs-html = docs.manual.html + /share/doc/nvf;
+        in
+          pkgs.writeShellScriptBin "docs-html-wrapped" ''
+            set -euo pipefail
 
-      # Helper utility for building the HTML manual and opening it in the
+            if [[ ! -v BROWSER || -z $BROWSER ]]; then
-      # browser with $BROWSER or using xdg-open as a fallback tool.
+              for candidate in xdg-open open w3m; do
-      # Adapted from Home-Manager, available under the MIT license.
+              BROWSER="$(type -P $candidate || true)"
-      docs-html-wrapped = let
+                if [[ -x $BROWSER ]]; then
-        xdg-open = lib.getExe' pkgs.xdg-utils "xdg-open";
+                  break;
-        docs-html = docs.manual.html + /share/doc/nvf;
+                fi
-      in
+              done
-        pkgs.writeShellScriptBin "docs-html-wrapped" ''
+            fi
-          set -euo pipefail
 
-          if [[ ! -v BROWSER || -z $BROWSER ]]; then
+            if [[ ! -v BROWSER || -z $BROWSER ]]; then
-            for candidate in xdg-open open w3m; do
+              echo "$0: unable to start a web browser; please set \$BROWSER"
-            BROWSER="$(type -P $candidate || true)"
+              echo "$0: Trying xdg-open as a fallback"
-              if [[ -x $BROWSER ]]; then
+              ${xdg-open} ${docs-html}/index.xhtml
-                break;
+            else
-              fi
+              echo "\$BROWSER is set. Attempting to open manual"
-            done
+              exec "$BROWSER" "${docs-html}/index.xhtml"
-          fi
+            fi
+          '';
 
-          if [[ ! -v BROWSER || -z $BROWSER ]]; then
+        # Exposed neovim configurations
-            echo "$0: unable to start a web browser; please set \$BROWSER"
+        nix = buildPkg false;
-            echo "$0: Trying xdg-open as a fallback"
+        maximal = buildPkg true;
-            ${xdg-open} ${docs-html}/index.xhtml
+        default = config.packages.nix;
-          else
+      };
-            echo "\$BROWSER is set. Attempting to open manual"
-            exec "$BROWSER" "${docs-html}/index.xhtml"
-          fi
-        '';
-
-      # Exposed neovim configurations
-      nix = buildPkg false;
-      maximal = buildPkg true;
-      default = config.packages.nix;
-    };
   };
 }

flake/pkgs/by-name/avante-nvim/package.nix

@@ -1,4 +1,5 @@
 {
+  pins,
   openssl,
   pkg-config,
   rustPlatform,
@@ -6,11 +7,17 @@
   vimUtils,
   makeWrapper,
   pkgs,
-  version,
-  src,
   ...
 }: let
-  inherit version src;
+  # From npins
+  pin = pins.avante-nvim;
+  version = pin.branch;
+  src = pkgs.fetchFromGitHub {
+    inherit (pin.repository) owner repo;
+    rev = pin.revision;
+    sha256 = pin.hash;
+  };
+
   avante-nvim-lib = rustPlatform.buildRustPackage {
     pname = "avante-nvim-lib";
     inherit version src;
@@ -48,10 +55,9 @@ in
       ext = stdenv.hostPlatform.extensions.sharedLibrary;
     in ''
       mkdir -p $out/build
-      ln -s ${avante-nvim-lib}/lib/libavante_repo_map${ext} $out/build/avante_repo_map${ext}
+      for lib in avante_repo_map avante_templates avante_tokenizers avante_html2md; do
-      ln -s ${avante-nvim-lib}/lib/libavante_templates${ext} $out/build/avante_templates${ext}
+        ln -s ${avante-nvim-lib}/lib/lib$lib${ext} $out/build/$$lib${ext}
-      ln -s ${avante-nvim-lib}/lib/libavante_tokenizers${ext} $out/build/avante_tokenizers${ext}
+      done
-      ln -s ${avante-nvim-lib}/lib/libavante_html2md${ext} $out/build/avante_html2md${ext}
     '';
 
     nvimSkipModules = [