tweak: include flake.lock in repository

.gitignore

@@ -1,6 +1,3 @@
 
 result*
 .direnv/
-
-flake.lock
-!/flake.lock

README.md

@@ -0,0 +1,46 @@
+# Toki's Nix Flake Template Repository
+
+This is my personal collection of Nix flake templates for various programming
+languages and build systems.
+
+## Motivation
+
+There already exists an [official repository of flake
+templates](https://github.com/NixOS/templates), so why make my own?
+
+I have a few different reasons:
+
+- **Comprehensiveness:** The official template repository is rather small and
+  doesn't have most of the templates I would actually want to use.
+- **Consistency:** The templates in the official repository are contributed by
+  community members, and there's very little stylistic or structural consistency
+  between them.
+- **Preference:** The structure of a flake can be very opinionated, and most of
+  the official flake templates are rather poorly constructed by my standards,
+  often not bothering to follow established best practices.
+
+## Usage
+
+Flake templates are used with the `nix flake init` command:
+
+```sh
+nix flake init -t git+https://git.tokinanpa.dev/toki/templates#<template>
+```
+
+Replace `<template>` with the template you want to use. In the simplest case,
+this is just the name of the programming language you want to use; the
+repository will pick a recommended default template for that language.
+
+If you want more control over the generated repository, you may select a
+specific template instead. Templates names are organized by underscore-separated
+*fields*; the number of fields may very depending on the language, but typically
+there are three or four:
+
+1. The programming language
+2. The build system used to compile/package the repository
+3. The Nix library/evaluation system used in the flake itself
+4. (Optional) Additional differences in project structure
+
+For example, the `python_pyproject_nixpkgs_cli` template generates a Python
+repository packaged in Pyproject format where the flake uses Nixpkgs' standard
+derivation builders (`buildPythonPackage`) and the repository exposes a CLI application.

bash/script/nixpkgs/flake.lock

@@ -0,0 +1,43 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1763806073,
+        "narHash": "sha256-FHsEKDvfWpzdADWj99z7vBk4D716Ujdyveo5+A048aI=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "878e468e02bfabeda08c79250f7ad583037f2227",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs",
+        "systems": "systems"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

fish/script/nixpkgs/flake.lock

@@ -0,0 +1,43 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1763806073,
+        "narHash": "sha256-FHsEKDvfWpzdADWj99z7vBk4D716Ujdyveo5+A048aI=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "878e468e02bfabeda08c79250f7ad583037f2227",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs",
+        "systems": "systems"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -3,41 +3,40 @@
 
   outputs = { self, ... }:
     let
+      aliases = {
+        bash = "bash_script_nixpkgs";
+        fish = "fish_script_nixpkgs";
+        python = "python_pyproject_nixpkgs_basic";
+      };
+
       # Get all project directories
       subdirs = dir:
-        let sub = builtins.readDir dir;
+        let sub = __readDir dir;
         in builtins.filter
           (d: sub.${d} == "directory")
           (builtins.attrNames sub);
 
-      vowelStart = str: builtins.elem (builtins.substring 0 1 str) [ "a" "e" "i" "o" "u" ];
-
       concatMapAttrs = func: attr:
         builtins.foldl' (x: y: x // y) {}
           (builtins.map func attr);
 
-      templateDirs =
+      flakeSubdirs = dir:
-        builtins.concatMap (lang:
+        builtins.concatMap (sub:
-          builtins.map
+          if builtins.pathExists /${dir}/${sub}/flake.nix then [ [ sub ] ] else
-            (pkg: { inherit lang pkg; })
+            builtins.map (l: [ sub ] ++ l) (flakeSubdirs /${dir}/${sub}))
-            (subdirs ./${lang}))
+          (subdirs dir);
-          (subdirs ./.);
     in {
-      templates = concatMapAttrs ({ lang, pkg }: {
+      templates = concatMapAttrs (path: {
-        "${lang}-${pkg}" = {
+        ${builtins.concatStringsSep "_" path} = {
-          description = "Packaging a${if vowelStart lang
+          description = "${builtins.head path} template - ${builtins.concatStringsSep
-                                      then "n"
+            ", " (builtins.tail path)}";
-                                      else ""} ${lang} executable using ${pkg}";
           path = builtins.filterSource
             (path: type: builtins.baseNameOf path != "flake.lock")
-            ./${lang}/${pkg};
+            (builtins.foldl' (dir: sub: /${dir}/${sub}) ./. path);
         };
-      }) templateDirs // concatMapAttrs (lang: {
+      }) (flakeSubdirs ./.) // builtins.mapAttrs (lang: def:
-        "${lang}" = self.templates."${lang}-nixpkgs" // {
+        self.templates.${def} // {
-          description = "Packaging a${if vowelStart lang
+          description = "${lang} template";
-                                      then "n"
+      }) aliases;
-                                      else ""} ${lang} executable";
-        };
-      }) (subdirs ./.);
     };
 }

