cli: init with template

LorenzBischof · LorenzBischof · commit 0fb087470846 · 2025-03-18T21:04:21.000+01:00
diff --git a/devenv/src/cli.rs b/devenv/src/cli.rs
@@ -182,7 +182,11 @@ impl GlobalOptions {
 #[derive(Subcommand, Clone)]
 pub enum Commands {
     #[command(about = "Scaffold devenv.yaml, devenv.nix, .gitignore and .envrc.")]
-    Init { target: Option<PathBuf> },
+    Init {
+        target: Option<PathBuf>,
+        #[arg(long, help = "Use template")]
+        template: Option<String>,
+    },
 
     #[command(about = "Generate devenv.yaml and devenv.nix using AI")]
     Generate {
diff --git a/devenv/src/cnix.rs b/devenv/src/cnix.rs
@@ -270,6 +270,20 @@ impl Nix {
 
         Ok(())
     }
+    
+    pub async fn flake_clone(&self, path: &PathBu, flake_ref: &str) -> Result<()> {
+        self.run_nix("nix", &["flake", "clone", flake_ref, "--dest", path], &self.options).await?;
+        Ok(())
+    }
+
+    pub async fn init(&self, path: &Path, flake_ref: &String) -> Result<()> {
+        let mut cmd =
+            self.prepare_command("nix", &["flake", "init", "--template", flake_ref], &self.options)?;
+        cmd.current_dir(path);
+        self.run_nix_command(cmd, &self.options).await?;
+
+        Ok(())
+    }
 
     pub async fn metadata(&self) -> Result<String> {
         let options = Options {
diff --git a/devenv/src/devenv.rs b/devenv/src/devenv.rs
@@ -144,7 +144,7 @@ impl Devenv {
         self.devenv_dotfile.join("processes.pid")
     }
 
-    pub fn init(&self, target: &Option<PathBuf>) -> Result<()> {
+    pub async fn init(&mut self, target: &Option<PathBuf>, template: &Option<String>) -> Result<()> {
         let target = target
             .clone()
             .unwrap_or_else(|| fs::canonicalize(".").expect("Failed to get current directory"));
@@ -154,6 +154,22 @@ impl Devenv {
             std::fs::create_dir_all(&target).expect("Failed to create target directory");
         }
 
+        if let Some(template) = template {
+            let temp_dir = self.devenv_runtime.join("clone");
+            self.nix.flake_clone(temp_dir, template).await?;
+            let options = DevenvOptions {
+                devenv_root: Some(temp_dir),
+                ..DevenvOptions::default()
+            };
+            let mut devenv = Devenv::new(options).await;
+            devenv.assemble(false).await?;
+            // Required, so that the directory is not viewed as a Git
+            // repository, otherwise the .devenv.flake.nix is ignored.
+            let flake_ref = format!("path:{}", &temp_dir);
+            self.nix.init(&target, &flake_ref).await?;
+            return Ok(());
+        }
+
         for filename in REQUIRED_FILES {
             info!("Creating {}", filename);
 
diff --git a/devenv/src/flake.tmpl.nix b/devenv/src/flake.tmpl.nix
@@ -135,5 +135,6 @@
           });
           devenv = config;
           build = build project.options project.config;
+          templates = config.templates;
         };
       }
diff --git a/devenv/src/main.rs b/devenv/src/main.rs
@@ -133,7 +133,7 @@ async fn main() -> Result<()> {
             };
             Ok(())
         }
-        Commands::Init { target } => devenv.init(&target),
+        Commands::Init { target, template } => devenv.init(&target, &template).await,
         Commands::Generate { .. } => match which::which("devenv-generate") {
             Ok(devenv_generate) => {
                 let error = Command::new(devenv_generate)
diff --git a/src/modules/top-level.nix b/src/modules/top-level.nix
@@ -1,11 +1,17 @@
-{ config, pkgs, lib, bootstrapPkgs ? null, ... }:
+{
+  config,
+  pkgs,
+  lib,
+  bootstrapPkgs ? null,
+  ...
+}:
 let
   types = lib.types;
   # Returns a list of all the entries in a folder
-  listEntries = path:
-    map (name: path + "/${name}") (builtins.attrNames (builtins.readDir path));
+  listEntries = path: map (name: path + "/${name}") (builtins.attrNames (builtins.readDir path));
 
-  drvOrPackageToPaths = drvOrPackage:
+  drvOrPackageToPaths =
+    drvOrPackage:
     if drvOrPackage ? outputs then
       builtins.map (output: drvOrPackage.${output}) drvOrPackage.outputs
     else
@@ -16,23 +22,44 @@ let
     ignoreCollisions = true;
   };
 
-  failedAssertions = builtins.map (x: x.message) (builtins.filter (x: !x.assertion) config.assertions);
+  failedAssertions = builtins.map (x: x.message) (
+    builtins.filter (x: !x.assertion) config.assertions
+  );
 
   performAssertions =
     let
-      formatAssertionMessage = message:
+      formatAssertionMessage =
+        message:
         let
           lines = lib.splitString "\n" message;
         in
         "- ${lib.concatStringsSep "\n  " lines}";
     in
-    if failedAssertions != [ ]
-    then
+    if failedAssertions != [ ] then
       throw ''
         Failed assertions:
         ${lib.concatStringsSep "\n" (builtins.map formatAssertionMessage failedAssertions)}
       ''
-    else lib.trivial.showWarnings config.warnings;
+    else
+      lib.trivial.showWarnings config.warnings;
+  templateType = types.submodule (
+    { name, config, ... }:
+    {
+      options = {
+        path = lib.mkOption {
+          type = lib.types.path;
+        };
+        description = lib.mkOption {
+          type = types.str;
+          description = "description";
+        };
+        welcomeText = lib.mkOption {
+          type = types.str;
+          description = "description";
+        };
+      };
+    }
+  );
 in
 {
   options = {
@@ -89,15 +116,14 @@ in
 
       # Remove the default apple-sdk on macOS.
       # Allow users to specify an optional SDK in `apple.sdk`.
-      apply = stdenv:
-        if stdenv.isDarwin
-        then
-          stdenv.override
-            (prev: {
-              extraBuildInputs =
-                builtins.filter (x: !lib.hasPrefix "apple-sdk" x.pname) prev.extraBuildInputs;
-            })
-        else stdenv;
+      apply =
+        stdenv:
+        if stdenv.isDarwin then
+          stdenv.override (prev: {
+            extraBuildInputs = builtins.filter (x: !lib.hasPrefix "apple-sdk" x.pname) prev.extraBuildInputs;
+          })
+        else
+          stdenv;
 
     };
 
@@ -170,7 +196,12 @@ in
       type = types.listOf types.unspecified;
       internal = true;
       default = [ ];
-      example = [{ assertion = false; message = "you can't enable this for that reason"; }];
+      example = [
+        {
+          assertion = false;
+          message = "you can't enable this for that reason";
+        }
+      ];
       description = ''
         This option allows modules to express conditions that must
         hold for the evaluation of the configuration to succeed,
@@ -201,6 +232,11 @@ in
       '';
     };
 
+    templates = lib.mkOption {
+      type = lib.types.attrsOf templateType;
+      description = "A set of templates.";
+    };
+
     devenv = {
       root = lib.mkOption {
         type = types.str;
@@ -243,7 +279,12 @@ in
             xdg = builtins.getEnv "XDG_RUNTIME_DIR";
             tmp = builtins.getEnv "TMPDIR";
           in
-          if xdg != "" then xdg else if tmp != "" then tmp else "/tmp";
+          if xdg != "" then
+            xdg
+          else if tmp != "" then
+            tmp
+          else
+            "/tmp";
       };
 
       profile = lib.mkOption {
@@ -253,26 +294,26 @@ in
     };
   };
 
-  imports = [
-    ./info.nix
-    ./outputs.nix
-    ./files.nix
-    ./processes.nix
-    ./outputs.nix
-    ./scripts.nix
-    ./update-check.nix
-    ./containers.nix
-    ./debug.nix
-    ./lib.nix
-    ./tests.nix
-    ./cachix.nix
-    ./tasks.nix
-  ]
-  ++ (listEntries ./languages)
-  ++ (listEntries ./services)
-  ++ (listEntries ./integrations)
-  ++ (listEntries ./process-managers)
-  ;
+  imports =
+    [
+      ./info.nix
+      ./outputs.nix
+      ./files.nix
+      ./processes.nix
+      ./outputs.nix
+      ./scripts.nix
+      ./update-check.nix
+      ./containers.nix
+      ./debug.nix
+      ./lib.nix
+      ./tests.nix
+      ./cachix.nix
+      ./tasks.nix
+    ]
+    ++ (listEntries ./languages)
+    ++ (listEntries ./services)
+    ++ (listEntries ./integrations)
+    ++ (listEntries ./process-managers);
 
   config = {
     assertions = [
@@ -285,7 +326,10 @@ in
         '';
       }
       {
-        assertion = config.devenv.flakesIntegration || config.overlays == [ ] || lib.versionAtLeast config.devenv.cliVersion "1.4.2";
+        assertion =
+          config.devenv.flakesIntegration
+          || config.overlays == [ ]
+          || lib.versionAtLeast config.devenv.cliVersion "1.4.2";
         message = ''
           Using overlays requires devenv 1.4.2 or higher, while your current version is ${config.devenv.cliVersion}.
         '';
@@ -305,8 +349,7 @@ in
     packages = [
       # needed to make sure we can load libs
       pkgs.pkg-config
-    ]
-    ++ lib.optional (config.apple.sdk != null) config.apple.sdk;
+    ] ++ lib.optional (config.apple.sdk != null) config.apple.sdk;
 
     enterShell = lib.mkBefore ''
       export PS1="\[\e[0;34m\](devenv)\[\e[0m\] ''${PS1-}"
@@ -357,19 +400,26 @@ in
         nativeBuildInputs = partitionedPkgs.wrong;
       in
       performAssertions (
-        (pkgs.mkShell.override { stdenv = config.stdenv; }) ({
-          name = "devenv-shell";
-          hardeningDisable = config.hardeningDisable;
-          inherit buildInputs nativeBuildInputs;
-          shellHook = ''
-            ${lib.optionalString config.devenv.debug "set -x"}
-            ${config.enterShell}
-          '';
-        } // config.env)
+        (pkgs.mkShell.override { stdenv = config.stdenv; }) (
+          {
+            name = "devenv-shell";
+            hardeningDisable = config.hardeningDisable;
+            inherit buildInputs nativeBuildInputs;
+            shellHook = ''
+              ${lib.optionalString config.devenv.debug "set -x"}
+              ${config.enterShell}
+            '';
+          }
+          // config.env
+        )
       );
 
     infoSections."env" = lib.mapAttrsToList (name: value: "${name}: ${toString value}") config.env;
-    infoSections."packages" = builtins.map (package: package.name) (builtins.filter (package: !(builtins.elem package.name (builtins.attrNames config.scripts))) config.packages);
+    infoSections."packages" = builtins.map (package: package.name) (
+      builtins.filter (
+        package: !(builtins.elem package.name (builtins.attrNames config.scripts))
+      ) config.packages
+    );
 
     _module.args.pkgs = bootstrapPkgs.appendOverlays config.overlays;
 

Original file line number	Diff line number	Diff line change
`@@ -135,5 +135,6 @@`
`135`	`135`	`});`
`136`	`136`	`devenv = config;`
`137`	`137`	`build = build project.options project.config;`
	`138`	`+ templates = config.templates;`
`138`	`139`	`};`
`139`	`140`	`}`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ async fn main() -> Result<()> {`
`133`	`133`	`};`
`134`	`134`	`Ok(())`
`135`	`135`	`}`
`136`		`- Commands::Init { target } => devenv.init(&target),`
	`136`	`+ Commands::Init { target, template } => devenv.init(&target, &template).await,`
`137`	`137`	`Commands::Generate { .. } => match which::which("devenv-generate") {`
`138`	`138`	`Ok(devenv_generate) => {`
`139`	`139`	`let error = Command::new(devenv_generate)`