Merge branch 'main' into release-notes-0.96.0

Author: IanManske

blog/2024-06-25-nushell_0_95_0.md

@@ -25,7 +25,6 @@ As part of this release, we also publish a set of optional plugins you can insta
   - [_Plugin version reporting_](#plugin-version-reporting-toc)
   - [_New `$nu.data-dir` and `$nu.cache-dir` constants_](#new-nudata-dir-and-nucache-dir-constants)
 - [_Changes to commands_](#changes-to-commands-toc)
-  - [_Additions_](#additions-toc)
   - [_Breaking changes_](#breaking-changes-toc)
     - [_`path type`_](#path-type-toc)
     - [_`to toml`_](#to-toml-toc)
@@ -111,7 +110,7 @@ If not using the Rust plugin API, you need to implement the new [`Metadata`](/co
 
 ## New `$nu.data-dir` and `$nu.cache-dir` Constants
 
-To standardize the locations for user-level items such as completions, the constant `$nu.data-dir` has been introduced. The default value of `NU_LIB_DIRS` will now be:
+To standardize the locations for user-level items such as completions, the constant `$nu.data-dir` has been introduced in [#13122](https://github.com/nushell/nushell/pull/13122). The default value of `NU_LIB_DIRS` will now be:
 
 ```nushell
 $env.NU_LIB_DIRS = [
@@ -122,25 +121,25 @@ $env.NU_LIB_DIRS = [
 
 ### Data Directory Locations
 
-The location of the data directory will vary based on the operating system:
+If the `$XDG_DATA_HOME` environment variable is present when nushell is launched, and it is a valid path, then the data directory will `$XDG_DATA_HOME/nushell`. Otherwise, the location of the data directory will vary based on the operating system:
 
-| Platform | Value                                                    | Example                                           |
-| -------- | -------------------------------------------------------- | ------------------------------------------------- |
-| Linux    | `$XDG_DATA_HOME/nushell` or `$HOME/.local/share/nushell` | `/home/alice/.local/share/nushell`                |
-| macOS    | `$HOME/Library/Application Support/nushell`              | `/home/alice/Library/Application Support/nushell` |
-| Windows  | `{FOLDERID_RoamingAppData}\nushell`                      | `C:\Users\Alice\AppData\Roaming\nushell`          |
+| Platform | Value                                       | Example                                           |
+| -------- | ------------------------------------------- | ------------------------------------------------- |
+| Linux    | `$HOME/.local/share/nushell`                | `/home/alice/.local/share/nushell`                |
+| macOS    | `$HOME/Library/Application Support/nushell` | `/home/alice/Library/Application Support/nushell` |
+| Windows  | `{FOLDERID_RoamingAppData}\nushell`         | `C:\Users\Alice\AppData\Roaming\nushell`          |
 
 ### Cache Directory Locations
 
-Additionally, the constant `$nu.cache-dir` has been added for future use. The location of the cache directory will vary based on the operating system:
+Additionally, the constant `$nu.cache-dir` has been added for future use. Like the data directory, if the `$XDG_CACHE_HOME` variable is present and valid, then the location of the cache directory will be `$XDG_CACHE_HOME/nushell`. Otherwise, the location of the cache directory will vary based on the operating system:
 
-| Platform | Value                                               | Example                                |
-| -------- | --------------------------------------------------- | -------------------------------------- |
-| Linux    | `$XDG_CACHE_HOME/nushell` or `$HOME/.cache/nushell` | `/home/alice/.cache/nushell`           |
-| macOS    | `$HOME/Library/Caches/nushell`                      | `/home/alice/Library/Caches/nushell`   |
-| Windows  | `{FOLDERID_LocalAppData}\nushell`                   | `C:\Users\Alice\AppData\Local\nushell` |
+| Platform | Value                             | Example                                |
+| -------- | --------------------------------- | -------------------------------------- |
+| Linux    | `$HOME/.cache/nushell`            | `/home/alice/.cache/nushell`           |
+| macOS    | `$HOME/Library/Caches/nushell`    | `/home/alice/Library/Caches/nushell`   |
+| Windows  | `{FOLDERID_LocalAppData}\nushell` | `C:\Users\Alice\AppData\Local\nushell` |
 
-New constants for system-level items such as $nu.vendor-autoload-dir will be introduced in future releases.
+New constants for system-level items such as `$nu.vendor-autoload-dir` will be introduced in future releases.
 
 # Changes to commands [[toc](#table-of-content)]
 
@@ -187,8 +186,6 @@ New constants for system-level items such as $nu.vendor-autoload-dir will be int
 | [@IanManske](https://github.com/IanManske)         | Disallow more characters in arguments for internal `cmd` commands                                  | [#13009](https://github.com/nushell/nushell/pull/13009) |
 | [@WindSoilder](https://github.com/WindSoilder)     | fix do closure with both required, options, and rest args                                          | [#13002](https://github.com/nushell/nushell/pull/13002) |
 
-## Additions [[toc](#table-of-content)]
-
 ## Breaking changes [[toc](#table-of-content)]
 
 ### `path type` [[toc](#table-of-content)]
@@ -300,8 +297,7 @@ Thanks to [@abusch](https://github.com/abusch) in [#13045](https://github.com/nu
 
 ### `into filesize` [[toc](#table-of-content)]
 
-- Thanks to [@hqsz](https://github.com/hqsz) in [#12974](https://github.com/nushell/nushell/pull/12974), `into filesize` can now parse (more) strings that start with a plus sign.
-- Thanks to [@hqsz](https://github.com/hqsz) in [#13110](https://github.com/nushell/nushell/pull/13110), a bug due to integer casting was fixed for `into filesize`.
+Thanks to [@hqsz](https://github.com/hqsz) in [#12974](https://github.com/nushell/nushell/pull/12974), `into filesize` can now parse (more) strings that start with a plus sign. In [#13110](https://github.com/nushell/nushell/pull/13110), they also fixed a bug caused by integer casting.
 
 ### `sys users` [[toc](#table-of-content)]
 

book/cheat_sheet.md

@@ -455,7 +455,7 @@ use question mark operator `?` to return null instead of error if provided path
 > $files.name?.0?
 ```
 
-assig the result of a pipeline to a variable:
+assign the result of a pipeline to a variable:
 
 ```nu
 > let big_files = (ls | where size > 10kb)

book/configuration.md

@@ -173,11 +173,14 @@ Note the `split row (char esep)` step. We need to add it because in `env.nu`, th
 To add multiple paths only if not already listed, one can add to `env.nu`:
 
 ```nu
-$env.PATH = $env.PATH | split row (char esep)
+$env.PATH = (
+  $env.PATH
+  | split row (char esep)
   | append /usr/local/bin
   | append ($env.CARGO_HOME | path join bin)
   | append ($env.HOME | path join .local bin)
   | uniq # filter so the paths are unique
+) 
 ```
 
 This will add `/usr/local/bin`, the `bin` directory of CARGO_HOME, the `.local/bin` of HOME to PATH. It will also remove duplicates from PATH.

book/dataframes.md

@@ -1,10 +1,8 @@
 # Dataframes
 
 ::: warning
-Starting with version 0.93, there is a more recent implementation of dataframes in `nu_plugin_polars`, which includes a newer version of `polars` and many bug fixes.
-From version 0.94 of Nushell, internal dataframes (with the `dfr` prefix) are going to be deprecated in favor of `nu_plugin_polars`.
 
-To use `nu_plugin_polars`, you'll need to install [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) and then install the plugin with commands:
+To use dataframes you'll need to install [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) and then install `nu_plugin_polars` with commands:
 
 ```nu no-run
 # Install the `polars` nushell plugin
@@ -118,6 +116,9 @@ bench -n 10 --pretty {
     }
 }
 ```
+
+Output
+
 ```
 3sec 268ms +/- 50ms
 ```
@@ -142,6 +143,9 @@ bench -n 10 --pretty {
     python load.py | null
 }
 ```
+
+Output
+
 ```
 1sec 322ms +/- 6ms
 ```
@@ -169,6 +173,9 @@ bench -n 10 --pretty {
     nu load.nu | complete | null
 }
 ```
+
+Output
+
 ```
 135ms +/- 4ms
 ```
@@ -436,6 +443,9 @@ $group
     (polars col float_2 | polars count)
 ] | polars sort-by first
 ```
+
+Output
+
 ```
 ╭────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────╮
 │ plan           │ SORT BY [col("first")]                                                                              │
@@ -904,6 +914,9 @@ in column `word`
 ```nu
 $df_1 | polars filter-with ($in.word | polars is-unique)
 ```
+
+Output
+
 ```
 ╭───┬───────┬───────┬─────────┬─────────┬───────┬────────┬───────┬───────╮
 │ # │ int_1 │ int_2 │ float_1 │ float_2 │ first │ second │ third │ word  │
@@ -918,6 +931,9 @@ Or all the duplicated ones
 ```nu
 $df_1 | polars filter-with ($in.word | polars is-duplicated)
 ```
+
+Output
+
 ```
 ╭───┬───────┬───────┬─────────┬─────────┬───────┬────────┬───────┬────────╮
 │ # │ int_1 │ int_2 │ float_1 │ float_2 │ first │ second │ third │  word  │
@@ -994,6 +1010,9 @@ $lf_0
 ]
 | polars collect
 ```
+
+Output
+
 ```
 ╭───┬───┬───┬──────────┬────────╮
 │ # │ a │ b │ double_a │ half_a │
@@ -1065,6 +1084,9 @@ $lf_1
 ]
 | polars collect
 ```
+
+Output
+
 ```
 ╭───┬──────┬─────┬──────╮
 │ # │ name │ sum │ mean │
@@ -1088,6 +1110,9 @@ let group = $lf_2
 
 $lf_2 | polars join $group name name | polars collect
 ```
+
+Output
+
 ```
 ╭───┬──────┬───────┬─────┬──────╮
 │ # │ name │ value │ sum │ mean │
@@ -1243,4 +1268,3 @@ mature.
 
 Keep visiting this book in order to check the new things happening to
 dataframes and how they can help you process data faster and efficiently.
-

book/how_nushell_code_gets_run.md

@@ -140,7 +140,7 @@ _Before going into examples, one note about the "dynamic" and "static" terminolo
 
 By insisting on strict parse-evaluation separation, we lose much of a flexibility users expect from dynamic interpreted languages, especially other shells, such as bash, fish, zsh and others. This leads to the examples at the beginning of this page not working. Let's break them down one by one
 
-_Note: The following examples use [`source`](/commands/docs/source.md), but similar conclusions apply to other commands that parse Nushell source code, such as [`use`](/commands/docs/use.md), [`overlay use`](/commands/docs/overlay_use.md), [`hide`](/commands/docs/hide.md), [`register`](/commands/docs/register.md) or [`source-env`](/commands/docs/source-env.md)._
+_Note: The following examples use [`source`](/commands/docs/source.md), but similar conclusions apply to other commands that parse Nushell source code, such as [`use`](/commands/docs/use.md), [`overlay use`](/commands/docs/overlay_use.md), [`hide`](/commands/docs/hide.md) or [`source-env`](/commands/docs/source-env.md)._
 
 ### 1. Sourcing a dynamic path
 

book/installation.md

@@ -82,10 +82,6 @@ Nu releases are published as source to the popular Rust package registry [crates
 
 That's it! The `cargo` tool will do the work of downloading Nu and its source dependencies, building it, and installing it into the cargo bin path.
 
-If you want to install with support for [dataframes](dataframes.md), you can install using the `--features=dataframe` flag.
-
-@[code](@snippets/installation/cargo_install_nu_more_features.sh)
-
 ### Building from the GitHub repository
 
 You can also build Nu from the latest source on GitHub. This gives you immediate access to the latest features and bug fixes. First, clone the repo:

book/operators.md

@@ -112,10 +112,10 @@ Operators are usually case-sensitive when operating on strings. There are a few
 "FOO" =~ "(?i)foo" # returns true
 ```
 
-2. Use the [`str contains`](/commands/docs/str_contains.md) command's `--insensitive` flag:
+2. Use the [`str contains`](/commands/docs/str_contains.md) command's `--ignore-case` flag:
 
 ```nu
-"FOO" | str contains --insensitive "foo"
+"FOO" | str contains --ignore-case "foo"
 ```
 
 3. Convert strings to lowercase with [`str downcase`](/commands/docs/str_downcase.md) before comparing:

commands/docs/alias.md

@@ -2,12 +2,11 @@
 title: alias
 categories: |
   core
-version: 0.94.0
+version: 0.95.0
 core: |
   Alias a command (with optional flags) to a new name.
 usage: |
   Alias a command (with optional flags) to a new name.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/all.md

@@ -2,12 +2,11 @@
 title: all
 categories: |
   filters
-version: 0.94.0
+version: 0.95.0
 filters: |
   Test if every element of the input fulfills a predicate expression.
 usage: |
   Test if every element of the input fulfills a predicate expression.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/ansi.md

@@ -2,12 +2,11 @@
 title: ansi
 categories: |
   platform
-version: 0.94.0
+version: 0.95.0
 platform: |
   Output ANSI codes to change color and style of text.
 usage: |
   Output ANSI codes to change color and style of text.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/ansi_gradient.md

@@ -2,12 +2,11 @@
 title: ansi gradient
 categories: |
   platform
-version: 0.94.0
+version: 0.95.0
 platform: |
   Add a color gradient (using ANSI color codes) to the given string.
 usage: |
   Add a color gradient (using ANSI color codes) to the given string.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/ansi_link.md

@@ -2,12 +2,11 @@
 title: ansi link
 categories: |
   platform
-version: 0.94.0
+version: 0.95.0
 platform: |
   Add a link (using OSC 8 escape sequence) to the given string.
 usage: |
   Add a link (using OSC 8 escape sequence) to the given string.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/ansi_strip.md

@@ -2,12 +2,11 @@
 title: ansi strip
 categories: |
   platform
-version: 0.94.0
+version: 0.95.0
 platform: |
   Strip ANSI escape sequences from a string.
 usage: |
   Strip ANSI escape sequences from a string.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/any.md

@@ -2,12 +2,11 @@
 title: any
 categories: |
   filters
-version: 0.94.0
+version: 0.95.0
 filters: |
   Tests if any element of the input fulfills a predicate expression.
 usage: |
   Tests if any element of the input fulfills a predicate expression.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/append.md

@@ -2,12 +2,11 @@
 title: append
 categories: |
   filters
-version: 0.94.0
+version: 0.95.0
 filters: |
   Append any number of rows to a table.
 usage: |
   Append any number of rows to a table.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/ast.md

@@ -2,12 +2,11 @@
 title: ast
 categories: |
   debug
-version: 0.94.0
+version: 0.95.0
 debug: |
   Print the abstract syntax tree (ast) for a pipeline.
 usage: |
   Print the abstract syntax tree (ast) for a pipeline.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/bits.md

@@ -2,12 +2,11 @@
 title: bits
 categories: |
   bits
-version: 0.94.0
+version: 0.95.0
 bits: |
   Various commands for working with bits.
 usage: |
   Various commands for working with bits.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
 

commands/docs/bits_and.md

@@ -2,12 +2,11 @@
 title: bits and
 categories: |
   bits
-version: 0.94.0
+version: 0.95.0
 bits: |
   Performs bitwise and for ints or binary values.
 usage: |
   Performs bitwise and for ints or binary values.
-feature: default
 ---
 <!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->