Merge pull request #8 from freepicheep/nu-env

feat: use `nu-env/` for all nu environment things, including `modules…

Author: freepicheep

README.md

@@ -69,7 +69,7 @@ A quiver project is a directory containing:
 - **`<project-dir-name>/mod.nu`** - the Nushell module entry point
 - **`quiver.lock`** - auto-generated lockfile pinning exact commits (commit this to version control)
 
-Running `qv install` fetches module dependencies into `.nu_modules/`.
+Running `qv install` fetches module dependencies into `.nu-env/modules/`.
 
 ## Activation
 
@@ -78,12 +78,12 @@ To make installed modules available to `use` in Nushell without full paths, add
 ### 1. Manual Activation (Recommended)
 `qv install` and `qv init` generate:
 
-- `.nu_modules/activate.nu` (module overlay): updates `$env.NU_LIB_DIRS` and imports module dependencies with `export use <name> *`
+- `.nu-env/activate.nu` (module overlay): updates `$env.NU_LIB_DIRS` and imports module dependencies with `export use <name> *`
 
 Activate modules with an overlay:
 
 ```nu
-overlay use .nu_modules/activate.nu
+overlay use .nu-env/activate.nu
 ```
 
 When you're done, run `deactivate` (or `overlay hide activate`) to unload the module overlay.

src/installer.rs

@@ -9,8 +9,10 @@ use crate::manifest::Manifest;
 use crate::resolver::{self, ResolvedDep};
 use walkdir::WalkDir;
 
-/// The name of the directory where local dependencies are installed.
-const MODULES_DIR: &str = ".nu_modules";
+/// The name of the local environment directory.
+const NU_ENV_DIR: &str = ".nu-env";
+/// The subdirectory within `.nu-env/` where module files are installed.
+const MODULES_SUBDIR: &str = "modules";
 
 #[derive(Debug, Default)]
 struct NupmMetadataHints {
@@ -22,11 +24,13 @@ struct NupmMetadataHints {
 pub fn install(project_dir: &Path, frozen: bool) -> Result<()> {
     let manifest = Manifest::from_dir(project_dir)?;
     let lock_path = project_dir.join("quiver.lock");
-    let modules_dir = project_dir.join(MODULES_DIR);
+    let nu_env_dir = project_dir.join(NU_ENV_DIR);
+    let modules_dir = nu_env_dir.join(MODULES_SUBDIR);
+    let display_name = format!("{NU_ENV_DIR}/{MODULES_SUBDIR}");
 
     if manifest.dependencies.is_empty() {
         eprintln!("No dependencies declared in nupackage.toml.");
-        write_activate_overlay(&modules_dir, MODULES_DIR, std::iter::empty::<&str>())?;
+        write_activate_overlay(&nu_env_dir, &display_name, std::iter::empty::<&str>())?;
         return Ok(());
     }
 
@@ -62,7 +66,7 @@ pub fn install(project_dir: &Path, frozen: bool) -> Result<()> {
     };
 
     // Install each dependency
-    install_resolved(&resolved_modules, &modules_dir, &lock_path, MODULES_DIR)
+    install_resolved(&resolved_modules, &modules_dir, &lock_path, &nu_env_dir, &display_name)
 }
 
 /// Run an update: always re-resolve, ignoring existing lockfile.
@@ -174,6 +178,7 @@ fn install_resolved(
     modules: &[ResolvedDep],
     modules_dir: &Path,
     lock_path: &Path,
+    overlay_dir: &Path,
     display_name: &str,
 ) -> Result<()> {
     std::fs::create_dir_all(modules_dir)?;
@@ -218,7 +223,7 @@ fn install_resolved(
     eprintln!("Installed {module_count} module{module_suffix} into {display_name}/");
 
     write_activate_overlay(
-        modules_dir,
+        overlay_dir,
         display_name,
         module_use_paths.iter().map(|path| path.as_str()),
     )?;
@@ -227,19 +232,19 @@ fn install_resolved(
 }
 
 fn write_activate_overlay<IM, SM>(
-    modules_dir: &Path,
+    overlay_dir: &Path,
     display_name: &str,
     module_names: IM,
 ) -> Result<()>
 where
     IM: IntoIterator<Item = SM>,
     SM: AsRef<str>,
 {
-    std::fs::create_dir_all(modules_dir)?;
+    std::fs::create_dir_all(overlay_dir)?;
 
-    let activate_path = modules_dir.join("activate.nu");
+    let activate_path = overlay_dir.join("activate.nu");
     let mut activate_script = String::from(
-        "# Generated by quiver - do not edit\nexport-env {\n    let modules_dir = ($env.FILE_PWD | path join)\n    $env.NU_LIB_DIRS = ($env.NU_LIB_DIRS | default [] | append $modules_dir)\n}\n\n",
+        "# Generated by quiver - do not edit\nexport-env {\n    let modules_dir = ($env.FILE_PWD | path join \"modules\")\n    $env.NU_LIB_DIRS = ($env.NU_LIB_DIRS | default [] | append $modules_dir)\n}\n\n",
     );
 
     for module_name in module_names {
@@ -605,7 +610,7 @@ mod tests {
     fn writes_activate_overlay_with_modules() {
         let modules_dir = make_temp_dir("with_modules");
 
-        write_activate_overlay(&modules_dir, ".nu_modules", ["nu-foo", "nu-bar"]).unwrap();
+        write_activate_overlay(&modules_dir, ".nu-env/modules", ["nu-foo", "nu-bar"]).unwrap();
 
         let activate = std::fs::read_to_string(modules_dir.join("activate.nu")).unwrap();
         assert!(activate.contains("export use nu-foo *"));
@@ -619,7 +624,7 @@ mod tests {
     fn writes_activate_overlay_without_modules() {
         let modules_dir = make_temp_dir("without_modules");
 
-        write_activate_overlay(&modules_dir, ".nu_modules", std::iter::empty::<&str>()).unwrap();
+        write_activate_overlay(&modules_dir, ".nu-env/modules", std::iter::empty::<&str>()).unwrap();
 
         let activate = std::fs::read_to_string(modules_dir.join("activate.nu")).unwrap();
         assert!(!activate.lines().any(|line| line.starts_with("export use ")));
@@ -745,7 +750,7 @@ version = "0.1.0"
         install(&project_dir, true).unwrap();
 
         let activate =
-            std::fs::read_to_string(project_dir.join(".nu_modules").join("activate.nu")).unwrap();
+            std::fs::read_to_string(project_dir.join(".nu-env").join("activate.nu")).unwrap();
         assert!(!activate.lines().any(|line| line.starts_with("export use ")));
         assert!(activate.contains("export alias deactivate = overlay hide activate"));
 

src/main.rs

@@ -118,8 +118,8 @@ fn cmd_init(
         std::fs::write(
             &mod_nu,
             r#"# Module entry point
-            # Export your commands here with: export use <submodule>
-            # Use installed modules with: use ../.nu_modules/module-name/module-name *
+# Export your commands here with: export use <submodule>
+# Use installed modules with: use ../.nu-env/modules/module-name/module-name *
             "#,
         )?;
         eprintln!("Created {}", mod_nu.display());
@@ -244,11 +244,11 @@ fn cmd_remove(dir: &Path, name: String) -> Result<()> {
     std::fs::write(dir.join("nupackage.toml"), content)?;
     eprintln!("Removed module '{name}' from nupackage.toml");
 
-    // Remove from .nu_modules/
-    let module_dir = dir.join(".nu_modules").join(&name);
+    // Remove from .nu-env/modules/
+    let module_dir = dir.join(".nu-env").join("modules").join(&name);
     if module_dir.exists() {
         std::fs::remove_dir_all(&module_dir)?;
-        eprintln!("Removed .nu_modules/{name}/");
+        eprintln!("Removed .nu-env/modules/{name}/");
     }
 
     // Update lockfile: remove the package entry
@@ -324,12 +324,12 @@ $env.config.hooks.env_change.PWD = (
 
         # Remove previous directory's modules if it was a quiver project
         if ($before | is-not-empty) and ($before | path join "nupackage.toml" | path exists) {
-            let old_modules = ($before | path join ".nu_modules")
+            let old_modules = ($before | path join ".nu-env" "modules")
             $env.NU_LIB_DIRS = ($env.NU_LIB_DIRS | default [] | where {|it| $it != $old_modules })
         }
         # Add new directory's modules if it is a quiver project
         if ($after | is-not-empty) and ($after | path join "nupackage.toml" | path exists) {
-            let new_modules = ($after | path join ".nu_modules")
+            let new_modules = ($after | path join ".nu-env" "modules")
             if ($new_modules | path exists) and ($new_modules not-in ($env.NU_LIB_DIRS | default [])) {
                 $env.NU_LIB_DIRS = ($env.NU_LIB_DIRS | default [] | append $new_modules)
             }
@@ -347,7 +347,7 @@ fn cmd_version() -> Result<()> {
 
 fn cmd_list(cwd: &Path) -> Result<()> {
     if cwd.join("nupackage.toml").exists() {
-        let modules_dir = cwd.join(".nu_modules");
+        let modules_dir = cwd.join(".nu-env").join("modules");
         let modules = list_installed_module_names(&modules_dir)?;
 
         if modules.is_empty() {