Skip to content

📚 Clearly communicate missing features when migrating from Prettier #3126

@difosfor

Description

@difosfor

Documentation URL

https://biomejs.dev/

Description

The page and documentation currently claim nearly complete compatibility with Prettier, i.e. on the front page:

scores 97% compatibility with Prettier

Only when you click through on that can you read in the small print that embedded language support is outside of that scope. Also quite some languages are not supported when compared to Prettier.

Nowhere in the documentation can I find a clear list of missing features for people that are migrating:

There are numerous related issues and discussions, but the migration experience is currently basically confusing if not misleading:

Expectations

I suggest on the front page after the 97% compatibility with Prettier link you mention a brief list of unsupported feature names between parentheses. And you can link that to the Differences with Prettier page where you could detail those missing features and perhaps link to the related issues here on GitHub and/or how to contribute. And perhaps also document how to use Prettier alongside Biome as a fallback, i.e: to format file types not supported by Biome.

Code of Conduct

  • I agree to follow Biome's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions