outfitter 0.2.2 → 0.2.4

package/dist/index.d.ts

@@ -1,96 +1,7 @@
 import { ActionRegistry } from "@outfitter/contracts";
 declare const outfitterActions: ActionRegistry;
 import { OutputMode } from "@outfitter/cli/types";
-import { Result as Result2 } from "@outfitter/contracts";
-import { AddBlockResult } from "@outfitter/tooling";
 import { Command } from "commander";
-import { Result, ValidationError } from "@outfitter/contracts";
-/**
-* Create planner types for kit-first project scaffolding.
-*
-* These types model preset intent separately from execution so future flows can
-* consume a deterministic plan before mutating the filesystem.
-*/
-type CreatePresetId = "basic" | "cli" | "daemon" | "mcp";
-interface CreatePresetDefinition {
-	readonly id: CreatePresetId;
-	readonly template: CreatePresetId;
-	readonly summary: string;
-	readonly defaultBlocks: readonly string[];
-}
-interface CreateProjectInput {
-	readonly name: string;
-	readonly targetDir: string;
-	readonly preset: CreatePresetId;
-	readonly packageName?: string;
-	readonly description?: string;
-	readonly version?: string;
-	readonly includeTooling?: boolean;
-	readonly local?: boolean;
-	readonly year?: string;
-}
-type CreatePlanChange = {
-	readonly type: "copy-template";
-	readonly template: string;
-	readonly targetDir: string;
-	readonly overlayBaseTemplate: boolean;
-} | {
-	readonly type: "inject-shared-config";
-} | {
-	readonly type: "rewrite-local-dependencies";
-	readonly mode: "workspace";
-} | {
-	readonly type: "add-blocks";
-	readonly blocks: readonly string[];
-};
-interface CreateProjectPlan {
-	readonly preset: CreatePresetDefinition;
-	readonly values: {
-		readonly packageName: string;
-		readonly projectName: string;
-		readonly version: string;
-		readonly description: string;
-		readonly binName: string;
-		readonly year: string;
-	};
-	readonly changes: readonly CreatePlanChange[];
-}
-declare function planCreateProject(input: CreateProjectInput): Result<CreateProjectPlan, ValidationError>;
-declare const CREATE_PRESETS: Readonly<Record<CreatePresetId, CreatePresetDefinition>>;
-declare const CREATE_PRESET_IDS: CreatePresetId[];
-declare function getCreatePreset(id: string): CreatePresetDefinition | undefined;
-type CreateStructure = "single" | "workspace";
-interface CreateOptions {
-	readonly targetDir: string;
-	readonly name?: string | undefined;
-	readonly preset?: CreatePresetId | undefined;
-	readonly structure?: CreateStructure | undefined;
-	readonly workspaceName?: string | undefined;
-	readonly local?: boolean | undefined;
-	readonly force: boolean;
-	readonly with?: string | undefined;
-	readonly noTooling?: boolean | undefined;
-	readonly yes?: boolean | undefined;
-}
-interface CreateResult {
-	readonly structure: CreateStructure;
-	readonly rootDir: string;
-	readonly projectDir: string;
-	readonly preset: CreatePresetId;
-	readonly packageName: string;
-	readonly blocksAdded?: AddBlockResult | undefined;
-}
-declare class CreateError extends Error {
-	readonly _tag: "CreateError";
-	constructor(message: string);
-}
-declare function runCreate(options: CreateOptions): Promise<Result2<CreateResult, CreateError>>;
-declare function printCreateResults(result: CreateResult, options?: {
-	mode?: OutputMode;
-}): Promise<void>;
-declare function createCommand(program: Command): void;
-import { OutputMode as OutputMode2 } from "@outfitter/cli/types";
-import { Command as Command2 } from "commander";
 /**
 * Options for the doctor command.
 */
@@ -202,7 +113,7 @@ declare function runDoctor(options: DoctorOptions): DoctorResult;
 * Formats and outputs doctor results.
 */
 declare function printDoctorResults(result: DoctorResult, options?: {
-	mode?: OutputMode2;
+	mode?: OutputMode;
 }): Promise<void>;
 /**
 * Registers the doctor command with the CLI program.
@@ -218,37 +129,104 @@ declare function printDoctorResults(result: DoctorResult, options?: {
 * doctorCommand(program);
 * ```
 */
