Issue with comment inside property chain

[fvictorio]

As reported by @wighawag:

This

game.
// CONFIG
config.resolveWindow = 1000;
config.defaultDelay = 0;

gets re-written as:

game.config.resolveWindow = 1000;
// CONFIG
config.defaultDelay = 0;

This seems like a PITA to fix, and I'm not even sure what the "correct" result should be.

[Janther]

I believe this should be formatted as

// CONFIG
game.config.resolveWindow = 1000;
config.defaultDelay = 0;

Will give this a look.

[fvictorio]

Agree, that's what prettier does for the same code in javascript.

[fvictorio]

@Janther what should we do about this issue? Is it still valid?

[Janther]

Prepending the comments to the beginning of the chain messes up the order of the comments since the chains are printed in reverse order..

game.
// CONFIG
config.
// Window
resolveWindow = 1000;
config.defaultDelay = 0;

// Window
// CONFIG
game.config.resolveWindow = 1000;
config.defaultDelay = 0;

We can force the chain to break if any member have comments but the comment will keep the indentation of the member it trails.

game.
// CONFIG
config.
// Window
resolveWindow = 1000;
config.defaultDelay = 0;

game.
// CONFIG
    config.
    // Window
    resolveWindow = 1000;
config.defaultDelay = 0;

Also consider that there can be more that one comment per member.

game.
// CONFIG
// Do not touch
config. // Window
// Resolution 1000
resolveWindow = 1000;
config.defaultDelay = 0;

game.
// CONFIG
// Do not touch
    config. // Window
    // Resolution 1000
    resolveWindow = 1000;
config.defaultDelay = 0;

It only looks weird if it's a comment in its own line. we can force it to be an end of line comment but will be weird with 2 consecutive comments. Personally I'm not inclined to do this.

game.
// CONFIG
// Do not touch
config. // Window
// Resolution 1000
resolveWindow = 1000;
config.defaultDelay = 0;

game. // CONFIG // Do not touch
    config. // Window // Resolution 1000
    resolveWindow = 1000;
config.defaultDelay = 0;

I haven't tested the behaviour yet, this is coming straight from my brain, prettier's comment allocation might be slightly different from these examples but this is an educated guess of how it would behave without tampering much with it.

[Janther]

having a look at this now, I can see we are already almost following the example I gave but the comment is displayed between the dot and the chain member 😅
Will need to see how to work this one as printing chains is one of our most complicated sections.

begin
    .// Comment 1
    functionCall(/* Comment about parameter */ parameter)
    .// Comment 2
    end;