@rrlab/oxc-plugin 0.0.1-git-06ed46c.0

package/README.md

@@ -0,0 +1,29 @@
+# @rrlab/oxc-plugin
+
+[oxc](https://oxc.rs) plugin for [`@rrlab/cli`](https://npmjs.com/package/@rrlab/cli). Provides `lint` (oxlint) and `format` (oxfmt) capabilities.
+
+## Install
+
+```sh
+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.
+
+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) |
+
+## Removal
+
+```sh
+rr plugins remove oxc
+```
+
+Removes `oxlint`, `oxfmt`, and `oxlint-tsgolint` from `package.json` and drops the `oxc()` entry from `run-run.config.{ts,mts}`. Tool config files (`oxlintrc.json`, `.oxfmtrc`) — if any — are left alone, they belong to the user.

package/dist/index.d.mts

@@ -0,0 +1,33 @@
+import { FormatOptions, Formatter, InstallContext, InstallResult, LintOptions, Linter, ToolService, UninstallContext, UninstallResult } from "@rrlab/cli/plugin";
+import { ShellService } from "@vlandoss/clibuddy";
+
+//#region src/tool-versions.d.ts
+declare const TOOL_VERSIONS: {
+  readonly oxlint: {
+    readonly install: "^1.0.0";
+    readonly peer: ">=1.0.0";
+  };
+  readonly oxfmt: {
+    readonly install: "^0.30.0";
+    readonly peer: ">=0.30.0";
+  };
+  readonly "oxlint-tsgolint": {
+    readonly install: "^0.15.0";
+    readonly peer: ">=0.15.0";
+  };
+};
+//#endregion
+//#region src/index.d.ts
+declare class OxlintService extends ToolService implements Linter {
+  constructor(shellService: ShellService);
+  lint(options: LintOptions): Promise<void>;
+}
+declare class OxfmtService extends ToolService implements Formatter {
+  constructor(shellService: ShellService);
+  format(options: FormatOptions): 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;
+//#endregion
+export { OxfmtService, OxlintService, TOOL_VERSIONS, oxc as default, install, uninstall };

package/dist/index.mjs

@@ -0,0 +1,84 @@
+import { ToolService, definePlugin } from "@rrlab/cli/plugin";
+import { colorize } from "@vlandoss/clibuddy";
+//#region src/tool-versions.ts
+const TOOL_VERSIONS = {
+	oxlint: {
+		install: "^1.0.0",
+		peer: ">=1.0.0"
+	},
+	oxfmt: {
+		install: "^0.30.0",
+		peer: ">=0.30.0"
+	},
+	"oxlint-tsgolint": {
+		install: "^0.15.0",
+		peer: ">=0.15.0"
+	}
+};
+//#endregion
+//#region src/index.ts
+const FROM = import.meta.url;
+const oxColor = colorize("#32F3E9");
+const UI_LINT = oxColor("oxlint");
+const UI_FMT = oxColor("oxfmt");
+var OxlintService = class extends ToolService {
+	constructor(shellService) {
+		super({
+			pkg: "oxlint",
+			ui: UI_LINT,
+			shellService,
+			from: FROM
+		});
+	}
+	async lint(options) {
+		await this.exec(["--report-unused-disable-directives", options.fix ? "--fix" : "--check"]);
+	}
+};
+var OxfmtService = class extends ToolService {
+	constructor(shellService) {
+		super({
+			pkg: "oxfmt",
+			ui: UI_FMT,
+			shellService,
+			from: FROM
+		});
+	}
+	async format(options) {
+		await this.exec(["--no-error-on-unmatched-pattern", options.fix ? "--fix" : "--check"]);
+	}
+};
+async function install(_ctx) {
+	return { devDependencies: {
+		oxlint: TOOL_VERSIONS.oxlint.install,
+		oxfmt: TOOL_VERSIONS.oxfmt.install,
+		"oxlint-tsgolint": TOOL_VERSIONS["oxlint-tsgolint"].install
+	} };
+}
+async function uninstall(_ctx) {
+	return { removeDependencies: [
+		"oxlint",
+		"oxfmt",
+		"oxlint-tsgolint"
+	] };
+}
+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
+		};
+	}
+}));
+//#endregion
+export { OxfmtService, OxlintService, TOOL_VERSIONS, oxc as default, install, uninstall };

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@rrlab/oxc-plugin",
+  "version": "0.0.1-git-06ed46c.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": {
+    "url": "https://github.com/variableland/dx/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/variableland/dx.git",
+    "directory": "run-run/oxc-plugin"
+  },
+  "license": "MIT",
+  "author": "rcrd <rcrd@variable.land>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/__tests__",
+    "!src/**/*.test.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "@vlandoss/clibuddy": "0.6.1"
+  },
+  "peerDependencies": {
+    "oxfmt": ">=0.30.0",
+    "oxlint": ">=1.0.0",
+    "oxlint-tsgolint": ">=0.15.0",
+    "@rrlab/cli": "0.0.2-git-06ed46c.0"
+  },
+  "peerDependenciesMeta": {
+    "oxlint-tsgolint": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "oxfmt": "0.35.0",
+    "oxlint": "1.50.0",
+    "oxlint-tsgolint": "0.15.0",
+    "@rrlab/cli": "0.0.2-git-06ed46c.0",
+    "@rrlab/tsdown-config": "^0.0.1-git-06ed46c.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run"
+  }
+}

package/src/index.ts

@@ -0,0 +1,80 @@
+import {
+  definePlugin,
+  type FormatOptions,
+  type Formatter,
+  type InstallContext,
+  type InstallResult,
+  type Linter,
+  type LintOptions,
+  ToolService,
+  type UninstallContext,
+  type UninstallResult,
+} from "@rrlab/cli/plugin";
+import { colorize, type ShellService } from "@vlandoss/clibuddy";
+import { TOOL_VERSIONS } from "./tool-versions.ts";
+
+export { TOOL_VERSIONS } from "./tool-versions.ts";
+
+const FROM = import.meta.url;
+const oxColor = colorize("#32F3E9");
+const UI_LINT = oxColor("oxlint");
+const UI_FMT = oxColor("oxfmt");
+
+export class OxlintService extends ToolService implements Linter {
+  constructor(shellService: ShellService) {
+    super({ pkg: "oxlint", ui: UI_LINT, shellService, from: FROM });
+  }
+
+  async lint(options: LintOptions) {
+    await this.exec(["--report-unused-disable-directives", options.fix ? "--fix" : "--check"]);
+  }
+}
+
+export class OxfmtService extends ToolService implements Formatter {
+  constructor(shellService: ShellService) {
+    super({ pkg: "oxfmt", ui: UI_FMT, shellService, from: FROM });
+  }
+
+  async format(options: FormatOptions) {
+    await this.exec(["--no-error-on-unmatched-pattern", options.fix ? "--fix" : "--check"]);
+  }
+}
+
+export async function install(_ctx: InstallContext): Promise<InstallResult> {
+  return {
+    devDependencies: {
+      oxlint: TOOL_VERSIONS.oxlint.install,
+      oxfmt: TOOL_VERSIONS.oxfmt.install,
+      "oxlint-tsgolint": TOOL_VERSIONS["oxlint-tsgolint"].install,
+    },
+  };
+}
+
+export async function uninstall(_ctx: UninstallContext): Promise<UninstallResult> {
+  return { removeDependencies: ["oxlint", "oxfmt", "oxlint-tsgolint"] };
+}
+
+const oxc = definePlugin<void>(() => ({
+  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,
+    };
+  },
+}));
+
+export default oxc;

package/src/tool-versions.ts

@@ -0,0 +1,5 @@
+export const TOOL_VERSIONS = {
+  oxlint: { install: "^1.0.0", peer: ">=1.0.0" },
+  oxfmt: { install: "^0.30.0", peer: ">=0.30.0" },
+  "oxlint-tsgolint": { install: "^0.15.0", peer: ">=0.15.0" },
+} as const;