-declare function doctorCommand(program: Command2): void;
+declare function doctorCommand(program: Command): void;
+import { OutputMode as OutputMode2 } from "@outfitter/cli/types";
 import { Result as Result3 } from "@outfitter/contracts";
-import { AddBlockResult as AddBlockResult2 } from "@outfitter/tooling";
-import { Command as Command3 } from "commander";
+import { AddBlockResult } from "@outfitter/tooling";
+import { Command as Command2 } from "commander";
+interface PostScaffoldResult {
+	readonly installResult: "success" | "failed" | "skipped";
+	readonly installError?: string | undefined;
+	readonly gitInitResult: "success" | "failed" | "skipped" | "already-repo";
+	readonly gitCommitResult: "success" | "failed" | "skipped";
+	readonly gitError?: string | undefined;
+	readonly nextSteps: readonly string[];
+}
+import { NotFoundError, Result as Result2, ValidationError } from "@outfitter/contracts";
+/**
+* Unique identifier for a scaffold target.
+*/
+type TargetId = "minimal" | "cli" | "mcp" | "daemon" | "api" | "worker" | "web" | "lib";
+/**
+* Whether the target produces a runnable application or a library package.
+*/
+type TargetCategory = "runnable" | "library";
+/**
+* Whether the target has a working template or is a planned placeholder.
+*/
+type TargetStatus = "ready" | "stub";
+/**
+* Whether a target can be used with init, scaffold, or both.
+*/
+type TargetScope = "init-only" | "scaffold-only" | "both";
+/**
+* Complete definition for a scaffold target.
+*/
+interface TargetDefinition {
+	readonly id: TargetId;
+	readonly description: string;
+	readonly category: TargetCategory;
+	readonly placement: "apps" | "packages";
+	readonly templateDir: string;
+	readonly defaultBlocks: readonly string[];
+	readonly status: TargetStatus;
+	readonly scope: TargetScope;
+}
+declare const TARGET_REGISTRY: ReadonlyMap<TargetId, TargetDefinition>;
+declare const TARGET_IDS: readonly TargetId[];
+declare const READY_TARGET_IDS: readonly TargetId[];
+declare const INIT_TARGET_IDS: readonly TargetId[];
+declare const SCAFFOLD_TARGET_IDS: readonly TargetId[];
+declare function getTarget(id: string): Result2<TargetDefinition, NotFoundError>;
+declare function getReadyTarget(id: string): Result2<TargetDefinition, NotFoundError | ValidationError>;
+declare function getInitTarget(id: string): Result2<TargetDefinition, NotFoundError | ValidationError>;
+declare function getScaffoldTarget(id: string): Result2<TargetDefinition, NotFoundError | ValidationError>;
+declare function resolvePlacement(target: TargetDefinition): "apps" | "packages";
+declare function listTargets(filter?: {
+	readonly status?: TargetStatus;
+	readonly scope?: TargetScope;
+	readonly category?: TargetCategory;
+}): readonly TargetDefinition[];
+type InitStructure = "single" | "workspace";
+type InitPresetId = Extract<TargetId, "minimal" | "cli" | "mcp" | "daemon">;
 /**
 * Options for the init command.
 */
 interface InitOptions {
-	/** Target directory to initialize the project in */
 	readonly targetDir: string;
-	/** Package name (defaults to directory name if not provided) */
 	readonly name: string | undefined;
-	/** Binary name (defaults to project name if not provided) */
 	readonly bin?: string | undefined;
-	/** Template to use (defaults to 'basic') */
-	readonly template: string | undefined;
-	/** Whether to use local/workspace dependencies */
+	readonly preset?: InitPresetId | undefined;
+	/** @deprecated Use `preset` instead. */
+	readonly template?: string | undefined;
+	readonly structure?: InitStructure | undefined;
+	readonly workspaceName?: string | undefined;
 	readonly local?: boolean | undefined;
-	/** Whether to overwrite existing files */
 	readonly force: boolean;
-	/** Tooling blocks to add (e.g., "scaffolding" or "claude,biome,lefthook") */
 	readonly with?: string | undefined;
-	/** Skip tooling prompt in interactive mode */
 	readonly noTooling?: boolean | undefined;
+	readonly yes?: boolean | undefined;
+	readonly dryRun?: boolean | undefined;
+	readonly skipInstall?: boolean | undefined;
+	readonly skipGit?: boolean | undefined;
+	readonly skipCommit?: boolean | undefined;
+	readonly installTimeout?: number | undefined;
 }
 /**
-* Result of running init, including any blocks added.
+* Result of running init.
 */
 interface InitResult {
-	/** The blocks that were added, if any */
-	readonly blocksAdded?: AddBlockResult2 | undefined;
+	readonly structure: InitStructure;
+	readonly rootDir: string;
+	readonly projectDir: string;
+	readonly preset: InitPresetId;
+	readonly packageName: string;
+	readonly blocksAdded?: AddBlockResult | undefined;
+	readonly postScaffold: PostScaffoldResult;
+	readonly dryRunPlan?: {
+		readonly operations: readonly unknown[];
+		readonly summary: Record<string, number>;
+	} | undefined;
 }
 /**
 * Error returned when initialization fails.
@@ -257,51 +235,14 @@ declare class InitError extends Error {
 	readonly _tag: "InitError";
 	constructor(message: string);
 }
-/**
-* Runs the init command programmatically.
-*
-* @param options - Init options
-* @returns Result indicating success or failure
-*
-* @example
-* ```typescript
-* const result = await runInit({
-*   targetDir: "./my-project",
-*   name: "my-project",
-*   template: "basic",
-*   force: false,
-*   blocks: "scaffolding", // Optional: add tooling blocks
-* });
-*
-* if (result.isOk()) {
-*   console.log("Project initialized successfully!");
-*   if (result.value.blocksAdded) {
-*     console.log(`Added ${result.value.blocksAdded.created.length} tooling files`);
-*   }
-* } else {
-*   console.error("Failed:", result.error.message);
-* }
-* ```
-*/
-declare function runInit(options: InitOptions): Promise<Result3<InitResult, InitError>>;
-/**
-* Registers the init command with the CLI program.
-*
-* @param program - Commander program instance
-*
-* @example
-* ```typescript
-* import { Command } from "commander";
-* import { initCommand } from "./commands/init.js";
-*
-* const program = new Command();
-* initCommand(program);
-* ```
-*/
-declare function initCommand(program: Command3): void;
-import { OutputMode as OutputMode4 } from "@outfitter/cli/types";
+declare function runInit(options: InitOptions, presetOverride?: InitPresetId): Promise<Result3<InitResult, InitError>>;
+declare function printInitResults(result: InitResult, options?: {
+	mode?: OutputMode2;
+}): Promise<void>;
+declare function initCommand(program: Command2): void;
+import { OutputMode as OutputMode3 } from "@outfitter/cli/types";
 import { Result as Result4 } from "@outfitter/contracts";
-import { Command as Command4 } from "commander";
+import { Command as Command3 } from "commander";
 interface DiffPreview {
 	readonly path: string;
 	readonly preview: string;
@@ -343,10 +284,145 @@ declare function runMigrateKit(options: MigrateKitOptions): Promise<Result4<Migr
 * Print migrate-kit results.
 */
 declare function printMigrateKitResults(result: MigrateKitResult, options?: {
-	mode?: OutputMode4;
+	mode?: OutputMode3;
 }): Promise<void>;
 /**
 * Register `migrate kit` command directly on Commander.
 */
-declare function migrateKitCommand(program: Command4): void;
-export { runMigrateKit, runInit, runDoctor, runCreate, printMigrateKitResults, printDoctorResults, printCreateResults, planCreateProject, outfitterActions, migrateKitCommand, initCommand, getCreatePreset, doctorCommand, createCommand, PackageJsonCheck, MigrateKitResult, MigrateKitOptions, MigrateKitError, InitOptions, InitError, DoctorSummary, DoctorResult, DoctorOptions, DirectoriesCheck, DependenciesCheck, CreateStructure, CreateResult, CreateProjectPlan, CreateProjectInput, CreatePresetId, CreatePresetDefinition, CreatePlanChange, CreateOptions, CreateError, ConfigFilesCheck, CheckResult, CREATE_PRESET_IDS, CREATE_PRESETS, BunVersionCheck };
+declare function migrateKitCommand(program: Command3): void;
+import { Command as Command5 } from "commander";
+type DocsMdxMode = "strict" | "lossy";
+interface DocsBaseOptions {
+	readonly cwd?: string;
+	readonly workspaceRoot?: string;
+	readonly packagesDir?: string;
+	readonly outputDir?: string;
+	readonly excludedFilenames?: readonly string[];
+	readonly mdxMode?: DocsMdxMode;
+}
+interface ExecuteCheckCommandOptions extends DocsBaseOptions {}
+interface ExecuteSyncCommandOptions extends DocsBaseOptions {}
+type DocsExportTarget = "packages" | "llms" | "llms-full" | "all";
+interface ExecuteExportCommandOptions extends DocsBaseOptions {
+	readonly llmsFile?: string;
+	readonly llmsFullFile?: string;
+	readonly target?: DocsExportTarget | string;
+}
+type RepoCheckSubject = "docs" | "exports" | "readme" | "registry" | "changeset" | "tree" | "boundary-invocations";
+interface RepoCommandIo {
+	readonly out?: (line: string) => void;
+	readonly err?: (line: string) => void;
+}
+interface RepoToolingInvocation {
+	readonly command: "check-exports" | "check-readme-imports" | "check-bunup-registry" | "check-changeset" | "check-clean-tree" | "check-boundary-invocations";
+	readonly args: readonly string[];
+	readonly cwd: string;
+}
+interface CreateRepoCommandOptions {
+	readonly commandName?: string;
+	readonly io?: RepoCommandIo;
+	readonly runDocsCheck?: (options: ExecuteCheckCommandOptions, io: Required<RepoCommandIo>) => Promise<number>;
+	readonly runDocsSync?: (options: ExecuteSyncCommandOptions, io: Required<RepoCommandIo>) => Promise<number>;
+	readonly runDocsExport?: (options: ExecuteExportCommandOptions, io: Required<RepoCommandIo>) => Promise<number>;
+	readonly runToolingCommand?: (input: RepoToolingInvocation) => Promise<number>;
+}
+declare function createRepoCommand(options?: CreateRepoCommandOptions): Command5;
+import { OutputMode as OutputMode4 } from "@outfitter/cli/types";
+import { Result as Result5 } from "@outfitter/contracts";
+import { AddBlockResult as AddBlockResult2 } from "@outfitter/tooling";
+import { Command as Command6 } from "commander";
+interface ScaffoldOptions {
+	readonly target: string;
+	readonly name?: string | undefined;
+	readonly force: boolean;
+	readonly skipInstall: boolean;
+	readonly dryRun: boolean;
+	readonly with?: string | undefined;
+	readonly noTooling?: boolean | undefined;
+	readonly local?: boolean | undefined;
+	readonly cwd: string;
+	readonly installTimeout?: number | undefined;
+}
+interface ScaffoldCommandResult {
+	readonly target: string;
+	readonly rootDir: string;
+	readonly targetDir: string;
+	readonly converted: boolean;
+	readonly movedExisting?: {
+		readonly from: string;
+		readonly to: string;
+		readonly name: string;
+	} | undefined;
+	readonly workspacePatternsUpdated: boolean;
+	readonly blocksAdded?: AddBlockResult2 | undefined;
+	readonly postScaffold: PostScaffoldResult;
+	readonly dryRunPlan?: {
+		readonly operations: readonly unknown[];
+		readonly summary: Record<string, number>;
+	} | undefined;
+}
+declare class ScaffoldCommandError extends Error {
+	readonly _tag: "ScaffoldCommandError";
+	constructor(message: string);
+}
+declare function runScaffold(options: ScaffoldOptions): Promise<Result5<ScaffoldCommandResult, ScaffoldCommandError>>;
+declare function printScaffoldResults(result: ScaffoldCommandResult, options?: {
+	readonly mode?: OutputMode4;
+}): Promise<void>;
+declare function scaffoldCommand(program: Command6): void;
+import { Result as Result6, ValidationError as ValidationError2 } from "@outfitter/contracts";
+/**
+* Create planner types for kit-first project scaffolding.
+*
+* These types model preset intent separately from execution so future flows can
+* consume a deterministic plan before mutating the filesystem.
+*/
+type CreatePresetId = "basic" | "cli" | "daemon" | "mcp";
+interface CreatePresetDefinition {
+	readonly id: CreatePresetId;
+	readonly template: CreatePresetId;
+	readonly summary: string;
+	readonly defaultBlocks: readonly string[];
+}
+interface CreateProjectInput {
+	readonly name: string;
+	readonly targetDir: string;
+	readonly preset: CreatePresetId;
+	readonly packageName?: string;
+	readonly description?: string;
+	readonly version?: string;
+	readonly includeTooling?: boolean;
+	readonly local?: boolean;
+	readonly year?: string;
+}
+type CreatePlanChange = {
+	readonly type: "copy-template";
+	readonly template: string;
+	readonly targetDir: string;
+	readonly overlayBaseTemplate: boolean;
+} | {
+	readonly type: "inject-shared-config";
+} | {
+	readonly type: "rewrite-local-dependencies";
+	readonly mode: "workspace";
+} | {
+	readonly type: "add-blocks";
+	readonly blocks: readonly string[];
+};
+interface CreateProjectPlan {
+	readonly preset: CreatePresetDefinition;
+	readonly values: {
+		readonly packageName: string;
+		readonly projectName: string;
+		readonly version: string;
+		readonly description: string;
+		readonly binName: string;
+		readonly year: string;
+	};
+	readonly changes: readonly CreatePlanChange[];
+}
+declare function planCreateProject(input: CreateProjectInput): Result6<CreateProjectPlan, ValidationError2>;
+declare const CREATE_PRESETS: Readonly<Record<CreatePresetId, CreatePresetDefinition>>;
+declare const CREATE_PRESET_IDS: CreatePresetId[];
+declare function getCreatePreset(id: string): CreatePresetDefinition | undefined;
+export { scaffoldCommand, runScaffold, runMigrateKit, runInit, runDoctor, resolvePlacement, printScaffoldResults, printMigrateKitResults, printInitResults, printDoctorResults, planCreateProject, outfitterActions, migrateKitCommand, listTargets, initCommand, getTarget, getScaffoldTarget, getReadyTarget, getInitTarget, getCreatePreset, doctorCommand, createRepoCommand, TargetStatus, TargetScope, TargetId, TargetDefinition, TargetCategory, TARGET_REGISTRY, TARGET_IDS, ScaffoldOptions, ScaffoldCommandResult, ScaffoldCommandError, SCAFFOLD_TARGET_IDS, RepoToolingInvocation, RepoCommandIo, RepoCheckSubject, READY_TARGET_IDS, PackageJsonCheck, MigrateKitResult, MigrateKitOptions, MigrateKitError, InitStructure, InitResult, InitPresetId, InitOptions, InitError, INIT_TARGET_IDS, DoctorSummary, DoctorResult, DoctorOptions, DirectoriesCheck, DependenciesCheck, CreateRepoCommandOptions, CreateProjectPlan, CreateProjectInput, CreatePresetId, CreatePresetDefinition, CreatePlanChange, ConfigFilesCheck, CheckResult, CREATE_PRESET_IDS, CREATE_PRESETS, BunVersionCheck };

package/dist/index.js

@@ -1,42 +1,172 @@
 import {
-  CREATE_PRESETS,
-  CREATE_PRESET_IDS,
-  CreateError,
+  INIT_TARGET_IDS,
   InitError,
   MigrateKitError,
-  createCommand,
+  READY_TARGET_IDS,
+  SCAFFOLD_TARGET_IDS,
+  ScaffoldCommandError,
+  TARGET_IDS,
+  TARGET_REGISTRY,
+  createRepoCommand,
+  deriveBinName,
+  deriveProjectName,
   doctorCommand,
-  getCreatePreset,
+  getInitTarget,
+  getReadyTarget,
+  getScaffoldTarget,
+  getTarget,
   initCommand,
+  listTargets,
   migrateKitCommand,
   outfitterActions,
-  planCreateProject,
-  printCreateResults,
   printDoctorResults,
+  printInitResults,
   printMigrateKitResults,
-  runCreate,
+  printScaffoldResults,
+  resolvePlacement,
   runDoctor,
   runInit,
-  runMigrateKit
-} from "./shared/chunk-sak1tt33.js";
+  runMigrateKit,
+  runScaffold,
+  scaffoldCommand
+} from "./shared/chunk-tpwtpa74.js";
+// src/create/planner.ts
+import { Result, ValidationError } from "@outfitter/contracts";
+
+// src/create/presets.ts
+var CREATE_PRESETS = {
+  basic: {
+    id: "basic",
+    template: "basic",
+    summary: "Minimal Bun + TypeScript project.",
+    defaultBlocks: ["scaffolding"]
+  },
+  cli: {
+    id: "cli",
+    template: "cli",
+    summary: "CLI starter with Outfitter command ergonomics.",
+    defaultBlocks: ["scaffolding"]
+  },
+  daemon: {
+    id: "daemon",
+    template: "daemon",
+    summary: "Daemon + control CLI starter.",
+    defaultBlocks: ["scaffolding"]
+  },
+  mcp: {
+    id: "mcp",
+    template: "mcp",
+    summary: "MCP server starter.",
+    defaultBlocks: ["scaffolding"]
+  }
+};
+var CREATE_PRESET_IDS = Object.keys(CREATE_PRESETS);
+function getCreatePreset(id) {
+  const presets = CREATE_PRESETS;
+  return presets[id];
+}
+
+// src/create/planner.ts
+function derivePackageName(input) {
+  return (input.packageName ?? input.name).trim();
+}
+function planCreateProject(input) {
+  const packageName = derivePackageName(input);
+  if (packageName.length === 0) {
+    return Result.err(new ValidationError({
+      message: "Project name must not be empty",
+      field: "name"
+    }));
+  }
+  const targetDir = input.targetDir.trim();
+  if (targetDir.length === 0) {
+    return Result.err(new ValidationError({
+      message: "Target directory must not be empty",
+      field: "targetDir"
+    }));
+  }
+  if (packageName.startsWith("@") && !packageName.includes("/")) {
+    return Result.err(new ValidationError({
+      message: "Could not derive a project name from package name",
+      field: "packageName"
+    }));
+  }
+  const projectName = deriveProjectName(packageName);
+  if (projectName.length === 0) {
+    return Result.err(new ValidationError({
+      message: "Could not derive a project name from package name",
+      field: "packageName"
+    }));
+  }
+  const preset = getCreatePreset(input.preset);
+  if (!preset) {
+    return Result.err(new ValidationError({
+      message: `Unknown create preset '${input.preset}'`,
+      field: "preset"
+    }));
+  }
+  const includeTooling = input.includeTooling ?? true;
+  const defaultBlocks = includeTooling ? [...preset.defaultBlocks] : [];
+  const changes = [
+    {
+      type: "copy-template",
+      template: preset.template,
+      targetDir,
+      overlayBaseTemplate: true
+    },
+    { type: "inject-shared-config" }
+  ];
+  if (input.local) {
+    changes.push({ type: "rewrite-local-dependencies", mode: "workspace" });
+  }
+  if (defaultBlocks.length > 0) {
+    changes.push({ type: "add-blocks", blocks: defaultBlocks });
+  }
+  const plan = {
+    preset,
+    values: {
+      packageName,
+      projectName,
+      version: input.version?.trim() || "0.1.0",
+      description: input.description?.trim() || "A new project created with Outfitter",
+      binName: deriveBinName(projectName),
+      year: input.year ?? String(new Date().getFullYear())
+    },
+    changes
+  };
+  return Result.ok(plan);
+}
 export {
+  scaffoldCommand,
+  runScaffold,
   runMigrateKit,
   runInit,
   runDoctor,
-  runCreate,
+  resolvePlacement,
+  printScaffoldResults,
   printMigrateKitResults,
+  printInitResults,
   printDoctorResults,
-  printCreateResults,
   planCreateProject,
   outfitterActions,
   migrateKitCommand,
+  listTargets,
   initCommand,
+  getTarget,
+  getScaffoldTarget,
+  getReadyTarget,
+  getInitTarget,
   getCreatePreset,
   doctorCommand,
-  createCommand,
+  createRepoCommand,
+  TARGET_REGISTRY,
+  TARGET_IDS,
+  ScaffoldCommandError,
+  SCAFFOLD_TARGET_IDS,
+  READY_TARGET_IDS,
   MigrateKitError,
   InitError,
-  CreateError,
+  INIT_TARGET_IDS,
   CREATE_PRESET_IDS,
   CREATE_PRESETS
 };