@openregion/biome-config
v1.0.0
Published
Open Region shared Biome config
Readme
Biome shared config
Open Region shared configuration for Biome.
This package replaces @openregion/eslint-config and @openregion/prettier-config for projects that are ready to move to Biome. It is a new recommended baseline, not a rule-for-rule migration of the previous ESLint, Airbnb, React, TypeScript ESLint, JSX accessibility, or Prettier settings.
Installation
npm install --save-dev @biomejs/biome @openregion/biome-configUsage
Create biome.json in the project root:
{
"extends": ["@openregion/biome-config"]
}Add scripts to the consumer project's package.json:
{
"scripts": {
"check": "biome check .",
"format": "biome check --write .",
"ci": "biome ci ."
}
}Included baseline
- Biome formatter.
- Biome recommended linter rules.
- Import organization through Biome assist actions.
- Git ignore integration.
- Conservative Open Region defaults for JavaScript and TypeScript projects.
Migration from Open Region ESLint and Prettier configs
Remove the old packages:
npm uninstall @openregion/eslint-config @openregion/prettier-config eslint prettierInstall Biome and the shared config:
npm install --save-dev @biomejs/biome @openregion/biome-configAdd biome.json:
{
"extends": ["@openregion/biome-config"]
}When the project is ready to apply formatting and safe fixes, run:
npx biome check --write .Review the resulting diff before committing. Biome formatter output can differ from Prettier, and recommended lint rules can surface findings that were not covered by the old shared configs.
Local package checks
npm run check
npm run ci
npm run pack:dry-run