Set shell to nushell, add initial configuration (mostly default)

home-manager/modules/nushell/config.nu

@@ -0,0 +1,460 @@
+# Nushell Config File
+
+# For more information on defining custom themes, see
+# https://www.nushell.sh/book/coloring_and_theming.html
+# And here is the theme collection
+# https://github.com/nushell/nu_scripts/tree/main/themes
+let dark_theme = {
+    # color for nushell primitives
+    separator: white
+    leading_trailing_space_bg: { attr: n } # no fg, no bg, attr none effectively turns this off
+    header: green_bold
+    empty: blue
+    # Closures can be used to choose colors for specific values.
+    # The value (in this case, a bool) is piped into the closure.
+    bool: { if $in { 'light_cyan' } else { 'light_gray' } }
+    int: white
+    filesize: {|e|
+      if $e == 0b {
+        'white'
+      } else if $e < 1mb {
+        'cyan'
+      } else { 'blue' }
+    }
+    duration: white
+    date: { (date now) - $in |
+      if $in < 1hr {
+        'red3b'
+      } else if $in < 6hr {
+        'orange3'
+      } else if $in < 1day {
+        'yellow3b'
+      } else if $in < 3day {
+        'chartreuse2b'
+      } else if $in < 1wk {
+        'green3b'
+      } else if $in < 6wk {
+        'darkturquoise'
+      } else if $in < 52wk {
+        'deepskyblue3b'
+      } else { 'dark_gray' }
+    }    
+    range: white
+    float: white
+    string: white
+    nothing: white
+    binary: white
+    cellpath: white
+    row_index: green_bold
+    record: white
+    list: white
+    block: white
+    hints: dark_gray
+
+    shape_and: purple_bold
+    shape_binary: purple_bold
+    shape_block: blue_bold
+    shape_bool: light_cyan
+    shape_custom: green
+    shape_datetime: cyan_bold
+    shape_directory: cyan
+    shape_external: cyan
+    shape_externalarg: green_bold
+    shape_filepath: cyan
+    shape_flag: blue_bold
+    shape_float: purple_bold
+    # shapes are used to change the cli syntax highlighting
+    shape_garbage: { fg: "#FFFFFF" bg: "#FF0000" attr: b}
+    shape_globpattern: cyan_bold
+    shape_int: purple_bold
+    shape_internalcall: cyan_bold
+    shape_list: cyan_bold
+    shape_literal: blue
+    shape_matching_brackets: { attr: u }
+    shape_nothing: light_cyan
+    shape_operator: yellow
+    shape_or: purple_bold
+    shape_pipe: purple_bold
+    shape_range: yellow_bold
+    shape_record: cyan_bold
+    shape_redirection: purple_bold
+    shape_signature: green_bold
+    shape_string: green
+    shape_string_interpolation: cyan_bold
+    shape_table: blue_bold
+    shape_variable: purple
+}
+
+# External completer example
+# let carapace_completer = {|spans|
+#     carapace $spans.0 nushell $spans | from json
+# }
+
+
+# The default config record. This is where much of your global configuration is setup.
+let-env config = {
+  ls: {
+    use_ls_colors: true # use the LS_COLORS environment variable to colorize output
+    clickable_links: true # enable or disable clickable links. Your terminal has to support links.
+  }
+  rm: {
+    always_trash: false # always act as if -t was given. Can be overridden with -p
+  }
+  cd: {
+    abbreviations: false # allows `cd s/o/f` to expand to `cd some/other/folder`
+  }
+  table: {
+    mode: rounded # basic, compact, compact_double, light, thin, with_love, rounded, reinforced, heavy, none, other
+    index_mode: always # "always" show indexes, "never" show indexes, "auto" = show indexes when a table has "index" column
+    trim: {
+      methodology: wrapping # wrapping or truncating
+      wrapping_try_keep_words: true # A strategy used by the 'wrapping' methodology
+      truncating_suffix: "..." # A suffix used by the 'truncating' methodology
+    }
+  }
+
+  explore: {
+    help_banner: true
+    exit_esc: true
+
+    command_bar_text: '#C4C9C6'
+    # command_bar: {fg: '#C4C9C6' bg: '#223311' }
+
+    status_bar_background: {fg: '#1D1F21' bg: '#C4C9C6' }
+    # status_bar_text: {fg: '#C4C9C6' bg: '#223311' }
+
+    highlight: {bg: 'yellow' fg: 'black' }
+
+    status: {
+      warn: {bg: 'yellow', fg: 'blue'}
+      error: {bg: 'yellow', fg: 'blue'}
+      info: {bg: 'yellow', fg: 'blue'}
+    }
+
+    try: {
+      border_color: 'blue'
+      highlighted_color: 'white'
+
+      reactive: true
+    }
+
+    table: {
+      split_line: '#404040'
+
+      cursor: true
+
+      line_index: true
+      line_shift: true
+      line_head_top: true
+      line_head_bottom: true
+
+      show_head: true
+      show_index: true
+
+      # selected_cell: {fg: 'white', bg: '#777777'}
+      # selected_row: {fg: 'yellow', bg: '#C1C2A3'}
+      # selected_column: blue
+
+      # padding_column_right: 2
+      # padding_column_left: 2
+
+      # padding_index_left: 2
+      # padding_index_right: 1
+    }
+
+    config: {
+      cursor_color: {bg: 'yellow' fg: 'black' }
+
+      # border_color: white
+      # list_color: green
+    }
+  }
+
+  history: {
+    max_size: 10000 # Session has to be reloaded for this to take effect
+    sync_on_enter: true # Enable to share history between multiple sessions, else you have to close the session to write history to file
+    file_format: "sqlite" # "sqlite" or "plaintext"
+  }
+  completions: {
+    case_sensitive: false # set to true to enable case-sensitive completions
+    quick: true  # set this to false to prevent auto-selecting completions when only one remains
+    partial: true  # set this to false to prevent partial filling of the prompt
+    algorithm: "fuzzy"  # prefix or fuzzy
+    external: {
+      enable: true # set to false to prevent nushell looking into $env.PATH to find more suggestions, `false` recommended for WSL users as this look up my be very slow
+      max_results: 100 # setting it lower can improve completion performance at the cost of omitting some options
+      completer: null # check 'carapace_completer' above as an example
+    }
+  }
+  filesize: {
+    metric: false # true => KB, MB, GB (ISO standard), false => KiB, MiB, GiB (Windows standard)
+    format: "auto" # b, kb, kib, mb, mib, gb, gib, tb, tib, pb, pib, eb, eib, zb, zib, auto
+  }
+  cursor_shape: {
+    emacs: line # block, underscore, line (line is the default)
+    vi_insert: block # block, underscore, line (block is the default)
+    vi_normal: underscore # block, underscore, line  (underscore is the default)
+  }
+  color_config: $dark_theme   # if you want a light theme, replace `$dark_theme` to `$light_theme`
+  use_grid_icons: true
+  footer_mode: "25" # always, never, number_of_rows, auto
+  float_precision: 2 # the precision for displaying floats in tables
+  # buffer_editor: "emacs" # command that will be used to edit the current line buffer with ctrl+o, if unset fallback to $env.EDITOR and $env.VISUAL
+  use_ansi_coloring: true
+  edit_mode: emacs # emacs, vi
+  shell_integration: true # enables terminal markers and a workaround to arrow keys stop working issue
+  # true or false to enable or disable the welcome banner at startup
+  show_banner: false
+  render_right_prompt_on_last_line: false # true or false to enable or disable right prompt to be rendered on last line of the prompt.
+
+  hooks: {
+    pre_prompt: [{
+      code: "
+        let direnv = (direnv export json | from json)
+        let direnv = if ($direnv | length) == 1 { $direnv } else { {} }
+        $direnv | load-env
+      "
+    }]
+    pre_execution: [{
+      null  # replace with source code to run before the repl input is run
+    }]
+    env_change: {
+      PWD: [{|before, after|
+        null  # replace with source code to run if the PWD environment is different since the last repl input
+      }]
+    }
+    display_output: {
+      if (term size).columns >= 100 { table -e } else { table }
+    }
+  }
+  menus: [    # Configuration for default nushell menus
+      # Note the lack of source parameter
+      {
+        name: completion_menu
+        only_buffer_difference: false
+        marker: "| "
+        type: {
+            layout: columnar
+            columns: 4
+            col_width: 20   # Optional value. If missing all the screen width is used to calculate column width
+            col_padding: 2
+        }
+        style: {
+            text: green
+            selected_text: green_reverse
+            description_text: yellow
+        }
+      }
+      {
+        name: history_menu
+        only_buffer_difference: true
+        marker: "? "
+        type: {
+            layout: list
+            page_size: 10
+        }
+        style: {
+            text: green
+            selected_text: green_reverse
+            description_text: yellow
+        }
+      }
+      {
+        name: help_menu
+        only_buffer_difference: true
+        marker: "? "
+        type: {
+            layout: description
+            columns: 4
+            col_width: 20   # Optional value. If missing all the screen width is used to calculate column width
+            col_padding: 2
+            selection_rows: 4
+            description_rows: 10
+        }
+        style: {
+            text: green
+            selected_text: green_reverse
+            description_text: yellow
+        }
+      }
+      # Example of extra menus created using a nushell source
+      # Use the source field to create a list of records that populates
+      # the menu
+      {
+        name: commands_menu
+        only_buffer_difference: false
+        marker: "# "
+        type: {
+            layout: columnar
+            columns: 4
+            col_width: 20
+            col_padding: 2
+        }
+        style: {
+            text: green
+            selected_text: green_reverse
+            description_text: yellow
+        }
+        source: { |buffer, position|
+            $nu.scope.commands
+            | where name =~ $buffer
+            | each { |it| {value: $it.name description: $it.usage} }
+        }
+      }
+      {
+        name: vars_menu
+        only_buffer_difference: true
+        marker: "# "
+        type: {
+            layout: list
+            page_size: 10
+        }
+        style: {
+            text: green
+            selected_text: green_reverse
+            description_text: yellow
+        }
+        source: { |buffer, position|
+            $nu.scope.vars
+            | where name =~ $buffer
+            | sort-by name
+            | each { |it| {value: $it.name description: $it.type} }
+        }
+      }
+      {
+        name: commands_with_description
+        only_buffer_difference: true
+        marker: "# "
+        type: {
+            layout: description
+            columns: 4
+            col_width: 20
+            col_padding: 2
+            selection_rows: 4
+            description_rows: 10
+        }
+        style: {
+            text: green
+            selected_text: green_reverse
+            description_text: yellow
+        }
+        source: { |buffer, position|
+            $nu.scope.commands
+            | where name =~ $buffer
+            | each { |it| {value: $it.name description: $it.usage} }
+        }
+      }
+  ]
+  keybindings: [
+    {
+      name: completion_menu
+      modifier: none
+      keycode: tab
+      mode: [emacs vi_normal vi_insert]
+      event: {
+        until: [
+          { send: menu name: completion_menu }
+          { send: menunext }
+        ]
+      }
+    }
+    {
+      name: completion_previous
+      modifier: shift
+      keycode: backtab
+      mode: [emacs, vi_normal, vi_insert] # Note: You can add the same keybinding to all modes by using a list
+      event: { send: menuprevious }
+    }
+    {
+      name: history_menu
+      modifier: control
+      keycode: char_r
+      mode: emacs
+      event: { send: menu name: history_menu }
+    }
+    {
+      name: next_page
+      modifier: control
+      keycode: char_x
+      mode: emacs
+      event: { send: menupagenext }
+    }
+    {
+      name: undo_or_previous_page
+      modifier: control
+      keycode: char_z
+      mode: emacs
+      event: {
+        until: [
+          { send: menupageprevious }
+          { edit: undo }
+        ]
+       }
+    }
+    {
+      name: yank
+      modifier: control
+      keycode: char_y
+      mode: emacs
+      event: {
+        until: [
+          {edit: pastecutbufferafter}
+        ]
+      }
+    }
+    {
+      name: unix-line-discard
+      modifier: control
+      keycode: char_u
+      mode: [emacs, vi_normal, vi_insert]
+      event: {
+        until: [
+          {edit: cutfromlinestart}
+        ]
+      }
+    }
+    {
+      name: kill-line
+      modifier: control
+      keycode: char_k
+      mode: [emacs, vi_normal, vi_insert]
+      event: {
+        until: [
+          {edit: cuttolineend}
+        ]
+      }
+    }
+    # Keybindings used to trigger the user defined menus
+    {
+      name: commands_menu
+      modifier: alt
+      keycode: char_t
+      mode: [emacs, vi_normal, vi_insert]
+      event: { send: menu name: commands_menu }
+    }
+    {
+      name: vars_menu
+      modifier: alt
+      keycode: char_o
+      mode: [emacs, vi_normal, vi_insert]
+      event: { send: menu name: vars_menu }
+    }
+    {
+      name: commands_with_description
+      modifier: alt
+      keycode: char_d
+      mode: [emacs, vi_normal, vi_insert]
+      event: { send: menu name: commands_with_description }
+    }
+    {
+      name: insert_last_token
+      modifier: alt
+      keycode: char_.
+      mode: emacs
+      event: [
+        { edit: InsertString, value: "!$" }
+        { send: Enter }
+      ]
+    }
+  ]
+}

