@side-xp/biome-config
v1.2.1
Published
Shared Biome configuration for projects at Sideways Experiments
Readme
Sideways Experiments' Biome config
A few Biome config files shared across Sideways Experiments projects.
Usage
In your Node project, you must use Biome as your linting & formatting tool in order to use these configurations. Plus, you must install this package as dev dependency:
npm i -D @biomejs/biome @side-xp/biome-configCreate a biome.json file at the root of your project, and add an extends rule with the appropriate config file:
{ "extends": ["@side-xp/biome-config"] }Our rules force using LF line-endings format. To make sure that your system doesn't conflict with this rule, you can add a .gitattributes at the root of your project, with the following content:
* text=auto eol=lf
For Node library projects
For Node library projects (that output a reusable package, not an app) you should also extend the biome.lib.json variant of our config:
{
"extends": [
"@side-xp/biome-config",
"@side-xp/biome-config/biome.lib.json"
]
}It enforces a few rules for libraries specifically, like considering an error to let console calls in the code unless they're used in tests.
For app projects
For Node app projects you should also extend the biome.app.json variant of our config:
{
"extends": [
"@side-xp/biome-config",
"@side-xp/biome-config/biome.app.json"
]
}It adds support for Tailwind directives like @theme.
Developer setup
git clone https://github.com/side-xp/biome-config
cd biome-config
npm installThe repository uses Husky to setup Git hooks:
- Check if JSON files are valid (no parsing error) on commit
- Enforce Conventional Commit notation in commit messages
Releases are automated with semantic-release in CI.
Crafted and maintained with love by Sideways Experiments
(c) 2022-2026 Sideways Experiments
