mirror of
https://github.com/nushell/nushell
synced 2024-12-29 14:33:13 +00:00
35c8485442
# Description i use `std clip` to copy everything from `nushell`. however i have the auto-expand on tables enabled and when i use `clip` on large tables, it does not copy what i see but the collapsed data => i have to edit the line and add `| table --expand` manually, which is a pain to do regularly 😱 in this PR, i just add `--expand` to `std clip` to automatically expand the data before copying it 😋 # User-Facing Changes exploring the `Cargo.toml` of `nushell` with auto-expand, one might see ``` > open Cargo.toml | get package.metadata.binstall.overrides ╭────────────────────────┬───────────────────╮ │ │ ╭─────────┬─────╮ │ │ x86_64-pc-windows-msvc │ │ pkg-fmt │ zip │ │ │ │ ╰─────────┴─────╯ │ ╰────────────────────────┴───────────────────╯ ``` but then ``` open Cargo.toml | get package.metadata.binstall.overrides | clip ``` would only copy ``` ╭────────────────────────┬──────────────────╮ │ x86_64-pc-windows-msvc │ {record 1 field} │ ╰────────────────────────┴──────────────────╯ ``` ... now ``` open Cargo.toml | get package.metadata.binstall.overrides | clip --expand ``` will copy the expanded record 👍 # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - ⚫ `toolkit test` - ⚫ `toolkit test stdlib` # After Submitting ``` $nothing ```
226 lines
7.6 KiB
Text
226 lines
7.6 KiB
Text
# std.nu, `used` to load all standard library components
|
||
|
||
export use dirs *
|
||
export-env {
|
||
use dirs *
|
||
}
|
||
export use help *
|
||
export use iter *
|
||
export use log *
|
||
export use testing *
|
||
export use xml *
|
||
|
||
# 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 │
|
||
# ╰───┴──────────╯
|
||
# ```
|
||
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-env PATH = (
|
||
$env.PATH
|
||
| if $append { append $paths }
|
||
else { prepend $paths }
|
||
)
|
||
|
||
if $ret {
|
||
$env.PATH
|
||
}
|
||
}
|
||
|
||
# print a command name as dimmed and italic
|
||
def pretty-command [] {
|
||
let command = $in
|
||
return $"(ansi default_dimmed)(ansi default_italic)($command)(ansi reset)"
|
||
}
|
||
|
||
# give a hint error when the clip command is not available on the system
|
||
def check-clipboard [
|
||
clipboard: string # the clipboard command name
|
||
--system: string # some information about the system running, for better error
|
||
] {
|
||
if (which $clipboard | is-empty) {
|
||
error make --unspanned {
|
||
msg: $"(ansi red)clipboard_not_found(ansi reset):
|
||
you are running ($system)
|
||
but
|
||
the ($clipboard | pretty-command) clipboard command was not found on your system."
|
||
}
|
||
}
|
||
}
|
||
|
||
# put the end of a pipe into the system clipboard.
|
||
#
|
||
# Dependencies:
|
||
# - xclip on linux x11
|
||
# - wl-copy on linux wayland
|
||
# - clip.exe on windows
|
||
#
|
||
# Examples:
|
||
# put a simple string to the clipboard, will be stripped to remove ANSI sequences
|
||
# >_ "my wonderful string" | clip
|
||
# my wonderful string
|
||
# saved to clipboard (stripped)
|
||
#
|
||
# put a whole table to the clipboard
|
||
# >_ ls *.toml | clip
|
||
# ╭───┬─────────────────────┬──────┬────────┬───────────────╮
|
||
# │ # │ name │ type │ size │ modified │
|
||
# ├───┼─────────────────────┼──────┼────────┼───────────────┤
|
||
# │ 0 │ Cargo.toml │ file │ 5.0 KB │ 3 minutes ago │
|
||
# │ 1 │ Cross.toml │ file │ 363 B │ 2 weeks ago │
|
||
# │ 2 │ rust-toolchain.toml │ file │ 1.1 KB │ 2 weeks ago │
|
||
# ╰───┴─────────────────────┴──────┴────────┴───────────────╯
|
||
#
|
||
# saved to clipboard
|
||
#
|
||
# put huge structured data in the clipboard, but silently
|
||
# >_ open Cargo.toml --raw | from toml | clip --silent
|
||
#
|
||
# when the clipboard system command is not installed
|
||
# >_ "mm this is fishy..." | clip
|
||
# Error:
|
||
# × clipboard_not_found:
|
||
# │ you are using xorg on linux
|
||
# │ but
|
||
# │ the xclip clipboard command was not found on your system.
|
||
export def clip [
|
||
--silent: bool # do not print the content of the clipboard to the standard output
|
||
--no-notify: bool # do not throw a notification (only on linux)
|
||
--expand (-e): bool # auto-expand the data given as input
|
||
] {
|
||
let input = (
|
||
$in
|
||
| if $expand { table --expand } else { table }
|
||
| into string
|
||
| ansi strip
|
||
)
|
||
|
||
match $nu.os-info.name {
|
||
"linux" => {
|
||
if ($env.WAYLAND_DISPLAY? | is-empty) {
|
||
check-clipboard xclip --system $"('xorg' | pretty-command) on linux"
|
||
$input | xclip -sel clip
|
||
} else {
|
||
check-clipboard wl-copy --system $"('wayland' | pretty-command) on linux"
|
||
$input | wl-copy
|
||
}
|
||
},
|
||
"windows" => {
|
||
chcp 65001 # see https://discord.com/channels/601130461678272522/601130461678272524/1085535756237426778
|
||
check-clipboard clip.exe --system $"('xorg' | pretty-command) on linux"
|
||
$input | clip.exe
|
||
},
|
||
"macos" => {
|
||
check-clipboard pbcopy --system macOS
|
||
$input | pbcopy
|
||
},
|
||
_ => {
|
||
error make --unspanned {
|
||
msg: $"(ansi red)unknown_operating_system(ansi reset):
|
||
'($nu.os-info.name)' is not supported by the ('clip' | pretty-command) command.
|
||
|
||
please open a feature request in the [issue tracker](char lparen)https://github.com/nushell/nushell/issues/new/choose(char rparen) to add your operating system to the standard library."
|
||
}
|
||
},
|
||
}
|
||
|
||
if not $silent {
|
||
print $input
|
||
print $"(ansi white_italic)(ansi white_dimmed)saved to clipboard(ansi reset)"
|
||
}
|
||
|
||
if (not $no_notify) and ($nu.os-info.name == linux) {
|
||
notify-send "std clip" "saved to clipboard"
|
||
}
|
||
}
|
||
|
||
# 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
|
||
# ╭───────┬────────────────────╮
|
||
# │ 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): bool # be more verbose (namely prints the progress)
|
||
--pretty: bool # 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 decimal
|
||
}
|
||
)
|
||
|
||
if $verbose { print $"($rounds) / ($rounds)" }
|
||
|
||
let report = {
|
||
mean: ($times | math avg | from ns)
|
||
std: ($times | math stddev | from ns)
|
||
times: ($times | each { from ns })
|
||
}
|
||
|
||
if $pretty {
|
||
$"($report.mean) +/- ($report.std)"
|
||
} else {
|
||
$report
|
||
}
|
||
}
|