home-manager/modules/nushell/default.nix

@@ -0,0 +1,21 @@
+{ config, lib, ... }:
+with lib;
+let
+  cfg = config.eboskma.programs.nushell;
+in
+{
+  options.eboskma.programs.nushell = { enable = mkEnableOption "nu shell"; };
+
+  config = mkIf cfg.enable {
+    programs.nushell = {
+      enable = true;
+      configFile.source = ./config.nu;
+      envFile.source = ./env.nu;
+
+      extraConfig = ''
+        source ${./starship.nu}
+        source ${./zoxide.nu}
+      '';
+    };
+  };
+}

home-manager/modules/nushell/env.nu

@@ -0,0 +1,40 @@
+# Nushell Environment Config File
+
+# The prompt indicators are environmental variables that represent
+# the state of the prompt
+let-env PROMPT_INDICATOR = { "> " }
+let-env PROMPT_INDICATOR_VI_INSERT = { ": " }
+let-env PROMPT_INDICATOR_VI_NORMAL = { "> " }
+let-env PROMPT_MULTILINE_INDICATOR = { "::: " }
+
+# Specifies how environment variables are:
+# - converted from a string to a value on Nushell startup (from_string)
+# - converted from a value back to a string when running external commands (to_string)
+# Note: The conversions happen *after* config.nu is loaded
+let-env ENV_CONVERSIONS = {
+  "PATH": {
+    from_string: { |s| $s | split row (char esep) | path expand -n }
+    to_string: { |v| $v | path expand -n | str join (char esep) }
+  }
+  "Path": {
+    from_string: { |s| $s | split row (char esep) | path expand -n }
+    to_string: { |v| $v | path expand -n | str join (char esep) }
+  }
+}
+
+# Directories to search for scripts when calling source or use
+#
+# By default, <nushell-config-dir>/scripts is added
+let-env NU_LIB_DIRS = [
+    ($nu.config-path | path dirname | path join 'scripts')
+]
+
+# Directories to search for plugin binaries when calling register
+#
+# By default, <nushell-config-dir>/plugins is added
+let-env NU_PLUGIN_DIRS = [
+    ($nu.config-path | path dirname | path join 'plugins')
+]
+
+# To add entries to PATH (on Windows you might use Path), you can use the following pattern:
+# let-env PATH = ($env.PATH | split row (char esep) | prepend '/some/path')

