Formatting breaks with specific types of in template strings strings

[JustLinuxUser]

Describe the bug

Formatting (parsing) breaks with some nested strings inside format strings.

Example:

> echo '$"("a:")"' | nufmt --stdin
$"(", a:")"

> echo '$"(http get "https://google.com")"' | nufmt --stdin
$"(http get ", https://google.com")"

When a similar sequence is present at any point in the script, none of it gets formatted

Environment

Please run show what operating system and version you're running and what version of nufmt you're running.

❯ $nu.os-info
❯ nufmt --version

╭────────────────┬───────────────╮
│ name           │ linux         │
│ arch           │ x86_64        │
│ family         │ unix          │
│ kernel_version │ 7.2.4-arch1-2 │
╰────────────────┴───────────────╯
nufmt 0.1.4

My Observations about the bug:

This appears to only happen when somewhere inside a template string, there is a string with a :, and something else preceding the colon. Doesn't happen when using nested 'single quote' string

[fdncred]

I'm not even sure '$"("a:")"' | nufmt --stdin is valid nushell syntax. nushell doesn't like double quotes inside of double quotes. I'm also not sure what the point of having a string interpolated string with nothing to interpolate.

My first advice would be to not use string interpolation with nothing to interpolate.

[JustLinuxUser]

I'm not even sure '$"("a:")"' | nufmt --stdin is valid nushell syntax. nushell doesn't like double quotes inside of double quotes. I'm also not sure what the point of having a string interpolated string with nothing to interpolate.

My first advice would be to not use string interpolation with nothing to interpolate.

This is just a small repro, the actuall use-case was valid, it was something like

# this, imo, valid code
let a = "hello "
let b = $"($a)(curl "https://jsonplaceholder.typicode.com/users" -q | from json | get 0.name)"
print $b

# gets formatted to this
let a = "hello "
let b = $"($a)(curl ", https://jsonplaceholder.typicode.com/users" -q | from json | get 0.name)"
print $b

And it works fine in nushell

[JustLinuxUser]

But for some reason if I change curl to http get, the formatter works fine, It's really weird... 🤔

[fdncred]

What happens if you do don't use double quotes inside of double quotes like this?

let b = $'($a)(curl "https://jsonplaceholder.typicode.com/users" -q | from json | get 0.name)'

or

let b = $"($a)(curl 'https://jsonplaceholder.typicode.com/users' -q | from json | get 0.name)"

both should probably work but, like i said, nushell doesn't typically like double quotes within double quotes.

[JustLinuxUser]

I am not trying to figure out a way to make my code work (although I appreciate the thought) , I have found a workaround by setting the thing to a variable first, I just wanted to make sure that this issue gets documented and that the maintainers (mostly you (thanks btw, I really like the project)) know about it :)

[fdncred]

Thanks. And what I'm saying is that if you don't use double quotes within double quotes nufmt works better.

❯ echo `let b = $'($a)(curl "https://jsonplaceholder.typicode.com/users" -q | from json | get 0.name)'` | nufmt --stdin
let b = $'($a)(curl "https://jsonplaceholder.typicode.com/users" -q | from json | get 0.name)'

[JustLinuxUser]

If you have some time to explain, why is that? I am a fan of parsing, and from what I understand about nushell syntax, there should be enough information to properly parse both cases

[fdncred]

I'm just speaking from experience. When I nest quotes I use backtick, single, double and try not to stack them. Nushell gets smarter with every PR but historically it hasn't been great at quoting. If it works in nushell, then that's great and it's improved in the last year.

[fdncred]

Having said all that, we'd accept a PR to make nufmt work better.

[JustLinuxUser]

in #221 I haven't dug down to the root cause of why detect_missing_record_comma_spans is broken. It's still a bug, still easy to trigger (by formatting some text that has a trivially fixable error somewhere else), and if I have some time, I will look into it later