@biomejs/runtime 2.6.5 → 2.6.7

package/js_ast.d.ts

@@ -1985,6 +1985,17 @@ export interface JsSvelteDeclarationRoot extends JsAstNode {
 	token(field: "semicolonToken" | "eofToken"): JsAstToken | undefined;
 	token(field: string): JsAstToken | undefined;
 }
+export interface JsSvelteLegacyConstRoot extends JsAstNode {
+	readonly kind: "JS_SVELTE_LEGACY_CONST_ROOT";
+	readonly declarator: AnyJsSvelteLegacyConstDeclarator | undefined;
+	withDeclarator(
+		value: AnyJsSvelteLegacyConstDeclarator,
+	): JsSvelteLegacyConstRoot;
+	readonly eofToken: string | undefined;
+	withEofToken(value: JsAstToken): JsSvelteLegacyConstRoot;
+	token(field: "eofToken"): JsAstToken | undefined;
+	token(field: string): JsAstToken | undefined;
+}
 export interface JsSvelteSnippetRoot extends JsAstNode {
 	readonly kind: "JS_SVELTE_SNIPPET_ROOT";
 	readonly name: AnyJsBinding | undefined;
@@ -4194,6 +4205,7 @@ export type AnyJsRoot =
 	| JsModule
 	| JsScript
 	| JsSvelteDeclarationRoot
+	| JsSvelteLegacyConstRoot
 	| JsSvelteSnippetRoot
 	| JsVueGenericRoot
 	| JsVueSlotPropsRoot
@@ -4235,6 +4247,7 @@ export type AnyJsStatement =
 export type AnyJsSvelteDeclaration =
 	| JsBogusVariableDeclaration
 	| JsVariableDeclaration;
+export type AnyJsSvelteLegacyConstDeclarator = JsBogus | JsVariableDeclarator;
 export type AnyJsSwitchClause = JsCaseClause | JsDefaultClause;
 export type AnyJsTemplateElement = JsTemplateChunkElement | JsTemplateElement;
 export type AnyJsVueGenericTypeParameters = JsBogus | TsTypeParameterList;
@@ -4517,6 +4530,7 @@ export interface JsNodeByKind {
 	readonly JS_STRING_LITERAL_EXPRESSION: JsStringLiteralExpression;
 	readonly JS_SUPER_EXPRESSION: JsSuperExpression;
 	readonly JS_SVELTE_DECLARATION_ROOT: JsSvelteDeclarationRoot;
+	readonly JS_SVELTE_LEGACY_CONST_ROOT: JsSvelteLegacyConstRoot;
 	readonly JS_SVELTE_SNIPPET_ROOT: JsSvelteSnippetRoot;
 	readonly JS_SWITCH_STATEMENT: JsSwitchStatement;
 	readonly JS_TEMPLATE_CHUNK_ELEMENT: JsTemplateChunkElement;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biomejs/runtime",
-  "version": "2.6.5",
+  "version": "2.6.7",
   "description": "JavaScript APIs for Biome JS plugins",
   "scripts": {
     "test:types": "tsc --project tsconfig.json"
@@ -34,7 +34,7 @@
     "typescript": "7.0.2"
   },
   "peerDependencies": {
-    "@biomejs/biome": "^2.6.5"
+    "@biomejs/biome": "^2.6.7"
   },
   "publishConfig": {
     "provenance": true

package/plugin.d.ts

@@ -14,24 +14,43 @@ export * from "./js_ast";
 export * from "./semantic";
 
 declare const queriedNode: unique symbol;
+declare const queryContext: unique symbol;
 declare const nativeMutation: unique symbol;
 declare const nodeKindSet: unique symbol;
 declare const tokenKindSet: unique symbol;
 
 /**
- * A query matching AST nodes by their syntax kinds, created with {@link ast}.
+ * A query created with {@link ast} or {@link grit}.
  *
  * `N` is the union of the node types matched by the query; it only exists at
  * the type level, to infer the argument type of {@link Rule#run}.
  */
-interface Query<N extends JsAstNode, K extends keyof ContextByQuery> {
-	readonly type: K;
-	readonly kinds: readonly (keyof JsNodeByKind)[];
+interface Query<N extends JsAstNode | JsAstToken, C> {
+	readonly type: "ast" | "grit";
 	readonly [queriedNode]?: N;
+	readonly [queryContext]?: C;
 }
 
-export type AstQuery<N extends JsAstNode> = Query<N, "ast">;
-export type SemanticQuery<N extends JsAstNode> = Query<N, "semantic">;
+export interface AstQuery<N extends JsAstNode, C = RuleContext>
+	extends Query<N, C> {
+	readonly type: "ast";
+	readonly kinds: readonly (keyof JsNodeByKind)[];
+}
+
+/**
+ * A query matching the nodes and tokens selected by a GritQL pattern, created
+ * with {@link grit}.
+ */
+export interface GritQuery<C = RuleContext> extends Query<JsAstElement, C> {
+	readonly type: "grit";
+	readonly pattern: string;
+}
+
+/**
+ * A Grit query created with `semantic: true`, whose `run` receives a semantic
+ * model.
+ */
+export type SemanticGritQuery = GritQuery<SemanticRuleContext>;
 
 /** File information supplied to each invocation of a rule. */
 export interface RuleContext {
@@ -47,11 +66,6 @@ export interface SemanticRuleContext extends RuleContext {
 	readonly model: SemanticModel;
 }
 
-type ContextByQuery = {
-	ast: RuleContext;
-	semantic: SemanticRuleContext;
-};
-
 /** JavaScript or TypeScript parsing settings for the analyzed source. */
 export interface JsFileSource {
 	readonly language:
@@ -94,17 +108,14 @@ export type JsEmbeddingKind =
  * A lint rule, created with {@link defineRule} and exported from the plugin
  * with `export const`. The name of the export is used as the rule name.
  */
-export interface Rule<
-	N extends JsAstNode,
-	K extends keyof ContextByQuery = "ast",
-> {
+export interface Rule<N extends JsAstElement, C = RuleContext> {
 	/**
 	 * The query selecting the nodes the rule runs on.
 	 */
-	readonly query: Query<N, K>;
+	readonly query: Query<N, C>;
 
 	/**
-	 * Called with every node matching the query.
+	 * Called with every node, or token for Grit queries, matching the query.
 	 * `context` information is read-only
 	 *
 	 * For example, inspect declarations only in TypeScript sources:
@@ -118,23 +129,18 @@ export interface Rule<
 	 * });
 	 * ```
 	 */
-	readonly run: (node: NoInfer<N>, context: NoInfer<ContextByQuery[K]>) => void;
+	readonly run: (node: NoInfer<N>, context: NoInfer<C>) => void;
 }
 
 /**
  * Creates a query matching every node of the given syntax kinds.
- */
-export function ast<K extends readonly (keyof JsNodeByKind)[]>(
-	...kinds: K
-): AstQuery<JsNodeByKind[K[number]]>;
-
-/**
- * Matches nodes by their syntax kinds and provides a semantic model in `context`.
+ *
+ * Pass `{ semantic: true }` to provide a semantic model in `context`.
  *
  * For example, inspect every read of a declared binding:
  * ```ts
  * export const inspectReads = defineRule({
- *   query: semantic("JS_IDENTIFIER_BINDING"),
+ *   query: ast("JS_IDENTIFIER_BINDING", { semantic: true }),
  *   run(node, context) {
  *     const binding = context.model.asBinding(node);
  *     for (const reference of binding?.allReads() ?? []) {
@@ -144,18 +150,58 @@ export function ast<K extends readonly (keyof JsNodeByKind)[]>(
  * });
  * ```
  */
-export function semantic<K extends readonly (keyof JsNodeByKind)[]>(
+export function ast<K extends readonly (keyof JsNodeByKind)[]>(
 	...kinds: K
-): SemanticQuery<JsNodeByKind[K[number]]>;
+): AstQuery<JsNodeByKind[K[number]]>;
+export function ast<K extends readonly (keyof JsNodeByKind)[]>(
+	...kinds: [...K, { semantic: true }]
+): AstQuery<JsNodeByKind[K[number]], SemanticRuleContext>;
+export function ast<K extends readonly (keyof JsNodeByKind)[]>(
+	...kinds: [...K, { semantic?: false }]
+): AstQuery<JsNodeByKind[K[number]]>;
+
+/**
+ * Creates a query matching the nodes selected by a GritQL pattern.
+ *
+ * The pattern runs against the analyzed file and `run` is called once for each
+ * match. When the pattern matches a list, such as several sibling statements,
+ * `run` is called for each node in the list. Patterns may also match leaf
+ * tokens, in which case `run` receives a token.
+ *
+ * The pattern cannot contain a rewrite. Report diagnostics from `run`
+ * instead. When the pattern matches a token, `run` receives a token and
+ * diagnostics can be reported on its `parent` node.
+ *
+ * Pass `{ semantic: true }` to provide a semantic model in `context`.
+ *
+ * For example, inspect console calls without a fixed list of syntax kinds:
+ * ```ts
+ * export const noConsole = defineRule({
+ *   query: grit("`console.log($args)`"),
+ *   run(element) {
+ *     if (element.kind !== "JS_CALL_EXPRESSION") return;
+ *     registerDiagnostic(element, "warning", "Unexpected console.log.");
+ *   },
+ * });
+ * ```
+ */
+export function grit(pattern: string): GritQuery;
+export function grit(
+	pattern: string,
+	options: { semantic: true },
+): SemanticGritQuery;
+export function grit(
+	pattern: string,
+	options?: { semantic?: false },
+): GritQuery;
 
 /**
  * Defines a lint rule. Export the returned rule with `export const` to
  * register it to the analyzer.
  */
-export function defineRule<
-	N extends JsAstNode,
-	K extends keyof ContextByQuery = "ast",
->(rule: Rule<N, K>): Rule<N, K>;
+export function defineRule<N extends JsAstElement, C = RuleContext>(
+	rule: Rule<N, C>,
+): Rule<N, C>;
 
 /**
  * Collects replacements and removals for one code fix without changing the

package/semantic.d.ts

@@ -67,7 +67,7 @@ export interface TextRange {
 
 /**
  * Bindings and references in one analyzed source snapshot.
- * Access it through `context.model` in a rule using `semantic(...)`.
+ * Access it through `context.model` in a rule using `ast(..., { semantic: true })`.
  *
  * Node arguments must belong to this model's source. Saved models and handles
  * retain their original source; prepared code fixes do not update the model.
@@ -79,7 +79,7 @@ export interface SemanticModel {
 	 * Resolves an identifier use to the binding it refers to, respecting shadowing.
 	 * Returns `undefined` for configured globals and unresolved references.
 	 *
-	 * In a rule querying `semantic("JS_REFERENCE_IDENTIFIER")`, highlight the
+	 * In a rule querying `ast("JS_REFERENCE_IDENTIFIER", { semantic: true })`, highlight the
 	 * declaration of the referenced name:
 	 * ```ts
 	 * const binding = context.model.binding(node);
@@ -93,7 +93,7 @@ export interface SemanticModel {
 	 * Looks up the binding introduced by a declaration's identifier node.
 	 * Returns `undefined` when the model does not track that declaration.
 	 *
-	 * In a rule querying `semantic("JS_IDENTIFIER_BINDING")`, report how many
+	 * In a rule querying `ast("JS_IDENTIFIER_BINDING", { semantic: true })`, report how many
 	 * references resolve to the declaration:
 	 * ```ts
 	 * const binding = context.model.asBinding(node);
@@ -185,7 +185,7 @@ export interface SemanticModel {
 	 * Returns the scope a declaration's identifier was hoisted to, if the model
 	 * records one. This can differ from the scope containing its source text.
 	 *
-	 * In a rule querying `semantic("JS_IDENTIFIER_BINDING")`, inspect hoisting:
+	 * In a rule querying `ast("JS_IDENTIFIER_BINDING", { semantic: true })`, inspect hoisting:
 	 * ```ts
 	 * const scope = context.model.scopeHoistedTo(node);
 	 * if (scope) {
@@ -222,7 +222,7 @@ export interface SemanticModel {
 	 * Returns whether an identifier use resolves to a configured global.
 	 * Returns `false` for local bindings and unresolved references.
 	 *
-	 * In a rule querying `semantic("JS_REFERENCE_IDENTIFIER")`, distinguish
+	 * In a rule querying `ast("JS_REFERENCE_IDENTIFIER", { semantic: true })`, distinguish
 	 * configured globals from other identifier uses:
 	 * ```ts
 	 * if (context.model.isGlobalReference(node)) {
@@ -235,7 +235,7 @@ export interface SemanticModel {
 	 * Returns whether an identifier use has no local binding or configured global.
 	 * A reference to a declaration later in the source can still resolve.
 	 *
-	 * In a rule querying `semantic("JS_REFERENCE_IDENTIFIER")`, report names the
+	 * In a rule querying `ast("JS_REFERENCE_IDENTIFIER", { semantic: true })`, report names the
 	 * model cannot resolve:
 	 * ```ts
 	 * if (context.model.isUnresolvedReference(node)) {
@@ -248,7 +248,7 @@ export interface SemanticModel {
 	 * Returns whether a declaration is imported, or a reference resolves to an
 	 * imported declaration. Returns `false` when a reference has no local binding.
 	 *
-	 * In a rule querying `semantic("JS_REFERENCE_IDENTIFIER")`, highlight uses
+	 * In a rule querying `ast("JS_REFERENCE_IDENTIFIER", { semantic: true })`, highlight uses
 	 * of imported names:
 	 * ```ts
 	 * if (context.model.isImported(node)) {
@@ -261,7 +261,7 @@ export interface SemanticModel {
 	 * Returns whether a declaration is exported, or a reference resolves to an
 	 * exported declaration. Returns `false` when a reference has no local binding.
 	 *
-	 * In a rule querying `semantic("JS_IDENTIFIER_BINDING")`, highlight exported
+	 * In a rule querying `ast("JS_IDENTIFIER_BINDING", { semantic: true })`, highlight exported
 	 * declarations:
 	 * ```ts
 	 * if (context.model.isExported(node)) {