nu_scripts/modules/filesystem/bm.nu

# simple bookmark module

# Prints general information about bm.
export def main [] {
  print -n (help bm)

  print (
  [
    $"(ansi green)Environment(ansi reset):"
    $"    (ansi cyan)BM_PATH(ansi reset) - path to save bookmarks to with ('add' | nu-highlight). Alternatively searches for  (ansi cyan)XDG_DATA_HOME(ansi reset) or (ansi cyan)~/.local/share/(ansi reset)"
  ] |
  str join "\n" |
  nu-highlight
  )
}

# List all bookmarked paths
export def list [] {
  let bm_path = (get_path)

  if (not ($bm_path | path exists))  {
    [] | save $bm_path
  }
    open ($bm_path)
}

def os_home [] {
  if ($nu.os-info.name == "windows" ) {
    ($env.USERPROFILE)
  } else {
    ($env.HOME)
  }
}

def get_path [] {
  $env.BM_PATH? |
  default (
    $env.XDG_DATA_HOME? |
    default (
      if $nu.os-info.name == windows {
        ($env.USERPROFILE? | path join "bm")
      } else {
        ($env.HOME? | path join ".local" "share")
      }
    )
  ) |
  if (not ($in | path exists)) {
    mkdir $in
    $in
  } else {
    $in
  }|
  path join "bookmarks.nuon"
}

def save_path [] {
  $in |
  update path { str replace (os_home) '~' } |
  save -f (get_path)
}

# Reset the bookmarks
export def reset [] {
  list |
  where name == "prev" |
  save -f (get_path)
}

# Add a new bookmark with an optional name
export def add [
  pth: path       # Path to bookmark to.
  name?: string   # Optional name to give to it
                    ] {
  if (($pth | path type) == "dir") and ($pth | path exists) {
    list | 
    append {name: ($name), path: ($pth)} |
    save_path
  }
}

# remove one or more bookmarks
export def remove [] {
  let rm_these = (
    list | 
    where name != "prev" |
    input list -m
  )

  list | where {|it|
    not $it in $rm_these
  } |
  print
  
}

def marks [] {
  list | each {|it| 
    {
    value: $it.path,
    description: $it.name
    }
  }
}

# Goto your bookmark
export def --env goto [
  pth: path@marks # Path to "go to"
  ] {
  let prev = $env.PWD
  cd $pth
  change_prev $prev
}

# Experimental use of `input` instead of completion
export def --env goto_alternative [] {
  let prev = $env.PWD
  list | input list -f | cd $in.path
  change_prev $prev
}

def change_prev [new_path: path] {
    ( list | 
      where name != "prev" 
    ) |
    append {name: prev, path: $new_path} |
    save_path
}