@oxlint/plugins 1.51.0 → 1.52.0

package/index.cjs

@@ -1,11 +1,43 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src-js/package/define.ts
+/**
+* Define a plugin.
+*
+* No-op function, just to provide type safety. Input is passed through unchanged.
+*
+* @param plugin - Plugin to define
+* @returns Same plugin as passed in
+*/
 function definePlugin(plugin) {
 	return plugin;
 }
+/**
+* Define a rule.
+*
+* No-op function, just to provide type safety. Input is passed through unchanged.
+*
+* @param rule - Rule to define
+* @returns Same rule as passed in
+*/
 function defineRule(rule) {
 	return rule;
 }
+//#endregion
+//#region src-js/package/compat.ts
 const EMPTY_VISITOR = {};
+/**
+* Convert a plugin which used Oxlint's `createOnce` API to also work with ESLint.
+*
+* If any of the plugin's rules use the Oxlint alternative `createOnce` API,
+* add ESLint-compatible `create` methods to those rules, which delegate to `createOnce`.
+* This makes the plugin compatible with ESLint.
+*
+* The `plugin` object passed in is mutated in-place.
+*
+* @param plugin - Plugin to convert
+* @returns Plugin with all rules having `create` method
+* @throws {Error} If `plugin` is not an object, or `plugin.rules` is not an object
+*/
 function eslintCompatPlugin(plugin) {
 	if (typeof plugin != "object" || !plugin) throw Error("Plugin must be an object");
 	let { rules } = plugin;
@@ -13,6 +45,14 @@ function eslintCompatPlugin(plugin) {
 	for (let ruleName in rules) Object.hasOwn(rules, ruleName) && convertRule(rules[ruleName]);
 	return plugin;
 }
+/**
+* Convert a rule.
+*
+* The `rule` object passed in is mutated in-place.
+*
+* @param rule - Rule to convert
+* @throws {Error} If `rule` is not an object
+*/
 function convertRule(rule) {
 	if (typeof rule != "object" || !rule) throw Error("Rule must be an object");
 	if ("create" in rule) return;
@@ -64,13 +104,19 @@ const FILE_CONTEXT = Object.freeze({
 		throw Error("Cannot access `context.parserPath` in `createOnce`");
 	}
 });
+/**
+* Call `createOnce` method of rule, and return `Context`, `Visitor`, and `beforeHook` (if any).
+*
+* @param rule - Rule with `createOnce` method
+* @returns Object with `context`, `visitor`, and `beforeHook` properties
+*/
 function createContextAndVisitor(rule) {
 	let { createOnce } = rule;
 	if (createOnce == null) throw Error("Rules must define either a `create` or `createOnce` method");
 	if (typeof createOnce != "function") throw Error("Rule `createOnce` property must be a function");
 	let context = Object.create(FILE_CONTEXT, {
 		id: {
-			value: "",
+			value: null,
 			enumerable: !0,
 			configurable: !0
 		},
@@ -80,7 +126,9 @@ function createContextAndVisitor(rule) {
 			configurable: !0
 		},
 		report: {
-			value: null,
+			value() {
+				throw Error("Cannot report errors in `createOnce`");
+			},
 			enumerable: !0,
 			configurable: !0
 		}

package/index.d.ts

@@ -1049,43 +1049,10 @@ Partial<Pick<ObjectType, Exclude<KeysType, Key>>> }[KeysType] & // 3. Add the re
 Except<ObjectType, KeysType>;
 //#endregion
 //#region src-js/plugins/tokens.d.ts
-/**
- * Options for various `SourceCode` methods e.g. `getFirstToken`.
- */
-interface SkipOptions {
-  /** Number of skipping tokens */
-  skip?: number;
-  /** `true` to include comment tokens in the result */
-  includeComments?: boolean;
-  /** Function to filter tokens */
-  filter?: FilterFn | null;
-}
-/**
- * Options for various `SourceCode` methods e.g. `getFirstTokens`.
- */
-interface CountOptions {
-  /** Maximum number of tokens to return */
-  count?: number;
-  /** `true` to include comment tokens in the result */
-  includeComments?: boolean;
-  /** Function to filter tokens */
-  filter?: FilterFn | null;
-}
-/**
- * Options for `getTokenByRangeStart`.
- */
-interface RangeOptions {
-  /** `true` to include comment tokens in the result */
-  includeComments?: boolean;
-}
-/**
- * Filter function, passed as `filter` property of `SkipOptions` and `CountOptions`.
- */
-type FilterFn = (token: TokenOrComment) => boolean;
 /**
  * AST token type.
  */
-type Token = BooleanToken | IdentifierToken | JSXIdentifierToken | JSXTextToken | KeywordToken | NullToken | NumericToken | PrivateIdentifierToken | PunctuatorToken | RegularExpressionToken | StringToken | TemplateToken;
+type TokenType = BooleanToken | IdentifierToken | JSXIdentifierToken | JSXTextToken | KeywordToken | NullToken | NumericToken | PrivateIdentifierToken | PunctuatorToken | RegularExpressionToken | StringToken | TemplateToken;
 interface BaseToken extends Span {
   value: string;
   regex: undefined;
@@ -1131,213 +1098,9 @@ interface StringToken extends BaseToken {
 interface TemplateToken extends BaseToken {
   type: "Template";
 }
-type TokenOrComment = Token | Comment;
-/**
- * Get all tokens that are related to the given node.
- * @param node - The AST node.
- * @param countOptions? - Options object. If is a function, equivalent to `{ filter: fn }`.
- * @returns Array of `Token`s.
- */
-/**
- * Get all tokens that are related to the given node.
- * @param node - The AST node.
- * @param beforeCount? - The number of tokens before the node to retrieve.
- * @param afterCount? - The number of tokens after the node to retrieve.
- * @returns Array of `Token`s.
- */
-declare function getTokens(node: Node, countOptions?: CountOptions | number | FilterFn | null, afterCount?: number | null): TokenOrComment[];
-/**
- * Get the first token of the given node.
- * @param node - The AST node.
- * @param skipOptions? - Options object.
- *   If is a number, equivalent to `{ skip: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns `Token`, or `null` if all were skipped.
- */
-declare function getFirstToken(node: Node, skipOptions?: SkipOptions | number | FilterFn | null): TokenOrComment | null;
-/**
- * Get the first tokens of the given node.
- * @param node - The AST node.
- * @param countOptions? - Options object.
- *   If is a number, equivalent to `{ count: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns Array of `Token`s.
- */
-declare function getFirstTokens(node: Node, countOptions?: CountOptions | number | FilterFn | null): TokenOrComment[];
-/**
- * Get the last token of the given node.
- * @param node - The AST node.
- * @param skipOptions? - Options object.
- *   If is a number, equivalent to `{ skip: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns `Token`, or `null` if all were skipped.
- */
-declare function getLastToken(node: Node, skipOptions?: SkipOptions | number | FilterFn | null): TokenOrComment | null;
-/**
- * Get the last tokens of the given node.
- * @param node - The AST node.
- * @param countOptions? - Options object.
- *   If is a number, equivalent to `{ count: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns Array of `Token`s.
- */
-declare function getLastTokens(node: Node, countOptions?: CountOptions | number | FilterFn | null): TokenOrComment[];
-/**
- * Get the token that precedes a given node or token.
- * @param nodeOrToken - The AST node or token.
- * @param skipOptions? - Options object.
- *   If is a number, equivalent to `{ skip: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns `Token`, or `null` if all were skipped.
- */
-declare function getTokenBefore(nodeOrToken: NodeOrToken, skipOptions?: SkipOptions | number | FilterFn | null): TokenOrComment | null;
-/**
- * Get the token that precedes a given node or token.
- *
- * @deprecated Use `sourceCode.getTokenBefore` with `includeComments: true` instead.
- *
- * @param nodeOrToken The AST node or token.
- * @param skip - Number of tokens to skip.
- * @returns `Token`, or `null` if all were skipped.
- */
-declare function getTokenOrCommentBefore(nodeOrToken: NodeOrToken, skip?: number): TokenOrComment | null;
-/**
- * Get the tokens that precede a given node or token.
- * @param nodeOrToken - The AST node or token.
- * @param countOptions? - Options object.
- *   If is a number, equivalent to `{ count: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns Array of `Token`s.
- */
-declare function getTokensBefore(nodeOrToken: NodeOrToken, countOptions?: CountOptions | number | FilterFn | null): TokenOrComment[];
-/**
- * Get the token that follows a given node or token.
- * @param nodeOrToken - The AST node or token.
- * @param skipOptions? - Options object.
- *   If is a number, equivalent to `{ skip: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns `Token`, or `null` if all were skipped.
- */
-declare function getTokenAfter(nodeOrToken: NodeOrToken, skipOptions?: SkipOptions | number | FilterFn | null): TokenOrComment | null;
-/**
- * Get the token that follows a given node or token.
- *
- * @deprecated Use `sourceCode.getTokenAfter` with `includeComments: true` instead.
- *
- * @param nodeOrToken The AST node or token.
- * @param skip - Number of tokens to skip.
- * @returns `Token`, or `null` if all were skipped.
- */
-declare function getTokenOrCommentAfter(nodeOrToken: NodeOrToken, skip?: number): TokenOrComment | null;
-/**
- * Get the tokens that follow a given node or token.
- * @param nodeOrToken - The AST node or token.
- * @param countOptions? - Options object.
- *   If is a number, equivalent to `{ count: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns Array of `Token`s.
- */
-declare function getTokensAfter(nodeOrToken: NodeOrToken, countOptions?: CountOptions | number | FilterFn | null): TokenOrComment[];
-/**
- * Get all of the tokens between two non-overlapping nodes.
- * @param left - Node or token before the desired token range.
- * @param right - Node or token after the desired token range.
- * @param countOptions? - Options object. If is a function, equivalent to `{ filter: fn }`.
- * @returns Array of `Token`s between `left` and `right`.
- */
-/**
- * Get all of the tokens between two non-overlapping nodes.
- * @param left - Node or token before the desired token range.
- * @param right - Node or token after the desired token range.
- * @param padding - Number of extra tokens on either side of center.
- * @returns Array of `Token`s between `left` and `right`.
- */
-declare function getTokensBetween(left: NodeOrToken, right: NodeOrToken, countOptions?: CountOptions | number | FilterFn | null): TokenOrComment[];
-/**
- * Get the first token between two non-overlapping nodes.
- * @param left - Node or token before the desired token range.
- * @param right - Node or token after the desired token range.
- * @param skipOptions? - Options object.
- *   If is a number, equivalent to `{ skip: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns `Token`, or `null` if all were skipped.
- */
-declare function getFirstTokenBetween(left: NodeOrToken, right: NodeOrToken, skipOptions?: SkipOptions | number | FilterFn | null): TokenOrComment | null;
-/**
- * Get the first tokens between two non-overlapping nodes.
- * @param left - Node or token before the desired token range.
- * @param right - Node or token after the desired token range.
- * @param countOptions? - Options object.
- *   If is a number, equivalent to `{ count: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns Array of `Token`s between `left` and `right`.
- */
-declare function getFirstTokensBetween(left: NodeOrToken, right: NodeOrToken, countOptions?: CountOptions | number | FilterFn | null): TokenOrComment[];
-/**
- * Get the last token between two non-overlapping nodes.
- * @param left - Node or token before the desired token range.
- * @param right - Node or token after the desired token range.
- * @param skipOptions? - Options object.
- *   If is a number, equivalent to `{ skip: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns `Token`, or `null` if all were skipped.
- */
-declare function getLastTokenBetween(left: NodeOrToken, right: NodeOrToken, skipOptions?: SkipOptions | number | FilterFn | null): TokenOrComment | null;
-/**
- * Get the last tokens between two non-overlapping nodes.
- * @param left - Node or token before the desired token range.
- * @param right - Node or token after the desired token range.
- * @param countOptions? - Options object.
- *   If is a number, equivalent to `{ count: n }`.
- *   If is a function, equivalent to `{ filter: fn }`.
- * @returns Array of `Token`s between `left` and `right`.
- */
-declare function getLastTokensBetween(left: NodeOrToken, right: NodeOrToken, countOptions?: CountOptions | number | FilterFn | null): TokenOrComment[];
-/**
- * Get the token starting at the specified index.
- * @param index - Index of the start of the token's range.
- * @param rangeOptions - Options object.
- * @returns The token starting at index, or `null` if no such token.
- */
-declare function getTokenByRangeStart(index: number, rangeOptions?: RangeOptions | null): TokenOrComment | null;
-/**
- * Determine if two nodes or tokens have at least one whitespace character between them.
- * Order does not matter.
- *
- * Returns `false` if the given nodes or tokens overlap.
- *
- * Checks for whitespace *between tokens*, not including whitespace *inside tokens*.
- * e.g. Returns `false` for `isSpaceBetween(x, y)` in `x+" "+y`.
- *
- * @param first - The first node or token to check between.
- * @param second - The second node or token to check between.
- * @returns `true` if there is a whitespace character between
- *   any of the tokens found between the two given nodes or tokens.
- */
-declare function isSpaceBetween(first: NodeOrToken, second: NodeOrToken): boolean;
-/**
- * Determine if two nodes or tokens have at least one whitespace character between them.
- * Order does not matter.
- *
- * Returns `false` if the given nodes or tokens overlap.
- *
- * Checks for whitespace *between tokens*, not including whitespace *inside tokens*.
- * e.g. Returns `false` for `isSpaceBetween(x, y)` in `x+" "+y`.
- *
- * Unlike `SourceCode#isSpaceBetween`, this function does return `true` if there is a `JSText` token between the two
- * input tokens, and it contains whitespace.
- * e.g. Returns `true` for `isSpaceBetweenTokens(x, slash)` in `<X>a b</X>`.
- *
- * @deprecated Use `sourceCode.isSpaceBetween` instead.
- *
- * @param first - The first node or token to check between.
- * @param second - The second node or token to check between.
- * @returns `true` if there is a whitespace character between
- *   any of the tokens found between the two given nodes or tokens.
- */
-declare function isSpaceBetweenTokens(first: NodeOrToken, second: NodeOrToken): boolean;
+type TokenOrComment = TokenType | Comment;
 declare namespace types_d_exports {
-  export { AccessorProperty, AccessorPropertyType, Argument, ArrayAssignmentTarget, ArrayExpression, ArrayExpressionElement, ArrayPattern, ArrowFunctionExpression, AssignmentExpression, AssignmentOperator, AssignmentPattern, AssignmentTarget, AssignmentTargetMaybeDefault, AssignmentTargetPattern, AssignmentTargetProperty, AssignmentTargetPropertyIdentifier, AssignmentTargetPropertyProperty, AssignmentTargetRest, AssignmentTargetWithDefault, AwaitExpression, BigIntLiteral, BinaryExpression, BinaryOperator, BindingIdentifier, BindingPattern, BindingProperty, BindingRestElement, BlockStatement, BooleanLiteral, BreakStatement, CallExpression, CatchClause, ChainElement, ChainExpression, Class, ClassBody, ClassElement, ClassType, Comment, ComputedMemberExpression, ConditionalExpression, ContinueStatement, DebuggerStatement, Declaration, Decorator, Directive, DoWhileStatement, EmptyStatement, ExportAllDeclaration, ExportDefaultDeclaration, ExportDefaultDeclarationKind, ExportNamedDeclaration, ExportSpecifier, Expression, ExpressionStatement, ForInStatement, ForOfStatement, ForStatement, ForStatementInit, ForStatementLeft, FormalParameter, FormalParameterRest, Function$1 as Function, FunctionBody, FunctionType, Hashbang, IdentifierName, IdentifierReference, IfStatement, ImportAttribute, ImportAttributeKey, ImportDeclaration, ImportDeclarationSpecifier, ImportDefaultSpecifier, ImportExpression, ImportNamespaceSpecifier, ImportOrExportKind, ImportPhase, ImportSpecifier, JSDocNonNullableType, JSDocNullableType, JSDocUnknownType, JSXAttribute, JSXAttributeItem, JSXAttributeName, JSXAttributeValue, JSXChild, JSXClosingElement, JSXClosingFragment, JSXElement, JSXElementName, JSXEmptyExpression, JSXExpression, JSXExpressionContainer, JSXFragment, JSXIdentifier, JSXMemberExpression, JSXMemberExpressionObject, JSXNamespacedName, JSXOpeningElement, JSXOpeningFragment, JSXSpreadAttribute, JSXSpreadChild, JSXText, LabelIdentifier, LabeledStatement, LogicalExpression, LogicalOperator, MemberExpression, MetaProperty, MethodDefinition, MethodDefinitionKind, MethodDefinitionType, ModuleDeclaration, ModuleExportName, ModuleKind, NewExpression, Node$1 as Node, NullLiteral, NumericLiteral, ObjectAssignmentTarget, ObjectExpression, ObjectPattern, ObjectProperty, ObjectPropertyKind, ParamPattern, ParenthesizedExpression, PrivateFieldExpression, PrivateIdentifier, PrivateInExpression, Program, PropertyDefinition, PropertyDefinitionType, PropertyKey$1 as PropertyKey, PropertyKind, RegExpLiteral, ReturnStatement, SequenceExpression, SimpleAssignmentTarget, Span, SpreadElement, Statement, StaticBlock, StaticMemberExpression, StringLiteral, Super, SwitchCase, SwitchStatement, TSAccessibility, TSAnyKeyword, TSArrayType, TSAsExpression, TSBigIntKeyword, TSBooleanKeyword, TSCallSignatureDeclaration, TSClassImplements, TSConditionalType, TSConstructSignatureDeclaration, TSConstructorType, TSEnumBody, TSEnumDeclaration, TSEnumMember, TSEnumMemberName, TSExportAssignment, TSExternalModuleReference, TSFunctionType, TSGlobalDeclaration, TSImportEqualsDeclaration, TSImportType, TSImportTypeQualifiedName, TSImportTypeQualifier, TSIndexSignature, TSIndexSignatureName, TSIndexedAccessType, TSInferType, TSInstantiationExpression, TSInterfaceBody, TSInterfaceDeclaration, TSInterfaceHeritage, TSIntersectionType, TSIntrinsicKeyword, TSLiteral, TSLiteralType, TSMappedType, TSMappedTypeModifierOperator, TSMethodSignature, TSMethodSignatureKind, TSModuleBlock, TSModuleDeclaration, TSModuleDeclarationKind, TSModuleReference, TSNamedTupleMember, TSNamespaceExportDeclaration, TSNeverKeyword, TSNonNullExpression, TSNullKeyword, TSNumberKeyword, TSObjectKeyword, TSOptionalType, TSParameterProperty, TSParenthesizedType, TSPropertySignature, TSQualifiedName, TSRestType, TSSatisfiesExpression, TSSignature, TSStringKeyword, TSSymbolKeyword, TSTemplateLiteralType, TSThisParameter, TSThisType, TSTupleElement, TSTupleType, TSType, TSTypeAliasDeclaration, TSTypeAnnotation, TSTypeAssertion, TSTypeLiteral, TSTypeName, TSTypeOperator, TSTypeOperatorOperator, TSTypeParameter, TSTypeParameterDeclaration, TSTypeParameterInstantiation, TSTypePredicate, TSTypePredicateName, TSTypeQuery, TSTypeQueryExprName, TSTypeReference, TSUndefinedKeyword, TSUnionType, TSUnknownKeyword, TSVoidKeyword, TaggedTemplateExpression, TemplateElement, TemplateElementValue, TemplateLiteral, ThisExpression, ThrowStatement, Token, TryStatement, UnaryExpression, UnaryOperator, UpdateExpression, UpdateOperator, V8IntrinsicExpression, VariableDeclaration, VariableDeclarationKind, VariableDeclarator, WhileStatement, WithStatement, YieldExpression };
+  export { AccessorProperty, AccessorPropertyType, Argument, ArrayAssignmentTarget, ArrayExpression, ArrayExpressionElement, ArrayPattern, ArrowFunctionExpression, AssignmentExpression, AssignmentOperator, AssignmentPattern, AssignmentTarget, AssignmentTargetMaybeDefault, AssignmentTargetPattern, AssignmentTargetProperty, AssignmentTargetPropertyIdentifier, AssignmentTargetPropertyProperty, AssignmentTargetRest, AssignmentTargetWithDefault, AwaitExpression, BigIntLiteral, BinaryExpression, BinaryOperator, BindingIdentifier, BindingPattern, BindingProperty, BindingRestElement, BlockStatement, BooleanLiteral, BreakStatement, CallExpression, CatchClause, ChainElement, ChainExpression, Class, ClassBody, ClassElement, ClassType, Comment, ComputedMemberExpression, ConditionalExpression, ContinueStatement, DebuggerStatement, Declaration, Decorator, Directive, DoWhileStatement, EmptyStatement, ExportAllDeclaration, ExportDefaultDeclaration, ExportDefaultDeclarationKind, ExportNamedDeclaration, ExportSpecifier, Expression, ExpressionStatement, ForInStatement, ForOfStatement, ForStatement, ForStatementInit, ForStatementLeft, FormalParameter, FormalParameterRest, Function$1 as Function, FunctionBody, FunctionType, Hashbang, IdentifierName, IdentifierReference, IfStatement, ImportAttribute, ImportAttributeKey, ImportDeclaration, ImportDeclarationSpecifier, ImportDefaultSpecifier, ImportExpression, ImportNamespaceSpecifier, ImportOrExportKind, ImportPhase, ImportSpecifier, JSDocNonNullableType, JSDocNullableType, JSDocUnknownType, JSXAttribute, JSXAttributeItem, JSXAttributeName, JSXAttributeValue, JSXChild, JSXClosingElement, JSXClosingFragment, JSXElement, JSXElementName, JSXEmptyExpression, JSXExpression, JSXExpressionContainer, JSXFragment, JSXIdentifier, JSXMemberExpression, JSXMemberExpressionObject, JSXNamespacedName, JSXOpeningElement, JSXOpeningFragment, JSXSpreadAttribute, JSXSpreadChild, JSXText, LabelIdentifier, LabeledStatement, LogicalExpression, LogicalOperator, MemberExpression, MetaProperty, MethodDefinition, MethodDefinitionKind, MethodDefinitionType, ModuleDeclaration, ModuleExportName, ModuleKind, NewExpression, Node$1 as Node, NullLiteral, NumericLiteral, ObjectAssignmentTarget, ObjectExpression, ObjectPattern, ObjectProperty, ObjectPropertyKind, ParamPattern, ParenthesizedExpression, PrivateFieldExpression, PrivateIdentifier, PrivateInExpression, Program, PropertyDefinition, PropertyDefinitionType, PropertyKey$1 as PropertyKey, PropertyKind, RegExpLiteral, ReturnStatement, SequenceExpression, SimpleAssignmentTarget, Span, SpreadElement, Statement, StaticBlock, StaticMemberExpression, StringLiteral, Super, SwitchCase, SwitchStatement, TSAccessibility, TSAnyKeyword, TSArrayType, TSAsExpression, TSBigIntKeyword, TSBooleanKeyword, TSCallSignatureDeclaration, TSClassImplements, TSConditionalType, TSConstructSignatureDeclaration, TSConstructorType, TSEnumBody, TSEnumDeclaration, TSEnumMember, TSEnumMemberName, TSExportAssignment, TSExternalModuleReference, TSFunctionType, TSGlobalDeclaration, TSImportEqualsDeclaration, TSImportType, TSImportTypeQualifiedName, TSImportTypeQualifier, TSIndexSignature, TSIndexSignatureName, TSIndexedAccessType, TSInferType, TSInstantiationExpression, TSInterfaceBody, TSInterfaceDeclaration, TSInterfaceHeritage, TSIntersectionType, TSIntrinsicKeyword, TSLiteral, TSLiteralType, TSMappedType, TSMappedTypeModifierOperator, TSMethodSignature, TSMethodSignatureKind, TSModuleBlock, TSModuleDeclaration, TSModuleDeclarationKind, TSModuleReference, TSNamedTupleMember, TSNamespaceExportDeclaration, TSNeverKeyword, TSNonNullExpression, TSNullKeyword, TSNumberKeyword, TSObjectKeyword, TSOptionalType, TSParameterProperty, TSParenthesizedType, TSPropertySignature, TSQualifiedName, TSRestType, TSSatisfiesExpression, TSSignature, TSStringKeyword, TSSymbolKeyword, TSTemplateLiteralType, TSThisParameter, TSThisType, TSTupleElement, TSTupleType, TSType, TSTypeAliasDeclaration, TSTypeAnnotation, TSTypeAssertion, TSTypeLiteral, TSTypeName, TSTypeOperator, TSTypeOperatorOperator, TSTypeParameter, TSTypeParameterDeclaration, TSTypeParameterInstantiation, TSTypePredicate, TSTypePredicateName, TSTypeQuery, TSTypeQueryExprName, TSTypeReference, TSUndefinedKeyword, TSUnionType, TSUnknownKeyword, TSVoidKeyword, TaggedTemplateExpression, TemplateElement, TemplateElementValue, TemplateLiteral, ThisExpression, ThrowStatement, TokenType as Token, TryStatement, UnaryExpression, UnaryOperator, UpdateExpression, UpdateOperator, V8IntrinsicExpression, VariableDeclaration, VariableDeclarationKind, VariableDeclarator, WhileStatement, WithStatement, YieldExpression };
 }
 interface Program extends Span {
   type: "Program";
@@ -1345,7 +1108,7 @@ interface Program extends Span {
   sourceType: ModuleKind;
   hashbang: Hashbang | null;
   comments: Comment[];
-  tokens: Token[];
+  tokens: TokenType[];
   parent: null;
 }
 type Expression = BooleanLiteral | NullLiteral | NumericLiteral | BigIntLiteral | RegExpLiteral | StringLiteral | TemplateLiteral | IdentifierReference | MetaProperty | Super | ArrayExpression | ArrowFunctionExpression | AssignmentExpression | AwaitExpression | BinaryExpression | CallExpression | ChainExpression | Class | ConditionalExpression | Function$1 | ImportExpression | LogicalExpression | NewExpression | ObjectExpression | ParenthesizedExpression | SequenceExpression | TaggedTemplateExpression | ThisExpression | UnaryExpression | UpdateExpression | YieldExpression | PrivateInExpression | JSXElement | JSXFragment | TSAsExpression | TSSatisfiesExpression | TSTypeAssertion | TSNonNullExpression | TSInstantiationExpression | V8IntrinsicExpression | MemberExpression;
@@ -2633,7 +2396,12 @@ type ModuleKind = "script" | "module" | "commonjs";
 type Node$1 = Program | IdentifierName | IdentifierReference | BindingIdentifier | LabelIdentifier | ThisExpression | ArrayExpression | ObjectExpression | ObjectProperty | TemplateLiteral | TaggedTemplateExpression | TemplateElement | ComputedMemberExpression | StaticMemberExpression | PrivateFieldExpression | CallExpression | NewExpression | MetaProperty | SpreadElement | UpdateExpression | UnaryExpression | BinaryExpression | PrivateInExpression | LogicalExpression | ConditionalExpression | AssignmentExpression | ArrayAssignmentTarget | ObjectAssignmentTarget | AssignmentTargetRest | AssignmentTargetWithDefault | AssignmentTargetPropertyIdentifier | AssignmentTargetPropertyProperty | SequenceExpression | Super | AwaitExpression | ChainExpression | ParenthesizedExpression | Directive | Hashbang | BlockStatement | VariableDeclaration | VariableDeclarator | EmptyStatement | ExpressionStatement | IfStatement | DoWhileStatement | WhileStatement | ForStatement | ForInStatement | ForOfStatement | ContinueStatement | BreakStatement | ReturnStatement | WithStatement | SwitchStatement | SwitchCase | LabeledStatement | ThrowStatement | TryStatement | CatchClause | DebuggerStatement | AssignmentPattern | ObjectPattern | BindingProperty | ArrayPattern | BindingRestElement | Function$1 | FunctionBody | ArrowFunctionExpression | YieldExpression | Class | ClassBody | MethodDefinition | PropertyDefinition | PrivateIdentifier | StaticBlock | AccessorProperty | ImportExpression | ImportDeclaration | ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier | ImportAttribute | ExportNamedDeclaration | ExportDefaultDeclaration | ExportAllDeclaration | ExportSpecifier | V8IntrinsicExpression | BooleanLiteral | NullLiteral | NumericLiteral | StringLiteral | BigIntLiteral | RegExpLiteral | JSXElement | JSXOpeningElement | JSXClosingElement | JSXFragment | JSXOpeningFragment | JSXClosingFragment | JSXNamespacedName | JSXMemberExpression | JSXExpressionContainer | JSXEmptyExpression | JSXAttribute | JSXSpreadAttribute | JSXIdentifier | JSXSpreadChild | JSXText | TSThisParameter | TSEnumDeclaration | TSEnumBody | TSEnumMember | TSTypeAnnotation | TSLiteralType | TSConditionalType | TSUnionType | TSIntersectionType | TSParenthesizedType | TSTypeOperator | TSArrayType | TSIndexedAccessType | TSTupleType | TSNamedTupleMember | TSOptionalType | TSRestType | TSAnyKeyword | TSStringKeyword | TSBooleanKeyword | TSNumberKeyword | TSNeverKeyword | TSIntrinsicKeyword | TSUnknownKeyword | TSNullKeyword | TSUndefinedKeyword | TSVoidKeyword | TSSymbolKeyword | TSThisType | TSObjectKeyword | TSBigIntKeyword | TSTypeReference | TSQualifiedName | TSTypeParameterInstantiation | TSTypeParameter | TSTypeParameterDeclaration | TSTypeAliasDeclaration | TSClassImplements | TSInterfaceDeclaration | TSInterfaceBody | TSPropertySignature | TSIndexSignature | TSCallSignatureDeclaration | TSMethodSignature | TSConstructSignatureDeclaration | TSIndexSignatureName | TSInterfaceHeritage | TSTypePredicate | TSModuleDeclaration | TSGlobalDeclaration | TSModuleBlock | TSTypeLiteral | TSInferType | TSTypeQuery | TSImportType | TSImportTypeQualifiedName | TSFunctionType | TSConstructorType | TSMappedType | TSTemplateLiteralType | TSAsExpression | TSSatisfiesExpression | TSTypeAssertion | TSImportEqualsDeclaration | TSExternalModuleReference | TSNonNullExpression | Decorator | TSExportAssignment | TSNamespaceExportDeclaration | TSInstantiationExpression | JSDocNullableType | JSDocNonNullableType | JSDocUnknownType | ParamPattern;
 //#endregion
 //#region src-js/generated/visitor.d.ts
-interface VisitorObject {
+// To understand why we need the "Bivariance hack", see: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/20219
+// For downsides, see: https://github.com/oxc-project/oxc/issues/18154#issuecomment-4012955607
+type BivarianceHackHandler<Handler extends (...args: any) => any> = {
+  bivarianceHack(...args: Parameters<Handler>): ReturnType<Handler>;
+}["bivarianceHack"];
+interface StrictVisitorObject {
   DebuggerStatement?: (node: DebuggerStatement) => void;
   "DebuggerStatement:exit"?: (node: DebuggerStatement) => void;
   EmptyStatement?: (node: EmptyStatement) => void;
@@ -2964,8 +2732,8 @@ interface VisitorObject {
   "TSTypeReference:exit"?: (node: TSTypeReference) => void;
   TSUnionType?: (node: TSUnionType) => void;
   "TSUnionType:exit"?: (node: TSUnionType) => void;
-  [key: string]: (node: Node$1) => void;
 }
+type VisitorObject = { [K in keyof StrictVisitorObject]?: BivarianceHackHandler<Exclude<StrictVisitorObject[K], undefined>> | undefined } & Record<string, BivarianceHackHandler<(node: Node$1) => void> | undefined>;
 //#endregion
 //#region src-js/plugins/types.d.ts
 type BeforeHook = () => boolean | void;
@@ -2975,7 +2743,7 @@ type VisitorWithHooks = VisitorObject & {
   after?: AfterHook;
 };
 interface Node extends Span {}
-type NodeOrToken = Node | Token | Comment;
+type NodeOrToken = Node | TokenType | Comment;
 interface Comment extends Span {
   type: "Line" | "Block" | "Shebang";
   value: string;
@@ -3298,6 +3066,257 @@ declare function getScope(node: Node$1): Scope;
  */
 declare function markVariableAsUsed(name: string, refNode: Node$1): boolean;
 //#endregion
+//#region src-js/plugins/tokens_methods.d.ts
+/**
+ * Options for various `SourceCode` methods e.g. `getFirstToken`.
+ */
+interface SkipOptions {
+  /** Number of skipping tokens */
+  skip?: number;
+  /** `true` to include comment tokens in the result */
+  includeComments?: boolean;
+  /** Function to filter tokens */
+  filter?: FilterFn | null;
+}
+/**
+ * Options for various `SourceCode` methods e.g. `getFirstTokens`.
+ */
+interface CountOptions {
+  /** Maximum number of tokens to return */
+  count?: number;
+  /** `true` to include comment tokens in the result */
+  includeComments?: boolean;
+  /** Function to filter tokens */
+  filter?: FilterFn | null;
+}
+/**
+ * Options for `getTokenByRangeStart`.
+ */
+interface RangeOptions {
+  /** `true` to include comment tokens in the result */
+  includeComments?: boolean;
+}
+/**
+ * Filter function, passed as `filter` property of `SkipOptions` and `CountOptions`.
+ */
+type FilterFn = (token: TokenOrComment) => boolean;
+/**
+ * Whether `Options` may include comment tokens in the result.
+ * Resolves to `true` if `Options` has an `includeComments` property whose type includes `true`
+ * (i.e. it's `true`, `boolean`, or `boolean | undefined`), and `false` otherwise.
+ */
+type MayIncludeComments<Options> = Options extends {
+  includeComments: false;
+} ? false : "includeComments" extends keyof Options ? true : false;
+/**
+ * Resolves to `TokenOrComment` if `Options` may include comments, `Token` otherwise.
+ */
+type TokenResult<Options> = MayIncludeComments<Options> extends true ? TokenOrComment : TokenType;
+/**
+ * Get all tokens that are related to the given node.
+ * @param node - The AST node.
+ * @param countOptions? - Options object. If is a function, equivalent to `{ filter: fn }`.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+/**
+ * Get all tokens that are related to the given node.
+ * @param node - The AST node.
+ * @param beforeCount? - The number of tokens before the node to retrieve.
+ * @param afterCount? - The number of tokens after the node to retrieve.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+declare function getTokens<Options extends CountOptions | number | FilterFn | null | undefined>(node: Node, countOptions?: Options, afterCount?: number | null): TokenResult<Options>[];
+/**
+ * Get the first token of the given node.
+ * @param node - The AST node.
+ * @param skipOptions? - Options object.
+ *   If is a number, equivalent to `{ skip: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns `Token` (or `Token | Comment` if `includeComments` is `true`), or `null` if none found.
+ */
+declare function getFirstToken<Options extends SkipOptions | number | FilterFn | null | undefined>(node: Node, skipOptions?: Options): TokenResult<Options> | null;
+/**
+ * Get the first tokens of the given node.
+ * @param node - The AST node.
+ * @param countOptions? - Options object.
+ *   If is a number, equivalent to `{ count: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+declare function getFirstTokens<Options extends CountOptions | number | FilterFn | null | undefined>(node: Node, countOptions?: Options): TokenResult<Options>[];
+/**
+ * Get the last token of the given node.
+ * @param node - The AST node.
+ * @param skipOptions? - Options object.
+ *   If is a number, equivalent to `{ skip: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns `Token` (or `Token | Comment` if `includeComments` is `true`), or `null` if none found.
+ */
+declare function getLastToken<Options extends SkipOptions | number | FilterFn | null | undefined>(node: Node, skipOptions?: Options): TokenResult<Options> | null;
+/**
+ * Get the last tokens of the given node.
+ * @param node - The AST node.
+ * @param countOptions? - Options object.
+ *   If is a number, equivalent to `{ count: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+declare function getLastTokens<Options extends CountOptions | number | FilterFn | null | undefined>(node: Node, countOptions?: Options): TokenResult<Options>[];
+/**
+ * Get the token that precedes a given node or token.
+ * @param nodeOrToken - The AST node or token.
+ * @param skipOptions? - Options object.
+ *   If is a number, equivalent to `{ skip: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns `Token` (or `Token | Comment` if `includeComments` is `true`), or `null` if none found.
+ */
+declare function getTokenBefore<Options extends SkipOptions | number | FilterFn | null | undefined>(nodeOrToken: NodeOrToken, skipOptions?: Options): TokenResult<Options> | null;
+/**
+ * Get the token that precedes a given node or token.
+ *
+ * @deprecated Use `sourceCode.getTokenBefore` with `includeComments: true` instead.
+ *
+ * @param nodeOrToken The AST node or token.
+ * @param skip - Number of tokens to skip.
+ * @returns `TokenOrComment | null`.
+ */
+declare function getTokenOrCommentBefore(nodeOrToken: NodeOrToken, skip?: number): TokenOrComment | null;
+/**
+ * Get the tokens that precede a given node or token.
+ * @param nodeOrToken - The AST node or token.
+ * @param countOptions? - Options object.
+ *   If is a number, equivalent to `{ count: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+declare function getTokensBefore<Options extends CountOptions | number | FilterFn | null | undefined>(nodeOrToken: NodeOrToken, countOptions?: Options): TokenResult<Options>[];
+/**
+ * Get the token that follows a given node or token.
+ * @param nodeOrToken - The AST node or token.
+ * @param skipOptions? - Options object.
+ *   If is a number, equivalent to `{ skip: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns `Token` (or `Token | Comment` if `includeComments` is `true`), or `null` if none found.
+ */
+declare function getTokenAfter<Options extends SkipOptions | number | FilterFn | null | undefined>(nodeOrToken: NodeOrToken, skipOptions?: Options): TokenResult<Options> | null;
+/**
+ * Get the token that follows a given node or token.
+ *
+ * @deprecated Use `sourceCode.getTokenAfter` with `includeComments: true` instead.
+ *
+ * @param nodeOrToken The AST node or token.
+ * @param skip - Number of tokens to skip.
+ * @returns `TokenOrComment | null`.
+ */
+declare function getTokenOrCommentAfter(nodeOrToken: NodeOrToken, skip?: number): TokenOrComment | null;
+/**
+ * Get the tokens that follow a given node or token.
+ * @param nodeOrToken - The AST node or token.
+ * @param countOptions? - Options object.
+ *   If is a number, equivalent to `{ count: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+declare function getTokensAfter<Options extends CountOptions | number | FilterFn | null | undefined>(nodeOrToken: NodeOrToken, countOptions?: Options): TokenResult<Options>[];
+/**
+ * Get all of the tokens between two non-overlapping nodes.
+ * @param left - Node or token before the desired token range.
+ * @param right - Node or token after the desired token range.
+ * @param countOptions? - Options object. If is a function, equivalent to `{ filter: fn }`.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+/**
+ * Get all of the tokens between two non-overlapping nodes.
+ * @param left - Node or token before the desired token range.
+ * @param right - Node or token after the desired token range.
+ * @param padding - Number of extra tokens on either side of center.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+declare function getTokensBetween<Options extends CountOptions | number | FilterFn | null | undefined>(left: NodeOrToken, right: NodeOrToken, countOptions?: Options): TokenResult<Options>[];
+/**
+ * Get the first token between two non-overlapping nodes.
+ * @param left - Node or token before the desired token range.
+ * @param right - Node or token after the desired token range.
+ * @param skipOptions? - Options object.
+ *   If is a number, equivalent to `{ skip: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns `Token` (or `Token | Comment` if `includeComments` is `true`), or `null` if none found.
+ */
+declare function getFirstTokenBetween<Options extends SkipOptions | number | FilterFn | null | undefined>(left: NodeOrToken, right: NodeOrToken, skipOptions?: Options): TokenResult<Options> | null;
+/**
+ * Get the first tokens between two non-overlapping nodes.
+ * @param left - Node or token before the desired token range.
+ * @param right - Node or token after the desired token range.
+ * @param countOptions? - Options object.
+ *   If is a number, equivalent to `{ count: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+declare function getFirstTokensBetween<Options extends CountOptions | number | FilterFn | null | undefined>(left: NodeOrToken, right: NodeOrToken, countOptions?: Options): TokenResult<Options>[];
+/**
+ * Get the last token between two non-overlapping nodes.
+ * @param left - Node or token before the desired token range.
+ * @param right - Node or token after the desired token range.
+ * @param skipOptions? - Options object.
+ *   If is a number, equivalent to `{ skip: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns `Token` (or `Token | Comment` if `includeComments` is `true`), or `null` if none found.
+ */
+declare function getLastTokenBetween<Options extends SkipOptions | number | FilterFn | null | undefined>(left: NodeOrToken, right: NodeOrToken, skipOptions?: Options): TokenResult<Options> | null;
+/**
+ * Get the last tokens between two non-overlapping nodes.
+ * @param left - Node or token before the desired token range.
+ * @param right - Node or token after the desired token range.
+ * @param countOptions? - Options object.
+ *   If is a number, equivalent to `{ count: n }`.
+ *   If is a function, equivalent to `{ filter: fn }`.
+ * @returns Array of `Token`s, or array of `Token | Comment`s if `includeComments` is `true`.
+ */
+declare function getLastTokensBetween<Options extends CountOptions | number | FilterFn | null | undefined>(left: NodeOrToken, right: NodeOrToken, countOptions?: Options): TokenResult<Options>[];
+/**
+ * Get the token starting at the specified index.
+ * @param index - Index of the start of the token's range.
+ * @param rangeOptions - Options object.
+ * @returns `Token` (or `Token | Comment` if `includeComments` is `true`), or `null` if none found.
+ */
+declare function getTokenByRangeStart<Options extends RangeOptions | null | undefined>(index: number, rangeOptions?: Options): TokenResult<Options> | null;
+/**
+ * Determine if two nodes or tokens have at least one whitespace character between them.
+ * Order does not matter.
+ *
+ * Returns `false` if the given nodes or tokens overlap.
+ *
+ * Checks for whitespace *between tokens*, not including whitespace *inside tokens*.
+ * e.g. Returns `false` for `isSpaceBetween(x, y)` in `x+" "+y`.
+ *
+ * @param first - The first node or token to check between.
+ * @param second - The second node or token to check between.
+ * @returns `true` if there is a whitespace character between
+ *   any of the tokens found between the two given nodes or tokens.
+ */
+declare function isSpaceBetween(first: NodeOrToken, second: NodeOrToken): boolean;
+/**
+ * Determine if two nodes or tokens have at least one whitespace character between them.
+ * Order does not matter.
+ *
+ * Returns `false` if the given nodes or tokens overlap.
+ *
+ * Checks for whitespace *between tokens*, not including whitespace *inside tokens*.
+ * e.g. Returns `false` for `isSpaceBetween(x, y)` in `x+" "+y`.
+ *
+ * Unlike `SourceCode#isSpaceBetween`, this function does return `true` if there is a `JSText` token between the two
+ * input tokens, and it contains whitespace.
+ * e.g. Returns `true` for `isSpaceBetweenTokens(x, slash)` in `<X>a b</X>`.
+ *
+ * @deprecated Use `sourceCode.isSpaceBetween` instead.
+ *
+ * @param first - The first node or token to check between.
+ * @param second - The second node or token to check between.
+ * @returns `true` if there is a whitespace character between
+ *   any of the tokens found between the two given nodes or tokens.
+ */
+declare function isSpaceBetweenTokens(first: NodeOrToken, second: NodeOrToken): boolean;
+//#endregion
 //#region src-js/plugins/source_code.d.ts
 declare const SOURCE_CODE: Readonly<{
   /**
@@ -3342,7 +3361,7 @@ declare const SOURCE_CODE: Readonly<{
   /**
    * Array of all tokens and comments in the file, in source order.
    */
-  readonly tokensAndComments: (Token | Comment)[];
+  readonly tokensAndComments: (TokenType | Comment)[];
   /**
    * Get the source code for the given node.
    * @param node? - The AST node to get the text for.
@@ -3772,7 +3791,7 @@ interface RuleMeta {
    * Type of fixes that the rule provides.
    * Must be `'code'` or `'whitespace'` if the rule provides fixes.
    */
-  fixable?: "code" | "whitespace";
+  fixable?: "code" | "whitespace" | null | undefined;
   /**
    * Specifies whether rule can return suggestions.
    * Must be `true` if the rule provides suggestions.
@@ -3963,4 +3982,4 @@ declare function defineRule(rule: Rule): Rule;
  */
 declare function eslintCompatPlugin(plugin: Plugin): Plugin;
 //#endregion
-export { type AfterHook, type BeforeHook, type BooleanToken, type Comment, type Context, type CountOptions, type CreateOnceRule, type CreateRule, type Definition, type DefinitionType, type Diagnostic, type DiagnosticData, type types_d_exports as ESTree, type Envs, type FilterFn, type Fix, type FixFn, type Fixer, type Globals, type IdentifierToken, type JSXIdentifierToken, type JSXTextToken, type KeywordToken, type LanguageOptions, type LineColumn, type Location, type Node, type NullToken, type NumericToken, type Options, type Plugin, type PrivateIdentifierToken, type PunctuatorToken, type Range, type RangeOptions, type Ranged, type Reference, type RegularExpressionToken, type Rule, type RuleDeprecatedInfo, type RuleDocs, type RuleMeta, type RuleOptionsSchema, type RuleReplacedByExternalSpecifier, type RuleReplacedByInfo, type Scope, type ScopeManager, type ScopeType, type Settings, type SkipOptions, type SourceCode, type Span, type StringToken, type Suggestion, type TemplateToken, type Token, type Variable, type VisitorObject as Visitor, type VisitorWithHooks, definePlugin, defineRule, eslintCompatPlugin };
+export { type AfterHook, type BeforeHook, type BooleanToken, type Comment, type Context, type CountOptions, type CreateOnceRule, type CreateRule, type Definition, type DefinitionType, type Diagnostic, type DiagnosticData, type types_d_exports as ESTree, type Envs, type FilterFn, type Fix, type FixFn, type Fixer, type Globals, type IdentifierToken, type JSXIdentifierToken, type JSXTextToken, type KeywordToken, type LanguageOptions, type LineColumn, type Location, type Node, type NullToken, type NumericToken, type Options, type Plugin, type PrivateIdentifierToken, type PunctuatorToken, type Range, type RangeOptions, type Ranged, type Reference, type RegularExpressionToken, type Rule, type RuleDeprecatedInfo, type RuleDocs, type RuleMeta, type RuleOptionsSchema, type RuleReplacedByExternalSpecifier, type RuleReplacedByInfo, type Scope, type ScopeManager, type ScopeType, type Settings, type SkipOptions, type SourceCode, type Span, type StringToken, type Suggestion, type TemplateToken, type TokenType as Token, type Variable, type VisitorObject as Visitor, type VisitorWithHooks, definePlugin, defineRule, eslintCompatPlugin };

package/index.js

@@ -1,10 +1,42 @@
+//#region src-js/package/define.ts
+/**
+* Define a plugin.
+*
+* No-op function, just to provide type safety. Input is passed through unchanged.
+*
+* @param plugin - Plugin to define
+* @returns Same plugin as passed in
+*/
 function definePlugin(plugin) {
 	return plugin;
 }
+/**
+* Define a rule.
+*
+* No-op function, just to provide type safety. Input is passed through unchanged.
+*
+* @param rule - Rule to define
+* @returns Same rule as passed in
+*/
 function defineRule(rule) {
 	return rule;
 }
+//#endregion
+//#region src-js/package/compat.ts
 const EMPTY_VISITOR = {};
+/**
+* Convert a plugin which used Oxlint's `createOnce` API to also work with ESLint.
+*
+* If any of the plugin's rules use the Oxlint alternative `createOnce` API,
+* add ESLint-compatible `create` methods to those rules, which delegate to `createOnce`.
+* This makes the plugin compatible with ESLint.
+*
+* The `plugin` object passed in is mutated in-place.
+*
+* @param plugin - Plugin to convert
+* @returns Plugin with all rules having `create` method
+* @throws {Error} If `plugin` is not an object, or `plugin.rules` is not an object
+*/
 function eslintCompatPlugin(plugin) {
 	if (typeof plugin != "object" || !plugin) throw Error("Plugin must be an object");
 	let { rules } = plugin;
@@ -12,6 +44,14 @@ function eslintCompatPlugin(plugin) {
 	for (let ruleName in rules) Object.hasOwn(rules, ruleName) && convertRule(rules[ruleName]);
 	return plugin;
 }
+/**
+* Convert a rule.
+*
+* The `rule` object passed in is mutated in-place.
+*
+* @param rule - Rule to convert
+* @throws {Error} If `rule` is not an object
+*/
 function convertRule(rule) {
 	if (typeof rule != "object" || !rule) throw Error("Rule must be an object");
 	if ("create" in rule) return;
@@ -63,13 +103,19 @@ const FILE_CONTEXT = Object.freeze({
 		throw Error("Cannot access `context.parserPath` in `createOnce`");
 	}
 });
+/**
+* Call `createOnce` method of rule, and return `Context`, `Visitor`, and `beforeHook` (if any).
+*
+* @param rule - Rule with `createOnce` method
+* @returns Object with `context`, `visitor`, and `beforeHook` properties
+*/
 function createContextAndVisitor(rule) {
 	let { createOnce } = rule;
 	if (createOnce == null) throw Error("Rules must define either a `create` or `createOnce` method");
 	if (typeof createOnce != "function") throw Error("Rule `createOnce` property must be a function");
 	let context = Object.create(FILE_CONTEXT, {
 		id: {
-			value: "",
+			value: null,
 			enumerable: !0,
 			configurable: !0
 		},
@@ -79,7 +125,9 @@ function createContextAndVisitor(rule) {
 			configurable: !0
 		},
 		report: {
-			value: null,
+			value() {
+				throw Error("Cannot report errors in `createOnce`");
+			},
 			enumerable: !0,
 			configurable: !0
 		}
@@ -107,4 +155,5 @@ function createContextAndVisitor(rule) {
 		beforeHook
 	};
 }
+//#endregion
 export { definePlugin, defineRule, eslintCompatPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxlint/plugins",
-  "version": "1.51.0",
+  "version": "1.52.0",
   "description": "Plugin utilities for Oxlint",
   "keywords": [
     "eslint",