@akistack/biome-config

Universal Biome linter/formatter config preset.

Visit https://biomejs.dev/ to read more about Biome.

Usage

Ensure @biomejs/biome is installed in your project.

Add @akistack/biome-config as a devDependency to your project:

# pnpm
pnpm i -D @akistack/biome-config

# yarn
yarn add -D @akistack/biome-config

# npm
npm i -D @akistack/biome-config

# rush
rush add -p @akistack/biome-config --dev

Add to your biome.json:

{
  "extends": ["@akistack/biome-config"]
}

For Monorepo

Currently, biome only provides limited support for Monorepo. You need to add extra configuration to make Biome work properly under a monorepo project.

nx / Turborepo / PNPM Workspace

Install @akistack/biome-config as workspace-wide package (for example, pnpm i -w -D @akistack/biome-config).

And follow this guide, create a biome.json and place it at workspace root.

Rush

For Rush and those monorepo solution with folden infra structure, you are not able to install package under workspace root. In this scene, you can install this config preset to your infra directory, and point to a relative path in your workspace root biome.json config.

Take Rush as example, you can create an auto-installer and install this config in the created auto-installer project. The workspace structure will look like this:

- common/
  - autoinstallers/
    - cli/
      - node_modules/
        - @biomejs/biome
        - @akistack/biome-config
      - package.json
- biome.json

Then add the relative path of @akistack/biome-config/biome.json to your workspace root config file:

{
	"$schema": "./common/autoinstallers/cli/node_modules/@biomejs/biome/configuration_schema.json",
	"extends": ["./common/autoinstallers/cli/node_modules/@akistack/biome-config/biome.json"]
}