📝 Formatter formats package.json in Prettier- & Yarn-incompatible way

[wojtekmaj]

📝 Formatter formats package.json in Prettier- & Yarn-incompatible way

[wojtekmaj]

It looks like a good temporary workaround is

  "overrides": [
    {
      "include": ["**/package.json"],
      "formatter": {
        "lineWidth": 1
      }
    }
  ]

thanks for pointing me in the right direction!

[ematipico]

@wojtekmaj Unfortunately, the playground isn't sufficient for reproduction. Can you please give us more information about the issue and how can we reproduce it, maybe with a repository?

[wojtekmaj]

Sorry, there was no place for that in the template, I'm working on an actual issue description.

[wojtekmaj]

Sorry, the issue I'm seeing has a different cause than I initially presumed. I thought I'm seeing the opposite errors on macOS and Linux, but that's not the case. Here's full explanation.

I migrated from Prettier to Biome for formatting. Immediately, I was met with the following error:

./package.json format ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Formatter would have printed the following content:
  
     4  4 │       "access": "public"
     5  5 │     },
     6    │ - ··"files":·[
     7    │ - ····"dist",
     8    │ - ····"src"
     9    │ - ··],
        6 │ + ··"files":·["dist",·"src"],
    10  7 │     "repository": {
    11  8 │       "type": "git",
  

Checked 32 files in 11ms. No fixes needed.
Found 1 error.
format ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Some errors were emitted while running checks.

Of course, running biome format . --write fixed the issue.

However, other tools in my toolchain attempt to format JSON in a Prettier-compatible way. Notably, running Yarn (4.1.1), reformats the package.json back so that files is split into multiple lines.

Since CI is basically yarn install + biome format, this causes the latter to fail.

I would still consider it a formatting bug in Biome. Here's why I believe so:

• Quoting documentation, "The formatting style of Biome is also considered relatively stable, continuing to match Prettier as much as possible". This is a difference between the two, and one not listed on Differences with Prettier page.
• These particular arrays found in package.json (workspaces, files) are FAR more readable when split into multiple lines.
• While technically correct, this discrepancy causes incompatibilities with other tools as described above.

[ematipico]

That's expected. Prettier formats package.json files using JSON.stringify(content, null, 2), which package managers usually do.

Biome, instead, uses the classic heuristic, that's why you see all these changes. I am considering creating an option for making the formatting similar to Prettie, however it will take a bit to create it.

For the time being, you can use overrides to ignore package.json files from being formatted with Biome.