@gamecrate/cli 1.0.0 → 1.2.0

package/dist/types/types.d.ts

@@ -18,6 +18,15 @@ export declare const Exit: {
     readonly Interrupted: 130;
 };
 export type ExitCode = (typeof Exit)[keyof typeof Exit];
+export type ExitReason = 'exited' | 'marker' | 'marker-timeout' | 'stopped' | 'window-closed' | 'timeout'
+/** The run never reached docker: staging, a pull or a build failed. */
+ | 'failed';
+export interface LaunchResult {
+    code: number;
+    reason: ExitReason;
+}
+/** 130 means runContainer caught a signal and stopped the container, not that the game died. */
+export declare function reasonFor(code: number): ExitReason;
 /** Every failure the tool raises deliberately. Anything else is a bug. */
 export declare class GamecrateError extends Error {
     readonly code: ExitCode;
@@ -26,7 +35,7 @@ export declare class GamecrateError extends Error {
 }
 /** Collected and reported together, so one run surfaces every problem at once. */
 export interface Problem {
-    /** JSON Pointer into profiles.json, or a file path, or a mod id. */
+    /** JSON Pointer into the global config, or a file path, or a mod id. */
     where: string;
     message: string;
     /** Populated by did-you-mean matching where it applies. */
@@ -101,6 +110,11 @@ export interface ScanRoot {
 export interface LibraryEntry {
     workshop?: number;
     path?: string;
+    git?: string;
+    branch?: string;
+    tag?: string;
+    commit?: string;
+    subdir?: string;
 }
 /** Matches a family of mods by pattern instead of naming each one. */
 export interface DynamicModEntry {
@@ -138,6 +152,12 @@ export interface ProfileConfig {
     alias?: string;
     /** Extra names this profile answers to, so one entry covers several spellings. */
     aliases?: string[];
+    /** A one-line note for `gamecrate list`. Never read by the launcher. */
+    description?: string;
+    /** Launch defaults for this profile. The matching --no-* flag overrides each one. */
+    detach?: boolean;
+    replace?: boolean;
+    build?: BuildPolicy;
 }
 export interface GameConfig {
     gameFiles: GameFilesSpec;
@@ -220,6 +240,11 @@ export interface ModRecord {
     };
     /** Which scanRoot produced it, for the precedence ladder. */
     rootIndex: number;
+    /**
+     * The clone directory's mtime. Source-cache records only, which is what keeps it from
+     * reordering a user's checkout against anything.
+     */
+    clonedAt?: number;
 }
 export type WorktreeSource = 'flag' | 'env' | 'cwd' | 'ref';
 export interface WorktreeRequest {
@@ -381,9 +406,52 @@ export interface ParsedArgs {
     noStaleCheck: boolean;
     /** Stops whatever holds this profile+instance, then launches. Never refuses. */
     replace: boolean;
+    /** Runs in the background: this process forks a supervisor and returns the prompt. */
+    detach: boolean;
+    /** One-run overrides. Only these turn the matching boolean back off. */
+    noDetach: boolean;
+    noReplace: boolean;
+    /** Set on the forked supervisor only. Never a config key, never in help. */
+    supervised: boolean;
+    /** `-f`: keep printing as the run writes, instead of dumping what is there. */
+    follow: boolean;
+    /** The write verb under `mods`. Unset means the read verb. */
+    subverb?: 'add' | 'rm' | 'sync';
+    /** Where `mods add` pulls the mod from. */
+    source?: {
+        kind: 'path';
+        value: string;
+    } | {
+        kind: 'workshop';
+        value: number;
+    } | {
+        kind: 'git';
+        url: string;
+        ref?: {
+            kind: 'branch' | 'tag' | 'commit';
+            value: string;
+        };
+        subdir?: string;
+    };
+    /** Which config file a write lands in. */
+    target?: 'global' | 'project';
+    /** Overwrite an existing entry instead of refusing. */
+    force?: boolean;
     rest: string[];
 }
-export type ProjectDefaults = Partial<Omit<ParsedArgs, 'subcommand' | 'cleanTier' | 'yes' | 'help' | 'rest'>>;
+export type ProjectDefaults = Partial<Omit<ParsedArgs, 'subcommand' | 'cleanTier' | 'yes' | 'help' | 'rest' | 'profile' | 'supervised' | 'noDetach' | 'noReplace' | 'follow' | 'subverb' | 'source' | 'target' | 'force'>> & {
+    /** Replaces the old `profile:` key. Falls back to the first entry in `profiles`. */
+    defaultProfile?: string;
+    /** Validated by validateConfig after the splice, not here. */
+    profiles?: Record<string, unknown>;
+    settings?: Record<string, unknown>;
+    /** Spliced per id over games.<game>.library, so a repo pin replaces a global one whole. */
+    library?: Record<string, unknown>;
+    /** Profile keys in source order. Object.keys sorts integer-like names to the front. */
+    profileOrder?: string[];
+    /** The file these came from. Four suffixes are legal, so output must not guess the name. */
+    configPath?: string;
+};
 /** Names that can never be a game or profile key. Enforced at config load. */
 export declare const RESERVED_NAMES: readonly string[];
 export declare const NAME_PATTERN: RegExp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gamecrate/cli",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Run a modded game in a container, with mods resolved from your local checkouts.",
   "license": "MIT",
   "type": "module",