Skip to content

feat(biome): new package for a shared config#1004

Merged
erunion merged 11 commits intomainfrom
feat/biome-config
Jul 15, 2025
Merged

feat(biome): new package for a shared config#1004
erunion merged 11 commits intomainfrom
feat/biome-config

Conversation

@erunion
Copy link
Copy Markdown
Member

@erunion erunion commented Jul 14, 2025

🧰 Changes

Since we're very slowly beginning to adopt Biome within our org we should have a common configuration.

@erunion erunion requested a review from kanadgupta July 14, 2025 22:07
@erunion erunion added the enhancement New feature or request label Jul 14, 2025
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I extrapolated the bulk of this from the config I ended up with over in Gitto.

{
"$schema": "https://biomejs.dev/schemas/2.1.1/schema.json",
"formatter": {
"enabled": false,
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Leaving this off by default since we still want to use Prettier in most places.

Copy link
Copy Markdown
Contributor

@kanadgupta kanadgupta left a comment

Choose a reason for hiding this comment

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

i only just thought of this so apologies for suggesting this well after you implemented this but... what if we did the following:

  • created a package called @readme/standards
  • exposed an exports entry called biome (i.e., @readme/standards/biome) that pointed to our biome config (per these docs)
  • exposed a prettier entry (i.e., @readme/standards/prettier) with our prettier config

the reason being i can't see us ditching prettier anytime soon1 and that way we can drop @readme/eslint-config while still having access to our prettier config

Footnotes

  1. i'd take this with a grain of salt but some not-so-flattering chatter about biome popped up on my feed this weekend

Comment thread packages/biome-config/README.md Outdated
Comment thread packages/biome-config/biome.jsonc Outdated
@erunion erunion changed the title feat(biome): new package for a shared Biome config feat(biome): new package for a shared config Jul 14, 2025
"lint": "biome check",
"lint:fix": "biome check --write ."
},
"optionalDependencies": {
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Moved Biome and Prettier from peer deps to optional so they are only installed when needed.

@erunion erunion requested a review from kanadgupta July 14, 2025 23:26
Copy link
Copy Markdown
Contributor

@kanadgupta kanadgupta left a comment

Choose a reason for hiding this comment

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

a few issues below but otherwise LGTM!

Comment thread packages/standards/package.json Outdated
Comment thread packages/standards/README.md Outdated
Comment thread packages/standards/README.md Outdated
Comment thread packages/standards/README.md Outdated
erunion and others added 4 commits July 14, 2025 17:15
Co-authored-by: Kanad Gupta <[email protected]>
Co-authored-by: Kanad Gupta <[email protected]>
Co-authored-by: Kanad Gupta <[email protected]>
Co-authored-by: Kanad Gupta <[email protected]>
@erunion erunion merged commit e892d85 into main Jul 15, 2025
3 checks passed
@erunion erunion deleted the feat/biome-config branch July 15, 2025 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants