@bensandee/tooling 0.66.0 → 0.68.0

package/dist/index.d.mts

@@ -1,2 +1,146 @@
-import { a as LegacyConfig, i as GeneratorResult, n as Generator, o as ProjectConfig, r as GeneratorContext, t as DetectedProjectState } from "./types-C6cLSf_a.mjs";
+import { z } from "zod";
+
+//#region src/utils/json.d.ts
+declare const PackageJsonSchema: z.ZodObject<{
+  name: z.ZodOptional<z.ZodString>;
+  version: z.ZodOptional<z.ZodString>;
+  private: z.ZodOptional<z.ZodBoolean>;
+  type: z.ZodOptional<z.ZodString>;
+  scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  peerDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  bin: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
+  exports: z.ZodOptional<z.ZodUnknown>;
+  main: z.ZodOptional<z.ZodString>;
+  types: z.ZodOptional<z.ZodString>;
+  typings: z.ZodOptional<z.ZodString>;
+  engines: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  devEngines: z.ZodOptional<z.ZodObject<{
+    runtime: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+      name: z.ZodString;
+      version: z.ZodOptional<z.ZodString>;
+      onFail: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodObject<{
+      name: z.ZodString;
+      version: z.ZodOptional<z.ZodString>;
+      onFail: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>]>>;
+  }, z.core.$loose>>;
+  repository: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+    url: z.ZodString;
+  }, z.core.$loose>]>>;
+  packageManager: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type PackageJson = z.infer<typeof PackageJsonSchema>;
+//#endregion
+//#region src/types.d.ts
+type CiPlatform = "github" | "forgejo" | "none";
+type ReleaseStrategy = "release-it" | "simple" | "changesets" | "none";
+type Formatter = "oxfmt" | "prettier";
+/** Whether the repo has TS/JS source at all. Never inferred from absence. */
+type Stack = "typescript" | "javascript" | "none";
+/** What compiles the project, if anything. */
+type Builder = "tsdown" | "vite" | "custom" | "none";
+/** User's answers from the interactive prompt or CLI flags. */
+interface ProjectConfig {
+  /** Project name (from package.json name or user input) */
+  name: string;
+  /** Project structure */
+  structure: "single" | "monorepo";
+  /** Include @bensandee/eslint-plugin oxlint plugin */
+  useEslintPlugin: boolean;
+  /** Formatter choice */
+  formatter: Formatter;
+  /** Whether the repo has TS/JS source at all */
+  stack: Stack;
+  /** What compiles the project */
+  builder: Builder;
+  /** Set up vitest with a starter test */
+  setupVitest: boolean;
+  /** CI platform choice */
+  ci: CiPlatform;
+  /** Set up Renovate for automated dependency updates */
+  setupRenovate: boolean;
+  /** Release management strategy */
+  releaseStrategy: ReleaseStrategy;
+  /** Opt-in: publish packages to npm registry */
+  publishNpm: boolean;
+  /** Opt-in: publish Docker images to a registry */
+  publishDocker: boolean;
+  /** Project type determines tsconfig base configuration */
+  projectType: "default" | "node" | "react" | "library";
+  /** Auto-detect and configure tsconfig bases for monorepo packages */
+  detectPackageTypes: boolean;
+  /** Target directory (default: cwd) */
+  targetDir: string;
+}
+/** Result from a single generator: what file was written and how. */
+interface GeneratorResult {
+  filePath: string;
+  action: "created" | "updated" | "skipped" | "archived" | "removed";
+  /** Human-readable description of what changed */
+  description: string;
+}
+/** Context passed to each generator function. */
+interface GeneratorContext {
+  config: ProjectConfig;
+  /** Absolute path to target directory */
+  targetDir: string;
+  /** Pre-parsed package.json from the target directory, or undefined if missing/invalid */
+  packageJson: PackageJson | undefined;
+  /** Check whether a file exists in the target directory */
+  exists: (relativePath: string) => boolean;
+  /** Read an existing file from the target directory, returns undefined if not found */
+  read: (relativePath: string) => string | undefined;
+  /** Write a file to the target directory (creating directories as needed) */
+  write: (relativePath: string, content: string) => void;
+  /** Remove a file from the target directory (no-op if not found) */
+  remove: (relativePath: string) => void;
+  /**
+   * Rewrite generated content the way the target repo's own formatter would — so a
+   * generated file is a fixed point of `pnpm format` and can't drift against
+   * `repo:sync --check`. Returns the content unchanged when the formatter isn't
+   * installed yet. See `utils/format.ts`.
+   */
+  format: (relativePath: string, content: string) => string;
+  /** Prompt user for conflict resolution on non-mergeable files */
+  confirmOverwrite: (relativePath: string) => Promise<"overwrite" | "skip">;
+}
+/** Generator function signature. */
+type Generator = (ctx: GeneratorContext) => Promise<GeneratorResult>;
+/** State detected from an existing project directory. */
+interface DetectedProjectState {
+  hasPackageJson: boolean;
+  hasTsconfig: boolean;
+  hasOxlintConfig: boolean;
+  /** Existing oxlint.config.ts already imports @bensandee/config/oxlint/recommended */
+  oxlintExtendsRecommended: boolean;
+  /** Legacy .oxlintrc.json found (should be migrated to oxlint.config.ts) */
+  hasLegacyOxlintJson: boolean;
+  hasGitignore: boolean;
+  hasVitestConfig: boolean;
+  hasTsdownConfig: boolean;
+  hasPnpmWorkspace: boolean;
+  hasKnipConfig: boolean;
+  hasRenovateConfig: boolean;
+  hasReleaseItConfig: boolean;
+  hasSimpleReleaseConfig: boolean;
+  hasChangesetsConfig: boolean;
+  /** Whether package.json has a repository field (needed for release workflows) */
+  hasRepositoryField: boolean;
+  /** Whether commit-and-tag-version is in root devDependencies (required for simple release strategy) */
+  hasCommitAndTagVersion: boolean;
+  /** Git remote origin URL (for inferring repository field) */
+  gitRemoteUrl: string | null;
+  /** Legacy tooling configs found */
+  legacyConfigs: LegacyConfig[];
+}
+declare const LEGACY_TOOLS: readonly ["eslint", "prettier", "jest", "webpack", "rollup"];
+type LegacyTool = (typeof LEGACY_TOOLS)[number];
+interface LegacyConfig {
+  tool: LegacyTool;
+  files: string[];
+}
+//#endregion
 export type { DetectedProjectState, Generator, GeneratorContext, GeneratorResult, LegacyConfig, ProjectConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bensandee/tooling",
-  "version": "0.66.0",
+  "version": "0.68.0",
   "description": "CLI tool to bootstrap and maintain standardized TypeScript project tooling",
   "license": "MIT",
   "repository": {
@@ -25,10 +25,6 @@
       "default": "./dist/index.mjs"
     },
     "./bin": "./dist/bin.mjs",
-    "./docker-check": {
-      "types": "./dist/docker-check/index.d.mts",
-      "default": "./dist/docker-check/index.mjs"
-    },
     "./package.json": "./package.json",
     "./tooling.schema.json": "./tooling.schema.json"
   },
