chore(oxlint/napi): add createWorkspace & destroyWorkspace js callback function

Author: Sysix

apps/oxlint/src-js/bindings.d.ts

@@ -1,16 +1,20 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-/** JS callback to clear loaded plugins. */
-export type JsClearLoadedPluginCb =
-  (() => void)
+/** JS callback to create a workspace. */
+export type JsCreateWorkspaceCb =
+  ((arg0: string) => Promise<undefined>)
+
+/** JS callback to destroying a workspace. */
+export type JsDestroyWorkspaceCb =
+  ((arg0: string) => void)
 
 /** JS callback to lint a file. */
 export type JsLintFileCb =
-  ((arg0: string, arg1: number, arg2: Uint8Array | undefined | null, arg3: Array<number>, arg4: string) => string)
+  ((arg0: string, arg1: string, arg2: number, arg3: Uint8Array | undefined | null, arg4: Array<number>, arg5: string) => string)
 
 /** JS callback to load a JS plugin. */
 export type JsLoadPluginCb =
-  ((arg0: string, arg1?: string | undefined | null) => Promise<string>)
+  ((arg0: string, arg1: string, arg2?: string | undefined | null) => Promise<string>)
 
 /**
  * NAPI entry point.
@@ -19,8 +23,9 @@ export type JsLoadPluginCb =
  * 1. `args`: Command line arguments (process.argv.slice(2))
  * 2. `load_plugin`: Load a JS plugin from a file path.
  * 3. `lint_file`: Lint a file.
- * 4. `clear_loaded_plugin`: Clear loaded plugin state.
+ * 4. `create_workspace`: Create a new workspace.
+ * 5. `destroy_workspace`: Destroy a workspace.
  *
  * Returns `true` if linting succeeded without errors, `false` otherwise.
  */
-export declare function lint(args: Array<string>, loadPlugin: JsLoadPluginCb, lintFile: JsLintFileCb, clearLoadedPlugin: JsClearLoadedPluginCb): Promise<boolean>
+export declare function lint(args: Array<string>, loadPlugin: JsLoadPluginCb, lintFile: JsLintFileCb, createWorkspace: JsCreateWorkspaceCb, destroyWorkspace: JsDestroyWorkspaceCb): Promise<boolean>

apps/oxlint/src-js/cli.ts

@@ -6,35 +6,42 @@ import { debugAssertIsNonNull } from "./utils/asserts.js";
 // are identical. Ditto `lintFile` and `lintFileWrapper`.
 let loadPlugin: typeof loadPluginWrapper | null = null;
 let lintFile: typeof lintFileWrapper | null = null;
-let clearLoadedPlugin: typeof clearLoadedPluginWrapper | null = null;
+let createWorkspace: typeof createWorkspaceWrapper | null = null;
+let destroyWorkspace: typeof destroyWorkspaceWrapper | null = null;
 
 /**
  * Load a plugin.
  *
  * Lazy-loads plugins code on first call, so that overhead is skipped if user doesn't use JS plugins.
  *
+ * @param workspaceDir - Workspace root directory
  * @param path - Absolute path of plugin file
  * @param packageName - Optional package name from `package.json` (fallback if `plugin.meta.name` is not defined)
  * @returns Plugin details or error serialized to JSON string
  */
