Biome configuration used on CleevioX projects
npm install @cleeviox/biome``bash`
bun add --dev @cleeviox/biome @biomejs/biome
Extend the appropriate configuration in your biome.json file by referencing the package through node_modules:
Suitable for general TypeScript projects.
`json`
{
"$schema": "https://biomejs.dev/schemas/2.3.14/schema.json",
"extends": ["./node_modules/@cleeviox/biome/base.json"]
}
For React (JSX) projects.
`json`
{
"$schema": "https://biomejs.dev/schemas/2.3.14/schema.json",
"extends": ["./node_modules/@cleeviox/biome/react.json"]
}
For Next.js projects (extends React configuration).
`json`
{
"$schema": "https://biomejs.dev/schemas/2.3.14/schema.json",
"extends": ["./node_modules/@cleeviox/biome/nextjs.json"]
}
For NestJS projects.
`json`
{
"$schema": "https://biomejs.dev/schemas/2.3.14/schema.json",
"extends": ["./node_modules/@cleeviox/biome/nestjs.json"]
}
After setting up your configuration, you can run Biome commands:
`bashCheck code
bun biome check .
Setup With IDE
First install the official VSCode extension.
Add the following settings to your
settings.json file:`json
{
"editor.codeActionsOnSave": {
"source.action.useSortedKeys.biome": "explicit",
"source.fixAll.biome": "explicit"
},
"editor.defaultFormatter": "biomejs.biome",
"[github-actions-workflow]": {
"editor.defaultFormatter": "redhat.vscode-yaml"
},
"[json]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[javascript]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[typescriptreact]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[jsonc]": {
"editor.defaultFormatter": "biomejs.biome"
}
}
``See the link below for a more detailed explanation.
- Biome combines formatting and linting in a single tool
- These configurations aim to match the existing ESLint and Prettier rules used in Cleevio projects
- Some ESLint rules may not have direct Biome equivalents - the configurations include the closest matches available