Ultracite

https://www.ultracite.ai/docs
Admin
Ultracite is a highly opinionated, zero-configuration preset for JavaScript and TypeScript linting...
Tokens:9,453
Snippets:163
Trust Score:6.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Initialize Ultracite with skill installation

Source: https://www.ultracite.ai/docs/ai/skills

Use this command for non-interactive flows to initialize Ultracite and install the skill simultaneously.

```bash
npx ultracite init --install-skill
```

--------------------------------

### Install VS Code Extensions

Source: https://www.ultracite.ai/docs/provider/eslint

Command-line instructions to install the necessary VS Code extensions for linting and formatting.

```bash
code --install-extension dbaeumer.vscode-eslint
code --install-extension esbenp.prettier-vscode
code --install-extension stylelint.vscode-stylelint
```

--------------------------------

### Install Oxlint Complexity Plugin

Source: https://www.ultracite.ai/docs/provider/oxlint

Install the third-party complexity plugin as a development dependency.

```bash
npm install -D oxlint-plugin-complexity
```

--------------------------------

### Initialize Oxlint with Anti-Slop

Source: https://www.ultracite.ai/docs/provider/oxlint

Use this command to enable the anti-slop plugin during the initial project setup.

```bash
npx ultracite init --linter oxlint --js-plugins anti-slop
```

--------------------------------

### Run the Ultracite initialization script

Source: https://www.ultracite.ai/docs/migrate/biome

Execute this command to start the automatic migration process and select Biome as the linting provider.

```bash
npx ultracite init
```

--------------------------------

### Install JS plugin dependencies

Source: https://www.ultracite.ai/docs/provider/oxlint

Install the required ESLint plugins manually if not using the interactive init command.

```bash
npm install -D eslint-plugin-github eslint-plugin-sonarjs oxlint-plugin-react-doctor
```

--------------------------------

### Initialize Ultracite with Git hooks

Source: https://www.ultracite.ai/docs/git-hooks

Run this command during project setup to automatically configure Husky and lint-staged integrations.

```bash
npx ultracite init --integrations husky lint-staged
```

--------------------------------

### Install Biome VS Code Extension

Source: https://www.ultracite.ai/docs/provider/biome

Command to install the Biome extension for VS Code via the terminal.

```bash
code --install-extension biomejs.biome
```

--------------------------------

### Install Tailwind CSS Extension

Source: https://www.ultracite.ai/docs/setup

Install the recommended VS Code extension for Tailwind CSS class sorting and hints.

```bash
code --install-extension bradlc.vscode-tailwindcss
```

--------------------------------

### Monorepo directory structure

Source: https://www.ultracite.ai/docs/monorepos

Example layout showing configuration files located at the root of a Turborepo project.

```text
my-turborepo/
├── apps/
├── packages/
├── turbo.json
└── biome.jsonc (or eslint.config.mjs, oxlint.config.ts, etc.)
```

--------------------------------

### Validate Ultracite setup

Source: https://www.ultracite.ai/docs/usage

Runs the doctor command to verify configuration and identify potential setup issues.

```bash
npx ultracite doctor
```

--------------------------------

### Install Oxc VS Code Extension

Source: https://www.ultracite.ai/docs/provider/oxlint

Use this command in your terminal to install the Oxc extension for VS Code.

```bash
code --install-extension oxc.oxc-vscode
```

--------------------------------

### Add Ultracite skill via CLI

Source: https://www.ultracite.ai/docs/ai/skills

Install the reusable skill bundle directly from the repository for compatible AI tools.

```bash
npx skills add haydenbleasel/ultracite
```

--------------------------------

### Manually configure agent hooks

Source: https://www.ultracite.ai/docs/ai/hooks

Command to manually enable specific editor hooks after the initial project setup.

```bash
npx ultracite init --hooks cursor windsurf codebuddy claude copilot
```

--------------------------------

### Initialize Ultracite Agent Files

Source: https://www.ultracite.ai/docs/ai/rules

Run the initialization command to select and generate rule files for supported AI coding assistants.

```bash
? Which agent files do you want to add (optional)?
  ◯ Universal (creates AGENTS.md for Codex, Jules, Devin, and more)
  ◯ Claude (creates .claude/CLAUDE.md)
  ◯ Replit (creates replit.md)
  # ... and more
```

