Introduction

This package provides the shared oxlint configuration for the entire FRAME monorepo. Its goal is to guarantee consistency in static analysis, code quality, and convention compliance across all applications and packages.

Tip

oxlint is an extremely fast linter written in Rust, designed as a complement or replacement for ESLint. Unlike ESLint, oxlint runs rules in parallel, reducing lint time by up to 50–100× on large projects.

Package architecture

The package exposes a single root configuration from src/base.ts, which groups four plugin layers applied via overrides according to file type:

graph TD
  A[base.ts] --> B[TypeScript Plugin]
  A --> C["Overrides *.cjs/*.cts"]
  A --> D["Overrides *.ts/*.tsx"]
  A --> E["Overrides *.js/*.jsx/*.ts/*.tsx"]
  E --> F[eslint-plugin-import]
  E --> G[eslint-plugin-perfectionist]
  E --> H[eslint-plugin-sonarjs]
  E --> I[eslint-plugin-unicorn]
  E --> J["@tanstack/eslint-plugin-query"]
  E --> K[eslint-plugin-check-file]

Included plugins

Plugin	Purpose
typescript	Static analysis rules for TypeScript
eslint-plugin-import	Validation of import/export declarations
eslint-plugin-perfectionist	Consistent ordering of imports, exports, objects, JSX props
eslint-plugin-sonarjs	Bug and code-smell detection in the SonarQube style
eslint-plugin-unicorn	Modern JavaScript/TypeScript best practices
@tanstack/eslint-plugin-query	Rules specific to TanStack Query
eslint-plugin-check-file	File and folder naming conventions
oxlint-tsgolint	Additional TypeScript rules via oxlint

Ignored patterns

The configuration automatically excludes the following build directories and files:

**/node_modules/**
**/.next/**
**/out/**
**/build/**
**/public/**
**/dist/**
**/coverage/**
**/.turbo/**
**/pnpm-lock.yaml
**/yarn.lock
**/package-lock.json

Notable rules

TypeScript

Rule	Level
@typescript-eslint/no-explicit-any	error
@typescript-eslint/no-namespace	error
@typescript-eslint/ban-ts-comment	error
@typescript-eslint/consistent-type-imports	warn
@typescript-eslint/no-unsafe-declaration-merging	error

Imports and exports

Rule	Level
import/no-duplicates	error
import/no-commonjs	error
import/no-dynamic-require	error
import/no-absolute-path	error
perfectionist/sort-exports	warn
perfectionist/sort-import-attributes	error

Unicorn (best practices)

Rule	Level
unicorn/filename-case	error (kebab-case)
unicorn/no-null	error
unicorn/prefer-node-protocol	error
unicorn/prefer-top-level-await	error
unicorn/no-array-for-each	error

How to use it in a new package

1. Add the package as a development dependency:

   package.json

   {
     "devDependencies": {
       "@frame/oxlint": "workspace:*"
     }
   }

2. Create an oxlint.config.ts file at the package root:

   oxlint.config.ts

    import base from "@frame/oxlint/base"
   
    export default {
      ...base,
      // override or extend rules as needed
    }

3. Add the lint script to `package.json`:
```json title="package.json"
{
  "scripts": {
    "lint": "oxlint --fix"
  }
}

4. Run lint manually:

   pnpm -F <package-name> lint

Note

In CI, lint runs through Turbo via the global pipeline. No additional configuration is required if the package is registered in the workspace.

File naming conventions

The check-file/folder-naming-convention rule enforces kebab-case in the following directories:

Directory	Convention
content/**	KEBAB_CASE
e2e/**	KEBAB_CASE

oxlint

Official oxlint documentation

Perfectionist

Sorting rules

Unicorn

Modern best practices

TanStack Query Plugin

TanStack Query rules