@rrlab/oxc-plugin 0.1.1 → 0.1.2-git-c5c6e0f.0

package/README.md

@@ -1,6 +1,6 @@
 # @rrlab/oxc-plugin
 
-[oxc](https://oxc.rs) plugin for [`@rrlab/cli`](https://npmjs.com/package/@rrlab/cli). Provides `lint` (oxlint) and `format` (oxfmt) capabilities.
+[oxc](https://oxc.rs) plugin for [`@rrlab/cli`](https://npmjs.com/package/@rrlab/cli). Provides `lint` (oxlint), `format` (oxfmt), and `tsc` (oxlint type-aware) capabilities.
 
 ## Install
 
@@ -8,17 +8,37 @@
 rr plugins add oxc
 ```
 
-Installs `@rrlab/oxc-plugin` and adds `oxlint`, `oxfmt`, and `oxlint-tsgolint` (optional) as `devDependencies`. No config file is scaffolded — oxlint and oxfmt work with sensible defaults and the projects that need to customise add their own `oxlintrc.json` / `.oxfmtrc` on demand.
+Installs `@rrlab/oxc-plugin` and adds `oxlint`, `oxfmt`, and `oxlint-tsgolint` as `devDependencies`. No config file is scaffolded — oxlint and oxfmt work with sensible defaults and the projects that need to customise add their own `oxlintrc.json` / `.oxfmtrc` on demand.
 
 For `rr jsc` (lint + format together), the kernel composes oxlint + oxfmt automatically when both capabilities are present and no plugin provides `jsc` directly.
 
 ## What it provides
 
-| Capability | Surface |
-|---|---|
-| `lint` | `rr lint`, `rr lint doctor` |
-| `format` | `rr format`, `rr format doctor` |
-| `jsc` (composed) | `rr jsc` (synthesised lint + format) |
+| Capability | Surface | Underlying command |
+|---|---|---|
+| `lint` | `rr lint`, `rr lint doctor` | `oxlint --check` / `--fix` |
+| `format` | `rr format`, `rr format doctor` | `oxfmt --check` / `--fix` |
+| `tsc` | `rr tsc`, `rr tsc doctor` | `oxlint --type-aware --type-check` (via `oxlint-tsgolint`) |
+| `jsc` (composed) | `rr jsc` (synthesised lint + format) | |
+
+## Picking only some capabilities
+
+Pass `only` to mix oxc with another plugin. Example: biome for lint+format, oxc just for the type-aware checks:
+
+```ts
+import biome from "@rrlab/biome-plugin";
+import oxc from "@rrlab/oxc-plugin";
+import { defineConfig } from "@rrlab/cli/config";
+
+export default defineConfig({
+  plugins: [
+    biome({ only: ["lint", "format"] }),
+    oxc({ only: ["tsc"] }),
+  ],
+});
+```
+
+The `only` array is typed against the kinds *this* plugin provides (`"lint" | "format" | "tsc"` for oxc), so typos like `oxc({ only: ["pack"] })` are caught at compile time.
 
 ## Removal
 

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { FormatOptions, Formatter, InstallContext, InstallResult, LintOptions, Linter, ToolService, UninstallContext, UninstallResult } from "@rrlab/cli/plugin";
+import { FormatOptions, Formatter, InstallContext, InstallResult, LintOptions, Linter, ToolService, TypeCheckOptions, TypeChecker, UninstallContext, UninstallResult } from "@rrlab/cli/plugin";
 import { ShellService } from "@vlandoss/clibuddy";
 
 //#region src/tool-versions.d.ts
@@ -26,8 +26,14 @@ declare class OxfmtService extends ToolService implements Formatter {
   constructor(shellService: ShellService);
   format(options: FormatOptions): Promise<void>;
 }
+declare class OxlintTypeCheckService extends ToolService implements TypeChecker {
+  constructor(shellService: ShellService);
+  check(options?: TypeCheckOptions): Promise<void>;
+}
 declare function install(_ctx: InstallContext): Promise<InstallResult>;
 declare function uninstall(_ctx: UninstallContext): Promise<UninstallResult>;
-declare const oxc: (options: void) => import("@rrlab/cli/plugin").Plugin;
+declare const oxc: (options?: {
+  only?: readonly ("lint" | "format" | "tsc")[] | undefined;
+} | undefined) => import("@rrlab/cli/plugin").Plugin;
 //#endregion
-export { OxfmtService, OxlintService, TOOL_VERSIONS, oxc as default, install, uninstall };
+export { OxfmtService, OxlintService, OxlintTypeCheckService, TOOL_VERSIONS, oxc as default, install, uninstall };

package/dist/index.mjs

@@ -47,6 +47,22 @@ var OxfmtService = class extends ToolService {
 		await this.exec(["--no-error-on-unmatched-pattern", options.fix ? "--fix" : "--check"]);
 	}
 };
+var OxlintTypeCheckService = class extends ToolService {
+	constructor(shellService) {
+		super({
+			pkg: "oxlint",
+			ui: UI_LINT,
+			shellService,
+			from: FROM
+		});
+	}
+	async check(options = {}) {
+		await this.exec(["--type-aware", "--type-check"], {
+			cwd: options.cwd,
+			verbose: !options.cwd
+		});
+	}
+};
 async function install(_ctx) {
 	return { devDependencies: {
 		oxlint: TOOL_VERSIONS.oxlint.install,
@@ -66,19 +82,11 @@ const oxc = definePlugin(() => ({
 	apiVersion: 1,
 	install,
 	uninstall,
-	async setup({ shell }) {
-		const lintSvc = new OxlintService(shell);
-		const fmtSvc = new OxfmtService(shell);
-		try {
-			await Promise.all([lintSvc.getBinDir(), fmtSvc.getBinDir()]);
-		} catch (_err) {
-			throw new Error("@rrlab/oxc-plugin requires oxlint and oxfmt to be installed in the host project. Run: rr plugins add oxc  (or: pnpm add -D oxlint oxfmt)");
-		}
-		return {
-			lint: lintSvc,
-			format: fmtSvc
-		};
-	}
+	capabilities: ({ shell }) => ({
+		lint: new OxlintService(shell),
+		format: new OxfmtService(shell),
+		tsc: new OxlintTypeCheckService(shell)
+	})
 }));
 //#endregion
-export { OxfmtService, OxlintService, TOOL_VERSIONS, oxc as default, install, uninstall };
+export { OxfmtService, OxlintService, OxlintTypeCheckService, TOOL_VERSIONS, oxc as default, install, uninstall };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rrlab/oxc-plugin",
-  "version": "0.1.1",
+  "version": "0.1.2-git-c5c6e0f.0",
   "description": "oxc plugin for @rrlab/cli — provides lint (oxlint) and format (oxfmt) capabilities.",
   "homepage": "https://github.com/variableland/dx/tree/main/run-run/oxc-plugin#readme",
   "bugs": {
@@ -39,7 +39,7 @@
     "oxfmt": ">=0.30.0",
     "oxlint": ">=1.0.0",
     "oxlint-tsgolint": ">=0.15.0",
-    "@rrlab/cli": "0.0.3"
+    "@rrlab/cli": "0.0.4-git-c5c6e0f.0"
   },
   "peerDependenciesMeta": {
     "oxlint-tsgolint": {
@@ -50,7 +50,7 @@
     "oxfmt": "0.35.0",
     "oxlint": "1.50.0",
     "oxlint-tsgolint": "0.15.0",
-    "@rrlab/cli": "0.0.3",
+    "@rrlab/cli": "0.0.4-git-c5c6e0f.0",
     "@rrlab/tsdown-config": "^0.1.0"
   },
   "scripts": {

package/src/index.ts

@@ -7,6 +7,8 @@ import {
   type Linter,
   type LintOptions,
   ToolService,
+  type TypeChecker,
+  type TypeCheckOptions,
   type UninstallContext,
   type UninstallResult,
 } from "@rrlab/cli/plugin";
@@ -40,6 +42,16 @@ export class OxfmtService extends ToolService implements Formatter {
   }
 }
 
+export class OxlintTypeCheckService extends ToolService implements TypeChecker {
+  constructor(shellService: ShellService) {
+    super({ pkg: "oxlint", ui: UI_LINT, shellService, from: FROM });
+  }
+
+  async check(options: TypeCheckOptions = {}): Promise<void> {
+    await this.exec(["--type-aware", "--type-check"], { cwd: options.cwd, verbose: !options.cwd });
+  }
+}
+
 export async function install(_ctx: InstallContext): Promise<InstallResult> {
   return {
     devDependencies: {
@@ -54,27 +66,16 @@ export async function uninstall(_ctx: UninstallContext): Promise<UninstallResult
   return { removeDependencies: ["oxlint", "oxfmt", "oxlint-tsgolint"] };
 }
 
-const oxc = definePlugin<void>(() => ({
+const oxc = definePlugin(() => ({
   name: "oxc",
   apiVersion: 1,
   install,
   uninstall,
-  async setup({ shell }) {
-    const lintSvc = new OxlintService(shell);
-    const fmtSvc = new OxfmtService(shell);
-    try {
-      await Promise.all([lintSvc.getBinDir(), fmtSvc.getBinDir()]);
-    } catch (_err) {
-      throw new Error(
-        "@rrlab/oxc-plugin requires oxlint and oxfmt to be installed in the host project. " +
-          "Run: rr plugins add oxc  (or: pnpm add -D oxlint oxfmt)",
-      );
-    }
-    return {
-      lint: lintSvc,
-      format: fmtSvc,
-    };
-  },
+  capabilities: ({ shell }) => ({
+    lint: new OxlintService(shell),
+    format: new OxfmtService(shell),
+    tsc: new OxlintTypeCheckService(shell),
+  }),
 }));
 
 export default oxc;