--------------------------------

### Initialize Oxlint with JS plugins

Source: https://www.ultracite.ai/docs/provider/oxlint

Use this command to interactively or non-interactively set up Oxlint with specific ESLint plugins.

```bash
npx ultracite init --linter oxlint --js-plugins eslint-plugin-github eslint-plugin-sonarjs oxlint-plugin-react-doctor
```

--------------------------------

### Initialize Biome with type-aware rules

Source: https://www.ultracite.ai/docs/usage

Configures the project to use type-aware rules for Biome by updating the configuration file.

```bash
npx ultracite init --linter biome --type-aware
```

--------------------------------

### Enable agent hooks via initialization

Source: https://www.ultracite.ai/docs/ai/hooks

Interactive prompt displayed during the initialization process to select desired editor hooks.

```bash
? Which agent hooks do you want to enable (optional)?
  ◯ Cursor
  ◯ Windsurf
  ◯ CodeBuddy
  ◯ Claude Code
  ◯ GitHub Copilot
```

--------------------------------

### Configure Biome with Framework Presets

Source: https://www.ultracite.ai/docs/provider/biome

Extend the core configuration with additional presets for React and Next.js.

```jsonc
{
  "extends": [
    "ultracite/biome/core",
    "ultracite/biome/react",
    "ultracite/biome/next",
  ],
}
```

--------------------------------

### Configure Biome with Type-Aware Rules

Source: https://www.ultracite.ai/docs/provider/biome

Enable project-graph rules by including the type-aware preset.

```jsonc
{
  "extends": ["ultracite/biome/core", "ultracite/biome/type-aware"],
}
```

--------------------------------

### Configure ESLint, Prettier, and Stylelint

Source: https://www.ultracite.ai/docs/provider/eslint

Basic configuration files generated by Ultracite for linting and formatting.

```javascript
import core from "ultracite/eslint/core";

export default [...core];
```

```javascript
import config from "ultracite/prettier";

export default {
  ...config,
  plugins: ["prettier-plugin-tailwindcss"],
};
```

```javascript
export { default } from "ultracite/stylelint";
```

--------------------------------

### Configure Oxlint with Core Presets

Source: https://www.ultracite.ai/docs/provider/oxlint

Basic configuration for Oxlint using the core preset and default ignore patterns.

```ts
import { defineConfig } from "oxlint";
import core from "ultracite/oxlint/core";

export default defineConfig({
  extends: [core],
  ignorePatterns: core.ignorePatterns,
});
```

--------------------------------

### Configure pre-commit framework

Source: https://www.ultracite.ai/docs/git-hooks

Define the local hook in .pre-commit-config.yaml to run Ultracite via the pre-commit framework.

```yaml
repos:
  - repo: local
    hooks:
      - id: ultracite
        name: ultracite
        entry: npx ultracite fix
        language: system
        types_or: [javascript, jsx, ts, tsx, json, css]
        pass_filenames: false
```

--------------------------------

### Configure Oxlint with Framework Presets

Source: https://www.ultracite.ai/docs/provider/oxlint

Extended configuration for Oxlint including React and Next.js presets.

```ts
import { defineConfig } from "oxlint";
import core from "ultracite/oxlint/core";
import next from "ultracite/oxlint/next";
import react from "ultracite/oxlint/react";

export default defineConfig({
  extends: [core, react, next],
  ignorePatterns: core.ignorePatterns,
});
```

--------------------------------

### Configure Husky pre-commit hook

Source: https://www.ultracite.ai/docs/git-hooks

This script runs Ultracite on staged files and re-stages them before completing the commit.

```bash
# ultracite
#!/bin/sh
# Check if there are any staged files
STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR)
if [ -z "$STAGED_FILES" ]; then
  echo "No staged files to format"
  exit 0
fi

# Run formatter, capturing the exit code so we can still re-stage and report
FORMAT_EXIT_CODE=0
npx ultracite fix || FORMAT_EXIT_CODE=$?

# Re-stage files that were already staged
echo "$STAGED_FILES" | while IFS= read -r file; do
  if [ -f "$file" ]; then
    git add -- "$file"
  fi
done

if [ $FORMAT_EXIT_CODE -ne 0 ]; then
  echo "Ultracite found issues that could not be auto-fixed."
  exit $FORMAT_EXIT_CODE
fi

echo "✨ Files formatted by Ultracite"
# ultracite end
```

