@sanity/groq-lint 0.0.1 → 0.0.2

package/dist/index.d.cts

@@ -0,0 +1,103 @@
+import { SchemaType } from 'groq-js';
+import { LinterConfig, Finding, Rule } from '@sanity/lint-core';
+export { Category, Finding, LinterConfig, Rule, RuleConfig, SchemaType, Severity, Suggestion, formatFindings, formatFindingsJson, summarizeFindings } from '@sanity/lint-core';
+
+/**
+ * Result of linting a query
+ */
+interface LintResult {
+    /** The query that was linted */
+    query: string;
+    /** Findings from the lint rules */
+    findings: Finding[];
+    /** Whether parsing failed */
+    parseError?: string;
+}
+/**
+ * Options for linting
+ */
+interface LintOptions {
+    /** Linter configuration */
+    config?: LinterConfig;
+    /** Schema for schema-aware rules */
+    schema?: SchemaType;
+    /** Force use of TypeScript rules even when WASM is available */
+    forceTs?: boolean;
+}
+/**
+ * Initialize the WASM linter for better performance
+ *
+ * Call this once at application startup. The linter will automatically
+ * fall back to TypeScript rules if WASM is not available.
+ *
+ * @returns Promise that resolves to true if WASM is available
+ *
+ * @example
+ * ```typescript
+ * import { initLinter, lint } from '@sanity/groq-lint'
+ *
+ * // Optional: Initialize WASM for better performance
+ * await initLinter()
+ *
+ * // Now lint() will use WASM for pure GROQ rules
+ * const result = lint('*[_type == "post"]{ author-> }')
+ * ```
+ */
+declare function initLinter(): Promise<boolean>;
+/**
+ * Lint a GROQ query
+ *
+ * Uses WASM for pure GROQ rules (if available) and TypeScript for schema-aware rules.
+ * Call `initLinter()` first to enable WASM support.
+ *
+ * @param query - The GROQ query string to lint
+ * @param options - Optional configuration and schema
+ * @returns Lint result with findings
+ */
+declare function lint(query: string, options?: LintOptions): LintResult;
+/**
+ * Lint multiple queries
+ *
+ * @param queries - Array of queries to lint
+ * @param options - Optional configuration and schema
+ * @returns Array of lint results
+ */
+declare function lintMany(queries: string[], options?: LintOptions): LintResult[];
+
+/**
+ * WASM-based linter for pure GROQ rules
+ *
+ * Uses @sanity/groq-wasm for high-performance linting of GROQ queries.
+ * Falls back gracefully if WASM is not available.
+ */
+
+/**
+ * Rules available in the WASM linter (from Rust groq-lint)
+ */
+declare const WASM_RULES: Set<string>;
+/**
+ * Check if WASM linter is available
+ */
+declare function isWasmAvailable(): boolean;
+
+/**
+ * Rule: join-in-filter
+ *
+ * Detects dereference operators (->) inside filter constraints.
+ * This is a performance anti-pattern because it prevents query optimization.
+ *
+ * Bad:  *[author->name == "Bob"]
+ * Good: *[_type == "post" && author._ref == $authorId]
+ */
+declare const joinInFilter: Rule;
+
+/**
+ * All available lint rules
+ */
+declare const rules: Rule[];
+/**
+ * Rules indexed by ID for quick lookup
+ */
+declare const rulesById: Record<string, Rule>;
+
+export { type LintOptions, type LintResult, WASM_RULES, initLinter, isWasmAvailable, joinInFilter, lint, lintMany, rules, rulesById };