@rrlab/ts-plugin 0.1.1 → 0.1.2-git-2238423.0

package/dist/index.d.mts

@@ -5,7 +5,6 @@ import { ShellService } from "@vlandoss/clibuddy";
 declare const TOOL_VERSIONS: {
   readonly typescript: {
     readonly install: "^6.0.0";
-    readonly peer: ">=5.0.0";
   };
   readonly "@types/node": {
     readonly install: ">=20";
@@ -19,6 +18,8 @@ declare class TscService extends ToolService implements TypeChecker {
 }
 declare function install(ctx: InstallContext): Promise<InstallResult>;
 declare function uninstall(ctx: UninstallContext): Promise<UninstallResult>;
-declare const ts: (options: void) => import("@rrlab/cli/plugin").Plugin;
+declare const ts: (options?: {
+  only?: readonly "tsc"[] | undefined;
+} | undefined) => import("@rrlab/cli/plugin").Plugin;
 //#endregion
 export { TOOL_VERSIONS, TscService, ts as default, install, uninstall };

package/dist/index.mjs

@@ -1,14 +1,11 @@
 import fs from "node:fs/promises";
 import path from "node:path";
-import { ToolService, definePlugin } from "@rrlab/cli/plugin";
+import { ToolService, decideScaffold, definePlugin, pickPreset } from "@rrlab/cli/plugin";
 import { colorize } from "@vlandoss/clibuddy";
 import { parse } from "comment-json";
 //#region src/tool-versions.ts
 const TOOL_VERSIONS = {
-	typescript: {
-		install: "^6.0.0",
-		peer: ">=5.0.0"
-	},
+	typescript: { install: "^6.0.0" },
 	"@types/node": { install: ">=20" }
 };
 //#endregion
@@ -62,9 +59,17 @@ const PRESETS = {
 };
 const DEFAULT_PRESET = "no-dom-app";
 async function install(ctx) {
-	const scaffoldDecision = await decideScaffoldAction(ctx, await pathExists(path.join(ctx.appPkg.dirPath, TSCONFIG)));
+	const scaffoldDecision = await decideScaffold(ctx, {
+		label: TSCONFIG,
+		fileExists: await pathExists(path.join(ctx.appPkg.dirPath, TSCONFIG)),
+		patchHint: "update extends, keep my other settings"
+	});
 	if (scaffoldDecision === "skip") return { devDependencies: { typescript: TOOL_VERSIONS.typescript.install } };
-	const presetInfo = PRESETS[await pickPreset(ctx)];
+	const presetInfo = PRESETS[await pickPreset(ctx, {
+		message: "Which kind of TS project do you need?",
+		presets: PRESETS,
+		defaultPreset: DEFAULT_PRESET
+	})];
 	const devDependencies = {
 		typescript: TOOL_VERSIONS.typescript.install,
 		"@rrlab/ts-config": await ctx.release.resolve("@rrlab/ts-config")
@@ -123,51 +128,6 @@ async function uninstall(ctx) {
 		files
 	};
 }
-async function decideScaffoldAction(ctx, fileExists) {
-	if (!fileExists) {
-		if (ctx.flags.yes || ctx.flags.nonInteractive) return "create";
-		const choice = await ctx.prompts.confirm({
-			message: `Scaffold ${TSCONFIG} with an @rrlab/ts-config preset?`,
-			initialValue: true
-		});
-		if (ctx.prompts.isCancel(choice)) throw new Error("Cancelled by user.");
-		return choice ? "create" : "skip";
-	}
-	if (ctx.flags.yes || ctx.flags.nonInteractive) return "patch";
-	const choice = await ctx.prompts.select({
-		message: `${TSCONFIG} already exists. What do you want to do?`,
-		options: [
-			{
-				value: "patch",
-				label: "Patch — update extends, keep my other settings"
-			},
-			{
-				value: "skip",
-				label: "Skip — leave it alone"
-			},
-			{
-				value: "overwrite",
-				label: "Overwrite — replace with a fresh scaffold"
-			}
-		],
-		initialValue: "patch"
-	});
-	if (ctx.prompts.isCancel(choice)) throw new Error("Cancelled by user.");
-	return choice;
-}
-async function pickPreset(ctx) {
-	if (ctx.flags.yes || ctx.flags.nonInteractive) return DEFAULT_PRESET;
-	const choice = await ctx.prompts.select({
-		message: "Which kind of TS project do you need?",
-		options: Object.entries(PRESETS).map(([value, meta]) => ({
-			value,
-			label: meta.label
-		})),
-		initialValue: DEFAULT_PRESET
-	});
-	if (ctx.prompts.isCancel(choice)) throw new Error("Cancelled by user.");
-	return choice;
-}
 async function pathExists(p) {
 	try {
 		await fs.access(p);
@@ -181,15 +141,7 @@ const ts = definePlugin(() => ({
 	apiVersion: 1,
 	install,
 	uninstall,
-	async setup({ shell }) {
-		const svc = new TscService(shell);
-		try {
-			await svc.getBinDir();
-		} catch (_err) {
-			throw new Error("@rrlab/ts-plugin requires typescript to be installed in the host project. Run: rr plugins add ts  (or: pnpm add -D typescript)");
-		}
-		return { tsc: svc };
-	}
+	capabilities: ({ shell }) => ({ tsc: new TscService(shell) })
 }));
 //#endregion
 export { TOOL_VERSIONS, TscService, ts as default, install, uninstall };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rrlab/ts-plugin",
-  "version": "0.1.1",
+  "version": "0.1.2-git-2238423.0",
   "description": "TypeScript plugin for @rrlab/cli — provides the tsc capability.",
   "homepage": "https://github.com/variableland/dx/tree/main/run-run/ts-plugin#readme",
   "bugs": {
@@ -38,12 +38,14 @@
   },
   "peerDependencies": {
     "typescript": ">=5.0.0",
-    "@rrlab/cli": "0.0.3"
+    "@rrlab/cli": "0.0.4-git-2238423.0"
   },
   "devDependencies": {
+    "@types/semver": "^7.7.1",
+    "semver": "^7.8.1",
     "typescript": "6.0.3",
-    "@rrlab/cli": "0.0.3",
-    "@rrlab/tsdown-config": "^0.1.0"
+    "@rrlab/tsdown-config": "^0.1.0",
+    "@rrlab/cli": "0.0.4-git-2238423.0"
   },
   "scripts": {
     "build": "tsdown",

package/src/index.ts

@@ -1,10 +1,12 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 import {
+  decideScaffold,
   definePlugin,
   type FileOp,
   type InstallContext,
   type InstallResult,
+  pickPreset,
   ToolService,
   type TypeChecker,
   type TypeCheckOptions,
@@ -50,18 +52,24 @@ const PRESETS: Record<Preset, PresetInfo> = {
 
 const DEFAULT_PRESET: Preset = "no-dom-app";
 
-type ExistingFileAction = "skip" | "patch" | "overwrite";
-
 export async function install(ctx: InstallContext): Promise<InstallResult> {
   const tsconfigPath = path.join(ctx.appPkg.dirPath, TSCONFIG);
   const fileExists = await pathExists(tsconfigPath);
+  const scaffoldDecision = await decideScaffold(ctx, {
+    label: TSCONFIG,
+    fileExists,
+    patchHint: "update extends, keep my other settings",
+  });
 
-  const scaffoldDecision = await decideScaffoldAction(ctx, fileExists);
   if (scaffoldDecision === "skip") {
     return { devDependencies: { typescript: TOOL_VERSIONS.typescript.install } };
   }
 
-  const preset = await pickPreset(ctx);
+  const preset = await pickPreset(ctx, {
+    message: "Which kind of TS project do you need?",
+    presets: PRESETS,
+    defaultPreset: DEFAULT_PRESET,
+  });
   const presetInfo = PRESETS[preset];
 
   const devDependencies: Record<string, string> = {
@@ -96,7 +104,6 @@ export async function uninstall(ctx: UninstallContext): Promise<UninstallResult>
     return { removeDependencies };
   }
 
-  // Read the current tsconfig to decide between full delete and surgical unset.
   let existing: Record<string, unknown> | undefined;
   try {
     const text = await fs.readFile(tsconfigPath, "utf8");
@@ -119,51 +126,6 @@ export async function uninstall(ctx: UninstallContext): Promise<UninstallResult>
   return { removeDependencies, files };
 }
 
-async function decideScaffoldAction(
-  ctx: InstallContext,
-  fileExists: boolean,
-): Promise<"create" | "patch" | "overwrite" | "skip"> {
-  if (!fileExists) {
-    if (ctx.flags.yes || ctx.flags.nonInteractive) return "create";
-    const choice = await ctx.prompts.confirm({
-      message: `Scaffold ${TSCONFIG} with an @rrlab/ts-config preset?`,
-      initialValue: true,
-    });
-    if (ctx.prompts.isCancel(choice)) throw new Error("Cancelled by user.");
-    return choice ? "create" : "skip";
-  }
-
-  // Existing file. Default to patch for migration safety.
-  if (ctx.flags.yes || ctx.flags.nonInteractive) return "patch";
-
-  const choice = await ctx.prompts.select<ExistingFileAction>({
-    message: `${TSCONFIG} already exists. What do you want to do?`,
-    options: [
-      { value: "patch", label: "Patch — update extends, keep my other settings" },
-      { value: "skip", label: "Skip — leave it alone" },
-      { value: "overwrite", label: "Overwrite — replace with a fresh scaffold" },
-    ],
-    initialValue: "patch",
-  });
-  if (ctx.prompts.isCancel(choice)) throw new Error("Cancelled by user.");
-  return choice;
-}
-
-async function pickPreset(ctx: InstallContext): Promise<Preset> {
-  if (ctx.flags.yes || ctx.flags.nonInteractive) return DEFAULT_PRESET;
-
-  const choice = await ctx.prompts.select<Preset>({
-    message: "Which kind of TS project do you need?",
-    options: (Object.entries(PRESETS) as Array<[Preset, PresetInfo]>).map(([value, meta]) => ({
-      value,
-      label: meta.label,
-    })),
-    initialValue: DEFAULT_PRESET,
-  });
-  if (ctx.prompts.isCancel(choice)) throw new Error("Cancelled by user.");
-  return choice;
-}
-
 async function pathExists(p: string): Promise<boolean> {
   try {
     await fs.access(p);
@@ -173,23 +135,12 @@ async function pathExists(p: string): Promise<boolean> {
   }
 }
 
-const ts = definePlugin<void>(() => ({
+const ts = definePlugin(() => ({
   name: "ts",
   apiVersion: 1,
   install,
   uninstall,
-  async setup({ shell }) {
-    const svc = new TscService(shell);
-    try {
-      await svc.getBinDir();
-    } catch (_err) {
-      throw new Error(
-        "@rrlab/ts-plugin requires typescript to be installed in the host project. " +
-          "Run: rr plugins add ts  (or: pnpm add -D typescript)",
-      );
-    }
-    return { tsc: svc };
-  },
+  capabilities: ({ shell }) => ({ tsc: new TscService(shell) }),
 }));
 
 export default ts;

package/src/tool-versions.ts

@@ -1,6 +1,7 @@
 export const TOOL_VERSIONS = {
-  // install range > peer range on purpose: pin latest stable for fresh installs,
-  // accept TS 5+ if the host already has it.
-  typescript: { install: "^6.0.0", peer: ">=5.0.0" },
+  // `install` is the prescriptive pin used by `rr plugins add`'s nypm call.
+  // For typescript we want fresh installs on the latest stable; the looser
+  // `>=5.0.0` contract lives in package.json#peerDependencies.
+  typescript: { install: "^6.0.0" },
   "@types/node": { install: ">=20" },
 } as const;