cue fix tries to align comments inside braces with those outside, causing weird field indentation

[cueckoo]

Originally opened by @zellyn in cuelang/cue#1006

What version of CUE are you using (cue version)?

$ cue version
cue version 0.4.0 darwin/amd64

Does this issue reproduce with the latest release?

Yes

What did you do?

indent-bug-repro.cue:

x: {
	y: string

	// Comment
	z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment

cue fix indent-bug-repro.cue

What did you expect to see?

The same output as input

What did you see instead?

x: {
	y: string

							// Comment
							z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment

[myitcv]

Thanks for raising this @zellyn, and apologies for the radio silence as we completed our migration (#1078).

Confirmed with ecb17c9:

cp x.cue x.cue.golden
exec cue fmt x.cue
cmp x.cue x.cue.golden

-- x.cue --
x: {
	y: string

	// Comment
	z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment

[rudifa]

This script compares different test inputs

# issue #1006: run with `testscript -continue 1006.txtar
env CUEDO_FMT_DEBUGSTR=1

# x -----------------------------------
cp x.cue x.cue.golden
exec cue fmt x.cue
cmp x.cue x.cue.golden

# y -----------------------------------
cp y.cue y.cue.golden
exec cue fmt y.cue
cmp y.cue y.cue.golden

# z -----------------------------------
cp z.cue z.cue.golden
exec cue fmt z.cue
cmp z.cue z.cue.golden

-- x.cue --
x: {
	y: string

	// Comment 4
	z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment 5
-- y.cue --
x: {
	y: string

	z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment 5
-- z.cue --
x: {
	y: string
	z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment 5

The tidied up output is

# x -----------------------------------
x: {
        y: string

                                                        // Comment 4
                                                        z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment 5
# y -----------------------------------
x: {
        y: string

                                                       z: string
        z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment 5
# z -----------------------------------
x: {
                                                       y: string
                                                       z: string
} | "long_string_to_push_out_the_comment_on_this_line" // Comment 5

and the corresponding DebugStr are

file: x.cue decoded ast DebugStr:<[5// Comment 5] x: {y: string, <[d0// Comment 4] z: string>}|"long_string_to_push_out_the_comment_on_this_line">
file: y.cue decoded ast DebugStr:<[5// Comment 5] x: {y: string, z: string}|"long_string_to_push_out_the_comment_on_this_line">
file: z.cue decoded ast DebugStr:<[5// Comment 5] x: {y: string, z: string}|"long_string_to_push_out_the_comment_on_this_line">