@danieljvdm/dev-kit 0.6.0 → 0.7.0

package/src/vite-plus-hooks.ts

@@ -0,0 +1,174 @@
+import { Config, Effect, FileSystem, Path, Schema, Stream } from "effect";
+import { ChildProcess } from "effect/unstable/process";
+
+import { readDirectDependencyNames } from "./project-package.ts";
+
+export const VITE_PLUS_HOOKS_DIR = ".vite-hooks";
+export const VITE_PLUS_HOOKS_PATH = `${VITE_PLUS_HOOKS_DIR}/_`;
+
+export type VitePlusHooksPlan = {
+  readonly action: "configure" | "unchanged" | "skipped";
+  readonly hooksDir: string;
+  readonly hooksPath: string;
+  readonly projectDir: string;
+  readonly vpBin: string;
+};
+
+export class VitePlusHooksDependencyError extends Schema.TaggedErrorClass<VitePlusHooksDependencyError>()(
+  "VitePlusHooksDependencyError",
+  { message: Schema.String },
+) {}
+
+export class VitePlusHooksConflictError extends Schema.TaggedErrorClass<VitePlusHooksConflictError>()(
+  "VitePlusHooksConflictError",
+  { hooksPath: Schema.String },
+) {
+  override get message() {
+    return `core.hooksPath is already set to "${this.hooksPath}"; refusing to replace another Git hook manager`;
+  }
+}
+
+class VitePlusHooksCommandError extends Schema.TaggedErrorClass<VitePlusHooksCommandError>()(
+  "VitePlusHooksCommandError",
+  { command: Schema.String, exitCode: Schema.Int, output: Schema.String },
+) {
+  override get message() {
+    return this.output.length > 0
+      ? `${this.command} exited with code ${this.exitCode}: ${this.output}`
+      : `${this.command} exited with code ${this.exitCode}`;
+  }
+}
+
+class VitePlusHooksConvergenceError extends Schema.TaggedErrorClass<VitePlusHooksConvergenceError>()(
+  "VitePlusHooksConvergenceError",
+  { message: Schema.String },
+) {}
+
+const runCommand = Effect.fn("runVitePlusHooksCommand")(function* (
+  cwd: string,
+  command: string,
+  args: ReadonlyArray<string>,
+  allowedExitCodes: ReadonlyArray<number> = [0],
+) {
+  const child = yield* ChildProcess.make(command, args, {
+    cwd,
+    stderr: "pipe",
+    stdout: "pipe",
+  });
+  const [output, exitCode] = yield* Effect.all([
+    Stream.mkString(Stream.decodeText(child.all)),
+    child.exitCode,
+  ]);
+  const trimmed = output.trim();
+
+  if (!allowedExitCodes.includes(exitCode)) {
+    return yield* new VitePlusHooksCommandError({
+      command: [command, ...args].join(" "),
+      exitCode,
+      output: trimmed,
+    });
+  }
+
+  return { exitCode, output: trimmed };
+});
+
+const hasExecutableFile = Effect.fn("hasExecutableVitePlusHookFile")(function* (filePath: string) {
+  const fs = yield* FileSystem.FileSystem;
+
+  if (!(yield* fs.exists(filePath))) return false;
+  const info = yield* fs.stat(filePath);
+
+  return info.type === "File" && (info.mode & 0o111) !== 0;
+});
+
+const hasVitePlusPreCommitHook = Effect.fn("hasVitePlusPreCommitHook")(function* (
+  filePath: string,
+) {
+  const fs = yield* FileSystem.FileSystem;
+
+  if (!(yield* fs.exists(filePath))) return false;
+  const info = yield* fs.stat(filePath);
+
+  return info.type === "File" && (yield* fs.readFileString(filePath)).includes("vp staged");
+});
+
+const inspectVitePlusHooks = Effect.fn("inspectVitePlusHooks")(function* (projectDir: string) {
+  const path = yield* Path.Path;
+  const configuredPath = yield* runCommand(
+    projectDir,
+    "git",
+    ["config", "--local", "--get", "core.hooksPath"],
+    [0, 1],
+  );
+  const hooksPath = configuredPath.exitCode === 0 ? configuredPath.output : "";
+
+  if (
+    hooksPath.length > 0 &&
+    hooksPath !== VITE_PLUS_HOOKS_PATH &&
+    hooksPath !== ".husky" &&
+    !hooksPath.startsWith(".husky/")
+  ) {
+    return yield* new VitePlusHooksConflictError({ hooksPath });
+  }
+  const internalDir = path.join(projectDir, VITE_PLUS_HOOKS_DIR, "_");
+  const [hasLauncher, hasDispatcher, hasPreCommit] = yield* Effect.all([
+    hasExecutableFile(path.join(internalDir, "h")),
+    hasExecutableFile(path.join(internalDir, "pre-commit")),
+    hasVitePlusPreCommitHook(path.join(projectDir, VITE_PLUS_HOOKS_DIR, "pre-commit")),
+  ]);
+
+  return hooksPath === VITE_PLUS_HOOKS_PATH && hasLauncher && hasDispatcher && hasPreCommit;
+});
+
+export const planVitePlusHooks = Effect.fn("planVitePlusHooks")(function* (projectDir: string) {
+  const fs = yield* FileSystem.FileSystem;
+  const path = yield* Path.Path;
+  const dependencies = yield* readDirectDependencyNames(projectDir);
+
+  if (!dependencies.includes("vite-plus")) {
+    return yield* new VitePlusHooksDependencyError({
+      message: "vite-plus must be a direct project dependency before enabling setup.vitePlus.hooks",
+    });
+  }
+  const vpBin = path.join(projectDir, "node_modules", ".bin", "vp");
+
+  if (!(yield* fs.exists(vpBin))) {
+    return yield* new VitePlusHooksDependencyError({
+      message:
+        "vite-plus must be installed before enabling setup.vitePlus.hooks: node_modules/.bin/vp is missing",
+    });
+  }
+  const viteGitHooks = yield* Config.string("VITE_GIT_HOOKS").pipe(Config.withDefault(""));
+  const husky = yield* Config.string("HUSKY").pipe(Config.withDefault(""));
+  const action =
+    viteGitHooks === "0" || husky === "0"
+      ? "skipped"
+      : (yield* inspectVitePlusHooks(projectDir))
+        ? "unchanged"
+        : "configure";
+
+  return {
+    action,
+    hooksDir: VITE_PLUS_HOOKS_DIR,
+    hooksPath: VITE_PLUS_HOOKS_PATH,
+    projectDir,
+    vpBin,
+  } satisfies VitePlusHooksPlan;
+});
+
+export const applyVitePlusHooksPlan = Effect.fn("applyVitePlusHooksPlan")(function* (
+  plan: VitePlusHooksPlan,
+) {
+  if (plan.action !== "configure") return;
+  yield* runCommand(plan.projectDir, plan.vpBin, [
+    "config",
+    "--no-agent",
+    "--hooks-dir",
+    plan.hooksDir,
+  ]);
+  if (!(yield* inspectVitePlusHooks(plan.projectDir))) {
+    return yield* new VitePlusHooksConvergenceError({
+      message: `Vite+ hook setup did not converge at ${plan.hooksPath}`,
+    });
+  }
+});

