inferative 0.0.0 → 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,120 @@
+import { ArgsDef, CommandDef } from "citty";
+//#region src/registry/registry-access.d.ts
+/** The result of one spawned command, captured rather than inherited. */
+interface ProcessRunResult {
+  /** The process exit code; a process that never exited counts as `1`. */
+  readonly exitCode: number;
+  /** Captured standard output. */
+  readonly stdout: string;
+  /** Captured standard error. */
+  readonly stderr: string;
+  /** Whether the program could not be started because it is not installed. */
+  readonly commandMissing?: boolean;
+}
+/** Spawns a command and resolves its captured result. A test injects one so no real `npm` runs. */
+type ProcessRunner = (command: string, commandArguments: readonly string[], workingDirectory: string, environment: Readonly<Record<string, string | undefined>>) => Promise<ProcessRunResult>;
+/** The verdict {@link RegistryAccess.probe} reaches. */
+declare const RegistryAccessStatus: {
+  /** Both scopes reach GitHub Packages and the registry answered for each probe package. */
+  readonly Ok: "ok";
+  /** A scope does not point at GitHub Packages. */
+  readonly ScopeNotRouted: "scope-not-routed";
+  /** The registry refused the request for lacking, or holding invalid, credentials. */
+  readonly Unauthorized: "unauthorized";
+  /** npm cannot be started: Node.js is installed without it, or not at all. */
+  readonly NpmNotFound: "npm-not-found";
+  /** The registry could not be reached (DNS, network, timeout or an unknown failure). */
+  readonly Unreachable: "unreachable";
+  /** The registry authorized the request, but the probe package is not there. */
+  readonly NotFound: "not-found";
+};
+/** One of {@link RegistryAccessStatus}. */
+type RegistryAccessStatusValue = (typeof RegistryAccessStatus)[keyof typeof RegistryAccessStatus];
+/** What {@link RegistryAccess.probe} reports. */
+interface RegistryAccessReport {
+  /** The verdict. */
+  readonly status: RegistryAccessStatusValue;
+  /** The scope the verdict is about: the first one that is not routed or not readable. Absent for `Ok`. */
+  readonly scope?: string;
+  /** The raw output behind the verdict, for a diagnosis. */
+  readonly detail?: string;
+}
+//#endregion
+//#region src/init/dependency-installer.d.ts
+/**
+ * Installs the dependencies of a project folder, and throws when the install fails. A test injects one so no real
+ * package manager runs.
+ */
+type InstallRunner = (directory: string) => Promise<void>;
+//#endregion
+//#region src/init/starter-source.d.ts
+/** Downloads one giget source into an empty folder. A test injects one so nothing touches the network. */
+type StarterDownload = (source: string, directory: string) => Promise<void>;
+//#endregion
+//#region src/init/project-initializer.d.ts
+/** Reads whether the scopes of a folder reach GitHub Packages. A test injects one so no real `npm` runs. */
+type RegistryProbe = (directory: string) => Promise<RegistryAccessReport>;
+/** The injectable parts of {@link ProjectInitializer}. */
+interface InitDependencies {
+  /** Downloads a giget source. Giget by default. */
+  readonly download?: StarterDownload;
+  /** Probes the registry. {@link RegistryAccess} by default. */
+  readonly probeRegistry?: RegistryProbe;
+  /** Runs the `npm` calls of the default registry probe. Spawns npm by default. */
+  readonly runNpm?: ProcessRunner;
+  /** Runs the install. Spawns pnpm by default. */
+  readonly runInstall?: InstallRunner;
+}
+//#endregion
+//#region src/init/init-command.d.ts
+/** What one `init` invocation was asked to do. */
+interface InitArguments {
+  /** The folder to create. The current folder when absent. */
+  readonly directory?: string;
+  /** The starter folder name. */
+  readonly starter?: string;
+  /** One giget source to use alone. */
+  readonly source?: string;
+  /** A local starters folder to copy from. */
+  readonly local?: string;
+  /** The folder that a named `directory` is created in. */
+  readonly cwd?: string;
+  /** Whether to install the dependencies. `false` for `--no-install`. */
+  readonly install?: boolean;
+}
+/** The parts of an `init` run that a test replaces. */
+interface InitOptions {
+  /** The working directory. The process's own by default. */
+  readonly cwd?: string;
+  /** The version of the command line. The package's own by default. */
+  readonly version?: string;
+  /** The download, the registry probe and the install. */
+  readonly dependencies?: InitDependencies;
+  /** Writes a line to the output. */
+  readonly print?: (line: string) => void;
+  /** Writes a line to the error output. */
+  readonly fail?: (line: string) => void;
+}
+/** The `init` command. */
+export declare class InitCommand {
+  /** The name it is registered under. */
+  static readonly name: string;
+  /** The exit code of a run that made a usable project. */
+  static readonly okExitCode: number;
+  /** The exit code of a run that failed, including a failed install. */
+  static readonly failureExitCode: number;
+  /** The command definition. */
+  static definition(): CommandDef;
+  /** The argument definition, which `create-inferative` shares. */
+  static args(): ArgsDef;
+  /**
+   * Creates one project and answers the exit code.
+   *
+   * @param args - What the invocation was asked to do.
+   * @param options - The working directory, the version and the replaceable parts. A test supplies them.
+   * @returns {@link okExitCode} when the project is usable, otherwise {@link failureExitCode}.
+   */
+  static execute(args: InitArguments, options?: InitOptions): Promise<number>;
+}
+//#endregion
+export type { InitArguments, InitOptions };

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import { t as InitCommand } from "./init-command-C2q2dkCV.mjs";
+export { InitCommand };