🐛 Biome corrupts formatting with formatOnType enabled and attempting to close parens or brackets

[mkahvi]

VS Code version

1.108.0

Extension version

3.3.0

Biome version

2.3.10

Operating system

• Windows
• macOS
• Linux

Description

Biome mildly corrupts formatting with formatOnType enabled when closing parens or brackets by adding extra padding before the opening paren/bracket and sometimes removes newlines.

For example

console.log(

Becomes

console.log      ()

or

  {
    { // <- closing this
  }

Becomes

    {      {
      }
    }

(), [] and {} all suffer from this. Happens in JS and JSON.

In some circumstances this doesn't happen, for example the above console.log() example doesn't happen if you type it inside unclosed curly brackets.

As a side note there doesn't seem to be a way to disable format-on-type specifically for Biome and I'd rather not disable that for everything that isn't formatted by biome also.

Steps to reproduce

1. Ensure editor.formatOnType is enabled
2. Close any paren or bracket in code

Expected behavior

Bracket is closed, not much else.

Does this issue occur when using the CLI directly?

Not sure / Not applicable

Link to a minimal reproduction

No response

Logs

[Nerivec]

Same kind of corruption occurs with formatOnPaste: true when pasting inside an if block or parens or after an if block (particularly when nested), and you have a comment before the if.
Observed results:

• the comment is moved inside the if block
  • code remains valid, but comment may no longer be in right place
  • happens even if comment was at end of previous code line and there was an empty line before the if => now really in wrong place
• the if line is removed entirely (the comment stays)
  • broken code

Note: after this happens, undo + save will apply correct formatting, so this is specific to the paste.
Note: this behavior is applicable to any Biome 2 version as far as I can tell.

[aubergineagain]

Similar issues:

• 🐛 Sometimes the extension kind of lags and formats files wrongly, corrupting them #923
• 🐛 Biome as auto-formatter in vscode, remoting from windows to macOS, mangles files #857
• 🐛 import organization messes up the file #695

Possibly similar:

• Auto fix with Astro deletes source code when formatting #894

[burakcan]

I'm having this issue both with the extension and with biome cli. Also in tsx files, it sometimes duplicates last couple of lines for no reason and breaks the syntax.
In normal ts files, a couple of times it removed the last function's body in files completely.

[github-actions]

Hello @mkahvi, please provide a minimal reproduction. You can use one of the following options:

• Provide a link to our playground, if it's applicable.
• Provide a link to a GitHub repository. To easily create a reproduction, you can use our interactive CLI via npm create @biomejs/biome-reproduction

Issues marked with Needs reproduction will be closed if they have no activity within 3 days.

[dyc3]

I think we need some more precise reproductions in order to diagnose this. My hunch is that multiple issues are manifesting as something that looks like the same thing.

@Nerivec please provide code samples, and be specific about where the cursor is when you paste
@burakcan if you encounter this in the cli, this should be really easy to reproduce with a minimal repo

[Nerivec]

Simplest case, 100% reproducible in latest vscode:

function doSomething() {}

export function myMain(a: number) {
    // this is a comment
    if (a === 1 /* paste anything inside parens, even inside this very comment, and the line disappears */) {
        doSomething();
    }
}

Result:

function doSomething() {}

export function myMain(a: number) {
    // this is a comment
        doSomething();
    }
}

This is triggered by "editor.formatOnPaste": true with "editor.defaultFormatter": "biomejs.biome" in vscode (hence, I don't think this can be reproduced in the playground).

[mkahvi]

I don't think the playground works for providing an example since it seems to use formatOnSave behaviour which is not the one failing. Otherwise you should be able to paste my examples there and follow the repro I provided.

[dyc3]

Thank you @Nerivec I can reproduce the issue with those instructions.