@brickkit/cli/lint/oxlint

The Brick lint rules as an oxlint JS plugin, and an oxlint config from brick.config.ts.

@brickkit/cli/lint/oxlint exports 3 names: 1 function, 1 interface, 1 variable.

import { default, fromProject } from "@brickkit/cli/lint/oxlint";

Functions

Function	Description
`fromProject`	Presets, rule settings, ignores and paths from brick.config.ts, as the fields of an oxlint config.

fromProject

function fromProject(
  options: { cwd?: string; config?: string } = {},
): Promise<OxlintConfig>

Presets, rule settings, ignores and paths from brick.config.ts, as the fields of an oxlint config.

Parameters

Name	Type	Description
`options?`	`{ cwd?: string; config?: string }` default `{}`

Returns Promise<OxlintConfig>

Source: packages/cli/src/lint/oxlint.ts:15

Interfaces

OxlintConfig

interface OxlintConfig

Properties

Name	Type	Description
`jsPlugins`	`{ name: string; specifier: string }[]`
`settings`	`Record<string, unknown>`
`rules`	`Record<string, Severity>`
`ignorePatterns`	`string[]`

Source: packages/cli/src/lint/oxlint.ts:7

Variables

default

const default: { meta: { name: string; }; rules: Record<string, Rule>; configs: Record<PresetName, FlatConfig> & { fromProject: typeof fromProject; }; }

The ESLint flat-config plugin; oxlint loads the same object through jsPlugins.

Source: packages/cli/src/lint/plugin.ts:24

@brickkit/cli/lint/oxlint

FunctionsCopy Anchor Link

fromProjectCopy Anchor Link

InterfacesCopy Anchor Link

OxlintConfigCopy Anchor Link

VariablesCopy Anchor Link