mirror of
https://github.com/nushell/nushell.git
synced 2025-06-30 14:40:06 +02:00
Improves startup time when using std-lib (#13842)
Updated summary for commit [612e0e2](612e0e2160) - While folks are welcome to read through the entire comments, the core information is summarized here. # Description This PR drastically improves startup times of Nushell by only parsing a single submodule of the Standard Library that provides the `banner` and `pwd` commands. All other Standard Library commands and submodules are parsed when imported by the user. This cuts startup times by more than 60%. At the moment, we have stopped adding to `std-lib` because every addition adds a small amount to the Nushell startup time. With this change, we should once again be able to allow new functionality to be added to the Standard Library without it impacting `nu` startup times. # User-Facing Changes * Nushell now starts about 60% faster * Breaking change: The `dirs` (Shells) aliases will return a warning message that it will not be auto-loaded in the following release, along with instructions on how to restore it (and disable the message) * The `use std <submodule> *` syntax is available for convenience, but should be avoided in scripts as it parses the entire `std` module and all other submodules and places it in scope. The correct syntax to *just* load a submodule is `use std/<submodule> *` (asterisk optional). The slash is important. This will be documented. * `use std *` can be used for convenience to load all of the library but still incurs the full loading-time. * `std/dirs`: Semi-breaking change. The `dirs` command replaces the `show` command. This is more in line with the directory-stack functionality found in other shells. Existing users will not be impacted by this as the alias (`shells`) remains the same. * Breaking-change: Technically a breaking change, but probably only impacts maintainers of `std`. The virtual path for the standard library has changed. It could previously be imported using its virtual path (and technically, this would have been the correct way to do it): ```nu use NU_STDLIB_VIRTUAL_DIR/std ``` The path is now simply `std/`: ```nu use std ``` All submodules have moved accordingly. # Timings Comparisons below were made: * In a temporary, clean config directory using `$env.XDG_CONFIG_HOME = (mktemp -d)`. * `nu` was run with a release build * `nu` was run one time to generate the default `config.nu` (etc.) files - Otherwise timings would include the user-prompt * The shell was exited and then restarted several times to get timing samples (Note: Old timings based on 0.97 rather than 0.98, but in the range of being accurate) | Scenario | `$nu.startup-time` | | --- | --- | | 0.97.2 ([aaaab8e](aaaab8e070)) Without this PR | 23ms - 24ms | | This PR with deprecated commands | 9ms - <11ms | | This PR after deprecated commands are removed in following release | 8ms - <10ms | | Final PR (remove deprecated), using `--no-std-lib` | 6.1ms to 6.4ms | | Final PR (remove deprecated), using `--no-config-file` | 3.1ms - 3.6ms | | Final PR (remove deprecated), using `--no-config-file --no-std-lib` | 1ms - 1.5ms | *These last two timings point to the opportunity for further optimization (see comment in thread below (will link once I write it).* # Implementation details for future maintenance * `use std banner` is a ridiculously deceptive call. That call parses and imports *all* of `std` into scope. Simply replacing it with `use std/core *` is essentially what saves ~14-15ms. This *only* imports the submodule with the `banner` and `pwd` commands. * From the code-comments, the reason that `NU_STDLIB_VIRTUAL_DIR` was used as a prefix was so that there wouldn't be an issue if a user had a `./std/mod.nu` in the current directory. This does **not** appear to be an issue. After removing the prefix, I tested with both a relative module as well as one in the `$env.NU_LIB_DIRS` path, and in all cases the *internal* `std` still took precedence. * By removing the prefix, users can now `use std` (and variants) without requiring that it already be parsed and in scope. * In the next release, we'll stop autoloading the `dirs` (shells) functionality. While this only costs an additional 1-1.5ms, I think it's better moved to the `config.nu` where the user can optionally remove it. The main reason is its use of aliases (which have also caused issues) - The `n`, `p`, and `g` short-commands are valuable real-estate, and users may want to map these to something else. For this release, there's an `deprecated_dirs` module that is still autoloaded. As with the top-level commands, use of these will give a deprecation warning with instructions on how to handle going forward. To help with this, moved the aliases to their own submodule inside the `dirs` module. * Also sneaks in a small change where the top-level `dirs` command is now the replacement for `dirs show` * Fixed a double-import of `assert` in `dirs.nu` * The `show_banner` step is replaced with simply `banner` rather than re-importing it. * A `virtual_path` may now be referenced with either a forward-slash or a backward-slash on Windows. This allows `use std/<submodule>` to work on all platforms. # Performance side-notes: * Future parsing and/or IR improvements should improve performance even further. * While the existing load time penalty of `std-lib` was not noticeable on many systems, Nushell runs on a wide-variety of hardware and OS platforms. Slower platforms will naturally see a bigger jump in performance here. For users starting multiple Nushell sessions frequently (e.g., `tmux`, Zellij, `screen`, et. al.) it is recommended to keep total startup time (including user configuration) under ~250ms. # Tests + Formatting * All tests are green * Updated tests: - Removed the test that confirmed that `std` was loaded (since we don't). - Removed the `shells` test since it is not autoloaded. Main `dirs.nu` functionality is tested through `stdlib-test`. - Many tests assumed that the library was fully loaded, because it was (even though we didn't intend for it to be). Fixed those tests. - Tests now import only the necessary submodules (e.g., `use std/assert`, rather than `use std assert`) - Some tests *thought* they were loading `std/log`, but were doing so improperly. This was masked by the now-fixed "load-everything-into-scope bug". Local CI would pass due the `$env.NU_LOG_<...>` variables being inherited from the calling process, but would fail in the "clean" GitHub CI environment. These tests have also been fixed. * Added additional tests for the changes # After Submitting Will update the Standard Library doc page
This commit is contained in:
Douglas
GitHub
71
crates/nu-std/std/bench.nu
Normal file
71
crates/nu-std/std/bench.nu
Normal file
@ -0,0 +1,71 @@
|
||||
# run a piece of `nushell` code multiple times and measure the time of execution.
|
||||
#
|
||||
# this command returns a benchmark report of the following form:
|
||||
# ```
|
||||
# record<
|
||||
# mean: duration
|
||||
# std: duration
|
||||
# times: list<duration>
|
||||
# >
|
||||
# ```
|
||||
#
|
||||
# > **Note**
|
||||
# > `std bench --pretty` will return a `string`.
|
||||
#
|
||||
# # Examples
|
||||
# measure the performance of simple addition
|
||||
# > std bench { 1 + 2 } -n 10 | table -e
|
||||
# ╭───────┬────────────────────╮
|
||||
# │ mean │ 4µs 956ns │
|
||||
# │ std │ 4µs 831ns │
|
||||
# │ │ ╭───┬────────────╮ │
|
||||
# │ times │ │ 0 │ 19µs 402ns │ │
|
||||
# │ │ │ 1 │ 4µs 322ns │ │
|
||||
# │ │ │ 2 │ 3µs 352ns │ │
|
||||
# │ │ │ 3 │ 2µs 966ns │ │
|
||||
# │ │ │ 4 │ 3µs │ │
|
||||
# │ │ │ 5 │ 3µs 86ns │ │
|
||||
# │ │ │ 6 │ 3µs 84ns │ │
|
||||
# │ │ │ 7 │ 3µs 604ns │ │
|
||||
# │ │ │ 8 │ 3µs 98ns │ │
|
||||
# │ │ │ 9 │ 3µs 653ns │ │
|
||||
# │ │ ╰───┴────────────╯ │
|
||||
# ╰───────┴────────────────────╯
|
||||
#
|
||||
# get a pretty benchmark report
|
||||
# > std bench { 1 + 2 } --pretty
|
||||
# 3µs 125ns +/- 2µs 408ns
|
||||
export def main [
|
||||
code: closure # the piece of `nushell` code to measure the performance of
|
||||
--rounds (-n): int = 50 # the number of benchmark rounds (hopefully the more rounds the less variance)
|
||||
--verbose (-v) # be more verbose (namely prints the progress)
|
||||
--pretty # shows the results in human-readable format: "<mean> +/- <stddev>"
|
||||
] {
|
||||
let times = (
|
||||
seq 1 $rounds | each {|i|
|
||||
if $verbose { print -n $"($i) / ($rounds)\r" }
|
||||
timeit { do $code } | into int | into float
|
||||
}
|
||||
)
|
||||
|
||||
if $verbose { print $"($rounds) / ($rounds)" }
|
||||
|
||||
let report = {
|
||||
mean: ($times | math avg | from ns)
|
||||
min: ($times | math min | from ns)
|
||||
max: ($times | math max | from ns)
|
||||
std: ($times | math stddev | from ns)
|
||||
times: ($times | each { from ns })
|
||||
}
|
||||
|
||||
if $pretty {
|
||||
$"($report.mean) +/- ($report.std)"
|
||||
} else {
|
||||
$report
|
||||
}
|
||||
}
|
||||
|
||||
# convert an integer amount of nanoseconds to a real duration
|
||||
def "from ns" [] {
|
||||
[$in "ns"] | str join | into duration
|
||||
}
|
||||
33
crates/nu-std/std/core.nu
Normal file
33
crates/nu-std/std/core.nu
Normal file
@ -0,0 +1,33 @@
|
||||
use dt [datetime-diff, pretty-print-duration]
|
||||
|
||||
# Print a banner for nushell with information about the project
|
||||
export def banner [] {
|
||||
let dt = (datetime-diff (date now) 2019-05-10T09:59:12-07:00)
|
||||
$"(ansi green) __ ,(ansi reset)
|
||||
(ansi green) .--\(\)°'.' (ansi reset)Welcome to (ansi green)Nushell(ansi reset),
|
||||
(ansi green)'|, . ,' (ansi reset)based on the (ansi green)nu(ansi reset) language,
|
||||
(ansi green) !_-\(_\\ (ansi reset)where all data is structured!
|
||||
|
||||
Please join our (ansi purple)Discord(ansi reset) community at (ansi purple)https://discord.gg/NtAbbGn(ansi reset)
|
||||
Our (ansi green_bold)GitHub(ansi reset) repository is at (ansi green_bold)https://github.com/nushell/nushell(ansi reset)
|
||||
Our (ansi green)Documentation(ansi reset) is located at (ansi green)https://nushell.sh(ansi reset)
|
||||
(ansi cyan)Tweet(ansi reset) us at (ansi cyan_bold)@nu_shell(ansi reset)
|
||||
Learn how to remove this at: (ansi green)https://nushell.sh/book/configuration.html#remove-welcome-message(ansi reset)
|
||||
|
||||
It's been this long since (ansi green)Nushell(ansi reset)'s first commit:
|
||||
(pretty-print-duration $dt)
|
||||
|
||||
Startup Time: ($nu.startup-time)
|
||||
"
|
||||
}
|
||||
|
||||
# Return the current working directory
|
||||
export def pwd [
|
||||
--physical (-P) # resolve symbolic links
|
||||
] {
|
||||
if $physical {
|
||||
$env.PWD | path expand
|
||||
} else {
|
||||
$env.PWD
|
||||
}
|
||||
}
|
||||
161
crates/nu-std/std/deprecated_dirs.nu
Normal file
161
crates/nu-std/std/deprecated_dirs.nu
Normal file
@ -0,0 +1,161 @@
|
||||
# Maintain a list of working directories and navigate them
|
||||
|
||||
# The directory stack.
|
||||
#
|
||||
# Exception: the entry for the current directory contains an
|
||||
# irrelevant value. Instead, the source of truth for the working
|
||||
# directory is $env.PWD. It has to be this way because cd doesn't
|
||||
# know about this module.
|
||||
#
|
||||
# Example: the following state represents a user-facing directory
|
||||
# stack of [/a, /var/tmp, /c], and we are currently in /var/tmp .
|
||||
#
|
||||
# PWD = /var/tmp
|
||||
# DIRS_POSITION = 1
|
||||
# DIRS_LIST = [/a, /b, /c]
|
||||
#
|
||||
# This situation could arise if we started with [/a, /b, /c], then
|
||||
# we changed directories from /b to /var/tmp.
|
||||
export-env {
|
||||
$env.DIRS_POSITION = 0
|
||||
$env.DIRS_LIST = [($env.PWD | path expand)]
|
||||
}
|
||||
|
||||
def deprecation_warning [ ] {
|
||||
print -e $"
|
||||
(ansi red)Warning:(ansi reset) The 'std dirs' module will no longer automatically
|
||||
be loaded in the next release. To continue using the Shells
|
||||
feature, and to remove this warning, please add the following
|
||||
to your config.nu:
|
||||
|
||||
use std/dirs shells-aliases *
|
||||
|
||||
Or see the documentation for more options.
|
||||
"
|
||||
}
|
||||
|
||||
# Add one or more directories to the list.
|
||||
# PWD becomes first of the newly added directories.
|
||||
export def --env add [
|
||||
...paths: string # directory or directories to add to working list
|
||||
] {
|
||||
deprecation_warning
|
||||
|
||||
mut abspaths = []
|
||||
for p in $paths {
|
||||
let exp = ($p | path expand)
|
||||
if ($exp | path type) != 'dir' {
|
||||
let span = (metadata $p).span
|
||||
error make {msg: "not a directory", label: {text: "not a directory", span: $span } }
|
||||
}
|
||||
$abspaths = ($abspaths | append $exp)
|
||||
}
|
||||
|
||||
$env.DIRS_LIST = ($env.DIRS_LIST | insert ($env.DIRS_POSITION + 1) $abspaths | flatten)
|
||||
|
||||
_fetch 1
|
||||
}
|
||||
|
||||
export alias enter = add
|
||||
|
||||
# Advance to the next directory in the list or wrap to beginning.
|
||||
export def --env next [
|
||||
N:int = 1 # number of positions to move.
|
||||
] {
|
||||
deprecation_warning
|
||||
_fetch $N
|
||||
}
|
||||
|
||||
export alias n = next
|
||||
|
||||
# Back up to the previous directory or wrap to the end.
|
||||
export def --env prev [
|
||||
N:int = 1 # number of positions to move.
|
||||
] {
|
||||
deprecation_warning
|
||||
_fetch (-1 * $N)
|
||||
}
|
||||
|
||||
export alias p = prev
|
||||
|
||||
# Drop the current directory from the list, if it's not the only one.
|
||||
# PWD becomes the next working directory
|
||||
export def --env drop [] {
|
||||
deprecation_warning
|
||||
if ($env.DIRS_LIST | length) > 1 {
|
||||
$env.DIRS_LIST = ($env.DIRS_LIST | reject $env.DIRS_POSITION)
|
||||
if ($env.DIRS_POSITION >= ($env.DIRS_LIST | length)) {$env.DIRS_POSITION = 0}
|
||||
}
|
||||
|
||||
# step to previous slot
|
||||
_fetch -1 --forget_current --always_cd
|
||||
|
||||
}
|
||||
|
||||
export alias dexit = drop
|
||||
|
||||
# Display current working directories.
|
||||
export def --env show [] {
|
||||
deprecation_warning
|
||||
mut out = []
|
||||
for $p in ($env.DIRS_LIST | enumerate) {
|
||||
let is_act_slot = $p.index == $env.DIRS_POSITION
|
||||
$out = ($out | append [
|
||||
[active, path];
|
||||
[($is_act_slot),
|
||||
(if $is_act_slot {$env.PWD} else {$p.item}) # show current PWD in lieu of active slot
|
||||
]
|
||||
])
|
||||
}
|
||||
|
||||
$out
|
||||
}
|
||||
|
||||
export alias shells = show
|
||||
|
||||
export def --env goto [shell?: int] {
|
||||
deprecation_warning
|
||||
if $shell == null {
|
||||
return (show)
|
||||
}
|
||||
|
||||
if $shell < 0 or $shell >= ($env.DIRS_LIST | length) {
|
||||
let span = (metadata $shell | get span)
|
||||
error make {
|
||||
msg: $"(ansi red_bold)invalid_shell_index(ansi reset)"
|
||||
label: {
|
||||
text: $"`shell` should be between 0 and (($env.DIRS_LIST | length) - 1)"
|
||||
span: $span
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_fetch ($shell - $env.DIRS_POSITION)
|
||||
}
|
||||
|
||||
export alias g = goto
|
||||
|
||||
# fetch item helper
|
||||
def --env _fetch [
|
||||
offset: int, # signed change to position
|
||||
--forget_current # true to skip saving PWD
|
||||
--always_cd # true to always cd
|
||||
] {
|
||||
if not ($forget_current) {
|
||||
# first record current working dir in current slot of ring, to track what CD may have done.
|
||||
$env.DIRS_LIST = ($env.DIRS_LIST | upsert $env.DIRS_POSITION $env.PWD)
|
||||
}
|
||||
|
||||
# figure out which entry to move to
|
||||
# nushell 'mod' operator is really 'remainder', can return negative values.
|
||||
# see: https://stackoverflow.com/questions/13683563/whats-the-difference-between-mod-and-remainder
|
||||
let len = ($env.DIRS_LIST | length)
|
||||
mut pos = ($env.DIRS_POSITION + $offset) mod $len
|
||||
if ($pos < 0) { $pos += $len}
|
||||
|
||||
# if using a different position in ring, CD there.
|
||||
if ($always_cd or $pos != $env.DIRS_POSITION) {
|
||||
$env.DIRS_POSITION = $pos
|
||||
cd ($env.DIRS_LIST | get $pos )
|
||||
}
|
||||
}
|
||||
@ -22,7 +22,8 @@ export-env {
|
||||
}
|
||||
|
||||
# Add one or more directories to the list.
|
||||
# PWD becomes first of the newly added directories.
|
||||
# The first directory listed becomes the new
|
||||
# active directory.
|
||||
export def --env add [
|
||||
...paths: string # directory or directories to add to working list
|
||||
] {
|
||||
@ -38,32 +39,33 @@ export def --env add [
|
||||
|
||||
$env.DIRS_LIST = ($env.DIRS_LIST | insert ($env.DIRS_POSITION + 1) $abspaths | flatten)
|
||||
|
||||
|
||||
_fetch 1
|
||||
}
|
||||
|
||||
export alias enter = add
|
||||
|
||||
# Advance to the next directory in the list or wrap to beginning.
|
||||
# Make the next directory on the list the active directory.
|
||||
# If the currenta ctive directory is the last in the list,
|
||||
# then cycle to the top of the list.
|
||||
export def --env next [
|
||||
N:int = 1 # number of positions to move.
|
||||
] {
|
||||
_fetch $N
|
||||
}
|
||||
|
||||
export alias n = next
|
||||
|
||||
# Back up to the previous directory or wrap to the end.
|
||||
# Make the previous directory on the list the active directory.
|
||||
# If the current active directory is the first in the list,
|
||||
# then cycle to the end of the list.
|
||||
export def --env prev [
|
||||
N:int = 1 # number of positions to move.
|
||||
] {
|
||||
_fetch (-1 * $N)
|
||||
}
|
||||
|
||||
export alias p = prev
|
||||
|
||||
# Drop the current directory from the list, if it's not the only one.
|
||||
# PWD becomes the next working directory
|
||||
# Drop the current directory from the list.
|
||||
# The previous directory in the list becomes
|
||||
# the new active directory.
|
||||
#
|
||||
# If there is only one directory in the list,
|
||||
# then this command has no effect.
|
||||
export def --env drop [] {
|
||||
if ($env.DIRS_LIST | length) > 1 {
|
||||
$env.DIRS_LIST = ($env.DIRS_LIST | reject $env.DIRS_POSITION)
|
||||
@ -75,10 +77,8 @@ export def --env drop [] {
|
||||
|
||||
}
|
||||
|
||||
export alias dexit = drop
|
||||
|
||||
# Display current working directories.
|
||||
export def --env show [] {
|
||||
# Display current working directories
|
||||
export def --env main [] {
|
||||
mut out = []
|
||||
for $p in ($env.DIRS_LIST | enumerate) {
|
||||
let is_act_slot = $p.index == $env.DIRS_POSITION
|
||||
@ -93,29 +93,26 @@ export def --env show [] {
|
||||
$out
|
||||
}
|
||||
|
||||
export alias shells = show
|
||||
|
||||
export def --env goto [shell?: int] {
|
||||
if $shell == null {
|
||||
return (show)
|
||||
# Jump to directory by index
|
||||
export def --env goto [dir_idx?: int] {
|
||||
if $dir_idx == null {
|
||||
return (main)
|
||||
}
|
||||
|
||||
if $shell < 0 or $shell >= ($env.DIRS_LIST | length) {
|
||||
let span = (metadata $shell | get span)
|
||||
if $dir_idx < 0 or $dir_idx >= ($env.DIRS_LIST | length) {
|
||||
let span = (metadata $dir_idx | get span)
|
||||
error make {
|
||||
msg: $"(ansi red_bold)invalid_shell_index(ansi reset)"
|
||||
msg: $"(ansi red_bold)invalid_dirs_index(ansi reset)"
|
||||
label: {
|
||||
text: $"`shell` should be between 0 and (($env.DIRS_LIST | length) - 1)"
|
||||
text: $"`idx` should be between 0 and (($env.DIRS_LIST | length) - 1)"
|
||||
span: $span
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_fetch ($shell - $env.DIRS_POSITION)
|
||||
_fetch ($dir_idx - $env.DIRS_POSITION)
|
||||
}
|
||||
|
||||
export alias g = goto
|
||||
|
||||
# fetch item helper
|
||||
def --env _fetch [
|
||||
offset: int, # signed change to position
|
||||
@ -140,3 +137,12 @@ def --env _fetch [
|
||||
cd ($env.DIRS_LIST | get $pos )
|
||||
}
|
||||
}
|
||||
|
||||
export module shells-aliases {
|
||||
export alias shells = main
|
||||
export alias enter = add
|
||||
export alias dexit = drop
|
||||
export alias p = prev
|
||||
export alias n = next
|
||||
export alias g = goto
|
||||
}
|
||||
124
crates/nu-std/std/lib.nu
Normal file
124
crates/nu-std/std/lib.nu
Normal file
@ -0,0 +1,124 @@
|
||||
# Add the given paths to the PATH.
|
||||
#
|
||||
# # Example
|
||||
# - adding some dummy paths to an empty PATH
|
||||
# ```nushell
|
||||
# >_ with-env { PATH: [] } {
|
||||
# std path add "foo"
|
||||
# std path add "bar" "baz"
|
||||
# std path add "fooo" --append
|
||||
#
|
||||
# assert equal $env.PATH ["bar" "baz" "foo" "fooo"]
|
||||
#
|
||||
# print (std path add "returned" --ret)
|
||||
# }
|
||||
# ╭───┬──────────╮
|
||||
# │ 0 │ returned │
|
||||
# │ 1 │ bar │
|
||||
# │ 2 │ baz │
|
||||
# │ 3 │ foo │
|
||||
# │ 4 │ fooo │
|
||||
# ╰───┴──────────╯
|
||||
# ```
|
||||
# - adding paths based on the operating system
|
||||
# ```nushell
|
||||
# >_ std path add {linux: "foo", windows: "bar", darwin: "baz"}
|
||||
# ```
|
||||
export def --env "path add" [
|
||||
--ret (-r) # return $env.PATH, useful in pipelines to avoid scoping.
|
||||
--append (-a) # append to $env.PATH instead of prepending to.
|
||||
...paths # the paths to add to $env.PATH.
|
||||
] {
|
||||
let span = (metadata $paths).span
|
||||
let paths = $paths | flatten
|
||||
|
||||
if ($paths | is-empty) or ($paths | length) == 0 {
|
||||
error make {msg: "Empty input", label: {
|
||||
text: "Provide at least one string or a record",
|
||||
span: $span
|
||||
}}
|
||||
}
|
||||
|
||||
let path_name = if "PATH" in $env { "PATH" } else { "Path" }
|
||||
|
||||
let paths = $paths | each {|p|
|
||||
let p = match ($p | describe | str replace --regex '<.*' '') {
|
||||
"string" => $p,
|
||||
"record" => { $p | get --ignore-errors $nu.os-info.name },
|
||||
}
|
||||
|
||||
$p | path expand --no-symlink
|
||||
}
|
||||
|
||||
if null in $paths or ($paths | is-empty) {
|
||||
error make {msg: "Empty input", label: {
|
||||
text: $"Received a record, that does not contain a ($nu.os-info.name) key",
|
||||
span: $span
|
||||
}}
|
||||
}
|
||||
|
||||
load-env {$path_name: (
|
||||
$env
|
||||
| get $path_name
|
||||
| split row (char esep)
|
||||
| if $append { append $paths } else { prepend $paths }
|
||||
)}
|
||||
|
||||
if $ret {
|
||||
$env | get $path_name
|
||||
}
|
||||
}
|
||||
|
||||
# the cute and friendly mascot of Nushell :)
|
||||
export def ellie [] {
|
||||
let ellie = [
|
||||
" __ ,",
|
||||
" .--()°'.'",
|
||||
"'|, . ,'",
|
||||
" !_-(_\\",
|
||||
]
|
||||
|
||||
$ellie | str join "\n" | $"(ansi green)($in)(ansi reset)"
|
||||
}
|
||||
|
||||
# repeat anything a bunch of times, yielding a list of *n* times the input
|
||||
#
|
||||
# # Examples
|
||||
# repeat a string
|
||||
# > "foo" | std repeat 3 | str join
|
||||
# "foofoofoo"
|
||||
export def repeat [
|
||||
n: int # the number of repetitions, must be positive
|
||||
]: any -> list<any> {
|
||||
let item = $in
|
||||
|
||||
if $n < 0 {
|
||||
let span = metadata $n | get span
|
||||
error make {
|
||||
msg: $"(ansi red_bold)invalid_argument(ansi reset)"
|
||||
label: {
|
||||
text: $"n should be a positive integer, found ($n)"
|
||||
span: $span
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if $n == 0 {
|
||||
return []
|
||||
}
|
||||
|
||||
1..$n | each { $item }
|
||||
}
|
||||
|
||||
# return a null device file.
|
||||
#
|
||||
# # Examples
|
||||
# run a command and ignore it's stderr output
|
||||
# > cat xxx.txt e> (null-device)
|
||||
export def null-device []: nothing -> path {
|
||||
if ($nu.os-info.name | str downcase) == "windows" {
|
||||
'\\.\NUL'
|
||||
} else {
|
||||
"/dev/null"
|
||||
}
|
||||
}
|
||||
@ -1,247 +1,28 @@
|
||||
# std.nu, `used` to load all standard library components
|
||||
|
||||
export module assert.nu
|
||||
export module dirs.nu
|
||||
export module dt.nu
|
||||
export module formats.nu
|
||||
export module help.nu
|
||||
export module input.nu
|
||||
export module iter.nu
|
||||
export module log.nu
|
||||
export module math.nu
|
||||
export module xml.nu
|
||||
export-env {
|
||||
use dirs.nu []
|
||||
use log.nu []
|
||||
}
|
||||
|
||||
use dt.nu [datetime-diff, pretty-print-duration]
|
||||
|
||||
# Add the given paths to the PATH.
|
||||
#
|
||||
# # Example
|
||||
# - adding some dummy paths to an empty PATH
|
||||
# ```nushell
|
||||
# >_ with-env { PATH: [] } {
|
||||
# std path add "foo"
|
||||
# std path add "bar" "baz"
|
||||
# std path add "fooo" --append
|
||||
#
|
||||
# assert equal $env.PATH ["bar" "baz" "foo" "fooo"]
|
||||
#
|
||||
# print (std path add "returned" --ret)
|
||||
# }
|
||||
# ╭───┬──────────╮
|
||||
# │ 0 │ returned │
|
||||
# │ 1 │ bar │
|
||||
# │ 2 │ baz │
|
||||
# │ 3 │ foo │
|
||||
# │ 4 │ fooo │
|
||||
# ╰───┴──────────╯
|
||||
# ```
|
||||
# - adding paths based on the operating system
|
||||
# ```nushell
|
||||
# >_ std path add {linux: "foo", windows: "bar", darwin: "baz"}
|
||||
# ```
|
||||
export def --env "path add" [
|
||||
--ret (-r) # return $env.PATH, useful in pipelines to avoid scoping.
|
||||
--append (-a) # append to $env.PATH instead of prepending to.
|
||||
...paths # the paths to add to $env.PATH.
|
||||
] {
|
||||
let span = (metadata $paths).span
|
||||
let paths = $paths | flatten
|
||||
|
||||
if ($paths | is-empty) or ($paths | length) == 0 {
|
||||
error make {msg: "Empty input", label: {
|
||||
text: "Provide at least one string or a record",
|
||||
span: $span
|
||||
}}
|
||||
}
|
||||
|
||||
let path_name = if "PATH" in $env { "PATH" } else { "Path" }
|
||||
|
||||
let paths = $paths | each {|p|
|
||||
let p = match ($p | describe | str replace --regex '<.*' '') {
|
||||
"string" => $p,
|
||||
"record" => { $p | get --ignore-errors $nu.os-info.name },
|
||||
}
|
||||
|
||||
$p | path expand --no-symlink
|
||||
}
|
||||
|
||||
if null in $paths or ($paths | is-empty) {
|
||||
error make {msg: "Empty input", label: {
|
||||
text: $"Received a record, that does not contain a ($nu.os-info.name) key",
|
||||
span: $span
|
||||
}}
|
||||
}
|
||||
|
||||
load-env {$path_name: (
|
||||
$env
|
||||
| get $path_name
|
||||
| split row (char esep)
|
||||
| if $append { append $paths } else { prepend $paths }
|
||||
)}
|
||||
|
||||
if $ret {
|
||||
$env | get $path_name
|
||||
}
|
||||
}
|
||||
|
||||
# convert an integer amount of nanoseconds to a real duration
|
||||
def "from ns" [] {
|
||||
[$in "ns"] | str join | into duration
|
||||
}
|
||||
|
||||
# run a piece of `nushell` code multiple times and measure the time of execution.
|
||||
#
|
||||
# this command returns a benchmark report of the following form:
|
||||
# ```
|
||||
# record<
|
||||
# mean: duration
|
||||
# std: duration
|
||||
# times: list<duration>
|
||||
# >
|
||||
# ```
|
||||
#
|
||||
# > **Note**
|
||||
# > `std bench --pretty` will return a `string`.
|
||||
#
|
||||
# # Examples
|
||||
# measure the performance of simple addition
|
||||
# > std bench { 1 + 2 } -n 10 | table -e
|
||||
# ╭───────┬────────────────────╮
|
||||
# │ mean │ 4µs 956ns │
|
||||
# │ std │ 4µs 831ns │
|
||||
# │ │ ╭───┬────────────╮ │
|
||||
# │ times │ │ 0 │ 19µs 402ns │ │
|
||||
# │ │ │ 1 │ 4µs 322ns │ │
|
||||
# │ │ │ 2 │ 3µs 352ns │ │
|
||||
# │ │ │ 3 │ 2µs 966ns │ │
|
||||
# │ │ │ 4 │ 3µs │ │
|
||||
# │ │ │ 5 │ 3µs 86ns │ │
|
||||
# │ │ │ 6 │ 3µs 84ns │ │
|
||||
# │ │ │ 7 │ 3µs 604ns │ │
|
||||
# │ │ │ 8 │ 3µs 98ns │ │
|
||||
# │ │ │ 9 │ 3µs 653ns │ │
|
||||
# │ │ ╰───┴────────────╯ │
|
||||
# ╰───────┴────────────────────╯
|
||||
#
|
||||
# get a pretty benchmark report
|
||||
# > std bench { 1 + 2 } --pretty
|
||||
# 3µs 125ns +/- 2µs 408ns
|
||||
export def bench [
|
||||
code: closure # the piece of `nushell` code to measure the performance of
|
||||
--rounds (-n): int = 50 # the number of benchmark rounds (hopefully the more rounds the less variance)
|
||||
--verbose (-v) # be more verbose (namely prints the progress)
|
||||
--pretty # shows the results in human-readable format: "<mean> +/- <stddev>"
|
||||
] {
|
||||
let times = (
|
||||
seq 1 $rounds | each {|i|
|
||||
if $verbose { print -n $"($i) / ($rounds)\r" }
|
||||
timeit { do $code } | into int | into float
|
||||
}
|
||||
)
|
||||
|
||||
if $verbose { print $"($rounds) / ($rounds)" }
|
||||
|
||||
let report = {
|
||||
mean: ($times | math avg | from ns)
|
||||
min: ($times | math min | from ns)
|
||||
max: ($times | math max | from ns)
|
||||
std: ($times | math stddev | from ns)
|
||||
times: ($times | each { from ns })
|
||||
}
|
||||
|
||||
if $pretty {
|
||||
$"($report.mean) +/- ($report.std)"
|
||||
} else {
|
||||
$report
|
||||
}
|
||||
}
|
||||
|
||||
# Print a banner for nushell with information about the project
|
||||
export def banner [] {
|
||||
let dt = (datetime-diff (date now) 2019-05-10T09:59:12-07:00)
|
||||
$"(ansi green) __ ,(ansi reset)
|
||||
(ansi green) .--\(\)°'.' (ansi reset)Welcome to (ansi green)Nushell(ansi reset),
|
||||
(ansi green)'|, . ,' (ansi reset)based on the (ansi green)nu(ansi reset) language,
|
||||
(ansi green) !_-\(_\\ (ansi reset)where all data is structured!
|
||||
|
||||
Please join our (ansi purple)Discord(ansi reset) community at (ansi purple)https://discord.gg/NtAbbGn(ansi reset)
|
||||
Our (ansi green_bold)GitHub(ansi reset) repository is at (ansi green_bold)https://github.com/nushell/nushell(ansi reset)
|
||||
Our (ansi green)Documentation(ansi reset) is located at (ansi green)https://nushell.sh(ansi reset)
|
||||
(ansi cyan)Tweet(ansi reset) us at (ansi cyan_bold)@nu_shell(ansi reset)
|
||||
Learn how to remove this at: (ansi green)https://nushell.sh/book/configuration.html#remove-welcome-message(ansi reset)
|
||||
|
||||
It's been this long since (ansi green)Nushell(ansi reset)'s first commit:
|
||||
(pretty-print-duration $dt)
|
||||
|
||||
Startup Time: ($nu.startup-time)
|
||||
"
|
||||
}
|
||||
|
||||
# the cute and friendly mascot of Nushell :)
|
||||
export def ellie [] {
|
||||
let ellie = [
|
||||
" __ ,",
|
||||
" .--()°'.'",
|
||||
"'|, . ,'",
|
||||
" !_-(_\\",
|
||||
]
|
||||
|
||||
$ellie | str join "\n" | $"(ansi green)($in)(ansi reset)"
|
||||
}
|
||||
|
||||
# Return the current working directory
|
||||
export def pwd [
|
||||
--physical (-P) # resolve symbolic links
|
||||
] {
|
||||
if $physical {
|
||||
$env.PWD | path expand
|
||||
} else {
|
||||
$env.PWD
|
||||
}
|
||||
}
|
||||
|
||||
# repeat anything a bunch of times, yielding a list of *n* times the input
|
||||
#
|
||||
# # Examples
|
||||
# repeat a string
|
||||
# > "foo" | std repeat 3 | str join
|
||||
# "foofoofoo"
|
||||
export def repeat [
|
||||
n: int # the number of repetitions, must be positive
|
||||
]: any -> list<any> {
|
||||
let item = $in
|
||||
|
||||
if $n < 0 {
|
||||
let span = metadata $n | get span
|
||||
error make {
|
||||
msg: $"(ansi red_bold)invalid_argument(ansi reset)"
|
||||
label: {
|
||||
text: $"n should be a positive integer, found ($n)"
|
||||
span: $span
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if $n == 0 {
|
||||
return []
|
||||
}
|
||||
|
||||
1..$n | each { $item }
|
||||
}
|
||||
|
||||
# return a null device file.
|
||||
#
|
||||
# # Examples
|
||||
# run a command and ignore it's stderr output
|
||||
# > cat xxx.txt e> (null-device)
|
||||
export def null-device []: nothing -> path {
|
||||
if ($nu.os-info.name | str downcase) == "windows" {
|
||||
'\\.\NUL'
|
||||
} else {
|
||||
"/dev/null"
|
||||
}
|
||||
# Top-level commands: ellie, repeat, null-device, and "path add"
|
||||
export use lib *
|
||||
|
||||
# std submodules
|
||||
export module assert
|
||||
export module bench
|
||||
export module dt
|
||||
export module formats
|
||||
export module help
|
||||
export module input
|
||||
export module iter
|
||||
export module log
|
||||
export module math
|
||||
export module xml
|
||||
|
||||
# Load main dirs command and all subcommands
|
||||
export use dirs main
|
||||
export module dirs {
|
||||
export use dirs [
|
||||
add
|
||||
drop
|
||||
next
|
||||
prev
|
||||
goto
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user