2022-03-16 23:21:06 +01:00
|
|
|
[package]
|
|
|
|
|
authors = ["The Nushell Project Developers"]
|
|
|
|
|
description = "Nushell utility functions"
|
|
|
|
|
edition = "2021"
|
|
|
|
|
license = "MIT"
|
|
|
|
|
name = "nu-utils"
|
2023-01-24 21:28:59 +01:00
|
|
|
repository = "https://github.com/nushell/nushell/tree/main/crates/nu-utils"
|
2024-10-20 23:12:41 +02:00
|
|
|
version = "0.99.2"
|
2022-03-16 23:21:06 +01:00
|
|
|
|
|
|
|
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
|
|
|
[[bin]]
|
|
|
|
|
name = "utils"
|
|
|
|
|
path = "src/main.rs"
|
2023-02-12 23:22:00 +01:00
|
|
|
bench = false
|
|
|
|
|
|
|
|
|
|
[lib]
|
|
|
|
|
bench = false
|
2022-03-16 23:21:06 +01:00
|
|
|
|
|
|
|
|
[dependencies]
|
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 13:43:26 +01:00
|
|
|
fancy-regex = { workspace = true }
|
2024-03-24 00:46:02 +01:00
|
|
|
lscolors = { workspace = true, default-features = false, features = ["nu-ansi-term"] }
|
2024-03-07 23:40:31 +01:00
|
|
|
log = { workspace = true }
|
2024-03-24 00:46:02 +01:00
|
|
|
num-format = { workspace = true }
|
|
|
|
|
strip-ansi-escapes = { workspace = true }
|
2024-04-14 03:42:03 +02:00
|
|
|
serde = { workspace = true }
|
2023-05-26 17:32:48 +02:00
|
|
|
sys-locale = "0.3"
|
2024-10-30 03:51:06 +01:00
|
|
|
unicase = "2.8.0"
|
2022-03-16 23:21:06 +01:00
|
|
|
|
|
|
|
|
[target.'cfg(windows)'.dependencies]
|
2023-05-26 17:32:48 +02:00
|
|
|
crossterm_winapi = "0.9"
|
2024-04-06 15:56:46 +02:00
|
|
|
|
|
|
|
|
[target.'cfg(unix)'.dependencies]
|
2024-08-28 23:37:17 +02:00
|
|
|
nix = { workspace = true, default-features = false, features = ["user", "fs"] }
|
|
|
|
|
|
|
|
|
|
[lints]
|
2024-10-15 21:01:08 +02:00
|
|
|
workspace = true
|