--------------------------------

### Configure Oxlint with JS plugins

Source: https://www.ultracite.ai/docs/provider/oxlint

Basic configuration for oxlint.config.ts to extend core and js-plugins presets.

```ts
import { defineConfig } from "oxlint";
import core from "ultracite/oxlint/core";
import jsPlugins, { jsPluginSettings } from "ultracite/oxlint/js-plugins";

export default defineConfig({
  extends: [core, jsPlugins],
  ignorePatterns: core.ignorePatterns,
  settings: jsPluginSettings,
});
```

--------------------------------

### Configure Oxlint for Next.js with JS plugins

Source: https://www.ultracite.ai/docs/provider/oxlint

Extended configuration for Next.js applications including framework-specific React Doctor rules.

```ts
import { defineConfig } from "oxlint";
import core from "ultracite/oxlint/core";
import next from "ultracite/oxlint/next";
import jsPlugins, { jsPluginSettings } from "ultracite/oxlint/js-plugins";
import nextJsPlugins from "ultracite/oxlint/next/js-plugins";

export default defineConfig({
  extends: [core, next, jsPlugins, nextJsPlugins],
  ignorePatterns: core.ignorePatterns,
  settings: jsPluginSettings,
});
```

--------------------------------

### Run Oxlint with type-aware and type-check flags

Source: https://www.ultracite.ai/docs/usage

Enables type-aware rules or TypeScript compiler diagnostics for Oxlint at runtime.

```bash
npx ultracite check --type-aware
npx ultracite fix --type-aware
```

```bash
npx ultracite check --type-check
npx ultracite fix --type-check
```

```bash
npx ultracite fix --type-aware --type-check
```

--------------------------------

### Configure Oxlint with Plugins

Source: https://www.ultracite.ai/docs/provider/oxlint

Extend the base configuration and register third-party plugins in oxlint.config.ts.

```typescript
import { defineConfig } from "oxlint";
import core from "ultracite/oxlint/core";

export default defineConfig({
  extends: [core],
  ignorePatterns: core.ignorePatterns,
  jsPlugins: ["oxlint-plugin-complexity"],
  rules: {
    "complexity/complexity": ["error", { cognitive: 15 }],
  },
});
```

--------------------------------

### Add Framework Presets to ESLint

Source: https://www.ultracite.ai/docs/provider/eslint

Extend the base ESLint configuration with specific framework presets like React and Next.js.

```javascript
import core from "ultracite/eslint/core";
import react from "ultracite/eslint/react";
import next from "ultracite/eslint/next";

export default [...core, ...react, ...next];
```

--------------------------------

### Configure root tasks in turbo.json

Source: https://www.ultracite.ai/docs/monorepos

Define root tasks in turbo.json to integrate Ultracite commands into the Turborepo pipeline.

```json
{
  "tasks": {
    "//#check": {},
    "//#fix": {
      "cache": false
    }
  }
}
```

--------------------------------

### Configure lint-staged for Ultracite

Source: https://www.ultracite.ai/docs/git-hooks

Add the lint-staged configuration to package.json to trigger Ultracite on staged files.

```json
{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,json,jsonc,css,scss,md,mdx}": ["npx ultracite fix"]
  }
}
```

--------------------------------

### Add root scripts to package.json

Source: https://www.ultracite.ai/docs/monorepos

Define check and fix commands in the root package.json to execute Ultracite across the entire monorepo.

```json
{
  "scripts": {
    "check": "ultracite check",
    "fix": "ultracite fix"
  }
}
```

--------------------------------

### Configure oxfmt.config.ts for Ultracite

Source: https://www.ultracite.ai/docs/migrate/oxlint

Import the Ultracite formatting preset into your oxfmt configuration file to standardize formatting rules.

```typescript
import { defineConfig } from "oxfmt";
import ultracite from "ultracite/oxfmt";

export default defineConfig({
  ...ultracite,
});
```

--------------------------------

### Fix code with Ultracite

Source: https://www.ultracite.ai/docs/usage

Runs the linter and applies auto-fixes. Use the --unsafe flag to allow fixes that may change runtime behavior.

```bash
npx ultracite fix
```

```bash
npx ultracite fix --unsafe
```

--------------------------------

