Linting & Formatting - Switch to Biome
Description
Prettier has served us really well for clean and consistent formatting of code; Biome may be a powerful improvement for us!
Use Case
Our code is formatted exactly the same, without contributors needing to consciously follow a standard. We can attach this to any pre-commits we add in the future too.
Proposed Solution
- Replace prettier installation and configs with biome, closely matching our prettier configuration for formatting.
- Update
CONTRIBUTING.mdwith recommendation to install https://biomejs.dev/reference/vscode/ for developers using vscode (or a vscode flavour editor).
Additional Thoughts
- When pre-commits are added, have Biome formatting run on the codebase automatically
@mrspence - let me know if you think we should still do this!
@will-lamerton definitely, can see there's some interest too 👍
Have paused to appreciate how this might impact existing contributors with prettier configs on their editors, so additional thoughts:
- Add pre-commit hooks to check biome formatting
- Add
formatscript topackage.json - Guidance for existing contributors for optimal use in vscode e.t.c
Open for anyone to action for a sec, assign when ready!
@will-lamerton can I take this issue?
@akramcodez go for it!