nushell/crates
Alex Ionescu 79ea70d4ec
Fix quoting in to nuon and refactor quoting functions (#14180)
<!--
if this PR closes one or more issues, you can automatically link the PR
with
them by using one of the [*linking
keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword),
e.g.
- this PR should close #xxxx
- fixes #xxxx

you can also mention related issues, PRs or discussions!
-->

# Description
<!--
Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.

Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.
-->

This PR fixes the quoting and escaping of column names in `to nuon`.
Before the PR, column names with quotes inside them would get quoted,
but not escaped:

```nushell
> { 'a"b': 2 } | to nuon
{ "a"b": 2 }

> { 'a"b': 2 } | to nuon | from nuon
Error:   × error when loading nuon text
   ╭─[entry #1:1:27]
 1 │ { "a\"b": 2 } | to nuon | from nuon
   ·                           ────┬────
   ·                               ╰── could not load nuon text
   ╰────

Error:   × error when parsing nuon text
   ╭─[entry #1:1:27]
 1 │ { "a\"b": 2 } | to nuon | from nuon
   ·                           ────┬────
   ·                               ╰── could not parse nuon text
   ╰────

Error:   × error when parsing
   ╭────
 1 │ {"a"b": 2}
   ·          ┬
   ·          ╰── Unexpected end of code.
   ╰────

> [['a"b']; [2] [3]] | to nuon
[["a"b"]; [2], [3]]

> [['a"b']; [2] [3]] | to nuon | from nuon
Error:   × error when loading nuon text
   ╭─[entry #1:1:32]
 1 │ [['a"b']; [2] [3]] | to nuon | from nuon
   ·                                ────┬────
   ·                                    ╰── could not load nuon text
   ╰────

Error:   × error when parsing nuon text
   ╭─[entry #1:1:32]
 1 │ [['a"b']; [2] [3]] | to nuon | from nuon
   ·                                ────┬────
   ·                                    ╰── could not parse nuon text
   ╰────

Error:   × error when parsing
   ╭────
 1 │ [["a"b"]; [2], [3]]
   ·                   ┬
   ·                   ╰── Unexpected end of code.
   ╰────
```

After this PR, the quote is escaped properly:

```nushell
> { 'a"b': 2 } | to nuon
{ "a\"b": 2 }

> { 'a"b': 2 } | to nuon | from nuon
╭─────┬───╮
│ a"b │ 2 │
╰─────┴───╯

> [['a"b']; [2] [3]] | to nuon
[["a\"b"]; [2], [3]]

> [['a"b']; [2] [3]] | to nuon | from nuon
╭─────╮
│ a"b │
├─────┤
│   2 │
│   3 │
╰─────╯
```

The cause of the issue was that `to nuon` simply wrapped column names in
`'"'` instead of calling `escape_quote_string`.

As part of this change, I also moved the functions related to quoting
(`needs_quoting` and `escape_quote_string`) into `nu-utils`, since
previously they were defined in very ad-hoc places (and, in the case of
`escape_quote_string`, it was defined multiple times with the same
body!).

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

`to nuon` now properly escapes quotes in column names.

# 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
> ```
-->

All tests pass, including workspace and stdlib tests.

# 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.
-->
2024-10-29 07:43:26 -05:00
..
nu_plugin_custom_values Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu_plugin_example Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu_plugin_formats Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu_plugin_gstat Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu_plugin_inc Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu_plugin_nu_example Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu_plugin_polars Upgrade to polars 0.43 (#14148) 2024-10-23 19:14:24 +02:00
nu_plugin_python Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu_plugin_query Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu_plugin_stress_internals Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-cli Fix quoting in to nuon and refactor quoting functions (#14180) 2024-10-29 07:43:26 -05:00
nu-cmd-base Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-cmd-extra Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-cmd-lang add rendered and json error messages in try/catch (#14082) 2024-10-20 23:14:11 +02:00
nu-cmd-plugin Make plugin list read state from plugin registry file as well (#14085) 2024-10-20 23:12:57 +02:00
nu-color-config Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-command ansi name for clear-scrollback code (#14184) 2024-10-29 07:01:32 -05:00
nu-derive-value Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-engine add command_type to help (#14165) 2024-10-24 19:06:49 +02:00
nu-explore Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-glob Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-json Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-lsp Fix LSP non-ascii characters offset issues. (#14002) 2024-10-29 06:35:37 -05:00
nu-parser Fix quoting in to nuon and refactor quoting functions (#14180) 2024-10-29 07:43:26 -05:00
nu-path Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-plugin Update to rust 1.80.1 (#14106) 2024-10-20 23:14:11 +02:00
nu-plugin-core Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-plugin-engine Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-plugin-protocol Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-plugin-test-support Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-pretty-hex Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-protocol add command_type to help (#14165) 2024-10-24 19:06:49 +02:00
nu-std add like and not-like operators as synonyms for the regex operators =~ and !~ (#14072) 2024-10-20 23:12:57 +02:00
nu-system add start_time to ps -l on macos (#14127) 2024-10-21 11:55:30 -05:00
nu-table Introduce footer_inheritance option (#14070) 2024-10-23 19:45:47 +02:00
nu-term-grid Bump to 0.99.2 (#14136) 2024-10-20 23:12:41 +02:00
nu-test-support Fix quoting in to nuon and refactor quoting functions (#14180) 2024-10-29 07:43:26 -05:00
nu-utils Fix quoting in to nuon and refactor quoting functions (#14180) 2024-10-29 07:43:26 -05:00
nuon Fix quoting in to nuon and refactor quoting functions (#14180) 2024-10-29 07:43:26 -05:00
README.md

Nushell core libraries and plugins

These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.

Foundational libraries are split into two kinds of crates:

  • Core crates - those crates that work together to build the Nushell language engine
  • Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.

Plugins are likewise also split into two types:

  • Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
  • Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.