Format

Biome - Fast formatter and linter for JavaScript and TypeScript.

bot.ts uses Biome for code formatting and linting. Biome is an extremely fast tool that combines the functionality of Prettier (formatting) and ESLint (linting) in a single package.

Usage

bun

bun run format

npm

yarn

Biome CLI

What it does

The format command runs Biome with the --write flag, which:

1. Formats your code according to the configured style

2. Lints your code for potential errors and bad practices

3. Organizes imports alphabetically and removes unused ones

4. Fixes auto-fixable issues automatically

Configuration

Biome is configured via the biome.json file at the root of your project.

Default configuration

{
  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
  "formatter": {
    "enabled": true,
    "indentStyle": "tab"
  },
  "organizeImports": {
    "enabled": true
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  },
  "javascript": {
    "formatter": {
      "quoteStyle": "double",
      "semicolons": "asNeeded"
    }
  }
}

Formatting options

Option	Default	Description
indentStyle	"tab"	Use tabs for indentation
quoteStyle	"double"	Use double quotes for strings
semicolons	"asNeeded"	Only add semicolons where necessary

Linter rules

The framework uses Biome's recommended rules with some exceptions to accommodate common Discord bot patterns:

Rule	Setting	Reason
noExplicitAny	off	Allows any type when needed
noConfusingVoidType	off	Allows void in union types
noAssignInExpressions	off	Allows assignments in expressions
noNonNullAssertion	off	Allows ! non-null assertions
noParameterAssign	off	Allows reassigning function parameters
noForEach	off	Allows .forEach() method
noDelete	off	Allows delete operator
useImportExtensions	off	No file extensions required in imports

Customization

Changing formatting style

To use spaces instead of tabs:

{
  "formatter": {
    "enabled": true,
    "indentStyle": "space",
    "indentWidth": 2
  }
}

Adding semicolons everywhere

{
  "javascript": {
    "formatter": {
      "semicolons": "always"
    }
  }
}

Using single quotes

{
  "javascript": {
    "formatter": {
      "quoteStyle": "single"
    }
  }
}

Ignoring files

{
  "files": {
    "ignore": ["dist/**", "node_modules/**", "*.min.js"]
  }
}

Enabling stricter rules

{
  "linter": {
    "rules": {
      "recommended": true,
      "suspicious": {
        "noExplicitAny": "error"
      },
      "style": {
        "noNonNullAssertion": "warn"
      }
    }
  }
}

IDE Integration

VS Code

Install the Biome extension for VS Code to get:

• Format on save

• Real-time linting

• Quick fixes

Add to your .vscode/settings.json:

{
  "editor.defaultFormatter": "biomejs.biome",
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "quickfix.biome": "explicit",
    "source.organizeImports.biome": "explicit"
  }
}

Other editors

Biome has plugins for many editors:

• IntelliJ / WebStorm

• Neovim

• Sublime Text

Running checks without fixing

To check for issues without auto-fixing them:

bunx biome check src

To see what would change without writing:

bunx biome check --write --dry-run src

CI Integration

Add Biome to your CI pipeline:

# GitHub Actions example
- name: Check formatting and linting
  run: bunx biome check src

More information

For complete documentation, visit the Biome website.