@danieljvdm/dev-kit 0.13.0 → 0.15.0

package/src/vite-plus-workflow.ts

@@ -0,0 +1,82 @@
+import { Effect, Schema } from "effect";
+
+import { readDirectDependencyNames } from "./project-package.ts";
+import { planScaffold, readScaffoldTemplate, replaceUniqueTemplateMarker } from "./scaffold.ts";
+import { validateInstalledVitePlus } from "./vite-plus-dependency.ts";
+
+export const VITE_PLUS_GITHUB_ACTIONS_PATH = ".github/workflows/check.yml";
+export const VITE_PLUS_GITHUB_ACTIONS_TEMPLATE = "templates/vite-plus/github-actions-check.yml";
+
+export class VitePlusWorkflowSupportError extends Schema.TaggedError<VitePlusWorkflowSupportError>()(
+  "VitePlusWorkflowSupportError",
+  { message: Schema.String },
+) {}
+
+const LOCKED_DEV_KIT_COMMAND =
+  "bun ./node_modules/@danieljvdm/dev-kit/bin/dev-kit.mjs apply --locked";
+
+export const renderVitePlusWorkflowTemplate = (
+  template: string,
+  options: { readonly devKitCommand?: string } = {},
+): string => {
+  const devKitCommand = options.devKitCommand;
+
+  return devKitCommand === undefined || devKitCommand === LOCKED_DEV_KIT_COMMAND
+    ? template
+    : replaceUniqueTemplateMarker(template, LOCKED_DEV_KIT_COMMAND, devKitCommand);
+};
+
+export const validateVitePlusWorkflowSupport = Effect.fn("validateVitePlusWorkflowSupport")(
+  function* (projectDir: string, packageRoot: string, typescriptPackage: string) {
+    const dependencies = yield* readDirectDependencyNames(projectDir);
+    const required = new Set(["effect", "@effect/tsgo", typescriptPackage]);
+
+    yield* validateInstalledVitePlus(projectDir).pipe(
+      Effect.mapError((error) => VitePlusWorkflowSupportError.make({ message: error.message })),
+    );
+
+    if (projectDir !== packageRoot) required.add("@danieljvdm/dev-kit");
+    const missing = [...required].filter((dependency) => !dependencies.includes(dependency));
+
+    if (missing.length > 0) {
+      return yield* VitePlusWorkflowSupportError.make({
+        message: `setup.vitePlus.workflow requires direct dependencies: ${missing.join(", ")}`,
+      });
+    }
+  },
+);
+
+export const planVitePlusWorkflow = (options: {
+  readonly packageRoot: string;
+  readonly projectDir: string;
+  readonly effectTsgoEnabled: boolean;
+  readonly typescriptPackage: string;
+}) =>
+  planScaffold({
+    projectDir: options.projectDir,
+    path: VITE_PLUS_GITHUB_ACTIONS_PATH,
+    content: Effect.gen(function* () {
+      if (!options.effectTsgoEnabled) {
+        return yield* VitePlusWorkflowSupportError.make({
+          message:
+            "setup.vitePlus.workflow requires setup.effectTsgo.enabled so the scaffolded workflow's typecheck uses the Effect-patched compiler",
+        });
+      }
+      yield* validateVitePlusWorkflowSupport(
+        options.projectDir,
+        options.packageRoot,
+        options.typescriptPackage,
+      );
+      const template = yield* readScaffoldTemplate(
+        options.packageRoot,
+        VITE_PLUS_GITHUB_ACTIONS_TEMPLATE,
+      );
+
+      return renderVitePlusWorkflowTemplate(
+        template,
+        options.projectDir === options.packageRoot
+          ? { devKitCommand: "./bin/dev-kit.mjs apply --locked" }
+          : {},
+      );
+    }),
+  });

package/src/worktrunk-config.ts

