mirror of
https://github.com/nushell/nushell.git
synced 2025-05-07 00:12:58 +00:00
758351c732
Should close #7255. # Description **TL;DR**: this PR adds `--indent <int>`, `--tabs <int>` and `--raw` to control a bit more the `string` output of `to nuon`, as done in `to json` already, the goal being to promote the `NUON` format through easy to read and formatted output `.nuon` files 😋 ### outside of `crates/nu-command/src/formats/to/nuon.rs` as the signature of `value_to_string` has changed, the single call to it outside of its module definition has been changed to use default values => `value_to_string(&value, Span::unknown(), 0, &None)` in `crates/nu-command/src/filters/uniq.rs` ### changes to `ToNuon` in `crates/nu-command/src/formats/to/nuon.rs` - the signature now features `--raw`, `--indent <int>` and `--tabs <int>` - the structure of the `run` method is inspired from the one in `to json` - we get the values of the arguments - we convert the input to a usable `Value` - depending on whether the user raised `--raw`, `--indent` or `--tabs`, we call the conversion to `string` with different values of the indentation, starting at depth 0 - finally, we return `Ok` or a `ShellError::CantConvert` depending on the conversion result - some tool functions - `get_true_indentation` gives the full indentation => `indent` repeated `depth` times - `get_true_separators` gives the line and field separators => a `("\n", "")` when using some formatting or `("", " ")` when converting as pure string on a single line the meat of `nuon.rs` is now the `value_to_string` recursive function: - takes the depth and the indent string - adds correct newlines, space separators and indentation to the output - calls itself with the same indent string but `depth + 1` to increase the indentation by one level - i used the `nl`, `idt`, `idt_po` (**i**n**d**en**t** **p**lus **o**ne) and `idt_pt` (**i**n**d**en**t** **p**lus **t**wo) to make the `format!`s easier to read # User-Facing Changes users can now - control the amount and nature of NUON string output indentation with - `--indent <number of " " per level>` - `--tabs <number of "\t" per level>` - use the previous behaviour of `to nuon` with the `--raw` option - have new examples with `help to nuon` > **Note** > the priority order of the options is the following > 1. `--raw` > 2. `--tabs` > 3. `--indent` > > the default is `--indent 2` # Tests + Formatting ### new tests - tests involving the string output of `to nuon`, i.e. tests not of the form `... | to nuon | from nuon ...`, now use the `to nuon --raw` command => this is the smallest change to have the tests pass, as the new `to nuon --raw` is equivalent to the old `to nuon` - in `crates/nu-command/src/formats/to/nuon.rs`, the previous example has been replaced with three examples - `[1 2 3] | to nuon` to show the default behaviour - `[1 2 3] | to nuon --raw` to show the not-formatted output - a more complex example with `{date: 2000-01-01, data: [1 [2 3] 4.56]} | to nuon` - the result values have been defined and the `examples` tests pass ### dev - 🟢 `cargo fmt --all` - 🟢 `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` - 🟢 `cargo test --workspace` ~~passes but without `to_nuon_errs_on_closure`~~ fixed in 0b4fad7effd5a3adf0ccf2aa694d7a77653f1b55 # After Submitting the `to nuon` page would have to be regenerated at some point due to the new tests