create-eigen-game 0.12.1 → 0.13.0

package/dist/cli.d.ts

@@ -1 +1,2 @@
 #!/usr/bin/env node
+export {};

package/dist/engine-range.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Where the engine range emitted into a scaffolded project comes from.
+ *
+ * Its own module because the two branches below execute in different worlds,
+ * one only inside this repository and the other only inside a published tarball,
+ * and a function whose published-only path never runs in CI is a function that
+ * is not tested. `src/index.ts` uses it; the package `exports` map does not
+ * expose it, so it is internal despite being importable by the tests.
+ */
+/** The dependency whose version the scaffolder emits into the generated server. */
+export declare const ENGINE_PACKAGE = "@eigeninteractive/server";
+/**
+ * The engine range for a scaffolded project, from this package's own
+ * `@eigeninteractive/server` devDependency.
+ *
+ * That number is not maintained by anyone: it is the version CI compiled the
+ * templates against, because `pnpm -r typecheck` runs
+ * `tsc -p templates/worker/tsconfig.json` inside this workspace. Emitting
+ * anything else would mean shipping templates paired with an engine no build
+ * ever saw.
+ *
+ * It replaced a derivation from this package's OWN version, which was correct
+ * only while `create-eigen-game` sat in the `fixed` changesets group, and that
+ * membership is what forced an engine-wide release for every scaffolder-only
+ * change. Reading the dependency keeps the guarantee and drops the coupling.
+ *
+ * Two branches, because the same manifest reads differently in the two places
+ * this runs:
+ *
+ * - **Published tarball**: pnpm rewrites `workspace:*` to the exact version
+ *   while packing, so the manifest already states it (`"0.2.0"`), and no
+ *   sibling package exists on disk to consult.
+ * - **This workspace**: the manifest still says `workspace:*`, which names no
+ *   version, so the sibling package is read directly.
+ *
+ * @param declared the raw `@eigeninteractive/server` devDependency value
+ * @param readSiblingVersion consulted only for the `workspace:` protocol
+ */
+export declare function engineRange(declared: string | undefined, readSiblingVersion: () => string | undefined): string;

package/dist/index.d.ts

@@ -1,13 +1,7 @@
-/** What the Firebase step managed to settle, and what it left for the console. */
-interface FirebaseLink {
-    /** The project now in `wrangler.jsonc`, or null when FlutterFire recorded none. */
-    projectId: string | null;
-    /** The OAuth web client now in `app-config.json`, or null when Google sign-in is not enabled yet. */
-    googleWebClientId: string | null;
-}
-
-type PackageManager = "npm" | "pnpm";
-type Runner = (command: string, args: string[], cwd: string) => void;
+import { type FirebaseLink } from "./link-firebase.js";
+export type { FirebaseLink } from "./link-firebase.js";
+export type PackageManager = "npm" | "pnpm";
+export type Runner = (command: string, args: string[], cwd: string) => void;
 /**
  * Where a scaffold says what it is doing, so that presentation belongs to the
  * caller and this module only has to name things.
@@ -17,7 +11,7 @@ type Runner = (command: string, args: string[], cwd: string) => void;
  * substitutes one that captures each step's output and shows it only if the
  * step fails.
  */
