@stkd/biome

Shared Biome configuration defaults for STKD projects.

Installation

npm install @stkd/biome --save-dev

Adding Biome to a New Repository

1. Install dependencies:

   npm install @stkd/biome @biomejs/biome --save-dev

2. Create biome.json in the project root:

   {
     "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
     "extends": ["@stkd/biome"],
     "files": {
       "includes": ["src/**/*.{js,jsx,ts,tsx}"]
     }
   }

3. Add scripts to package.json:

   "scripts": {
     "format": "biome format --write",
     "format-lint": "biome check --write",
     "lint": "biome lint --write"
   }

4. Run formatting:

   npm run format-lint

Usage

In your project's biome.json, extend this base configuration:

{
  "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
  "extends": ["./node_modules/@stkd/biome/biome.json"],
  "files": {
    "includes": ["src/**/*.{js,jsx,ts,tsx}"]
  }
}

Base Configuration

The base config provides:

Formatter

• Indent style: tabs
• Line width: 120 characters
• Quote style: single quotes (JavaScript and CSS)

Linter Rules

• recommended: enabled
• noUnusedImports: error
• noUnusedVariables: error
• useParseIntRadix: off
• useNodejsImportProtocol: off
• noDoubleEquals: off
• noGlobalIsNan: off
• useLiteralKeys: off
• useOptionalChain: off
• useIterableCallbackReturn: off
• noDocumentCookie: info
• noDuplicateProperties: error

CSS Support

• Tailwind directives parsing enabled
• noUnknownAtRules ignores tailwind and apply

Assists

• organizeImports: on
• useSortedKeys: on
• useSortedProperties: on

Vue Support

Vue files have relaxed rules (no unused import/variable warnings) since SFC compilers handle these.

Repository Customization

Each repository should override:

files.includes

Define which files Biome should process:

"files": {
  "includes": ["src/**/*.{js,jsx,ts,tsx}"]
}

Releasing

This package uses GitHub Actions with npm Trusted Publishing for secure, secret-free publishing.

| Workflow | Purpose | | -------- | ---------------------------- | | Release | Patch, minor, or major bump |

To release:

1. Go to the Actions tab in the GitHub repository
2. Click Release
3. Choose patch, minor, or major
4. Click Run workflow
5. The version will be bumped, published to npm, and changes pushed automatically

Trusted Publishing note:

• Configure npm to trust the exact workflow file you run: release.yml
• Keep Trusted Publishing pointed at this single workflow file

Schema Version

Base config uses: 2.3.10

When upgrading, update the $schema in both this base config and all projects that extend it.