@@ -56,7 +52,7 @@
     "prettier": "3.8.4",
     "release-it": "20.2.0",
     "tsdown": "0.22.3",
-    "@bensandee/claude-hooks": "0.10.0"
+    "@bensandee/claude-hooks": "0.10.1"
   },
   "scripts": {
     "build": "tsdown",

package/tooling.schema.json

@@ -83,6 +83,11 @@
             "additionalProperties": {
               "type": "string"
             }
+          },
+          "imageName": {
+            "description": "Image name used for docker:build tags, docker:publish refs, and docker:check cross-referencing. Falls back to the derived name: the package.json name for the root package (npm scope stripped), or {root-name}-{package-name} for a monorepo package.",
+            "type": "string",
+            "minLength": 1
           }
         },
         "additionalProperties": false
@@ -339,7 +344,7 @@
               ]
             },
             "dirs": {
-              "description": "Extra active doc dirs beyond convention (e.g. [\"docs/rfcs\"]). Each retires into its own completed/ subdir.",
+              "description": "Extra active doc dirs beyond convention (e.g. [\"docs/rfcs\"]). Each retires into its own retired/ subdir.",
               "type": "array",
               "items": {
                 "type": "string"

package/dist/docker-check/index.d.mts

@@ -1,299 +0,0 @@
-import { z } from "zod";
-
-//#region src/release/types.d.ts
-/** Result of executing a shell command. */
-interface ExecResult {
-  stdout: string;
-  stderr: string;
-  exitCode: number;
-}
-/** Options for executing a shell command. */
-interface ExecOptions {
-  cwd?: string;
-  env?: Record<string, string>;
-  /** Data to pass to the command via stdin. */
-  input?: string;
-}
-/** Shared command execution and HTTP fetch interface. */
-interface BaseExecutor {
-  /** Run a command with arguments and return the result (stdout/stderr captured). */
-  exec(file: string, args: string[], options?: ExecOptions): ExecResult;
-  /** Run a command with arguments, streaming stdout/stderr to the console. */
-  execInherit(file: string, args: string[], options?: ExecOptions): void;
-  /** Perform an HTTP request (mirrors the global fetch signature). */
-  fetch(url: string, init?: RequestInit): Promise<Response>;
-}
-//#endregion
-//#region src/docker-check/types.d.ts
-/** Abstraction over side effects for testability. */
-interface DockerCheckExecutor extends BaseExecutor {
-  /** Get current time in ms (mockable clock). */
-  now(): number;
-  /** Sleep for the given duration (mockable delay). */
-  sleep(ms: number): Promise<void>;
-  /** Register a process signal handler. Returns a dispose function. */
-  onSignal(signal: NodeJS.Signals, handler: () => void): () => void;
-  /** Log a message to the console. */
-  log(message: string): void;
-  /** Log an error to the console. */
-  logError(message: string): void;
-}
-/** A single HTTP health check definition. */
-interface HttpHealthCheck {
-  /** Human-readable name for logging (e.g. "API", "Frontend"). */
-  name: string;
-  /** URL to fetch. */
-  url: string;
-  /** Validate the response. Return true if healthy. */
-  validate: (response: Response) => Promise<boolean>;
-}
-/** Docker compose configuration. */
-interface ComposeConfig {
-  /** Working directory for docker compose commands. */
-  cwd: string;
-  /** Compose files to use (e.g. ["docker-compose.yaml", "docker-compose.check.yaml"]). */
-  composeFiles: string[];
-  /**
-   * Project namespace passed to `docker compose --project-name`. Required so a
-   * check run cannot share a project (and thus its named volumes) with another
-   * stack on the same docker daemon. See `deriveProjectName()`.
-   */
-  projectName: string;
-  /** Optional env file for compose. */
-  envFile?: string;
-  /**
-   * Extra environment variables applied to every `docker compose` invocation.
-   * Used to inject a dynamically allocated `PORT` so the check stack avoids
-   * host port collisions. Shell env takes precedence over `--env-file` for
-   * compose variable interpolation.
-   */
-  env?: Record<string, string>;
-  /** Service names to monitor for container-level health. */
-  services: string[];
-}
-/** Full docker check configuration. */
-interface CheckConfig {
-  /** Docker compose settings. */
-  compose: ComposeConfig;
-  /** Optional build command to run before starting compose (e.g. ["pnpm", "image:build"]). */
-  buildCommand?: string[];
-  /** Working directory for the build command (defaults to compose.cwd). */
-  buildCwd?: string;
-  /** HTTP health checks to poll. All must pass for success. */
-  healthChecks: HttpHealthCheck[];
-  /** Optional smoketest command to run after all health checks pass (e.g. ["pnpm", "test:smoke"]). */
-  smoketest?: string[];
-  /** Working directory for the smoketest command (defaults to compose.cwd). */
-  smoketestCwd?: string;
-  /** Maximum time to wait for all checks to pass, in ms. Default: 120000. */
-  timeoutMs?: number;
-  /** Interval between polling attempts, in ms. Default: 5000. */
-  pollIntervalMs?: number;
-  /** If true, emit detailed debug logging. */
-  verbose?: boolean;
-}
-/** Result of the docker check run. */
-type CheckResult = {
-  success: true;
-  elapsedMs: number;
-} | {
-  success: false;
-  reason: "timeout" | "unhealthy-container" | "smoketest-failed" | "startup-failed" | "error";
-  message: string;
-  elapsedMs: number;
-};
-//#endregion
-//#region src/docker-check/executor.d.ts
-/** Create an executor that runs real commands, fetches, and manages process signals. */
-declare function createRealExecutor(): DockerCheckExecutor;
-//#endregion
-//#region src/docker-check/check.d.ts
-/** Run the full Docker check lifecycle. */
-declare function runDockerCheck(executor: DockerCheckExecutor, rawConfig: CheckConfig): Promise<CheckResult>;
-//#endregion
-//#region src/docker-check/compose.d.ts
-/** Zod schema for a single container entry from `docker compose ps --format json`. */
-declare const ContainerInfoSchema: z.ZodObject<{
-  Service: z.ZodString;
-  Health: z.ZodString;
-}, z.core.$strip>;
-type ContainerInfo = z.infer<typeof ContainerInfoSchema>;
-/** Build the `docker compose` base args from config. */
-declare function composeArgs(config: ComposeConfig): string[];
-/** Start the compose stack in detached mode. */
-declare function composeUp(executor: DockerCheckExecutor, config: ComposeConfig): void;
-/** Tear down the compose stack, removing volumes and orphans. Swallows errors. */
-declare function composeDown(executor: DockerCheckExecutor, config: ComposeConfig): void;
-/** Show logs for a specific service (or all services if not specified). Swallows errors. */
-declare function composeLogs(executor: DockerCheckExecutor, config: ComposeConfig, service?: string): void;
-/**
- * Query container status via `docker compose ps --format json`.
- * Handles both JSON array and newline-delimited JSON (varies by docker compose version).
- */
-declare function composePs(executor: DockerCheckExecutor, config: ComposeConfig): ContainerInfo[];
-//#endregion
-//#region src/docker-check/health.d.ts
-/** Look up the health status of a specific service from container info. */
-declare function getContainerHealth(containers: ContainerInfo[], serviceName: string): string;
-/** Run a single HTTP health check, returning true if the validator passes. */
-declare function checkHttpHealth(executor: DockerCheckExecutor, check: HttpHealthCheck): Promise<boolean>;
-//#endregion
-//#region src/docker-check/project-name.d.ts
-/**
- * Derive the `docker compose --project-name` value for a check run.
- *
- * Always returns a unique, non-colliding namespace so a stray `compose down -v`
- * during the check cannot target volumes belonging to a long-running stack
- * sharing the same docker daemon (the failure mode that wiped prod volumes
- * when a CI runner bind-mounted /var/run/docker.sock and the check overlay
- * inherited the base file's `name:`).
- *
- * Format: `<sanitized-repo>-check-<suffix>` where suffix prefers a CI run id
- * for traceability and falls back to `process.pid` locally so two concurrent
- * `bst docker:check` invocations on the same machine don't collide.
- */
-declare function deriveProjectName(repoName: string, env?: NodeJS.ProcessEnv): string;
-//#endregion
-//#region src/utils/tooling-config.d.ts
-declare const ToolingConfigSchema: z.ZodObject<{
-  $schema: z.ZodOptional<z.ZodString>;
-  structure: z.ZodOptional<z.ZodEnum<{
-    single: "single";
-    monorepo: "monorepo";
-  }>>;
-  useEslintPlugin: z.ZodOptional<z.ZodBoolean>;
-  formatter: z.ZodOptional<z.ZodEnum<{
-    prettier: "prettier";
-    oxfmt: "oxfmt";
-  }>>;
-  setupVitest: z.ZodOptional<z.ZodBoolean>;
-  ci: z.ZodOptional<z.ZodEnum<{
-    github: "github";
-    forgejo: "forgejo";
-    none: "none";
-  }>>;
-  setupRenovate: z.ZodOptional<z.ZodBoolean>;
-  releaseStrategy: z.ZodOptional<z.ZodEnum<{
-    none: "none";
-    "release-it": "release-it";
-    simple: "simple";
-    changesets: "changesets";
-  }>>;
-  publishNpm: z.ZodOptional<z.ZodBoolean>;
-  publishDocker: z.ZodOptional<z.ZodBoolean>;
-  projectType: z.ZodOptional<z.ZodEnum<{
-    default: "default";
-    node: "node";
-    react: "react";
-    library: "library";
-  }>>;
-  detectPackageTypes: z.ZodOptional<z.ZodBoolean>;
-  docker: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-    dockerfile: z.ZodOptional<z.ZodString>;
-    context: z.ZodOptional<z.ZodString>;
-    buildArgs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-  }, z.core.$strip>>>;
-  dockerCheck: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodObject<{
-    composeFiles: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    envFile: z.ZodOptional<z.ZodString>;
-    services: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    healthChecks: z.ZodOptional<z.ZodArray<z.ZodObject<{
-      name: z.ZodString;
-      url: z.ZodString;
-      status: z.ZodOptional<z.ZodNumber>;
-    }, z.core.$strip>>>;
-    buildCommand: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    buildCwd: z.ZodOptional<z.ZodString>;
-    smoketest: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    smoketestCwd: z.ZodOptional<z.ZodString>;
-    timeoutMs: z.ZodOptional<z.ZodNumber>;
-    pollIntervalMs: z.ZodOptional<z.ZodNumber>;
-  }, z.core.$strip>]>>;
-  registryHost: z.ZodOptional<z.ZodString>;
-  registryNamespace: z.ZodOptional<z.ZodString>;
-  releaseAssets: z.ZodOptional<z.ZodArray<z.ZodObject<{
-    command: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    file: z.ZodString;
-    name: z.ZodOptional<z.ZodString>;
-  }, z.core.$strict>>>;
-  postReleaseHook: z.ZodOptional<z.ZodString>;
-  postReleaseHookSecrets: z.ZodOptional<z.ZodArray<z.ZodString>>;
-  coverage: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodObject<{
-    history: z.ZodOptional<z.ZodEnum<{
-      none: "none";
-      "orphan-branch": "orphan-branch";
-    }>>;
-    historyBranch: z.ZodOptional<z.ZodString>;
-    tolerancePp: z.ZodOptional<z.ZodNumber>;
-    gateOnPullRequests: z.ZodOptional<z.ZodBoolean>;
-  }, z.core.$strict>]>>;
-  health: z.ZodOptional<z.ZodObject<{
-    enabled: z.ZodOptional<z.ZodBoolean>;
-    src: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    extensions: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    directoryFileLimit: z.ZodOptional<z.ZodNumber>;
-    fanInLimit: z.ZodOptional<z.ZodNumber>;
-    fanOutLimit: z.ZodOptional<z.ZodNumber>;
-    history: z.ZodOptional<z.ZodEnum<{
-      none: "none";
-      "orphan-branch": "orphan-branch";
-    }>>;
-    historyBranch: z.ZodOptional<z.ZodString>;
-    tolerance: z.ZodOptional<z.ZodNumber>;
-  }, z.core.$strip>>;
-  docs: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodObject<{
-    enforced: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
-    dirs: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    staleDays: z.ZodOptional<z.ZodNumber>;
-    staleEnforced: z.ZodOptional<z.ZodBoolean>;
-  }, z.core.$strict>]>>;
-  deploy: z.ZodOptional<z.ZodObject<{
-    dispatchRepo: z.ZodString;
-    stack: z.ZodOptional<z.ZodString>;
-    workflow: z.ZodOptional<z.ZodString>;
-    ref: z.ZodOptional<z.ZodString>;
-  }, z.core.$strict>>;
-  pnpmWorkspace: z.ZodOptional<z.ZodLiteral<false>>;
-  defaultBranch: z.ZodOptional<z.ZodString>;
-  unmanagedDevDependencies: z.ZodOptional<z.ZodArray<z.ZodString>>;
-  stack: z.ZodOptional<z.ZodEnum<{
-    none: "none";
-    typescript: "typescript";
-    javascript: "javascript";
-  }>>;
-  builder: z.ZodOptional<z.ZodEnum<{
-    none: "none";
-    custom: "custom";
-    tsdown: "tsdown";
-    vite: "vite";
-  }>>;
-  checks: z.ZodOptional<z.ZodObject<{
-    add: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    skip: z.ZodOptional<z.ZodArray<z.ZodString>>;
-  }, z.core.$strict>>;
-}, z.core.$strict>;
-type ToolingConfig = z.infer<typeof ToolingConfigSchema>;
-//#endregion
-//#region src/docker-check/compose-lint.d.ts
-interface ComposeLintIssue {
-  kind: "missing-name" | "duplicate-name";
-  /** Repo-relative paths involved in this issue (1 for missing-name, 2+ for duplicate-name). */
-  files: string[];
-  /** Pre-rendered human-readable message ready for `log.error`. */
-  message: string;
-}
-/**
- * Walk compose files in `targetDir` and report lint violations:
- *
- * - Rule A (`missing-name`): every override compose file must declare a
- *   top-level `name:` directive. Base files (docker-compose.yml etc.) are
- *   exempt — their default of dir-basename is fine — but overrides without
- *   `name:` silently inherit the base's project namespace, which is how a
- *   `compose down -v` against the check overlay wiped the prod-volume project.
- * - Rule B (`duplicate-name`): no two compose files in a single dir may
- *   declare the same `name:`. Base files participate in collision detection.
- */
-declare function lintComposeFiles(targetDir: string, config: ToolingConfig | undefined): ComposeLintIssue[];
-//#endregion
-export { type CheckConfig, type CheckResult, type ComposeConfig, type ComposeLintIssue, type ContainerInfo, type DockerCheckExecutor, type HttpHealthCheck, checkHttpHealth, composeArgs, composeDown, composeLogs, composePs, composeUp, createRealExecutor, deriveProjectName, getContainerHealth, lintComposeFiles, runDockerCheck };

package/dist/docker-check/index.mjs

@@ -1,2 +0,0 @@
-import { a as composeArgs, c as composePs, d as lintComposeFiles, i as getContainerHealth, l as composeUp, n as runDockerCheck, o as composeDown, r as checkHttpHealth, s as composeLogs, t as deriveProjectName, u as createRealExecutor } from "../project-name-CNaAmafB.mjs";
-export { checkHttpHealth, composeArgs, composeDown, composeLogs, composePs, composeUp, createRealExecutor, deriveProjectName, getContainerHealth, lintComposeFiles, runDockerCheck };