Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(website): add Formatter Option Philosophy page #1022

Merged
merged 3 commits into from
Dec 5, 2023

Conversation

faultyserver
Copy link
Contributor

Summary

As Biome grows in popularity, and particularly as people look at potentially migrating from Prettier now that we've won the challenge and promote that compatibility, we're going to get a lot of the same requests for adding options to the formatter.

Even before the challenge, Biome intended to be a strongly-opinionated formatter, much like Prettier, and had the chance to start fresh with a blank set of options and no historical baggage. After the challenge, we've had to implement all of the options that Prettier already has, but we don't want to keep adding more. This page on the website acts as something we can point to when requests come up, explaining that the ideal world for Biome is no options, and the existing ones only exist for compatibility.

It also leaves the door open for radical advancements in the future and even changes to the core style of Biome itself, should they ever come up, but makes it clear that requests for new options most likely will not be considered.

Test Plan

Just opened the page on the site locally and it worked as expected.

Copy link

netlify bot commented Dec 2, 2023

Deploy Preview for rad-torte-839a59 ready!

Name Link
🔨 Latest commit 7ef2780
🔍 Latest deploy log https://app.netlify.com/sites/rad-torte-839a59/deploys/656e1cce03ca7c000805785a
😎 Deploy Preview https://deploy-preview-1022--rad-torte-839a59.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the A-Website Area: website label Dec 2, 2023
Copy link
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few suggestions, let me know what you think. Happy to merge it when you're happy!

website/src/content/docs/formatter/option-philosophy.md Outdated Show resolved Hide resolved
website/src/content/docs/formatter/option-philosophy.md Outdated Show resolved Hide resolved
website/src/content/docs/formatter/option-philosophy.md Outdated Show resolved Hide resolved
@faultyserver
Copy link
Contributor Author

faultyserver commented Dec 4, 2023

All great improvements, thanks for the review :) I think it's good to go now.

@Conaclos Conaclos changed the title docs(website): Add Formatter Option Philosophy page docs(website): add Formatter Option Philosophy page Dec 4, 2023
@ematipico ematipico merged commit 8638de0 into main Dec 5, 2023
10 checks passed
@ematipico ematipico deleted the faulty/option-philosophy branch December 5, 2023 02:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Website Area: website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants