corsa-oxlint

36 documented exports.

AST_NODE_TYPES

No documentation comment yet.

ts
const AST_NODE_TYPES: Readonly<{ readonly AccessorProperty: "AccessorProperty"; readonly ArrayExpression: "ArrayExpression"; readonly ArrayPattern: "ArrayPattern"; readonly ArrowFunctionExpression: "ArrowFunctionExpression"; ... 171 more ...; readonly TSVoidKeyword: "TSVoidKeyword"; }>

Source

AST_TOKEN_TYPES

No documentation comment yet.

ts
const AST_TOKEN_TYPES: Readonly<{ readonly Boolean: "Boolean"; readonly Identifier: "Identifier"; readonly JSXIdentifier: "JSXIdentifier"; readonly PrivateIdentifier: "PrivateIdentifier"; readonly JSXText: "JSXText"; ... 8 more ...; readonly Line: "Line"; }>

Source

TSESTree

No documentation comment yet.

ts
const TSESTree: Readonly<{ AST_NODE_TYPES: Readonly<{ readonly AccessorProperty: "AccessorProperty"; readonly ArrayExpression: "ArrayExpression"; readonly ArrayPattern: "ArrayPattern"; readonly ArrowFunctionExpression: "ArrowFunctionExpression"; ... 171 more ...; readonly TSVoidKeyword: "TSVoidKeyword"; }>; AST_TOKEN_TYPES: Readonl...

Source

ESLintUtils

No documentation comment yet.

ts
const ESLintUtils: Readonly<{ NullThrowsReasons: Readonly<{ MissingParent: "Expected node to have a parent."; MissingToken: (token: string, thing: string) => string; }>; RuleCreator: ((urlCreator: (ruleName: string) => string) => RuleCreatorFactory) & { ...; }; ... 4 more ...; nullThrows: <T>(value: T | ... 1 more ... | undefined, mes...

Source

OxlintUtils

Self-hosted type-aware utilities for Oxlint rules backed by Corsa.

ts
const OxlintUtils: Readonly<{ RuleCreator(urlCreator: (ruleName: string) => string): RuleCreatorFactory; getParserServices(context: ContextWithParserOptions, allowWithoutFullTypeInformation?: boolean): ParserServices; }>

Source

RuleCreator

No documentation comment yet.

ts
const RuleCreator: ((urlCreator: (ruleName: string) => string) => RuleCreatorFactory) & { withoutDocs<TRule extends Omit<RuleCreatorRule, "name">>(rule: TRule): Rule & { ...; }; }

Source

compatPlugin

No documentation comment yet.

ts
compatPlugin(plugin: Plugin): Plugin

Source

Parameter Type Description
plugin Plugin -

Returns: Plugin

definePlugin

No documentation comment yet.

ts
definePlugin(plugin: Plugin): Plugin

Source

Parameter Type Description
plugin Plugin -

Returns: Plugin

defineRule

Defines a single Oxlint rule with type-aware parser services.

ts
defineRule<MessageId extends string = string, const Options extends readonly unknown[] = readonly unknown[]>(rule: RuleDefinition<MessageId, Options>): Rule

Source

Parameter Type Description
rule RuleDefinition<MessageId, Options> -

Returns: Rule

Plugin

No documentation comment yet.

ts
export type Plugin = Omit<OxlintPlugin, "rules"> &

Source

Rule

No documentation comment yet.

ts
export type Rule = OxlintRule & Record<string, unknown>;

Source

RuleContext

No documentation comment yet.

ts
export type RuleContext<
  MessageId extends string = string,
  Options extends readonly unknown[] = readonly unknown[],
> = Omit<ContextWithParserOptions, "options" | "report"> &

Source

RuleDefinition

No documentation comment yet.

ts
export type RuleDefinition<
  MessageId extends string = string,
  Options extends readonly unknown[] = readonly unknown[],
> = Record<string, unknown> &

Source

RuleDocs

No documentation comment yet.

ts
export type RuleDocs =

Source

RuleDiagnostic

No documentation comment yet.

ts
export type RuleDiagnostic<MessageId extends string = string> = Diagnostic &

Source

RuleMetaWithMessages

No documentation comment yet.

ts
export type RuleMetaWithMessages<MessageId extends string = string> = Omit<
  OxlintRuleMeta,
  "docs" | "messages"
> &

Source

getParserServices

Returns type-aware parser services backed by Corsa.

ts
getParserServices(context: ParserServicesContext, allowWithoutFullTypeInformation?: boolean): ParserServices

Source

Parameter Type Description
context ParserServicesContext -
allowWithoutFullTypeInformation boolean -

Returns: ParserServices

RuleTester

No documentation comment yet.

ts
export class RuleTester

Source

RuleTesterConfig

No documentation comment yet.

ts
export type RuleTesterConfig = TesterConfig &

Source

TSESLint

No documentation comment yet.

ts
const TSESLint: Readonly<{ ESLint: typeof UnsupportedTSESLintClass; FlatESLint: typeof UnsupportedTSESLintClass; LegacyESLint: typeof UnsupportedTSESLintClass; Linter: typeof UnsupportedTSESLintClass; RuleTester: typeof RuleTester; Scope: Readonly<...>; SourceCode: typeof UnsupportedTSESLintClass; }>

Source

oxlintCompat

No documentation comment yet.

ts
const oxlintCompat: Readonly<{ config(...configs: readonly unknown[]): unknown[]; configs: Readonly<{}>; parser: Readonly<{ meta: { name: string; version: string; }; parse(): never; }>; plugin: Readonly<{ configs: Readonly<{}>; rules: Readonly<...>; }>; }>

Source

ESTree

No documentation comment yet.

ts
export type ESTree = ESTree.NodeTypes;

Source

CorsaNode

No documentation comment yet.

ts
export interface CorsaNode

Source

CorsaProgramShape

No documentation comment yet.

ts
export interface CorsaProgramShape

Source

CorsaRuntimeOptions

No documentation comment yet.

ts
export interface CorsaRuntimeOptions

Source

CorsaOxlintSettings

No documentation comment yet.

ts
export interface CorsaOxlintSettings extends TypeAwareParserOptions

Source

CorsaStylisticSettings

No documentation comment yet.

ts
export interface CorsaStylisticSettings

Source

CorsaSignature

No documentation comment yet.

ts
export interface CorsaSignature

Source

CorsaSymbol

No documentation comment yet.

ts
export interface CorsaSymbol

Source

CorsaType

No documentation comment yet.

ts
export interface CorsaType extends TypeResponse

Source

CorsaTypeCheckerShape

No documentation comment yet.

ts
export interface CorsaTypeCheckerShape

Source

ContextWithParserOptions

No documentation comment yet.

ts
export type ContextWithParserOptions = Context &

Source

ParserServices

No documentation comment yet.

ts
export interface ParserServices

Source

ParserServicesWithTypeInformation

No documentation comment yet.

ts
export type ParserServicesWithTypeInformation = ParserServices &

Source

ProjectServiceOptions

No documentation comment yet.

ts
export interface ProjectServiceOptions

Source

TypeAwareParserOptions

No documentation comment yet.

ts
export interface TypeAwareParserOptions

Source