@@ -0,0 +1,88 @@
+import { Effect, Schema } from "effect";
+
+import {
+  detectPackageManager,
+  PACKAGE_MANAGER_COMMANDS,
+  readDirectDependencyNames,
+  readProjectPackage,
+} from "./project-package.ts";
+import { planScaffold, readScaffoldTemplate, replaceUniqueTemplateMarker } from "./scaffold.ts";
+
+export const WORKTRUNK_CONFIG_PATH = ".config/wt.toml";
+export const WORKTRUNK_CONFIG_TEMPLATE = "templates/worktrunk/wt.toml";
+
+export class WorktrunkConfigSupportError extends Schema.TaggedError<WorktrunkConfigSupportError>()(
+  "WorktrunkConfigSupportError",
+  { message: Schema.String },
+) {}
+
+export type WorktrunkConfigCommands = {
+  readonly preMerge: string;
+  readonly install: string;
+  readonly dev: string;
+};
+
+const TEMPLATE_COMMANDS: WorktrunkConfigCommands = {
+  preMerge: "vp run check",
+  install: "vp install",
+  dev: "vp dev",
+};
+
+export const renderWorktrunkConfigTemplate = (
+  template: string,
+  commands: WorktrunkConfigCommands = TEMPLATE_COMMANDS,
+): string => {
+  const replacements: ReadonlyArray<readonly [string, string]> = [
+    [`pre-merge = "${TEMPLATE_COMMANDS.preMerge}"`, `pre-merge = "${commands.preMerge}"`],
+    [`install = "${TEMPLATE_COMMANDS.install}"`, `install = "${commands.install}"`],
+    [TEMPLATE_COMMANDS.dev, commands.dev],
+  ];
+  let rendered = template;
+
+  for (const [marker, replacement] of replacements) {
+    if (marker === replacement) continue;
+    rendered = replaceUniqueTemplateMarker(rendered, marker, replacement);
+  }
+
+  return rendered;
+};
+
+export const resolveWorktrunkConfigCommands = Effect.fn("resolveWorktrunkConfigCommands")(
+  function* (projectDir: string) {
+    const dependencies = yield* readDirectDependencyNames(projectDir);
+
+    if (dependencies.includes("vite-plus")) return TEMPLATE_COMMANDS;
+    const projectPackage = yield* readProjectPackage(projectDir).pipe(
+      Effect.catchTag("ProjectPackageError", (error) =>
+        error.message.startsWith("package.json not found:") ? Effect.void : Effect.fail(error),
+      ),
+    );
+    const scripts = projectPackage?.scripts ?? {};
+
+    if (scripts["check"] === undefined) {
+      return yield* WorktrunkConfigSupportError.make({
+        message:
+          'setup.worktrunk.config requires a direct vite-plus dependency or a root "check" package script for the pre-merge hook',
+      });
+    }
+    const manager = yield* detectPackageManager(projectDir, projectPackage?.packageManager);
+
+    return {
+      preMerge: "bun run check",
+      install: PACKAGE_MANAGER_COMMANDS[manager ?? "bun"].install,
+      dev: "bun run dev",
+    } satisfies WorktrunkConfigCommands;
+  },
+);
+
+export const planWorktrunkConfig = (packageRoot: string, projectDir: string) =>
+  planScaffold({
+    projectDir,
+    path: WORKTRUNK_CONFIG_PATH,
+    content: Effect.gen(function* () {
+      const template = yield* readScaffoldTemplate(packageRoot, WORKTRUNK_CONFIG_TEMPLATE);
+      const commands = yield* resolveWorktrunkConfigCommands(projectDir);
+
+      return renderWorktrunkConfigTemplate(template, commands);
+    }),
+  });

package/templates/vite-plus/github-actions-check.yml

@@ -38,8 +38,6 @@ jobs:
       - name: Verify locked Dev Kit setup
         run: bun ./node_modules/@danieljvdm/dev-kit/bin/dev-kit.mjs apply --locked
 
-      # Dev Kit inserts configured quality.workflow.beforeChecks steps here.
-
       - name: Check formatting
         run: vp fmt --check
 

package/templates/worktrunk/wt.toml

@@ -0,0 +1,27 @@
+# Worktrunk project hooks, scaffolded by @danieljvdm/dev-kit (setup.worktrunk.config).
+# This repository owns the file — edit hooks freely; dev-kit never rewrites it.
+# Hooks never run until each user reviews and approves them: wt config approvals add
+# Reference: https://worktrunk.dev/hooks/
+
+# Full validation before a worktree merges back.
+pre-merge = "vp run check"
+
+# Copy gitignored files matched by .worktreeinclude (.env, local caches) from
+# the source worktree; without a .worktreeinclude file this is a no-op.
+[[pre-start]]
+copy-ignored = "wt step copy-ignored --require-include"
+
+# Install dependencies after ignored files land so the new worktree is runnable.
+[[pre-start]]
+install = "vp install"
+
+# Optional per-worktree dev server on a stable branch-derived port; tether stops
+# the server when its worktree is removed. Point the command at this
+# repository's dev entrypoint (for example add `apps/web` in a monorepo) and
+# uncomment:
+# [post-start]
+# dev = "wt step tether -- vp dev --host 127.0.0.1 --port {{ branch | hash_port }} --strictPort"
+
+# Optional: show each worktree's dev-server URL in `wt list`:
+# [list]
+# url = "http://localhost:{{ branch | hash_port }}"

package/src/vite-plus-quality.ts