-interface Reporter {
+export interface Reporter {
     /** Runs `body` as one named step. Its subprocesses can be captured. */
     step<T>(label: string, body: () => T): T;
     /**
@@ -42,12 +36,12 @@ interface Reporter {
  * with `RangeError: Invalid string length`. Supplying the default its check
  * misses is better than giving up the drawing.
  */
-declare function normaliseTerminalWidth(stream: {
+export declare function normaliseTerminalWidth(stream: {
     isTTY?: boolean;
     columns?: number;
 }): void;
 /** Runs every step plainly, which is what a library caller gets by default. */
-declare const plainReporter: Reporter;
+export declare const plainReporter: Reporter;
 /**
  * The runner a scaffold uses when the caller has not supplied one: it asks the
  * reporter whether the terminal is spoken for.
@@ -57,8 +51,8 @@ declare const plainReporter: Reporter;
  * handed to the reporter: on success so it can discard them, and on failure
  * so the reason survives.
  */
-declare function capturingRunner(reporter: Reporter): Runner;
-interface ScaffoldOptions {
+export declare function capturingRunner(reporter: Reporter): Runner;
+export interface ScaffoldOptions {
     directory: string;
     org?: string;
     packageManager?: PackageManager;
@@ -107,8 +101,8 @@ interface ScaffoldOptions {
  * than guess. `failed` has already warned by the time it is returned, and
  * carries no advice of its own.
  */
-type GitOutcome = "committed" | "existing" | "skipped" | "failed";
-interface ScaffoldResult {
+export type GitOutcome = "committed" | "existing" | "skipped" | "failed";
+export interface ScaffoldResult {
     root: string;
     name: string;
     git: GitOutcome;
@@ -132,10 +126,10 @@ interface ScaffoldResult {
  * the *prefix*, not the whole identifier, which is the part worth seeing
  * before answering: Google Play makes it permanent at first upload.
  */
-declare function applicationId(directory: string, org?: string): string;
-declare function detectPackageManager(userAgent?: string | undefined): PackageManager | undefined;
-declare function decodeUtf8(bytes: Buffer): string | undefined;
-interface AddContinuousIntegrationOptions {
+export declare function applicationId(directory: string, org?: string): string;
+export declare function detectPackageManager(userAgent?: string | undefined): PackageManager | undefined;
+export declare function decodeUtf8(bytes: Buffer): string | undefined;
+export interface AddContinuousIntegrationOptions {
     directory: string;
     /** Overrides the manager recorded in the project's own package.json. */
     packageManager?: PackageManager;
@@ -147,23 +141,23 @@ interface AddContinuousIntegrationOptions {
  * long as its author likes, then gain the same PR gate and signed release
  * pipeline a `--ci` scaffold would have produced.
  */
-declare function addContinuousIntegration(options: AddContinuousIntegrationOptions): {
+export declare function addContinuousIntegration(options: AddContinuousIntegrationOptions): {
     root: string;
     files: string[];
 };
 /** Asks a command a question. `ok` is "ran and succeeded"; a tool that is not installed and one that fails are both `false`, because neither can be used. */
-type Probe = (command: string, args: string[]) => {
+export type Probe = (command: string, args: string[]) => {
     ok: boolean;
     stdout: string;
 };
 /** One thing standing between this machine and a configured Firebase project, and the single command that clears it. */
-interface FirebaseProblem {
+export interface FirebaseProblem {
     /** Said as a sentence fragment, so it reads after "Firebase is not set up here:". */
     reason: string;
     /** The one command that fixes this, and nothing else. */
     fix: string;
 }
-type FirebaseReadiness = {
+export type FirebaseReadiness = {
     ready: true;
 } | {
     ready: false;
@@ -189,7 +183,7 @@ type FirebaseReadiness = {
  * that errors or grows a different output shape is left to the command that
  * actually needs the credentials.
  */
-declare function firebaseReadiness(probe?: Probe): FirebaseReadiness;
+export declare function firebaseReadiness(probe?: Probe): FirebaseReadiness;
 /**
  * Whether the scaffold would land inside a repository that already exists.
  *
@@ -222,8 +216,6 @@ declare function firebaseReadiness(probe?: Probe): FirebaseReadiness;
  * the last one. {@link scaffoldGame} asks it again, for callers that are not
  * the CLI.
  */
-declare function destinationProblem(directory: string): string | undefined;
-declare function insideWorkTree(directory: string, probe?: Probe): boolean;
-declare function scaffoldGame(options: ScaffoldOptions): ScaffoldResult;
-
-export { type AddContinuousIntegrationOptions, type FirebaseLink, type FirebaseProblem, type FirebaseReadiness, type GitOutcome, type PackageManager, type Probe, type Reporter, type Runner, type ScaffoldOptions, type ScaffoldResult, addContinuousIntegration, applicationId, capturingRunner, decodeUtf8, destinationProblem, detectPackageManager, firebaseReadiness, insideWorkTree, normaliseTerminalWidth, plainReporter, scaffoldGame };
+export declare function destinationProblem(directory: string): string | undefined;
+export declare function insideWorkTree(directory: string, probe?: Probe): boolean;
+export declare function scaffoldGame(options: ScaffoldOptions): ScaffoldResult;

package/dist/link-firebase.d.ts

@@ -0,0 +1,28 @@
+/** What the Firebase step managed to settle, and what it left for the console. */
+export interface FirebaseLink {
+    /** The project now in `wrangler.jsonc`, or null when FlutterFire recorded none. */
+    projectId: string | null;
+    /** The OAuth web client now in `app-config.json`, or null when Google sign-in is not enabled yet. */
+    googleWebClientId: string | null;
+}
+/**
+ * The project FlutterFire recorded for the Dart output this app uses.
+ *
+ * `firebase.json` is FlutterFire's own record rather than something this
+ * scaffold writes, so it is read defensively: a shape that does not match is
+ * treated as "not configured", which is the same answer as a run that never
+ * happened.
+ */
+export declare function configuredProject(appRoot: string): string | null;
+/**
+ * The OAuth web client id that `configure_firebase` copied into
+ * `app-config.json`, when there was one to copy.
+ *
+ * Empty is an ordinary outcome rather than a failure. Firebase creates that
+ * client when the Google sign-in provider is enabled, which is a console
+ * action no CLI can perform, so a project that has never had it enabled has
+ * nothing to offer here.
+ */
+export declare function configuredWebClientId(appRoot: string): string | null;
+/** What the Firebase step settled, for the summary to report. */
+export declare function readFirebaseLink(root: string): FirebaseLink;

package/dist/prompt.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Every question this CLI asks, in one module so the wording lives together
+ * and can be asserted. `cli.ts` is the bin entry and runs `main` on import,
+ * which makes anything defined there untestable.
+ *
+ * The organization prompt is the reason this drops to `@clack/core` rather
+ * than using `@clack/prompts`' `text`. The suffix: `flutter create --org X
+ * --project-name Y` derives `X.Y`, so the organization is a *prefix*, and the
+ * reliable way to say so is to render the rest of the identifier, dimmed,
+ * while it is being typed. `text` has no hook for that; a custom `TextPrompt`
+ * render returns a string, so it does.
+ *
+ * Everything else comes from `@clack/prompts` rather than being drawn here.
+ * Its symbols are exported for exactly this, and they are not constants: each
+ * falls back to ASCII on a terminal that cannot show the box-drawing
+ * characters, which a hand-typed `│` cannot do.
+ */
+import type { Readable, Writable } from "node:stream";
+import type { PackageManager } from "./index.js";
+/**
+ * Where a question reads its answer from. Parameters for the same reason every
+ * clack prompt takes them: a prompt is otherwise the one part of a CLI that
+ * cannot be driven by a test.
+ */
+export interface Io {
+    input?: Readable;
+    output?: Writable;
+}
+/**
+ * Two or more dot-separated Java identifiers. `flutter create --org` accepts
+ * anything and defers the complaint to Gradle, which reports it as a manifest
+ * error in a generated file, so `com.example-games` costs a full scaffold and
+ * a first build before anyone learns that a hyphen is not legal in a package
+ * segment.
+ */
+export declare const ORG: RegExp;
+/** The default, which an empty answer accepts. */
+export declare const DEFAULT_ORG = "com.example";
+/** A `com.acme.chess` answer to a game called `chess`, which yields `com.acme.chess.chess`. */
+export declare function repeatsGameName(org: string, game: string): boolean;
+/** The organization implied by an answer that already ends in the game name. */
+export declare function withoutGameName(org: string): string | undefined;
+/**
+ * Asks, with the game name rendered dimmed after the cursor so the shape of
+ * the answer is visible while it is being given.
+ *
+ * Returns the organization, `undefined` for the default, or `null` when
+ * cancelled.
+ *
+ * `input` and `output` default to this process's, and are parameters for the
+ * same reason every clack prompt takes them: a prompt is otherwise the one
+ * part of a CLI that cannot be driven by a test.
+ */
+export declare function askForOrg(game: string, registering: boolean, io?: Io): Promise<string | undefined | null>;
+/**
+ * Asked only when {@link firebaseReadiness} found something missing, and
+ * defaulted to "no" because the honest answer usually is: the tools are two
+ * commands away, and the alternative is an app that throws at launch until
+ * they are installed anyway.
+ */
+export declare function askToScaffoldWithoutFirebase(io?: Io): Promise<boolean | null>;
+/** Defaulted to yes: the scaffold is a few hundred generated files, and a commit is what makes the first `git diff` the first game change rather than all of them. */
+export declare function askForGit(io?: Io): Promise<boolean | null>;
+/**
+ * Defaulted to no, and the hint says why rather than leaving it as an
+ * arbitrary-looking choice: `release.yml` needs an upload keystore and a Play
+ * service account, so a project that takes the workflows before it has either
+ * gets a red `main` from its first push.
+ */
+export declare function askForWorkflows(io?: Io): Promise<boolean | null>;
+/**
+ * The package manager, asked only when nothing else could say.
+ *
+ * `npm create` and `pnpm create` both set `npm_config_user_agent`, so this is
+ * reached by the paths that do not: a global install, or running the binary
+ * directly. Rare, but it decides what every generated script says, and the old
+ * silent fallback to pnpm was a guess printed into a project's package.json.
+ */
+export declare function askForPackageManager(io?: Io): Promise<PackageManager | null>;

package/dist/summary.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The closing summary, and the only output of a scaffold anyone reads.
+ *
+ * A run drives several tools with plenty to say, so where the project went,
+ * what to edit, and what to run are worth restating at the bottom. Returned in
+ * pieces rather than as one block, because the CLI renders each in a different
+ * shape: the outcomes as status lines, the commands as a boxed note, the
+ * destination as the closing line.
+ *
+ * Its own module so it can be asserted: `cli.ts` is the bin entry and runs
+ * `main` on import, which makes anything defined there untestable. The package
+ * `exports` map does not expose this, so it is internal despite being
+ * importable by the tests.
+ */
+import type { PackageManager, ScaffoldResult } from "./index.js";
+export interface Summary {
+    /** What became of the repository and of Firebase, when there is something to say. */
+    status: string[];
+    /** The commands worth having, as one block. */
+    next: string;
+    /** One-line asides, after the block. */
+    footnotes: string[];
+    /** The closing line. */
+    headline: string;
+}
+export declare function summarise(result: ScaffoldResult, manager: PackageManager, workflows: boolean): Summary;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-eigen-game",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "license": "MIT",
   "description": "Scaffold an EigenInteractive game Worker and Flutter app without cloning the engine repositories.",
   "type": "module",
@@ -25,13 +25,13 @@
   "devDependencies": {
     "@types/node": "^26.1.1",
     "tsup": "^8.5.1",
-    "typescript": "^5.9.3",
+    "typescript": "~6.0.2",
     "vitest": "^4.1.10",
     "wrangler": "^4.110.0",
     "zod": "^4.4.3",
-    "@eigeninteractive/rules": "0.5.0",
-    "@eigeninteractive/server": "0.5.0",
-    "@eigeninteractive/testkit": "0.5.0"
+    "@eigeninteractive/rules": "0.5.1",
+    "@eigeninteractive/testkit": "0.5.1",
+    "@eigeninteractive/server": "0.5.1"
   },
   "engines": {
     "node": ">=22"
@@ -48,7 +48,7 @@
     "url": "https://github.com/eigeninteractive/eigen-platform/issues"
   },
   "scripts": {
-    "build": "tsup src/index.ts src/cli.ts --format esm --dts --sourcemap --clean",
+    "build": "tsup src/index.ts src/cli.ts --format esm --sourcemap --clean && tsc -p tsconfig.build.json",
     "test": "vitest run",
     "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p templates/worker/tsconfig.json"
   }

package/templates/worker/package.json

@@ -46,7 +46,7 @@
   "devDependencies": {
     "@eigeninteractive/testkit": "{{ENGINE_VERSION}}",
     "@types/node": "^26.1.1",
-    "typescript": "^5.9.3",
+    "typescript": "~6.0.2",
     "vitest": "^4.1.10",
     "wrangler": "^4.110.0"
   }