0372e8c53c
# Description
This PR is an attempt to add a standard location for people to put
completions in. I saw this topic come up again recently and IIRC we
decided to create a standard location. I used the dirs-next crate to
dictate where these locations are. I know some people won't like that
but at least this gets the ball rolling in a direction that has a
standard directory.
This is what the default NU_LIB_DIRS looks like now in the
default_env.nu. It should also be like this when starting nushell with
`nu -n`
```nushell
$env.NU_LIB_DIRS = [
($nu.default-config-dir | path join 'scripts') # add <nushell-config-dir>/scripts
($nu.data-dir | path join 'completions') # default home for nushell completions
]
```
I also added these default folders to the `$nu` variable so now there is
`$nu.data-path` and `$nu.cache-path`.
## Data Dir Default
While I was in there, I also decided to add a cache dir
## Cache Dir Default
### This is what the default looks like in Ubuntu.
### This is what it looks like with XDG_CACHE_HOME and XDG_DATA_HOME
overridden
```nushell
XDG_DATA_HOME=/tmp/data_home XDG_CACHE_HOME=/tmp/cache_home cargo r
```
### This is what the defaults look like in Windows (username scrubbed to
protect the innocent)
How my NU_LIB_DIRS is set in the images above
```nushell
$env.NU_LIB_DIRS = [
($nu.default-config-dir | path join 'scripts') # add <nushell-config-dir>/scripts
'/Users/fdncred/src/nu_scripts'
($nu.config-path | path dirname)
($nu.data-dir | path join 'completions') # default home for nushell completions
]
```
Let the debate begin.
# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.
Make sure you've run and fixed any issues with these commands:
- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the
tests for the standard library
> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->
# After Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
102 lines
4.2 KiB
Plaintext
102 lines
4.2 KiB
Plaintext
# Nushell Environment Config File
|
|
#
|
|
# version = "0.94.3"
|
|
|
|
def create_left_prompt [] {
|
|
let dir = match (do --ignore-shell-errors { $env.PWD | path relative-to $nu.home-path }) {
|
|
null => $env.PWD
|
|
'' => '~'
|
|
$relative_pwd => ([~ $relative_pwd] | path join)
|
|
}
|
|
|
|
let path_color = (if (is-admin) { ansi red_bold } else { ansi green_bold })
|
|
let separator_color = (if (is-admin) { ansi light_red_bold } else { ansi light_green_bold })
|
|
let path_segment = $"($path_color)($dir)"
|
|
|
|
$path_segment | str replace --all (char path_sep) $"($separator_color)(char path_sep)($path_color)"
|
|
}
|
|
|
|
def create_right_prompt [] {
|
|
# create a right prompt in magenta with green separators and am/pm underlined
|
|
let time_segment = ([
|
|
(ansi reset)
|
|
(ansi magenta)
|
|
(date now | format date '%x %X') # try to respect user's locale
|
|
] | str join | str replace --regex --all "([/:])" $"(ansi green)${1}(ansi magenta)" |
|
|
str replace --regex --all "([AP]M)" $"(ansi magenta_underline)${1}")
|
|
|
|
let last_exit_code = if ($env.LAST_EXIT_CODE != 0) {([
|
|
(ansi rb)
|
|
($env.LAST_EXIT_CODE)
|
|
] | str join)
|
|
} else { "" }
|
|
|
|
([$last_exit_code, (char space), $time_segment] | str join)
|
|
}
|
|
|
|
# Use nushell functions to define your right and left prompt
|
|
$env.PROMPT_COMMAND = {|| create_left_prompt }
|
|
# FIXME: This default is not implemented in rust code as of 2023-09-08.
|
|
$env.PROMPT_COMMAND_RIGHT = {|| create_right_prompt }
|
|
|
|
# The prompt indicators are environmental variables that represent
|
|
# the state of the prompt
|
|
$env.PROMPT_INDICATOR = {|| "> " }
|
|
$env.PROMPT_INDICATOR_VI_INSERT = {|| ": " }
|
|
$env.PROMPT_INDICATOR_VI_NORMAL = {|| "> " }
|
|
$env.PROMPT_MULTILINE_INDICATOR = {|| "::: " }
|
|
|
|
# If you want previously entered commands to have a different prompt from the usual one,
|
|
# you can uncomment one or more of the following lines.
|
|
# This can be useful if you have a 2-line prompt and it's taking up a lot of space
|
|
# because every command entered takes up 2 lines instead of 1. You can then uncomment
|
|
# the line below so that previously entered commands show with a single `🚀`.
|
|
# $env.TRANSIENT_PROMPT_COMMAND = {|| "🚀 " }
|
|
# $env.TRANSIENT_PROMPT_INDICATOR = {|| "" }
|
|
# $env.TRANSIENT_PROMPT_INDICATOR_VI_INSERT = {|| "" }
|
|
# $env.TRANSIENT_PROMPT_INDICATOR_VI_NORMAL = {|| "" }
|
|
# $env.TRANSIENT_PROMPT_MULTILINE_INDICATOR = {|| "" }
|
|
# $env.TRANSIENT_PROMPT_COMMAND_RIGHT = {|| "" }
|
|
|
|
# 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
|
|
$env.ENV_CONVERSIONS = {
|
|
"PATH": {
|
|
from_string: { |s| $s | split row (char esep) | path expand --no-symlink }
|
|
to_string: { |v| $v | path expand --no-symlink | str join (char esep) }
|
|
}
|
|
"Path": {
|
|
from_string: { |s| $s | split row (char esep) | path expand --no-symlink }
|
|
to_string: { |v| $v | path expand --no-symlink | str join (char esep) }
|
|
}
|
|
}
|
|
|
|
# Directories to search for scripts when calling source or use
|
|
# The default for this is $nu.default-config-dir/scripts
|
|
$env.NU_LIB_DIRS = [
|
|
($nu.default-config-dir | path join 'scripts') # add <nushell-config-dir>/scripts
|
|
($nu.data-dir | path join 'completions') # default home for nushell completions
|
|
]
|
|
|
|
# Directories to search for plugin binaries when calling register
|
|
# The default for this is $nu.default-config-dir/plugins
|
|
$env.NU_PLUGIN_DIRS = [
|
|
($nu.default-config-dir | path join 'plugins') # add <nushell-config-dir>/plugins
|
|
]
|
|
|
|
# To add entries to PATH (on Windows you might use Path), you can use the following pattern:
|
|
# $env.PATH = ($env.PATH | split row (char esep) | prepend '/some/path')
|
|
# An alternate way to add entries to $env.PATH is to use the custom command `path add`
|
|
# which is built into the nushell stdlib:
|
|
# use std "path add"
|
|
# $env.PATH = ($env.PATH | split row (char esep))
|
|
# path add /some/path
|
|
# path add ($env.CARGO_HOME | path join "bin")
|
|
# path add ($env.HOME | path join ".local" "bin")
|
|
# $env.PATH = ($env.PATH | uniq)
|
|
|
|
# To load from a custom file you can use:
|
|
# source ($nu.default-config-dir | path join 'custom.nu')
|