home-manager/modules/nushell/starship.nu

@@ -0,0 +1,27 @@
+let-env STARSHIP_SHELL = "nu"
+let-env STARSHIP_SESSION_KEY = (random chars -l 16)
+let-env PROMPT_MULTILINE_INDICATOR = (^/etc/profiles/per-user/erwin/bin/starship prompt --continuation)
+
+# Does not play well with default character module.
+# TODO: Also Use starship vi mode indicators?
+let-env PROMPT_INDICATOR = ""
+
+let-env PROMPT_COMMAND = {
+    # jobs are not supported
+    let width = (term size).columns
+    ^/etc/profiles/per-user/erwin/bin/starship prompt $"--cmd-duration=($env.CMD_DURATION_MS)" $"--status=($env.LAST_EXIT_CODE)" $"--terminal-width=($width)"
+}
+
+# Whether we have config items
+let has_config_items = (not ($env | get -i config | is-empty))
+
+let-env config = if $has_config_items {
+    $env.config | upsert render_right_prompt_on_last_line true
+} else {
+    {render_right_prompt_on_last_line: true}
+}
+
+let-env PROMPT_COMMAND_RIGHT = {
+    let width = (term size).columns
+    ^/etc/profiles/per-user/erwin/bin/starship prompt --right $"--cmd-duration=($env.CMD_DURATION_MS)" $"--status=($env.LAST_EXIT_CODE)" $"--terminal-width=($width)"
+}