package/src/vite-plus-quality.ts

@@ -0,0 +1,49 @@
+import { Effect, FileSystem, Path, Schema } from "effect";
+
+import { readDirectDependencyNames, readProjectPackage } from "./project-package.ts";
+
+export const VITE_PLUS_CONFIG_PATH = "vite.config.ts";
+export const VITE_PLUS_CONFIG_TEMPLATE = "templates/vite-plus/vite.config.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.TaggedErrorClass<VitePlusQualitySupportError>()(
+  "VitePlusQualitySupportError",
+  { message: Schema.String },
+) {}
+
+export const validateVitePlusQualitySupport = Effect.fn("validateVitePlusQualitySupport")(
+  function* (projectDir: string, packageRoot: string, typescriptPackage: string) {
+    const fs = yield* FileSystem.FileSystem;
+    const path = yield* Path.Path;
+    const packageJson = yield* readProjectPackage(projectDir);
+    const dependencies = yield* readDirectDependencyNames(projectDir);
+    const required = new Set(["vite-plus", "effect", "@effect/tsgo", typescriptPackage]);
+
+    if (projectDir !== packageRoot) required.add("@danieljvdm/dev-kit");
+    const missing = [...required].filter((dependency) => !dependencies.includes(dependency));
+
+    if (missing.length > 0) {
+      return yield* new VitePlusQualitySupportError({
+        message: `setup.vitePlus.quality requires direct dependencies: ${missing.join(", ")}`,
+      });
+    }
+    const conflictingScripts = ["check", "typecheck"].filter(
+      (script) => packageJson.scripts?.[script] !== undefined,
+    );
+
+    if (conflictingScripts.length > 0) {
+      return yield* new VitePlusQualitySupportError({
+        message: `setup.vitePlus.quality defines Vite tasks that conflict with package scripts: ${conflictingScripts.join(", ")}`,
+      });
+    }
+    const vpBin = path.join(projectDir, "node_modules", ".bin", "vp");
+
+    if (!(yield* fs.exists(vpBin))) {
+      return yield* new VitePlusQualitySupportError({
+        message:
+          "vite-plus must be installed before enabling setup.vitePlus.quality: node_modules/.bin/vp is missing",
+      });
+    }
+  },
+);

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

@@ -0,0 +1,44 @@
+name: Check
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Set up Vite+
+        uses: voidzero-dev/setup-vp@v1
+        with:
+          node-version: "24"
+          cache: true
+
+      - name: Install dependencies
+        run: vp install
+
+      - name: Check formatting
+        run: vp fmt --check
+
+      - name: Lint
+        run: vp lint
+
+      - name: Run tests
+        run: vp test
+
+      - name: Type check with Effect TypeScript-Go
+        run: vp run typecheck

package/templates/vite-plus/vite.config.ts

@@ -0,0 +1,22 @@
+import { recommendedOxfmtConfig } from "@danieljvdm/dev-kit/oxfmt";
+import { recommendedOxlintConfig } from "@danieljvdm/dev-kit/oxlint";
+import { defineConfig } from "vite-plus";
+
+export default defineConfig({
+  staged: {
+    "*": "vp check --fix",
+  },
+  fmt: {
+    ...recommendedOxfmtConfig,
+  },
+  lint: {
+    extends: [recommendedOxlintConfig],
+    ignorePatterns: [".agents/**", ".dev-kit/**", ".repos/**"],
+  },
+  run: {
+    tasks: {
+      check: ["vp fmt --check", "vp lint", "vp test", "vp run typecheck"],
+      typecheck: "tsc --noEmit",
+    },
+  },
+});