PR feedback on addtion of registry values

Author: mkatychev

README.md

@@ -32,29 +32,24 @@ Both of the above commands will make `nupm` and all its subcommands available in
 > ```
 
 ## :gear: configuration [[toc](#table-of-content)]
-One can change the location of the Nupm directory with `$env.NUPM_HOME`, e.g.
+One can change the location of the Nupm directory with `$env.nupm.home`, e.g.
 ```nushell
 # env.nu
 
-$env.NUPM_HOME = ($env.XDG_DATA_HOME | path join "nupm")
+$env.nupm.home = ($env.XDG_DATA_HOME | path join "nupm")
 ```
 
-Because Nupm will install modules and scripts in `{{nupm-home}}/modules/` and `{{nupm-home}}/scripts/` respectively, it is a good idea to add these paths to `$env.NU_LIB_DIRS` and `$env.PATH` respectively, e.g. if you have `$env.NUPM_HOME` defined:
+If you would like installed modules, scripts, and plugins to show up in [nushell search
+paths](https://www.nushell.sh/book/configuration.html#launch-stages), set the
+`nu_search_path` to `true` before calling `use nupm`:
 ```nushell
 # env.nu
-
-$env.NU_LIB_DIRS = [
-    ...
-    ($env.NUPM_HOME | path join "modules")
-]
-
-$env.PATH = (
-    $env.PATH
-        | split row (char esep)
-        | ....
-        | prepend ($env.NUPM_HOME | path join "scripts")
-        | uniq
-)
+$env.nupm = {
+  home: "path/to/my_home"
+  config: { nu_search_path: true }
+}
+# ...
+use path/to/nupm
 ```
 
 ## :rocket: usage [[toc](#table-of-content)]

nupm/registry.nu

@@ -1,7 +1,8 @@
 # Registry management for nupm
 
 use utils/dirs.nu [nupm-home-prompt REGISTRY_FILENAME]
-use utils/log.nu throw-error
+use utils/log.nu [throw-error UNIMPLEMENTED]
+use utils/registry.nu registry-cache
 
 # Manage nupm registires
 @example "List all configured registries" { nupm registry }
@@ -30,25 +31,25 @@ export def describe [
     }
 
     let registry_url = $env.NUPM_REGISTRIES | get $registry
-    let registry_cache_dir = cache-dir --ensure | path join $registry
-    let cached_registry = $registry_cache_dir | path join $REGISTRY_FILENAME
+    let cache = registry-cache $registry
+    let cached_registry = $cache.dir | path join $REGISTRY_FILENAME
 
     # Always check cache first, only fall back to URL if cache doesn't exist
-    let registry_data = if ($cached_registry | path exists) {
-        open $cached_registry
+    let registry_data = if ($cache.file | path exists) {
+        open $cache.file
     } else if ($registry_url | path exists) {
         # Local registry file
         open $registry_url
     } else {
         # Remote registry - fetch and cache
         let data = http get $registry_url
-        mkdir $registry_cache_dir
-        $data | save $cached_registry
+        mkdir $cache.dir
+        $data | save $cache.file
         $data
     }
 
     $registry_data | each {|entry|
-        let package_cache_path = $registry_cache_dir | path join $"($entry.name).nuon"
+        let package_cache_path = $cache.dir | path join $"($entry.name).nuon"
 
         # Always check cache first for package data too
         let package_file_data = if ($package_cache_path | path exists) {
@@ -91,12 +92,17 @@ export def --env add [
         throw-error $"Registry '($name)' already exists. Use 'nupm registry update' to modify it."
     }
     $env.NUPM_REGISTRIES = $env.NUPM_REGISTRIES | insert $name $url
+    mut add_success_msg =  $"Registry '($name)' added successfully"
 
     if $save {
       $env.NUPM_REGISTRIES | save --force $env.NUPM_INDEX_PATH
+      $add_success_msg = $add_success_msg | append $" and written to ($env.NUPM_INDEX_PATH)." | str join " "
+
+    } else {
+      $add_success_msg = $add_success_msg | append $". To commit the change to disk, use the `--save` flag." | str join " "
     }
 
-    print $"Registry '($name)' added successfully."
+    print $add_success_msg
 }
 
 # Remove a registry
@@ -174,5 +180,6 @@ export def init [--index] {
         return
     }
     # TODO initialize registry index here
+    throw-error UNIMPLEMENTED "`nupm registry --index` is not implemented."
 }
 

nupm/utils/log.nu

@@ -1,3 +1,6 @@
+# denotes an error msg that a section of code is yet to be implemented
+export const UNIMPLEMENTED = "unimplemented"
+
 export def throw-error [
     error: string
     text?: string

nupm/utils/registry.nu

@@ -10,6 +10,13 @@ export const REG_COLS = [ name path hash ]
 # Columns of a registry package file
 export const REG_PKG_COLS = [ name version path type info ]
 
+
+# return the respective registry cache directory and package index
+export def registry-cache [name: string]: nothing -> record<dir: path, file: path> {
+    let dir = cache-dir --ensure | path join "registry" $name
+    { dir: $dir, file: ($dir | path join $REGISTRY_FILENAME) }
+}
+
 # Search for a package in a registry
 export def search-package [
     package: string  # Name of the package
@@ -47,23 +54,22 @@ export def search-package [
 
             } else {
                 try {
-                    let registry_cache_dir = cache-dir --ensure | path join $name
-                    let reg_file = $registry_cache_dir | path join $REGISTRY_FILENAME
+                    let cache = registry-cache $name
 
-                    let reg = if ($reg_file | path exists) {
-                        open $reg_file
+                    let reg = if ($cache.file | path exists) {
+                        open $cache.file
                     } else {
                         let data = http get $url_or_path
-                        mkdir $registry_cache_dir
-                        $data | save --force $reg_file
+                        mkdir $cache.dir
+                        $data | save --force $cache.file
                         $data
                     }
 
                     {
                         reg: $reg
-                        path: $reg_file
+                        path: $cache.file
                         is_url: true
-                        cache_dir: $registry_cache_dir
+                        cache_dir: $cache.dir
                     }
                 } catch {
                     throw-error $"Cannot open '($url_or_path)' as a file or URL."