home-manager/modules/nushell/zoxide.nu

@@ -0,0 +1,61 @@
+# Code generated by zoxide. DO NOT EDIT.
+
+# =============================================================================
+#
+# Hook configuration for zoxide.
+#
+
+# Initialize hook to add new entries to the database.
+if (not ($env | default false __zoxide_hooked | get __zoxide_hooked)) {
+  let-env __zoxide_hooked = true
+  let-env config = ($env | default {} config).config
+  let-env config = ($env.config | default {} hooks)
+  let-env config = ($env.config | update hooks ($env.config.hooks | default {} env_change))
+  let-env config = ($env.config | update hooks.env_change ($env.config.hooks.env_change | default [] PWD))
+  let-env config = ($env.config | update hooks.env_change.PWD ($env.config.hooks.env_change.PWD | append {|_, dir|
+    zoxide add -- $dir
+  }))
+}
+
+# =============================================================================
+#
+# When using zoxide with --no-cmd, alias these internal functions as desired.
+#
+
+# Jump to a directory using only keywords.
+def-env __zoxide_z [...rest:string] {
+  # `z -` does not work yet, see https://github.com/nushell/nushell/issues/4769
+  let arg0 = ($rest | append '~').0
+  let path = if (($rest | length) <= 1) and ($arg0 == '-' or ($arg0 | path expand | path type) == dir) {
+    $arg0
+  } else {
+    (zoxide query --exclude $env.PWD -- $rest | str trim -r -c "\n")
+  }
+  cd $path
+}
+
+# Jump to a directory using interactive search.
+def-env __zoxide_zi  [...rest:string] {
+  cd $'(zoxide query -i -- $rest | str trim -r -c "\n")'
+}
+
+# =============================================================================
+#
+# Commands for zoxide. Disable these using --no-cmd.
+#
+
+alias z = __zoxide_z
+alias zi = __zoxide_zi
+
+# =============================================================================
+#
+# Add this to your env file (find it by running `$nu.env-path` in Nushell):
+#
+#   zoxide init nushell | save -f ~/.zoxide.nu
+#
+# Now, add this to the end of your config file (find it by running
+# `$nu.config-path` in Nushell):
+#
+#   source ~/.zoxide.nu
+#
+# Note: zoxide only supports Nushell v0.73.0 and above.

users/erwin/default.nix

@@ -27,7 +27,7 @@ in
       home = "/home/erwin";
       extraGroups = [ "wheel" "adm" "audio" "video" "dialout" "input" ]
         ++ (optional config.hardware.i2c.enable config.hardware.i2c.group);
-      shell = pkgs.fish;
+      shell = pkgs.nushell;
       openssh.authorizedKeys.keyFiles = [
         (pkgs.fetchurl {
           url = "https://github.com/eboskma.keys";

users/erwin/home.nix

@@ -69,6 +69,7 @@ in
             gpg.enable = true;
             mpd.enable = true;
             neovim.enable = true;
+            nushell.enable = true;
             obs-studio.enable = true;
             rclone = {
               enable = true;