Fix quoting in to nuon and refactor quoting functions (#14180)

# Description  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  `to nuon` now properly escapes quotes in column names. # Tests + Formatting  All tests pass, including workspace and stdlib tests. # After Submitting
2025-08-11 01:33:47 +02:00 · 2024-10-29 13:43:26 +01:00
parent 3ec76af96e
commit 79ea70d4ec
12 changed files with 76 additions and 86 deletions
--- a/crates/nuon/src/to.rs
+++ b/crates/nuon/src/to.rs
@ -1,10 +1,8 @@
 use core::fmt::Write;
-use fancy_regex::Regex;
-use once_cell::sync::Lazy;

 use nu_engine::get_columns;
-use nu_parser::escape_quote_string;
 use nu_protocol::{Range, ShellError, Span, Value};
+use nu_utils::{escape_quote_string, needs_quoting};

 use std::ops::Bound;

@ -129,11 +127,12 @@ fn value_to_string(
                let headers: Vec<String> = headers
                    .iter()
                    .map(|string| {
-                        if needs_quotes(string) {
-                            format!("{idt}\"{string}\"")
+                        let string = if needs_quoting(string) {
+                            &escape_quote_string(string)
                        } else {
-                            format!("{idt}{string}")
-                        }
+                            string
+                        };
+                        format!("{idt}{string}")
                    })
                    .collect();
                let headers_output = headers.join(&format!(",{sep}{nl}{idt_pt}"));
@ -199,19 +198,15 @@ fn value_to_string(
        Value::Record { val, .. } => {
            let mut collection = vec![];
            for (col, val) in &**val {
-                collection.push(if needs_quotes(col) {
-                    format!(
-                        "{idt_po}\"{}\": {}",
-                        col,
-                        value_to_string_without_quotes(val, span, depth + 1, indent)?
-                    )
+                let col = if needs_quoting(col) {
+                    &escape_quote_string(col)
                } else {
-                    format!(
-                        "{idt_po}{}: {}",
-                        col,
-                        value_to_string_without_quotes(val, span, depth + 1, indent)?
-                    )
-                });
+                    col
+                };
+                collection.push(format!(
+                    "{idt_po}{col}: {}",
+                    value_to_string_without_quotes(val, span, depth + 1, indent)?
+                ));
            }
            Ok(format!(
                "{{{nl}{}{nl}{idt}}}",
@ -247,7 +242,7 @@ fn value_to_string_without_quotes(
 ) -> Result<String, ShellError> {
    match v {
        Value::String { val, .. } => Ok({
-            if needs_quotes(val) {
+            if needs_quoting(val) {
                escape_quote_string(val)
            } else {
                val.clone()
@ -256,30 +251,3 @@ fn value_to_string_without_quotes(
        _ => value_to_string(v, span, depth, indent),
    }
 }
-
-// This hits, in order:
-// • Any character of []:`{}#'";()|$,
-// • Any digit (\d)
-// • Any whitespace (\s)
-// • Case-insensitive sign-insensitive float "keywords" inf, infinity and nan.
-static NEEDS_QUOTES_REGEX: Lazy<Regex> = Lazy::new(|| {
-    Regex::new(r#"[\[\]:`\{\}#'";\(\)\|\$,\d\s]|(?i)^[+\-]?(inf(inity)?|nan)$"#)
-        .expect("internal error: NEEDS_QUOTES_REGEX didn't compile")
-});
-
-fn needs_quotes(string: &str) -> bool {
-    if string.is_empty() {
-        return true;
-    }
-    // These are case-sensitive keywords
-    match string {
-        // `true`/`false`/`null` are active keywords in JSON and NUON
-        // `&&` is denied by the nu parser for diagnostics reasons
-        // (https://github.com/nushell/nushell/pull/7241)
-        // TODO: remove the extra check in the nuon codepath
-        "true" | "false" | "null" | "&&" => return true,
-        _ => (),
-    };
-    // All other cases are handled here
-    NEEDS_QUOTES_REGEX.is_match(string).unwrap_or(false)
-}