python/nixpkgs/package.nix

@@ -1,13 +0,0 @@
-{ python3
-}:
-
-python3.pkgs.buildPythonApplication {
-  pname = "hello";
-  version = "0.1";
-  src = ./.;
-
-  pyproject = true;
-  build-system = [ python3.pkgs.setuptools ];
-
-  doCheck = false;
-}

python/pyproject/nixpkgs/basic/package.nix

@@ -0,0 +1,20 @@
+{ python3
+}:
+
+python3.pkgs.buildPythonPackage {
+  pname = "hello";
+  version = "0.1";
+  src = ./.;
+
+  pyproject = true;
+  build-system = with python3.pkgs; [
+    # build-system.{requires,setup_requires}
+    setuptools
+  ];
+
+  dependencies = [
+    # Python package dependencies
+  ];
+
+  doCheck = false;
+}

python/pyproject/nixpkgs/basic/pyproject.toml

@@ -0,0 +1,7 @@
+[project]
+name = "hello"
+version = "0.1.0"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

python/pyproject/nixpkgs/basic/src/hello/main.py

@@ -0,0 +1,3 @@
+
+def hello():
+    return "Hello, World!"

python/pyproject/nixpkgs/cli/.envrc

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+use flake

python/pyproject/nixpkgs/cli/flake.lock

@@ -0,0 +1,43 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1763618868,
+        "narHash": "sha256-v5afmLjn/uyD9EQuPBn7nZuaZVV9r+JerayK/4wvdWA=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "a8d610af3f1a5fb71e23e08434d8d61a466fc942",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs",
+        "systems": "systems"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

python/pyproject/nixpkgs/cli/flake.nix

@@ -0,0 +1,23 @@
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    systems.url = "github:nix-systems/default";
+  };
+
+  outputs = { self, nixpkgs, systems, ... }:
+    let eachSystem = nixpkgs.lib.genAttrs (import systems);
+    in {
+      packages = eachSystem (system:
+        let pkgs = nixpkgs.legacyPackages.${system};
+        in {
+          hello = pkgs.callPackage ./package.nix {};
+          default = self.packages.${system}.hello;
+        });
+
+      devShells = eachSystem (system:
+        let pkgs = nixpkgs.legacyPackages.${system};
+        in {
+          default = pkgs.callPackage ./shell.nix {};
+        });
+    };
+}

python/pyproject/nixpkgs/cli/package.nix

@@ -0,0 +1,20 @@
+{ python3
+}:
+
+python3.pkgs.buildPythonApplication {
+  pname = "hello";
+  version = "0.1";
+  src = ./.;
+
+  pyproject = true;
+  build-system = with python3.pkgs; [
+    # build-system.{requires,setup_requires}
+    setuptools
+  ];
+
+  dependencies = [
+    # Python package dependencies
+  ];
+
+  doCheck = false;
+}

python/pyproject/nixpkgs/cli/shell.nix

@@ -0,0 +1,8 @@
+{ mkShell
+, python3
+}:
+
+mkShell {
+  inputsFrom = [ python3.buildEnv.env ];
+  packages = [ python3.pkgs.python-lsp-server ];
+}

python/pyproject/nixpkgs/cli/src/hello/__init__.py

@@ -0,0 +1 @@
+from .main import *