@@ -1,148 +0,0 @@
-import { Effect, Schema } from "effect";
-
-import type { VitePlusQualityWorkflowStep } from "./manifest.ts";
-import { readDirectDependencyNames } from "./project-package.ts";
-import { validateInstalledVitePlus } from "./vite-plus-dependency.ts";
-
-export const VITE_PLUS_GITHUB_ACTIONS_PATH = ".github/workflows/check.yml";
-export const VITE_PLUS_GITHUB_ACTIONS_TEMPLATE = "templates/vite-plus/github-actions-check.yml";
-
-export class VitePlusQualitySupportError extends Schema.TaggedError<VitePlusQualitySupportError>()(
-  "VitePlusQualitySupportError",
-  { message: Schema.String },
-) {}
-
-export type VitePlusQualityWorkflow = {
-  readonly beforeChecks: ReadonlyArray<VitePlusQualityWorkflowStep>;
-  readonly typecheck: ReadonlyArray<string>;
-};
-
-export type VitePlusQualitySelection = {
-  readonly workflow: VitePlusQualityWorkflow;
-};
-
-const LOCKED_DEV_KIT_COMMAND =
-  "bun ./node_modules/@danieljvdm/dev-kit/bin/dev-kit.mjs apply --locked";
-const BEFORE_CHECKS_MARKER =
-  "      # Dev Kit inserts configured quality.workflow.beforeChecks steps here.\n\n";
-const DEFAULT_WORKFLOW_TYPECHECK = `      - name: Type check with Effect TypeScript-Go
-        run: vp run typecheck`;
-
-const replaceUniqueTemplateMarker = (
-  template: string,
-  marker: string,
-  replacement: string,
-): string => {
-  const parts = template.split(marker);
-
-  if (parts.length !== 2) {
-    throw new Error(`expected exactly one generated template marker: ${marker}`);
-  }
-
-  return `${parts[0]}${replacement}${parts[1]}`;
-};
-
-export const renderVitePlusWorkflowTemplate = (
-  template: string,
-  options: {
-    readonly devKitCommand?: string;
-    readonly workflow?: VitePlusQualityWorkflow;
-  } = {},
-): string => {
-  const devKitCommand = options.devKitCommand;
-  const workflow = options.workflow;
-  let rendered =
-    devKitCommand === undefined || devKitCommand === LOCKED_DEV_KIT_COMMAND
-      ? template
-      : replaceUniqueTemplateMarker(template, LOCKED_DEV_KIT_COMMAND, devKitCommand);
-
-  if (workflow !== undefined) {
-    const steps = workflow.beforeChecks
-      .map((step) => {
-        const commands = step.run
-          .flatMap((command) => command.split("\n"))
-          .map((line) => `          ${line}`)
-          .join("\n");
-
-        return `      - name: ${JSON.stringify(step.name)}
-        run: |
-${commands}`;
-      })
-      .join("\n\n");
-
-    rendered = replaceUniqueTemplateMarker(
-      rendered,
-      BEFORE_CHECKS_MARKER,
-      steps.length === 0 ? "" : `${steps}\n\n`,
-    );
-  }
-  if (
-    workflow !== undefined &&
-    (workflow.typecheck.length !== 1 || workflow.typecheck[0] !== "vp run typecheck")
-  ) {
-    const commands = workflow.typecheck
-      .flatMap((command) => command.split("\n"))
-      .map((line) => `          ${line}`)
-      .join("\n");
-
-    rendered = replaceUniqueTemplateMarker(
-      rendered,
-      DEFAULT_WORKFLOW_TYPECHECK,
-      `      - name: Type check with Effect TypeScript-Go
-        run: |
-${commands}`,
-    );
-  }
-
-  return rendered;
-};
-
-export const validateVitePlusQualitySupport = Effect.fn("validateVitePlusQualitySupport")(
-  function* (
-    projectDir: string,
-    packageRoot: string,
-    typescriptPackage: string,
-    selection: VitePlusQualitySelection,
-  ) {
-    const dependencies = yield* readDirectDependencyNames(projectDir);
-    const required = new Set(["effect", "@effect/tsgo", typescriptPackage]);
-
-    yield* validateInstalledVitePlus(projectDir).pipe(
-      Effect.mapError((error) => VitePlusQualitySupportError.make({ message: error.message })),
-    );
-
-    if (projectDir !== packageRoot) required.add("@danieljvdm/dev-kit");
-    const missing = [...required].filter((dependency) => !dependencies.includes(dependency));
-
-    if (missing.length > 0) {
-      return yield* VitePlusQualitySupportError.make({
-        message: `setup.vitePlus.quality requires direct dependencies: ${missing.join(", ")}`,
-      });
-    }
-    if (selection.workflow.typecheck.length === 0) {
-      return yield* VitePlusQualitySupportError.make({
-        message: "setup.vitePlus.quality.workflow.typecheck requires at least one command",
-      });
-    }
-    for (const command of selection.workflow.typecheck) {
-      if (command.trim().length === 0) {
-        return yield* VitePlusQualitySupportError.make({
-          message: "setup.vitePlus.quality.workflow.typecheck commands must not be empty",
-        });
-      }
-    }
-    for (const step of selection.workflow.beforeChecks) {
-      if (step.name.trim().length === 0 || step.run.length === 0) {
-        return yield* VitePlusQualitySupportError.make({
-          message:
-            "setup.vitePlus.quality.workflow.beforeChecks steps require a name and at least one command",
-        });
-      }
-      if (step.run.some((command) => command.trim().length === 0)) {
-        return yield* VitePlusQualitySupportError.make({
-          message: "setup.vitePlus.quality.workflow.beforeChecks commands must not be empty",
-        });
-      }
-    }
-  },
-);