-function loadPluginWrapper(path: string, packageName: string | null): Promise<string> {
+function loadPluginWrapper(
+  workspaceDir: string,
+  path: string,
+  packageName: string | null,
+): Promise<string> {
   if (loadPlugin === null) {
     // Use promises here instead of making `loadPluginWrapper` an async function,
     // to avoid a micro-tick and extra wrapper `Promise` in all later calls to `loadPluginWrapper`
     return import("./plugins/index.js").then((mod) => {
-      ({ loadPlugin, lintFile, clearLoadedPlugin } = mod);
-      return loadPlugin(path, packageName);
+      ({ loadPlugin, lintFile, createWorkspace, destroyWorkspace } = mod);
+      return loadPlugin(workspaceDir, path, packageName);
     });
   }
   debugAssertIsNonNull(loadPlugin);
-  return loadPlugin(path, packageName);
+  return loadPlugin(workspaceDir, path, packageName);
 }
 
 /**
  * Lint a file.
  *
  * Delegates to `lintFile`, which was lazy-loaded by `loadPluginWrapper`.
  *
+ * @param workspaceDir - Directory of the workspace
  * @param filePath - Absolute path of file being linted
  * @param bufferId - ID of buffer containing file data
  * @param buffer - Buffer containing file data, or `null` if buffer with this ID was previously sent to JS
@@ -43,6 +50,7 @@ function loadPluginWrapper(path: string, packageName: string | null): Promise<st
  * @returns Diagnostics or error serialized to JSON string
  */
 function lintFileWrapper(
+  rootDir: string,
   filePath: string,
   bufferId: number,
   buffer: Uint8Array | null,
@@ -52,26 +60,54 @@ function lintFileWrapper(
   // `lintFileWrapper` is never called without `loadPluginWrapper` being called first,
   // so `lintFile` must be defined here
   debugAssertIsNonNull(lintFile);
-  return lintFile(filePath, bufferId, buffer, ruleIds, settingsJSON);
+  return lintFile(rootDir, filePath, bufferId, buffer, ruleIds, settingsJSON);
 }
 
 /**
- * Clear loaded plugin state.
+ * Create a new workspace.
  *
- * Delegates to `clearLoadedPlugin`, which was lazy-loaded by `loadPluginWrapper`.
- * If plugins haven't been loaded yet, this is a no-op.
+ * Delegates to `createWorkspace`, which was lazy-loaded by `createWorkspaceWrapper`.
+ *
+ * @param rootDir - Root directory of the workspace
+ * @returns Promise that resolves when workspace is created
  */
-function clearLoadedPluginWrapper(): void {
-  if (clearLoadedPlugin !== null) {
-    clearLoadedPlugin();
+function createWorkspaceWrapper(rootDir: string): Promise<undefined> {
+  if (createWorkspace === null) {
+    // Use promises here instead of making `createWorkspaceWrapper` an async function,
+    // to avoid a micro-tick and extra wrapper `Promise` in all later calls to `createWorkspaceWrapper`
+    return import("./plugins/index.js").then((mod) => {
+      ({ loadPlugin, lintFile, createWorkspace, destroyWorkspace } = mod);
+      return createWorkspace(rootDir);
+    });
   }
+
+  debugAssertIsNonNull(createWorkspace);
+  return Promise.resolve(createWorkspace(rootDir));
+}
+
+/**
+ * Destroy a workspace.
+ *
+ * @param rootDir - Root directory of the workspace
+ */
+function destroyWorkspaceWrapper(rootDir: string): void {
+  // `destroyWorkspaceWrapper` is never called without `createWorkspaceWrapper` being called first,
+  // so `destroyWorkspace` must be defined here
+  debugAssertIsNonNull(destroyWorkspace);
+  destroyWorkspace(rootDir);
 }
 
 // Get command line arguments, skipping first 2 (node binary and script path)
 const args = process.argv.slice(2);
 
 // Call Rust, passing `loadPlugin`, `lintFile`, and `clearLoadedPlugin` as callbacks, and CLI arguments
-const success = await lint(args, loadPluginWrapper, lintFileWrapper, clearLoadedPluginWrapper);
+const success = await lint(
+  args,
+  loadPluginWrapper,
+  lintFileWrapper,
+  createWorkspaceWrapper,
+  destroyWorkspaceWrapper,
+);
 
 // Note: It's recommended to set `process.exitCode` instead of calling `process.exit()`.
 // `process.exit()` kills the process immediately and `stdout` may not be flushed before process dies.

apps/oxlint/src-js/index.ts

@@ -11,7 +11,16 @@ export type * as ESTree from "./generated/types.d.ts";
 export type { Context, LanguageOptions } from "./plugins/context.ts";
 export type { Fix, Fixer, FixFn } from "./plugins/fix.ts";
 export type { CreateOnceRule, CreateRule, Options, Plugin, Rule } from "./plugins/load.ts";
+export type { LineColumn, Location, Range, Ranged, Span } from "./plugins/location.ts";
 export type { Diagnostic, Suggestion } from "./plugins/report.ts";
+export type {
+  RuleDeprecatedInfo,
+  RuleDocs,
+  RuleMeta,
+  RuleOptionsSchema,
+  RuleReplacedByExternalSpecifier,
+  RuleReplacedByInfo,
+} from "./plugins/rule_meta.ts";
 export type {
   Definition,
   DefinitionType,
@@ -24,36 +33,27 @@ export type {
 export type { Settings } from "./plugins/settings.ts";
 export type { SourceCode } from "./plugins/source_code.ts";
 export type {
-  CountOptions,
-  FilterFn,
-  RangeOptions,
-  SkipOptions,
-  Token,
+  BlockCommentToken,
   BooleanToken,
   CommentToken,
-  BlockCommentToken,
-  LineCommentToken,
+  CountOptions,
+  FilterFn,
   IdentifierToken,
   JSXIdentifierToken,
   JSXTextToken,
   KeywordToken,
+  LineCommentToken,
   NullToken,
   NumericToken,
   PrivateIdentifierToken,
   PunctuatorToken,
+  RangeOptions,
   RegularExpressionToken,
+  SkipOptions,
   StringToken,
   TemplateToken,
+  Token,
 } from "./plugins/tokens.ts";
-export type {
-  RuleMeta,
-  RuleDocs,
-  RuleOptionsSchema,
-  RuleDeprecatedInfo,
-  RuleReplacedByInfo,
-  RuleReplacedByExternalSpecifier,
-} from "./plugins/rule_meta.ts";
-export type { LineColumn, Location, Range, Ranged, Span } from "./plugins/location.ts";
 export type {
   AfterHook,
   BeforeHook,
@@ -286,19 +286,3 @@ function createContextAndVisitor(rule: CreateOnceRule): {
 
   return { context, visitor, beforeHook };
 }
-
-/**
- * Clear all loaded plugins and rules.
- *
- * This function clears the internal state of registered plugins and rules,
- * allowing plugins to be reloaded from scratch. This is useful for the
- * language server when restarting or reloading configuration.
- *
- * Note: This function is lazy-loaded and will only be available after
- * the first plugin has been loaded. It will not have any effect if no
- * plugins have been loaded yet.
- */
-export async function clearLoadedPlugin(): Promise<void> {
-  const mod = await import("./plugins/index.js");
-  mod.clearLoadedPlugin();
-}

apps/oxlint/src-js/plugins/index.ts

@@ -1,4 +1,5 @@
 import { lintFile } from "./lint.js";
-import { clearLoadedPlugin, loadPlugin } from "./load.js";
+import { loadPlugin } from "./load.js";
+import { createWorkspace, destroyWorkspace } from "./workspace.js";
 
-export { clearLoadedPlugin, lintFile, loadPlugin };
+export { createWorkspace, destroyWorkspace, lintFile, loadPlugin };

apps/oxlint/src-js/plugins/lint.ts

@@ -1,10 +1,10 @@
-import { setupFileContext, resetFileContext } from "./context.js";
+import { debugAssertIsNonNull, typeAssertIs } from "../utils/asserts.js";
+import { getErrorMessage } from "../utils/utils.js";
+import { resetFileContext, setupFileContext } from "./context.js";
 import { registeredRules } from "./load.js";
 import { diagnostics } from "./report.js";
-import { setSettingsForFile, resetSettings } from "./settings.js";
+import { resetSettings, setSettingsForFile } from "./settings.js";
 import { ast, initAst, resetSourceAndAst, setupSourceForFile } from "./source_code.js";
-import { typeAssertIs, debugAssertIsNonNull } from "../utils/asserts.js";
-import { getErrorMessage } from "../utils/utils.js";
 import {
   addVisitorToCompiled,
   compiledVisitor,
@@ -41,6 +41,7 @@ const PARSER_SERVICES_DEFAULT: Record<string, unknown> = Object.freeze({});
  *
  * Main logic is in separate function `lintFileImpl`, because V8 cannot optimize functions containing try/catch.
  *
+ * @param workspaceDir - Directory of the workspace
  * @param filePath - Absolute path of file being linted
  * @param bufferId - ID of buffer containing file data
  * @param buffer - Buffer containing file data, or `null` if buffer with this ID was previously sent to JS
@@ -49,14 +50,15 @@ const PARSER_SERVICES_DEFAULT: Record<string, unknown> = Object.freeze({});
  * @returns Diagnostics or error serialized to JSON string
  */
 export function lintFile(
+  workspaceDir: string,
   filePath: string,
   bufferId: number,
   buffer: Uint8Array | null,
   ruleIds: number[],
   settingsJSON: string,
 ): string {
   try {
-    lintFileImpl(filePath, bufferId, buffer, ruleIds, settingsJSON);
+    lintFileImpl(workspaceDir, filePath, bufferId, buffer, ruleIds, settingsJSON);
     return JSON.stringify({ Success: diagnostics });
   } catch (err) {
     return JSON.stringify({ Failure: getErrorMessage(err) });
@@ -68,6 +70,7 @@ export function lintFile(
 /**
  * Run rules on a file.
  *
+ * @param workspaceDir - Directory of the workspace
  * @param filePath - Absolute path of file being linted
  * @param bufferId - ID of buffer containing file data
  * @param buffer - Buffer containing file data, or `null` if buffer with this ID was previously sent to JS
@@ -78,6 +81,7 @@ export function lintFile(
  * @throws {*} If any rule throws
  */
 function lintFileImpl(
+  workspaceDir: string,
   filePath: string,
   bufferId: number,
   buffer: Uint8Array | null,
@@ -133,10 +137,16 @@ function lintFileImpl(
 
   // Get visitors for this file from all rules
   initCompiledVisitor();
+  if (DEBUG) {
+    if (!registeredRules.has(workspaceDir))
+      throw new Error(`No registered rules for workspaceDir "${workspaceDir}"`);
+  }
+
+  const rules = registeredRules.get(workspaceDir)!;
 
   for (let i = 0, len = ruleIds.length; i < len; i++) {
     const ruleId = ruleIds[i],
-      ruleDetails = registeredRules[ruleId];
+      ruleDetails = rules[ruleId];
 
     // Set `ruleIndex` for rule. It's used when sending diagnostics back to Rust.
     ruleDetails.ruleIndex = i;