### Check code with Ultracite

Source: https://www.ultracite.ai/docs/usage

Runs the linter without modifying any files.

```bash
npx ultracite check
```

--------------------------------

### Configure Oxfmt with Tailwind Support

Source: https://www.ultracite.ai/docs/provider/oxlint

Customize Oxfmt settings and specify a stylesheet for Tailwind class sorting in oxfmt.config.ts.

```typescript
import { defineConfig } from "oxfmt";
import ultracite from "ultracite/oxfmt";

export default defineConfig({
  ...ultracite,
  sortTailwindcss: {
    functions: ["clsx", "cva", "tw", "twMerge", "cn", "twJoin", "tv"],
    stylesheet: "./app/globals.css",
  },
});
```

--------------------------------

### Extend Ultracite in biome.jsonc

Source: https://www.ultracite.ai/docs/migrate/biome

Manually configure an existing Biome project to use the Ultracite core preset by updating the extends field.

```jsonc
{
  "extends": ["ultracite/biome/core"],
}
```

--------------------------------

### Configure Lefthook for Ultracite

Source: https://www.ultracite.ai/docs/git-hooks

Define the pre-commit job in lefthook.yml to run Ultracite on specific file types.

```yaml
pre-commit:
  jobs:
    - run: npx ultracite fix
      glob:
        - "**/*.js"
        - "**/*.jsx"
        - "**/*.ts"
        - "**/*.tsx"
        - "**/*.json"
        - "**/*.jsonc"
        - "**/*.css"
      stage_fixed: true
```

--------------------------------

### Exclude Files in Biome Configuration

Source: https://www.ultracite.ai/docs/provider/biome

Add negated patterns to the files includes array to exclude specific directories. Always include "**" as the first entry to ensure files are matched.

```jsonc
{
  "extends": ["ultracite/biome/core"],
  "files": {
    "includes": ["**", "!components/ui/**", "!prisma/client", "!public"],
  },
}
```

--------------------------------

### Run Ultracite Programmatically

Source: https://www.ultracite.ai/docs/setup

Use the --quiet flag to suppress interactive prompts and output for automated environments.

```bash
npx ultracite init --quiet --pm npm
```

```bash
CI=true npx ultracite init --pm npm
```

```bash
npx ultracite init --quiet --linter eslint --pm npm
```

--------------------------------

### Configure Anti-Slop in oxlint.config.ts

Source: https://www.ultracite.ai/docs/provider/oxlint

Manually add the anti-slop preset to your Oxlint configuration file.

```typescript
import { defineConfig } from "oxlint";
import antiSlop from "ultracite/oxlint/anti-slop";
import core from "ultracite/oxlint/core";

export default defineConfig({
  extends: [core, antiSlop],
  ignorePatterns: core.ignorePatterns,
});
```

--------------------------------

### Configure oxlint.config.ts for Ultracite

Source: https://www.ultracite.ai/docs/migrate/oxlint

Extend the Ultracite core preset in your Oxlint configuration file to inherit shared rules and ignore patterns.

```typescript
import { defineConfig } from "oxlint";

import core from "ultracite/oxlint/core";

export default defineConfig({
  extends: [core],
  ignorePatterns: core.ignorePatterns,
});
```

--------------------------------

### Bypass Git hooks

Source: https://www.ultracite.ai/docs/git-hooks

Use the --no-verify flag to commit without running the pre-commit hooks.

```bash
git commit --no-verify
```

--------------------------------

### Override Biome Rules

Source: https://www.ultracite.ai/docs/configuration

Demonstrates how to disable a specific rule, such as useButtonType, within the linter configuration block.

```jsonc
{
  "extends": ["ultracite/biome/core"],
  "linter": {
    "rules": {
      "a11y": {
        "useButtonType": "off",
      },
    },
  },
}
```

--------------------------------

### AI-powered code fixing

Source: https://www.ultracite.ai/docs/usage

Uses external agents to autonomously repair issues that survive the standard autofix pass.

```bash
npx ultracite fix --claude
npx ultracite fix --codex
```

--------------------------------

### Disable VS Code TypeScript validation

Source: https://www.ultracite.ai/docs/troubleshooting

Add this setting to your VS Code configuration to prevent duplicate type error reporting.

```json
"typescript.validate.enable": false
```
Tokens:
Raw