@jakubmazanec/cli 0.1.3-next.e2c3f48 → 0.2.0-unstable.fe83933

package/dist/constants.d.ts

@@ -1 +1,3 @@
+export declare const PACKAGE_PATH: string;
+export declare const CACHE_PATH: string;
 export declare const DELIMITER = "$ ";

package/dist/constants.js

@@ -1,3 +1,8 @@
+import path from 'node:path';
+import url from 'node:url';
+let directory = path.dirname(url.fileURLToPath(import.meta.url));
+export const PACKAGE_PATH = path.resolve(directory, '..');
+export const CACHE_PATH = path.resolve(PACKAGE_PATH, 'node_modules/.cache');
 export const DELIMITER = '$ ';
 
 //# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["export const DELIMITER = '$ ';\n"],"names":["DELIMITER"],"mappings":"AAAA,OAAO,MAAMA,YAAY,KAAK"}
+{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["import path from 'node:path';\nimport url from 'node:url';\n\nlet directory = path.dirname(url.fileURLToPath(import.meta.url));\n\nexport const PACKAGE_PATH = path.resolve(directory, '..');\nexport const CACHE_PATH = path.resolve(PACKAGE_PATH, 'node_modules/.cache');\n\nexport const DELIMITER = '$ ';\n"],"names":["path","url","directory","dirname","fileURLToPath","PACKAGE_PATH","resolve","CACHE_PATH","DELIMITER"],"mappings":"AAAA,OAAOA,UAAU,YAAY;AAC7B,OAAOC,SAAS,WAAW;AAE3B,IAAIC,YAAYF,KAAKG,OAAO,CAACF,IAAIG,aAAa,CAAC,YAAYH,GAAG;AAE9D,OAAO,MAAMI,eAAeL,KAAKM,OAAO,CAACJ,WAAW,MAAM;AAC1D,OAAO,MAAMK,aAAaP,KAAKM,OAAO,CAACD,cAAc,uBAAuB;AAE5E,OAAO,MAAMG,YAAY,KAAK"}

package/dist/program/Command.js

@@ -1,5 +1,4 @@
 import { parseArguments } from '@jakubmazanec/args';
-// import {type ProgramCommand} from './ProgramCommand.js';
 /**
  * Command encapsulates piece of a CLI's logic and is executed when {@link Program} instance parses that command from the command line arguments.
  */ export class Command {

package/dist/program/Command.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/program/Command.ts"],"sourcesContent":["import {\n  type Argv,\n  parseArguments,\n  type OptionsConfig,\n  type ParametersConfig,\n  type Arguments,\n} from '@jakubmazanec/args';\n\nimport {type CommandAction} from './CommandAction.js';\nimport {type CommandOptions} from './CommandOptions.js';\nimport {type Program} from './Program.js';\n// import {type ProgramCommand} from './ProgramCommand.js';\n\n/**\n * Command encapsulates piece of a CLI's logic and is executed when {@link Program} instance parses that command from the command line arguments.\n */\nexport class Command<\n  A extends string,\n  const B extends ParametersConfig | undefined = undefined,\n  const C extends OptionsConfig | undefined = undefined,\n  D extends boolean = false,\n  E extends boolean = false,\n> {\n  readonly name: A;\n  readonly description?: string;\n  readonly parameters: B extends ParametersConfig ? B : null;\n  readonly options: C extends OptionsConfig ? C : null;\n  readonly allowUnknownOptions: D;\n  readonly allowUnknownParameters: E;\n  private readonly action: CommandAction<A, B, C, D, E>;\n\n  /**\n   * @param name Command name, ie. space-separated words consisting only of letters, numbers (but not at the start of the word) or dashes.\n   * @param action Function that runs when command is executed.\n   * @param options Additionl command options.\n   */\n  constructor(\n    name: A,\n    action: CommandAction<A, B, C, D, E>,\n    {\n      description,\n      parameters,\n      options,\n      allowUnknownOptions,\n      allowUnknownParameters,\n    }: CommandOptions<NonNullable<B>, NonNullable<C>, D, E>,\n  ) {\n    this.name = name;\n    this.action = action;\n\n    if (description) {\n      this.description = description;\n    }\n\n    if (parameters) {\n      this.parameters = parameters as B extends ParametersConfig ? B : null;\n    } else {\n      this.parameters = null as B extends ParametersConfig ? B : null;\n    }\n\n    if (options) {\n      this.options = options as C extends OptionsConfig ? C : null;\n    } else {\n      this.options = null as C extends OptionsConfig ? C : null;\n    }\n\n    if (allowUnknownOptions) {\n      this.allowUnknownOptions = allowUnknownOptions;\n    } else {\n      this.allowUnknownOptions = false as D;\n    }\n\n    if (allowUnknownParameters) {\n      this.allowUnknownParameters = allowUnknownParameters;\n    } else {\n      this.allowUnknownParameters = false as E;\n    }\n  }\n\n  /**\n   * Parses a list of command line arguments into an arguments object. Parser is pre-configured based on this command.\n   */\n  parseArguments(argv: Argv): Arguments<{\n    commands: readonly [A];\n    parameters: B;\n    options: C;\n    allowUnknownOptions: D;\n    allowUnknownParameters: E;\n  }> {\n    return parseArguments(argv, {\n      commands: [this.name],\n      parameters: this.parameters ?? undefined,\n      options: this.options ?? undefined,\n      allowUnknownOptions: this.allowUnknownOptions,\n      allowUnknownParameters: this.allowUnknownParameters,\n    } as {\n      commands: readonly [A];\n      parameters: B;\n      options: C;\n      allowUnknownOptions: D;\n      allowUnknownParameters: E;\n    });\n  }\n\n  /**\n   * Executes command action with provided parsed arguments and {@link Program} instance.\n   */\n  async run(\n    parsedArgs: Arguments<{\n      commands: readonly [A];\n      parameters: B;\n      options: C;\n      allowUnknownOptions: D;\n      allowUnknownParameters: E;\n    }>,\n    program: Program,\n  ): Promise<void> {\n    await this.action(parsedArgs, program);\n  }\n}\n"],"names":["parseArguments","Command","name","description","parameters","options","allowUnknownOptions","allowUnknownParameters","action","constructor","argv","commands","undefined","run","parsedArgs","program"],"mappings":"AAAA,SAEEA,cAAc,QAIT,qBAAqB;AAK5B,2DAA2D;AAE3D;;CAEC,GACD,OAAO,MAAMC;IAOFC,KAAQ;IACRC,YAAqB;IACrBC,WAAkD;IAClDC,QAA4C;IAC5CC,oBAAuB;IACvBC,uBAA0B;IAClBC,OAAqC;IAEtD;;;;GAIC,GACDC,YACEP,IAAO,EACPM,MAAoC,EACpC,EACEL,WAAW,EACXC,UAAU,EACVC,OAAO,EACPC,mBAAmB,EACnBC,sBAAsB,EAC+B,CACvD;QACA,IAAI,CAACL,IAAI,GAAGA;QACZ,IAAI,CAACM,MAAM,GAAGA;QAEd,IAAIL,aAAa;YACf,IAAI,CAACA,WAAW,GAAGA;QACrB;QAEA,IAAIC,YAAY;YACd,IAAI,CAACA,UAAU,GAAGA;QACpB,OAAO;YACL,IAAI,CAACA,UAAU,GAAG;QACpB;QAEA,IAAIC,SAAS;YACX,IAAI,CAACA,OAAO,GAAGA;QACjB,OAAO;YACL,IAAI,CAACA,OAAO,GAAG;QACjB;QAEA,IAAIC,qBAAqB;YACvB,IAAI,CAACA,mBAAmB,GAAGA;QAC7B,OAAO;YACL,IAAI,CAACA,mBAAmB,GAAG;QAC7B;QAEA,IAAIC,wBAAwB;YAC1B,IAAI,CAACA,sBAAsB,GAAGA;QAChC,OAAO;YACL,IAAI,CAACA,sBAAsB,GAAG;QAChC;IACF;IAEA;;GAEC,GACDP,eAAeU,IAAU,EAMtB;QACD,OAAOV,eAAeU,MAAM;YAC1BC,UAAU;gBAAC,IAAI,CAACT,IAAI;aAAC;YACrBE,YAAY,IAAI,CAACA,UAAU,IAAIQ;YAC/BP,SAAS,IAAI,CAACA,OAAO,IAAIO;YACzBN,qBAAqB,IAAI,CAACA,mBAAmB;YAC7CC,wBAAwB,IAAI,CAACA,sBAAsB;QACrD;IAOF;IAEA;;GAEC,GACD,MAAMM,IACJC,UAME,EACFC,OAAgB,EACD;QACf,MAAM,IAAI,CAACP,MAAM,CAACM,YAAYC;IAChC;AACF"}
+{"version":3,"sources":["../../src/program/Command.ts"],"sourcesContent":["import {\n  type Argv,\n  parseArguments,\n  type OptionsConfig,\n  type ParametersConfig,\n  type Arguments,\n} from '@jakubmazanec/args';\n\nimport {type CommandAction} from './CommandAction.js';\nimport {type CommandOptions} from './CommandOptions.js';\nimport {type Program} from './Program.js';\n\n/**\n * Command encapsulates piece of a CLI's logic and is executed when {@link Program} instance parses that command from the command line arguments.\n */\nexport class Command<\n  A extends string,\n  const B extends ParametersConfig | undefined = undefined,\n  const C extends OptionsConfig | undefined = undefined,\n  D extends boolean = false,\n  E extends boolean = false,\n> {\n  readonly name: A;\n  readonly description?: string;\n  readonly parameters: B extends ParametersConfig ? B : null;\n  readonly options: C extends OptionsConfig ? C : null;\n  readonly allowUnknownOptions: D;\n  readonly allowUnknownParameters: E;\n  private readonly action: CommandAction<A, B, C, D, E>;\n\n  /**\n   * @param name Command name, ie. space-separated words consisting only of letters, numbers (but not at the start of the word) or dashes.\n   * @param action Function that runs when command is executed.\n   * @param options Additionl command options.\n   */\n  constructor(\n    name: A,\n    action: CommandAction<A, B, C, D, E>,\n    {\n      description,\n      parameters,\n      options,\n      allowUnknownOptions,\n      allowUnknownParameters,\n    }: CommandOptions<NonNullable<B>, NonNullable<C>, D, E>,\n  ) {\n    this.name = name;\n    this.action = action;\n\n    if (description) {\n      this.description = description;\n    }\n\n    if (parameters) {\n      this.parameters = parameters as B extends ParametersConfig ? B : null;\n    } else {\n      this.parameters = null as B extends ParametersConfig ? B : null;\n    }\n\n    if (options) {\n      this.options = options as C extends OptionsConfig ? C : null;\n    } else {\n      this.options = null as C extends OptionsConfig ? C : null;\n    }\n\n    if (allowUnknownOptions) {\n      this.allowUnknownOptions = allowUnknownOptions;\n    } else {\n      this.allowUnknownOptions = false as D;\n    }\n\n    if (allowUnknownParameters) {\n      this.allowUnknownParameters = allowUnknownParameters;\n    } else {\n      this.allowUnknownParameters = false as E;\n    }\n  }\n\n  /**\n   * Parses a list of command line arguments into an arguments object. Parser is pre-configured based on this command.\n   */\n  parseArguments(argv: Argv): Arguments<{\n    commands: readonly [A];\n    parameters: B;\n    options: C;\n    allowUnknownOptions: D;\n    allowUnknownParameters: E;\n  }> {\n    return parseArguments(argv, {\n      commands: [this.name],\n      parameters: this.parameters ?? undefined,\n      options: this.options ?? undefined,\n      allowUnknownOptions: this.allowUnknownOptions,\n      allowUnknownParameters: this.allowUnknownParameters,\n    } as {\n      commands: readonly [A];\n      parameters: B;\n      options: C;\n      allowUnknownOptions: D;\n      allowUnknownParameters: E;\n    });\n  }\n\n  /**\n   * Executes command action with provided parsed arguments and {@link Program} instance.\n   */\n  async run(\n    parsedArgs: Arguments<{\n      commands: readonly [A];\n      parameters: B;\n      options: C;\n      allowUnknownOptions: D;\n      allowUnknownParameters: E;\n    }>,\n    program: Program,\n  ): Promise<void> {\n    await this.action(parsedArgs, program);\n  }\n}\n"],"names":["parseArguments","Command","name","description","parameters","options","allowUnknownOptions","allowUnknownParameters","action","constructor","argv","commands","undefined","run","parsedArgs","program"],"mappings":"AAAA,SAEEA,cAAc,QAIT,qBAAqB;AAM5B;;CAEC,GACD,OAAO,MAAMC;IAOFC,KAAQ;IACRC,YAAqB;IACrBC,WAAkD;IAClDC,QAA4C;IAC5CC,oBAAuB;IACvBC,uBAA0B;IAClBC,OAAqC;IAEtD;;;;GAIC,GACDC,YACEP,IAAO,EACPM,MAAoC,EACpC,EACEL,WAAW,EACXC,UAAU,EACVC,OAAO,EACPC,mBAAmB,EACnBC,sBAAsB,EAC+B,CACvD;QACA,IAAI,CAACL,IAAI,GAAGA;QACZ,IAAI,CAACM,MAAM,GAAGA;QAEd,IAAIL,aAAa;YACf,IAAI,CAACA,WAAW,GAAGA;QACrB;QAEA,IAAIC,YAAY;YACd,IAAI,CAACA,UAAU,GAAGA;QACpB,OAAO;YACL,IAAI,CAACA,UAAU,GAAG;QACpB;QAEA,IAAIC,SAAS;YACX,IAAI,CAACA,OAAO,GAAGA;QACjB,OAAO;YACL,IAAI,CAACA,OAAO,GAAG;QACjB;QAEA,IAAIC,qBAAqB;YACvB,IAAI,CAACA,mBAAmB,GAAGA;QAC7B,OAAO;YACL,IAAI,CAACA,mBAAmB,GAAG;QAC7B;QAEA,IAAIC,wBAAwB;YAC1B,IAAI,CAACA,sBAAsB,GAAGA;QAChC,OAAO;YACL,IAAI,CAACA,sBAAsB,GAAG;QAChC;IACF;IAEA;;GAEC,GACDP,eAAeU,IAAU,EAMtB;QACD,OAAOV,eAAeU,MAAM;YAC1BC,UAAU;gBAAC,IAAI,CAACT,IAAI;aAAC;YACrBE,YAAY,IAAI,CAACA,UAAU,IAAIQ;YAC/BP,SAAS,IAAI,CAACA,OAAO,IAAIO;YACzBN,qBAAqB,IAAI,CAACA,mBAAmB;YAC7CC,wBAAwB,IAAI,CAACA,sBAAsB;QACrD;IAOF;IAEA;;GAEC,GACD,MAAMM,IACJC,UAME,EACFC,OAAgB,EACD;QACf,MAAM,IAAI,CAACP,MAAM,CAACM,YAAYC;IAChC;AACF"}

package/dist/program/Program.d.ts

@@ -2,7 +2,7 @@ import { type ParametersConfig, type Argv, type OptionsConfig } from '@jakubmaza
 import { type ComponentType } from 'react';
 import { type FallbackProps } from 'react-error-boundary';
 import { type Command } from './Command.js';
-import { type ProgramOptions } from './ProgramOptions.js';
+import { type ProgramCreateOptions } from './ProgramCreateOptions.js';
 import { type ProgramStreams } from './ProgramStreams.js';
 /**
  * Program manages and executes {@link Command} instances attached to it based on parsing command line arguments.
@@ -10,8 +10,12 @@ import { type ProgramStreams } from './ProgramStreams.js';
 export declare class Program {
     /** Program name. */
     readonly name?: string;
+    /** More readable program name. */
+    readonly displayName?: string;
     /** Program version. */
     readonly version?: string;
+    /** Program latest version. */
+    readonly latestVersion?: string;
     /** Program description. */
     readonly description?: string;
     /** Program executable name. */
@@ -22,7 +26,8 @@ export declare class Program {
     readonly streams: ProgramStreams;
     /** Custom error boundary fallback component */
     ErrorBoundaryFallbackComponent: ComponentType<FallbackProps>;
-    constructor({ name, version, description, bin, ErrorBoundaryFallbackComponent }: ProgramOptions);
+    private constructor();
+    static create({ name, version, description, bin, ErrorBoundaryFallbackComponent, checkForUpdate, }: ProgramCreateOptions): Promise<Program>;
     /**
      * Adds command to the program.
      *

package/dist/program/Program.js

@@ -1,11 +1,17 @@
-/* eslint-disable @typescript-eslint/no-explicit-any -- needed */ import { ProgramError } from './ProgramError.js';
+/* eslint-disable @typescript-eslint/no-explicit-any -- needed */ import fs from 'fs-extra';
+import fetchLatestVersion from 'latest-version';
+import path from 'path';
+import { ProgramError } from './ProgramError.js';
+import { CACHE_PATH } from '../constants.js';
 import { Wrapper } from '../ui/internals.js';
 import { Failure, Help } from '../ui.js';
 /**
  * Program manages and executes {@link Command} instances attached to it based on parsing command line arguments.
  */ export class Program {
     /** Program name. */ name;
+    /** More readable program name. */ displayName;
     /** Program version. */ version;
+    /** Program latest version. */ latestVersion;
     /** Program description. */ description;
     /** Program executable name. */ bin;
     /** Program commands */ commands = [];
@@ -16,13 +22,19 @@ import { Failure, Help } from '../ui.js';
         stdout: process.stdout
     };
     /** Custom error boundary fallback component */ ErrorBoundaryFallbackComponent;
-    constructor({ name, version, description, bin, ErrorBoundaryFallbackComponent }){
+    constructor({ name, displayName, version, latestVersion, description, bin, ErrorBoundaryFallbackComponent }){
         if (name) {
             this.name = name;
         }
+        if (displayName) {
+            this.displayName = displayName;
+        }
         if (version) {
             this.version = version;
         }
+        if (latestVersion) {
+            this.latestVersion = latestVersion;
+        }
         if (description) {
             this.description = description;
         }
@@ -35,6 +47,35 @@ import { Failure, Help } from '../ui.js';
             this.ErrorBoundaryFallbackComponent = Failure;
         }
     }
+    static async create({ name, version, description, bin, ErrorBoundaryFallbackComponent, checkForUpdate }) {
+        let latestVersion;
+        if (checkForUpdate && name) {
+            let cachePath = path.join(CACHE_PATH, name, 'latest-version.json');
+            let cachedLatestVersion;
+            try {
+                cachedLatestVersion = await fs.readJson(cachePath);
+            } catch  {
+            // no-op
+            }
+            // if there is no cache or the cached value is old, refetch and recache
+            if (!cachedLatestVersion || Date.now() - cachedLatestVersion.datetime > 86_400_00) {
+                latestVersion = await fetchLatestVersion(name);
+                await fs.ensureFile(cachePath);
+                await fs.writeJson(cachePath, {
+                    value: latestVersion,
+                    datetime: Date.now()
+                });
+            }
+        }
+        return new this({
+            name,
+            version,
+            latestVersion,
+            description,
+            bin,
+            ErrorBoundaryFallbackComponent
+        });
+    }
     /**
    * Adds command to the program.
    *

package/dist/program/Program.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/program/Program.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any -- needed */\nimport {type ParametersConfig, type Argv, type OptionsConfig} from '@jakubmazanec/args';\nimport {type ComponentType} from 'react';\nimport {type FallbackProps} from 'react-error-boundary';\n\nimport {type Command} from './Command.js';\nimport {ProgramError} from './ProgramError.js';\nimport {type ProgramOptions} from './ProgramOptions.js';\nimport {type ProgramStreams} from './ProgramStreams.js';\nimport {Wrapper} from '../ui/internals.js';\nimport {Failure, Help} from '../ui.js';\n\n/**\n * Program manages and executes {@link Command} instances attached to it based on parsing command line arguments.\n */\nexport class Program {\n  /** Program name. */\n  readonly name?: string;\n\n  /** Program version. */\n  readonly version?: string;\n\n  /** Program description. */\n  readonly description?: string;\n\n  /** Program executable name. */\n  readonly bin?: string;\n\n  /** Program commands */\n  readonly commands: Array<\n    Command<string, ParametersConfig | undefined, OptionsConfig | undefined, boolean, boolean>\n  > = [];\n\n  protected isRendering = false;\n\n  readonly streams: ProgramStreams = {\n    stderr: process.stderr,\n    stdin: process.stdin,\n    stdout: process.stdout,\n  };\n\n  /** Custom error boundary fallback component */\n  ErrorBoundaryFallbackComponent: ComponentType<FallbackProps>;\n\n  constructor({name, version, description, bin, ErrorBoundaryFallbackComponent}: ProgramOptions) {\n    if (name) {\n      this.name = name;\n    }\n\n    if (version) {\n      this.version = version;\n    }\n\n    if (description) {\n      this.description = description;\n    }\n\n    if (bin) {\n      this.bin = bin;\n    }\n\n    if (ErrorBoundaryFallbackComponent) {\n      this.ErrorBoundaryFallbackComponent = ErrorBoundaryFallbackComponent;\n    } else {\n      this.ErrorBoundaryFallbackComponent = Failure;\n    }\n  }\n\n  /**\n   * Adds command to the program.\n   *\n   * @param command Command to add.\n   * @returns Program instance.\n   */\n  addCommand(command: Command<any, any, any, any, any>): this {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- it doesn't matter here; `any` is used to make TypeScript happy in this method, but isn't propagated further.\n    this.commands.push(command);\n\n    return this;\n  }\n\n  /**\n   * Renders a React element using Ink and outputs to the configured streams.\n   *\n   * @param element The React element to render.\n   */\n  async renderElement(element: React.ReactElement): Promise<void> {\n    if (this.isRendering) {\n      throw new ProgramError('NO_NESTED_RENDER');\n    } else {\n      this.isRendering = true;\n    }\n\n    let {render} = await import('ink');\n    let {createElement} = await import('react');\n    let {stdin, stdout, stderr} = this.streams;\n\n    try {\n      render(createElement(Wrapper, {program: this}, element), {\n        exitOnCtrlC: true,\n        patchConsole: true,\n        stderr,\n        stdin,\n        stdout,\n      });\n    } catch (error: unknown) {\n      if (error instanceof Error) {\n        await this.renderElement(\n          createElement(this.ErrorBoundaryFallbackComponent, {error, resetErrorBoundary: () => {}}),\n        );\n      }\n    } finally {\n      this.isRendering = false;\n    }\n  }\n\n  /**\n   * Runs the program.\n   *\n   * @param argv Unparsed command line arguments.\n   */\n  async run(argv: Argv): Promise<void> {\n    let hasCommandRun = false;\n\n    for (let command of this.commands) {\n      let parsedArgs = command.parseArguments(argv);\n\n      if (parsedArgs.command) {\n        hasCommandRun = true;\n\n        if (parsedArgs.errors.length) {\n          let {createElement} = await import('react');\n\n          for (let error of parsedArgs.errors) {\n            process.exitCode = 1;\n\n            await this.renderElement(\n              createElement(this.ErrorBoundaryFallbackComponent, {\n                error,\n                resetErrorBoundary: () => {},\n              }),\n            );\n          }\n        } else {\n          try {\n            await command.run(parsedArgs, this);\n          } catch (error: unknown) {\n            let {createElement} = await import('react');\n\n            if (error instanceof Error) {\n              process.exitCode = 1;\n\n              await this.renderElement(\n                createElement(this.ErrorBoundaryFallbackComponent, {\n                  error,\n                  resetErrorBoundary: () => {},\n                }),\n              );\n            }\n          }\n\n          break;\n        }\n      }\n    }\n\n    if (!hasCommandRun) {\n      let {createElement} = await import('react');\n\n      await this.renderElement(createElement(Help, {program: this}));\n    }\n  }\n}\n"],"names":["ProgramError","Wrapper","Failure","Help","Program","name","version","description","bin","commands","isRendering","streams","stderr","process","stdin","stdout","ErrorBoundaryFallbackComponent","constructor","addCommand","command","push","renderElement","element","render","createElement","program","exitOnCtrlC","patchConsole","error","Error","resetErrorBoundary","run","argv","hasCommandRun","parsedArgs","parseArguments","errors","length","exitCode"],"mappings":"AAAA,+DAA+D,GAM/D,SAAQA,YAAY,QAAO,oBAAoB;AAG/C,SAAQC,OAAO,QAAO,qBAAqB;AAC3C,SAAQC,OAAO,EAAEC,IAAI,QAAO,WAAW;AAEvC;;CAEC,GACD,OAAO,MAAMC;IACX,kBAAkB,GAClB,AAASC,KAAc;IAEvB,qBAAqB,GACrB,AAASC,QAAiB;IAE1B,yBAAyB,GACzB,AAASC,YAAqB;IAE9B,6BAA6B,GAC7B,AAASC,IAAa;IAEtB,qBAAqB,GACrB,AAASC,WAEL,EAAE,CAAC;IAEGC,cAAc,MAAM;IAErBC,UAA0B;QACjCC,QAAQC,QAAQD,MAAM;QACtBE,OAAOD,QAAQC,KAAK;QACpBC,QAAQF,QAAQE,MAAM;IACxB,EAAE;IAEF,6CAA6C,GAC7CC,+BAA6D;IAE7DC,YAAY,EAACZ,IAAI,EAAEC,OAAO,EAAEC,WAAW,EAAEC,GAAG,EAAEQ,8BAA8B,EAAiB,CAAE;QAC7F,IAAIX,MAAM;YACR,IAAI,CAACA,IAAI,GAAGA;QACd;QAEA,IAAIC,SAAS;YACX,IAAI,CAACA,OAAO,GAAGA;QACjB;QAEA,IAAIC,aAAa;YACf,IAAI,CAACA,WAAW,GAAGA;QACrB;QAEA,IAAIC,KAAK;YACP,IAAI,CAACA,GAAG,GAAGA;QACb;QAEA,IAAIQ,gCAAgC;YAClC,IAAI,CAACA,8BAA8B,GAAGA;QACxC,OAAO;YACL,IAAI,CAACA,8BAA8B,GAAGd;QACxC;IACF;IAEA;;;;;GAKC,GACDgB,WAAWC,OAAyC,EAAQ;QAC1D,iLAAiL;QACjL,IAAI,CAACV,QAAQ,CAACW,IAAI,CAACD;QAEnB,OAAO,IAAI;IACb;IAEA;;;;GAIC,GACD,MAAME,cAAcC,OAA2B,EAAiB;QAC9D,IAAI,IAAI,CAACZ,WAAW,EAAE;YACpB,MAAM,IAAIV,aAAa;QACzB,OAAO;YACL,IAAI,CAACU,WAAW,GAAG;QACrB;QAEA,IAAI,EAACa,MAAM,EAAC,GAAG,MAAM,MAAM,CAAC;QAC5B,IAAI,EAACC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC;QACnC,IAAI,EAACV,KAAK,EAAEC,MAAM,EAAEH,MAAM,EAAC,GAAG,IAAI,CAACD,OAAO;QAE1C,IAAI;YACFY,OAAOC,cAAcvB,SAAS;gBAACwB,SAAS,IAAI;YAAA,GAAGH,UAAU;gBACvDI,aAAa;gBACbC,cAAc;gBACdf;gBACAE;gBACAC;YACF;QACF,EAAE,OAAOa,OAAgB;YACvB,IAAIA,iBAAiBC,OAAO;gBAC1B,MAAM,IAAI,CAACR,aAAa,CACtBG,cAAc,IAAI,CAACR,8BAA8B,EAAE;oBAACY;oBAAOE,oBAAoB,KAAO;gBAAC;YAE3F;QACF,SAAU;YACR,IAAI,CAACpB,WAAW,GAAG;QACrB;IACF;IAEA;;;;GAIC,GACD,MAAMqB,IAAIC,IAAU,EAAiB;QACnC,IAAIC,gBAAgB;QAEpB,KAAK,IAAId,WAAW,IAAI,CAACV,QAAQ,CAAE;YACjC,IAAIyB,aAAaf,QAAQgB,cAAc,CAACH;YAExC,IAAIE,WAAWf,OAAO,EAAE;gBACtBc,gBAAgB;gBAEhB,IAAIC,WAAWE,MAAM,CAACC,MAAM,EAAE;oBAC5B,IAAI,EAACb,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC;oBAEnC,KAAK,IAAII,SAASM,WAAWE,MAAM,CAAE;wBACnCvB,QAAQyB,QAAQ,GAAG;wBAEnB,MAAM,IAAI,CAACjB,aAAa,CACtBG,cAAc,IAAI,CAACR,8BAA8B,EAAE;4BACjDY;4BACAE,oBAAoB,KAAO;wBAC7B;oBAEJ;gBACF,OAAO;oBACL,IAAI;wBACF,MAAMX,QAAQY,GAAG,CAACG,YAAY,IAAI;oBACpC,EAAE,OAAON,OAAgB;wBACvB,IAAI,EAACJ,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC;wBAEnC,IAAII,iBAAiBC,OAAO;4BAC1BhB,QAAQyB,QAAQ,GAAG;4BAEnB,MAAM,IAAI,CAACjB,aAAa,CACtBG,cAAc,IAAI,CAACR,8BAA8B,EAAE;gCACjDY;gCACAE,oBAAoB,KAAO;4BAC7B;wBAEJ;oBACF;oBAEA;gBACF;YACF;QACF;QAEA,IAAI,CAACG,eAAe;YAClB,IAAI,EAACT,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC;YAEnC,MAAM,IAAI,CAACH,aAAa,CAACG,cAAcrB,MAAM;gBAACsB,SAAS,IAAI;YAAA;QAC7D;IACF;AACF"}
+{"version":3,"sources":["../../src/program/Program.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any -- needed */\nimport {type ParametersConfig, type Argv, type OptionsConfig} from '@jakubmazanec/args';\nimport fs from 'fs-extra';\nimport fetchLatestVersion from 'latest-version';\nimport path from 'path';\nimport {type ComponentType} from 'react';\nimport {type FallbackProps} from 'react-error-boundary';\n\nimport {type Command} from './Command.js';\nimport {type ProgramCreateOptions} from './ProgramCreateOptions.js';\nimport {ProgramError} from './ProgramError.js';\nimport {type ProgramOptions} from './ProgramOptions.js';\nimport {type ProgramStreams} from './ProgramStreams.js';\nimport {CACHE_PATH} from '../constants.js';\nimport {Wrapper} from '../ui/internals.js';\nimport {Failure, Help} from '../ui.js';\n\n/**\n * Program manages and executes {@link Command} instances attached to it based on parsing command line arguments.\n */\nexport class Program {\n  /** Program name. */\n  readonly name?: string;\n\n  /** More readable program name. */\n  readonly displayName?: string;\n\n  /** Program version. */\n  readonly version?: string;\n\n  /** Program latest version. */\n  readonly latestVersion?: string;\n\n  /** Program description. */\n  readonly description?: string;\n\n  /** Program executable name. */\n  readonly bin?: string;\n\n  /** Program commands */\n  readonly commands: Array<\n    Command<string, ParametersConfig | undefined, OptionsConfig | undefined, boolean, boolean>\n  > = [];\n\n  protected isRendering = false;\n\n  readonly streams: ProgramStreams = {\n    stderr: process.stderr,\n    stdin: process.stdin,\n    stdout: process.stdout,\n  };\n\n  /** Custom error boundary fallback component */\n  ErrorBoundaryFallbackComponent: ComponentType<FallbackProps>;\n\n  private constructor({\n    name,\n    displayName,\n    version,\n    latestVersion,\n    description,\n    bin,\n    ErrorBoundaryFallbackComponent,\n  }: ProgramOptions) {\n    if (name) {\n      this.name = name;\n    }\n\n    if (displayName) {\n      this.displayName = displayName;\n    }\n\n    if (version) {\n      this.version = version;\n    }\n\n    if (latestVersion) {\n      this.latestVersion = latestVersion;\n    }\n\n    if (description) {\n      this.description = description;\n    }\n\n    if (bin) {\n      this.bin = bin;\n    }\n\n    if (ErrorBoundaryFallbackComponent) {\n      this.ErrorBoundaryFallbackComponent = ErrorBoundaryFallbackComponent;\n    } else {\n      this.ErrorBoundaryFallbackComponent = Failure;\n    }\n  }\n\n  static async create({\n    name,\n    version,\n    description,\n    bin,\n    ErrorBoundaryFallbackComponent,\n    checkForUpdate,\n  }: ProgramCreateOptions) {\n    let latestVersion: string | undefined;\n\n    if (checkForUpdate && name) {\n      // first we try to read the cached latest version\n      type CachedLatestVersion = {\n        value: string;\n        datetime: number;\n      };\n\n      let cachePath = path.join(CACHE_PATH, name, 'latest-version.json');\n      let cachedLatestVersion: CachedLatestVersion | undefined;\n\n      try {\n        cachedLatestVersion = (await fs.readJson(cachePath)) as CachedLatestVersion;\n      } catch {\n        // no-op\n      }\n\n      // if there is no cache or the cached value is old, refetch and recache\n      if (!cachedLatestVersion || Date.now() - cachedLatestVersion.datetime > 86_400_00) {\n        latestVersion = await fetchLatestVersion(name);\n\n        await fs.ensureFile(cachePath);\n        await fs.writeJson(cachePath, {\n          value: latestVersion,\n          datetime: Date.now(),\n        });\n      }\n    }\n\n    return new this({\n      name,\n      version,\n      latestVersion,\n      description,\n      bin,\n      ErrorBoundaryFallbackComponent,\n    });\n  }\n\n  /**\n   * Adds command to the program.\n   *\n   * @param command Command to add.\n   * @returns Program instance.\n   */\n  addCommand(command: Command<any, any, any, any, any>): this {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- it doesn't matter here; `any` is used to make TypeScript happy in this method, but isn't propagated further.\n    this.commands.push(command);\n\n    return this;\n  }\n\n  /**\n   * Renders a React element using Ink and outputs to the configured streams.\n   *\n   * @param element The React element to render.\n   */\n  async renderElement(element: React.ReactElement): Promise<void> {\n    if (this.isRendering) {\n      throw new ProgramError('NO_NESTED_RENDER');\n    } else {\n      this.isRendering = true;\n    }\n\n    let {render} = await import('ink');\n    let {createElement} = await import('react');\n    let {stdin, stdout, stderr} = this.streams;\n\n    try {\n      render(createElement(Wrapper, {program: this}, element), {\n        exitOnCtrlC: true,\n        patchConsole: true,\n        stderr,\n        stdin,\n        stdout,\n      });\n    } catch (error: unknown) {\n      if (error instanceof Error) {\n        await this.renderElement(\n          createElement(this.ErrorBoundaryFallbackComponent, {error, resetErrorBoundary: () => {}}),\n        );\n      }\n    } finally {\n      this.isRendering = false;\n    }\n  }\n\n  /**\n   * Runs the program.\n   *\n   * @param argv Unparsed command line arguments.\n   */\n  async run(argv: Argv): Promise<void> {\n    let hasCommandRun = false;\n\n    for (let command of this.commands) {\n      let parsedArgs = command.parseArguments(argv);\n\n      if (parsedArgs.command) {\n        hasCommandRun = true;\n\n        if (parsedArgs.errors.length) {\n          let {createElement} = await import('react');\n\n          for (let error of parsedArgs.errors) {\n            process.exitCode = 1;\n\n            await this.renderElement(\n              createElement(this.ErrorBoundaryFallbackComponent, {\n                error,\n                resetErrorBoundary: () => {},\n              }),\n            );\n          }\n        } else {\n          try {\n            await command.run(parsedArgs, this);\n          } catch (error: unknown) {\n            let {createElement} = await import('react');\n\n            if (error instanceof Error) {\n              process.exitCode = 1;\n\n              await this.renderElement(\n                createElement(this.ErrorBoundaryFallbackComponent, {\n                  error,\n                  resetErrorBoundary: () => {},\n                }),\n              );\n            }\n          }\n\n          break;\n        }\n      }\n    }\n\n    if (!hasCommandRun) {\n      let {createElement} = await import('react');\n\n      await this.renderElement(createElement(Help, {program: this}));\n    }\n  }\n}\n"],"names":["fs","fetchLatestVersion","path","ProgramError","CACHE_PATH","Wrapper","Failure","Help","Program","name","displayName","version","latestVersion","description","bin","commands","isRendering","streams","stderr","process","stdin","stdout","ErrorBoundaryFallbackComponent","create","checkForUpdate","cachePath","join","cachedLatestVersion","readJson","Date","now","datetime","ensureFile","writeJson","value","addCommand","command","push","renderElement","element","render","createElement","program","exitOnCtrlC","patchConsole","error","Error","resetErrorBoundary","run","argv","hasCommandRun","parsedArgs","parseArguments","errors","length","exitCode"],"mappings":"AAAA,+DAA+D,GAE/D,OAAOA,QAAQ,WAAW;AAC1B,OAAOC,wBAAwB,iBAAiB;AAChD,OAAOC,UAAU,OAAO;AAMxB,SAAQC,YAAY,QAAO,oBAAoB;AAG/C,SAAQC,UAAU,QAAO,kBAAkB;AAC3C,SAAQC,OAAO,QAAO,qBAAqB;AAC3C,SAAQC,OAAO,EAAEC,IAAI,QAAO,WAAW;AAEvC;;CAEC,GACD,OAAO,MAAMC;IACX,kBAAkB,GAClB,AAASC,KAAc;IAEvB,gCAAgC,GAChC,AAASC,YAAqB;IAE9B,qBAAqB,GACrB,AAASC,QAAiB;IAE1B,4BAA4B,GAC5B,AAASC,cAAuB;IAEhC,yBAAyB,GACzB,AAASC,YAAqB;IAE9B,6BAA6B,GAC7B,AAASC,IAAa;IAEtB,qBAAqB,GACrB,AAASC,WAEL,EAAE,CAAC;IAEGC,cAAc,MAAM;IAErBC,UAA0B;QACjCC,QAAQC,QAAQD,MAAM;QACtBE,OAAOD,QAAQC,KAAK;QACpBC,QAAQF,QAAQE,MAAM;IACxB,EAAE;IAEF,6CAA6C,GAC7CC,+BAA6D;IAE7D,YAAoB,EAClBb,IAAI,EACJC,WAAW,EACXC,OAAO,EACPC,aAAa,EACbC,WAAW,EACXC,GAAG,EACHQ,8BAA8B,EACf,CAAE;QACjB,IAAIb,MAAM;YACR,IAAI,CAACA,IAAI,GAAGA;QACd;QAEA,IAAIC,aAAa;YACf,IAAI,CAACA,WAAW,GAAGA;QACrB;QAEA,IAAIC,SAAS;YACX,IAAI,CAACA,OAAO,GAAGA;QACjB;QAEA,IAAIC,eAAe;YACjB,IAAI,CAACA,aAAa,GAAGA;QACvB;QAEA,IAAIC,aAAa;YACf,IAAI,CAACA,WAAW,GAAGA;QACrB;QAEA,IAAIC,KAAK;YACP,IAAI,CAACA,GAAG,GAAGA;QACb;QAEA,IAAIQ,gCAAgC;YAClC,IAAI,CAACA,8BAA8B,GAAGA;QACxC,OAAO;YACL,IAAI,CAACA,8BAA8B,GAAGhB;QACxC;IACF;IAEA,aAAaiB,OAAO,EAClBd,IAAI,EACJE,OAAO,EACPE,WAAW,EACXC,GAAG,EACHQ,8BAA8B,EAC9BE,cAAc,EACO,EAAE;QACvB,IAAIZ;QAEJ,IAAIY,kBAAkBf,MAAM;YAO1B,IAAIgB,YAAYvB,KAAKwB,IAAI,CAACtB,YAAYK,MAAM;YAC5C,IAAIkB;YAEJ,IAAI;gBACFA,sBAAuB,MAAM3B,GAAG4B,QAAQ,CAACH;YAC3C,EAAE,OAAM;YACN,QAAQ;YACV;YAEA,uEAAuE;YACvE,IAAI,CAACE,uBAAuBE,KAAKC,GAAG,KAAKH,oBAAoBI,QAAQ,GAAG,WAAW;gBACjFnB,gBAAgB,MAAMX,mBAAmBQ;gBAEzC,MAAMT,GAAGgC,UAAU,CAACP;gBACpB,MAAMzB,GAAGiC,SAAS,CAACR,WAAW;oBAC5BS,OAAOtB;oBACPmB,UAAUF,KAAKC,GAAG;gBACpB;YACF;QACF;QAEA,OAAO,IAAI,IAAI,CAAC;YACdrB;YACAE;YACAC;YACAC;YACAC;YACAQ;QACF;IACF;IAEA;;;;;GAKC,GACDa,WAAWC,OAAyC,EAAQ;QAC1D,iLAAiL;QACjL,IAAI,CAACrB,QAAQ,CAACsB,IAAI,CAACD;QAEnB,OAAO,IAAI;IACb;IAEA;;;;GAIC,GACD,MAAME,cAAcC,OAA2B,EAAiB;QAC9D,IAAI,IAAI,CAACvB,WAAW,EAAE;YACpB,MAAM,IAAIb,aAAa;QACzB,OAAO;YACL,IAAI,CAACa,WAAW,GAAG;QACrB;QAEA,IAAI,EAACwB,MAAM,EAAC,GAAG,MAAM,MAAM,CAAC;QAC5B,IAAI,EAACC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC;QACnC,IAAI,EAACrB,KAAK,EAAEC,MAAM,EAAEH,MAAM,EAAC,GAAG,IAAI,CAACD,OAAO;QAE1C,IAAI;YACFuB,OAAOC,cAAcpC,SAAS;gBAACqC,SAAS,IAAI;YAAA,GAAGH,UAAU;gBACvDI,aAAa;gBACbC,cAAc;gBACd1B;gBACAE;gBACAC;YACF;QACF,EAAE,OAAOwB,OAAgB;YACvB,IAAIA,iBAAiBC,OAAO;gBAC1B,MAAM,IAAI,CAACR,aAAa,CACtBG,cAAc,IAAI,CAACnB,8BAA8B,EAAE;oBAACuB;oBAAOE,oBAAoB,KAAO;gBAAC;YAE3F;QACF,SAAU;YACR,IAAI,CAAC/B,WAAW,GAAG;QACrB;IACF;IAEA;;;;GAIC,GACD,MAAMgC,IAAIC,IAAU,EAAiB;QACnC,IAAIC,gBAAgB;QAEpB,KAAK,IAAId,WAAW,IAAI,CAACrB,QAAQ,CAAE;YACjC,IAAIoC,aAAaf,QAAQgB,cAAc,CAACH;YAExC,IAAIE,WAAWf,OAAO,EAAE;gBACtBc,gBAAgB;gBAEhB,IAAIC,WAAWE,MAAM,CAACC,MAAM,EAAE;oBAC5B,IAAI,EAACb,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC;oBAEnC,KAAK,IAAII,SAASM,WAAWE,MAAM,CAAE;wBACnClC,QAAQoC,QAAQ,GAAG;wBAEnB,MAAM,IAAI,CAACjB,aAAa,CACtBG,cAAc,IAAI,CAACnB,8BAA8B,EAAE;4BACjDuB;4BACAE,oBAAoB,KAAO;wBAC7B;oBAEJ;gBACF,OAAO;oBACL,IAAI;wBACF,MAAMX,QAAQY,GAAG,CAACG,YAAY,IAAI;oBACpC,EAAE,OAAON,OAAgB;wBACvB,IAAI,EAACJ,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC;wBAEnC,IAAII,iBAAiBC,OAAO;4BAC1B3B,QAAQoC,QAAQ,GAAG;4BAEnB,MAAM,IAAI,CAACjB,aAAa,CACtBG,cAAc,IAAI,CAACnB,8BAA8B,EAAE;gCACjDuB;gCACAE,oBAAoB,KAAO;4BAC7B;wBAEJ;oBACF;oBAEA;gBACF;YACF;QACF;QAEA,IAAI,CAACG,eAAe;YAClB,IAAI,EAACT,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC;YAEnC,MAAM,IAAI,CAACH,aAAa,CAACG,cAAclC,MAAM;gBAACmC,SAAS,IAAI;YAAA;QAC7D;IACF;AACF"}

package/dist/program/ProgramCreateOptions.d.ts

@@ -0,0 +1,21 @@
+import { type ComponentType } from 'react';
+import { type FallbackProps } from 'react-error-boundary';
+/**
+ * {@link Program.create} options parameter.
+ */
+export type ProgramCreateOptions = {
+    /** Program name. */
+    name?: string | undefined;
+    /** More readable program name. */
+    displayName?: string | undefined;
+    /** Program version. */
+    version?: string | undefined;
+    /** Program description. */
+    description?: string | undefined;
+    /** Program executable name. */
+    bin?: string | undefined;
+    /** Custom error boundary fallback component */
+    ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps>;
+    /** Perform check whether a newer version of the program is available. */
+    checkForUpdate?: boolean;
+};

package/dist/program/ProgramCreateOptions.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=ProgramCreateOptions.js.map

package/dist/program/ProgramCreateOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/ProgramCreateOptions.ts"],"sourcesContent":["import {type ComponentType} from 'react';\nimport {type FallbackProps} from 'react-error-boundary';\n\n/**\n * {@link Program.create} options parameter.\n */\nexport type ProgramCreateOptions = {\n  /** Program name. */\n  name?: string | undefined;\n\n  /** More readable program name. */\n  displayName?: string | undefined;\n\n  /** Program version. */\n  version?: string | undefined;\n\n  /** Program description. */\n  description?: string | undefined;\n\n  /** Program executable name. */\n  bin?: string | undefined;\n\n  /** Custom error boundary fallback component */\n  ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps>;\n\n  /** Perform check whether a newer version of the program is available. */\n  checkForUpdate?: boolean;\n};\n"],"names":[],"mappings":"AAAA,WA2BE"}

package/dist/program/ProgramOptions.d.ts

@@ -1,17 +1,23 @@
 import { type ComponentType } from 'react';
 import { type FallbackProps } from 'react-error-boundary';
 /**
- * {@link Project.constructor | Program constructor} options parameter.
+ * {@link Program.constructor | Program constructor} options parameter.
  */
 export type ProgramOptions = {
     /** Program name. */
     name?: string | undefined;
+    /** More readable program name. */
+    displayName?: string | undefined;
     /** Program version. */
     version?: string | undefined;
+    /** Program latest version. */
+    latestVersion?: string | undefined;
     /** Program description. */
     description?: string | undefined;
     /** Program executable name. */
     bin?: string | undefined;
     /** Custom error boundary fallback component */
-    ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps>;
+    ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps> | undefined;
+    /** Perform check whether a newer version of the program is available. */
+    checkForUpdate?: boolean;
 };

package/dist/program/ProgramOptions.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/program/ProgramOptions.ts"],"sourcesContent":["import {type ComponentType} from 'react';\nimport {type FallbackProps} from 'react-error-boundary';\n\n/**\n * {@link Project.constructor | Program constructor} options parameter.\n */\nexport type ProgramOptions = {\n  /** Program name. */\n  name?: string | undefined;\n\n  /** Program version. */\n  version?: string | undefined;\n\n  /** Program description. */\n  description?: string | undefined;\n\n  /** Program executable name. */\n  bin?: string | undefined;\n\n  /** Custom error boundary fallback component */\n  ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps>;\n};\n"],"names":[],"mappings":"AAAA,WAqBE"}
+{"version":3,"sources":["../../src/program/ProgramOptions.ts"],"sourcesContent":["import {type ComponentType} from 'react';\nimport {type FallbackProps} from 'react-error-boundary';\n\n/**\n * {@link Program.constructor | Program constructor} options parameter.\n */\nexport type ProgramOptions = {\n  /** Program name. */\n  name?: string | undefined;\n\n  /** More readable program name. */\n  displayName?: string | undefined;\n\n  /** Program version. */\n  version?: string | undefined;\n\n  /** Program latest version. */\n  latestVersion?: string | undefined;\n\n  /** Program description. */\n  description?: string | undefined;\n\n  /** Program executable name. */\n  bin?: string | undefined;\n\n  /** Custom error boundary fallback component */\n  ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps> | undefined;\n\n  /** Perform check whether a newer version of the program is available. */\n  checkForUpdate?: boolean;\n};\n"],"names":[],"mappings":"AAAA,WA8BE"}

package/dist/program.d.ts

@@ -4,6 +4,7 @@ export * from './program/CommandArguments.js';
 export * from './program/CommandOptions.js';
 export * from './program/getProgramDetail.js';
 export * from './program/Program.js';
+export * from './program/ProgramCreateOptions.js';
 export * from './program/ProgramDetail.js';
 export * from './program/ProgramError.js';
 export * from './program/ProgramOptions.js';

package/dist/program.js

@@ -4,6 +4,7 @@ export * from './program/CommandArguments.js';
 export * from './program/CommandOptions.js';
 export * from './program/getProgramDetail.js';
 export * from './program/Program.js';
+export * from './program/ProgramCreateOptions.js';
 export * from './program/ProgramDetail.js';
 export * from './program/ProgramError.js';
 export * from './program/ProgramOptions.js';

package/dist/program.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/program.ts"],"sourcesContent":["export * from './program/Command.js';\nexport * from './program/CommandAction.js';\nexport * from './program/CommandArguments.js';\nexport * from './program/CommandOptions.js';\nexport * from './program/getProgramDetail.js';\nexport * from './program/Program.js';\nexport * from './program/ProgramDetail.js';\nexport * from './program/ProgramError.js';\nexport * from './program/ProgramOptions.js';\nexport * from './program/ProgramStreams.js';\n"],"names":[],"mappings":"AAAA,cAAc,uBAAuB;AACrC,cAAc,6BAA6B;AAC3C,cAAc,gCAAgC;AAC9C,cAAc,8BAA8B;AAC5C,cAAc,gCAAgC;AAC9C,cAAc,uBAAuB;AACrC,cAAc,6BAA6B;AAC3C,cAAc,4BAA4B;AAC1C,cAAc,8BAA8B;AAC5C,cAAc,8BAA8B"}
+{"version":3,"sources":["../src/program.ts"],"sourcesContent":["export * from './program/Command.js';\nexport * from './program/CommandAction.js';\nexport * from './program/CommandArguments.js';\nexport * from './program/CommandOptions.js';\nexport * from './program/getProgramDetail.js';\nexport * from './program/Program.js';\nexport * from './program/ProgramCreateOptions.js';\nexport * from './program/ProgramDetail.js';\nexport * from './program/ProgramError.js';\nexport * from './program/ProgramOptions.js';\nexport * from './program/ProgramStreams.js';\n"],"names":[],"mappings":"AAAA,cAAc,uBAAuB;AACrC,cAAc,6BAA6B;AAC3C,cAAc,gCAAgC;AAC9C,cAAc,8BAA8B;AAC5C,cAAc,gCAAgC;AAC9C,cAAc,uBAAuB;AACrC,cAAc,oCAAoC;AAClD,cAAc,6BAA6B;AAC3C,cAAc,4BAA4B;AAC1C,cAAc,8BAA8B;AAC5C,cAAc,8BAA8B"}

package/dist/ui/Help.js

@@ -12,7 +12,7 @@ import * as icons from './icons.js';
         flexDirection: "column",
         children: [
             /*#__PURE__*/ _jsx(Text, {
-                children: `${chalk[colors.notice](program.name ?? '?')} ${chalk[colors.muted](program.version ?? '?')}`
+                children: `${chalk[colors.notice](program.displayName ?? program.name ?? '?')} ${chalk[colors.muted](program.version ?? '?')}`
             }),
             /*#__PURE__*/ _jsx(Text, {
                 color: colors.body,

package/dist/ui/Help.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/ui/Help.tsx"],"sourcesContent":["import chalk from 'chalk';\nimport {Box, Text, type BoxProps} from 'ink';\n\nimport * as colors from './colors.js';\nimport {Header} from './Header.js';\nimport * as icons from './icons.js';\nimport {type Program} from '../program.js';\n\n/**\n * {@link Help} component props.\n */\nexport type HelpProps = BoxProps & {\n  /** {@link Program} instance. */\n  program: Program;\n};\n\n/**\n * A component that renders help information.\n */\nexport function Help({program, ...boxProps}: HelpProps) {\n  return (\n    <Box {...boxProps} flexDirection=\"column\">\n      <Text>{`${chalk[colors.notice](program.name ?? '?')} ${chalk[colors.muted](\n        program.version ?? '?',\n      )}`}</Text>\n      <Text color={colors.body}>{program.description}</Text>\n\n      {program.commands.length ? (\n        <>\n          <Header icon={icons.info} marginTop={1}>\n            <Text color={colors.highlighted}>Usage</Text>\n          </Header>\n          {program.commands.map((command) => {\n            let line = `${chalk[colors.muted](program.bin ?? '?')} ${command.name}`;\n\n            if (command.parameters) {\n              if (command.parameters.some((parameterConfig) => !!parameterConfig.required)) {\n                line += ` ${chalk[colors.muted]('<parameters>')}`;\n              } else {\n                line += ` ${chalk[colors.muted]('[<parameters>]')}`;\n              }\n            }\n\n            if (command.options) {\n              if (\n                Object.entries(command.options).some(([, optionConfig]) => !!optionConfig.required)\n              ) {\n                line += ` ${chalk[colors.muted]('<options>')}`;\n              } else {\n                line += ` ${chalk[colors.muted]('[<options>]')}`;\n              }\n            }\n\n            if (command.description) {\n              line += ` ${command.description}`;\n            }\n\n            return (\n              <Box key={command.name} marginLeft={2} flexDirection=\"column\">\n                <Text>{line}</Text>\n              </Box>\n            );\n          })}\n        </>\n      ) : null}\n    </Box>\n  );\n}\n"],"names":["chalk","Box","Text","colors","Header","icons","Help","program","boxProps","flexDirection","notice","name","muted","version","color","body","description","commands","length","icon","info","marginTop","highlighted","map","command","line","bin","parameters","some","parameterConfig","required","options","Object","entries","optionConfig","marginLeft"],"mappings":";AAAA,OAAOA,WAAW,QAAQ;AAC1B,SAAQC,GAAG,EAAEC,IAAI,QAAsB,MAAM;AAE7C,YAAYC,YAAY,cAAc;AACtC,SAAQC,MAAM,QAAO,cAAc;AACnC,YAAYC,WAAW,aAAa;AAWpC;;CAEC,GACD,OAAO,SAASC,KAAK,EAACC,OAAO,EAAE,GAAGC,UAAoB;IACpD,qBACE,MAACP;QAAK,GAAGO,QAAQ;QAAEC,eAAc;;0BAC/B,KAACP;0BAAM,CAAC,EAAEF,KAAK,CAACG,OAAOO,MAAM,CAAC,CAACH,QAAQI,IAAI,IAAI,KAAK,CAAC,EAAEX,KAAK,CAACG,OAAOS,KAAK,CAAC,CACxEL,QAAQM,OAAO,IAAI,KACnB,CAAC;;0BACH,KAACX;gBAAKY,OAAOX,OAAOY,IAAI;0BAAGR,QAAQS,WAAW;;YAE7CT,QAAQU,QAAQ,CAACC,MAAM,iBACtB;;kCACE,KAACd;wBAAOe,MAAMd,MAAMe,IAAI;wBAAEC,WAAW;kCACnC,cAAA,KAACnB;4BAAKY,OAAOX,OAAOmB,WAAW;sCAAE;;;oBAElCf,QAAQU,QAAQ,CAACM,GAAG,CAAC,CAACC;wBACrB,IAAIC,OAAO,CAAC,EAAEzB,KAAK,CAACG,OAAOS,KAAK,CAAC,CAACL,QAAQmB,GAAG,IAAI,KAAK,CAAC,EAAEF,QAAQb,IAAI,CAAC,CAAC;wBAEvE,IAAIa,QAAQG,UAAU,EAAE;4BACtB,IAAIH,QAAQG,UAAU,CAACC,IAAI,CAAC,CAACC,kBAAoB,CAAC,CAACA,gBAAgBC,QAAQ,GAAG;gCAC5EL,QAAQ,CAAC,CAAC,EAAEzB,KAAK,CAACG,OAAOS,KAAK,CAAC,CAAC,gBAAgB,CAAC;4BACnD,OAAO;gCACLa,QAAQ,CAAC,CAAC,EAAEzB,KAAK,CAACG,OAAOS,KAAK,CAAC,CAAC,kBAAkB,CAAC;4BACrD;wBACF;wBAEA,IAAIY,QAAQO,OAAO,EAAE;4BACnB,IACEC,OAAOC,OAAO,CAACT,QAAQO,OAAO,EAAEH,IAAI,CAAC,CAAC,GAAGM,aAAa,GAAK,CAAC,CAACA,aAAaJ,QAAQ,GAClF;gCACAL,QAAQ,CAAC,CAAC,EAAEzB,KAAK,CAACG,OAAOS,KAAK,CAAC,CAAC,aAAa,CAAC;4BAChD,OAAO;gCACLa,QAAQ,CAAC,CAAC,EAAEzB,KAAK,CAACG,OAAOS,KAAK,CAAC,CAAC,eAAe,CAAC;4BAClD;wBACF;wBAEA,IAAIY,QAAQR,WAAW,EAAE;4BACvBS,QAAQ,CAAC,CAAC,EAAED,QAAQR,WAAW,CAAC,CAAC;wBACnC;wBAEA,qBACE,KAACf;4BAAuBkC,YAAY;4BAAG1B,eAAc;sCACnD,cAAA,KAACP;0CAAMuB;;2BADCD,QAAQb,IAAI;oBAI1B;;iBAEA;;;AAGV"}
+{"version":3,"sources":["../../src/ui/Help.tsx"],"sourcesContent":["import chalk from 'chalk';\nimport {Box, Text, type BoxProps} from 'ink';\n\nimport * as colors from './colors.js';\nimport {Header} from './Header.js';\nimport * as icons from './icons.js';\nimport {type Program} from '../program.js';\n\n/**\n * {@link Help} component props.\n */\nexport type HelpProps = BoxProps & {\n  /** {@link Program} instance. */\n  program: Program;\n};\n\n/**\n * A component that renders help information.\n */\nexport function Help({program, ...boxProps}: HelpProps) {\n  return (\n    <Box {...boxProps} flexDirection=\"column\">\n      <Text>{`${chalk[colors.notice](program.displayName ?? program.name ?? '?')} ${chalk[\n        colors.muted\n      ](program.version ?? '?')}`}</Text>\n      <Text color={colors.body}>{program.description}</Text>\n\n      {program.commands.length ? (\n        <>\n          <Header icon={icons.info} marginTop={1}>\n            <Text color={colors.highlighted}>Usage</Text>\n          </Header>\n          {program.commands.map((command) => {\n            let line = `${chalk[colors.muted](program.bin ?? '?')} ${command.name}`;\n\n            if (command.parameters) {\n              if (command.parameters.some((parameterConfig) => !!parameterConfig.required)) {\n                line += ` ${chalk[colors.muted]('<parameters>')}`;\n              } else {\n                line += ` ${chalk[colors.muted]('[<parameters>]')}`;\n              }\n            }\n\n            if (command.options) {\n              if (\n                Object.entries(command.options).some(([, optionConfig]) => !!optionConfig.required)\n              ) {\n                line += ` ${chalk[colors.muted]('<options>')}`;\n              } else {\n                line += ` ${chalk[colors.muted]('[<options>]')}`;\n              }\n            }\n\n            if (command.description) {\n              line += ` ${command.description}`;\n            }\n\n            return (\n              <Box key={command.name} marginLeft={2} flexDirection=\"column\">\n                <Text>{line}</Text>\n              </Box>\n            );\n          })}\n        </>\n      ) : null}\n    </Box>\n  );\n}\n"],"names":["chalk","Box","Text","colors","Header","icons","Help","program","boxProps","flexDirection","notice","displayName","name","muted","version","color","body","description","commands","length","icon","info","marginTop","highlighted","map","command","line","bin","parameters","some","parameterConfig","required","options","Object","entries","optionConfig","marginLeft"],"mappings":";AAAA,OAAOA,WAAW,QAAQ;AAC1B,SAAQC,GAAG,EAAEC,IAAI,QAAsB,MAAM;AAE7C,YAAYC,YAAY,cAAc;AACtC,SAAQC,MAAM,QAAO,cAAc;AACnC,YAAYC,WAAW,aAAa;AAWpC;;CAEC,GACD,OAAO,SAASC,KAAK,EAACC,OAAO,EAAE,GAAGC,UAAoB;IACpD,qBACE,MAACP;QAAK,GAAGO,QAAQ;QAAEC,eAAc;;0BAC/B,KAACP;0BAAM,CAAC,EAAEF,KAAK,CAACG,OAAOO,MAAM,CAAC,CAACH,QAAQI,WAAW,IAAIJ,QAAQK,IAAI,IAAI,KAAK,CAAC,EAAEZ,KAAK,CACjFG,OAAOU,KAAK,CACb,CAACN,QAAQO,OAAO,IAAI,KAAK,CAAC;;0BAC3B,KAACZ;gBAAKa,OAAOZ,OAAOa,IAAI;0BAAGT,QAAQU,WAAW;;YAE7CV,QAAQW,QAAQ,CAACC,MAAM,iBACtB;;kCACE,KAACf;wBAAOgB,MAAMf,MAAMgB,IAAI;wBAAEC,WAAW;kCACnC,cAAA,KAACpB;4BAAKa,OAAOZ,OAAOoB,WAAW;sCAAE;;;oBAElChB,QAAQW,QAAQ,CAACM,GAAG,CAAC,CAACC;wBACrB,IAAIC,OAAO,CAAC,EAAE1B,KAAK,CAACG,OAAOU,KAAK,CAAC,CAACN,QAAQoB,GAAG,IAAI,KAAK,CAAC,EAAEF,QAAQb,IAAI,CAAC,CAAC;wBAEvE,IAAIa,QAAQG,UAAU,EAAE;4BACtB,IAAIH,QAAQG,UAAU,CAACC,IAAI,CAAC,CAACC,kBAAoB,CAAC,CAACA,gBAAgBC,QAAQ,GAAG;gCAC5EL,QAAQ,CAAC,CAAC,EAAE1B,KAAK,CAACG,OAAOU,KAAK,CAAC,CAAC,gBAAgB,CAAC;4BACnD,OAAO;gCACLa,QAAQ,CAAC,CAAC,EAAE1B,KAAK,CAACG,OAAOU,KAAK,CAAC,CAAC,kBAAkB,CAAC;4BACrD;wBACF;wBAEA,IAAIY,QAAQO,OAAO,EAAE;4BACnB,IACEC,OAAOC,OAAO,CAACT,QAAQO,OAAO,EAAEH,IAAI,CAAC,CAAC,GAAGM,aAAa,GAAK,CAAC,CAACA,aAAaJ,QAAQ,GAClF;gCACAL,QAAQ,CAAC,CAAC,EAAE1B,KAAK,CAACG,OAAOU,KAAK,CAAC,CAAC,aAAa,CAAC;4BAChD,OAAO;gCACLa,QAAQ,CAAC,CAAC,EAAE1B,KAAK,CAACG,OAAOU,KAAK,CAAC,CAAC,eAAe,CAAC;4BAClD;wBACF;wBAEA,IAAIY,QAAQR,WAAW,EAAE;4BACvBS,QAAQ,CAAC,CAAC,EAAED,QAAQR,WAAW,CAAC,CAAC;wBACnC;wBAEA,qBACE,KAAChB;4BAAuBmC,YAAY;4BAAG3B,eAAc;sCACnD,cAAA,KAACP;0CAAMwB;;2BADCD,QAAQb,IAAI;oBAI1B;;iBAEA;;;AAGV"}

package/dist/ui/internals/Wrapper.js

@@ -1,8 +1,9 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import { Box } from 'ink';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Box, Spacer, Text } from 'ink';
 import { useMemo } from 'react';
 import { ErrorBoundary } from 'react-error-boundary';
 import { programContext } from './programContext.js';
+import { highlighted, notice } from '../colors.js';
 import { Failure } from '../Failure.js';
 /**
  * A component that wraps anything {@link Program} tries to render with an error boundary and all neccessary providers.
@@ -14,11 +15,50 @@ import { Failure } from '../Failure.js';
     ]);
     return /*#__PURE__*/ _jsx(ErrorBoundary, {
         FallbackComponent: Failure,
-        children: /*#__PURE__*/ _jsx(programContext.Provider, {
+        children: /*#__PURE__*/ _jsxs(programContext.Provider, {
             value: programContextValue,
-            children: /*#__PURE__*/ _jsx(Box, {
-                children: children
-            })
+            children: [
+                program.latestVersion && program.latestVersion !== program.version ? /*#__PURE__*/ _jsxs(Box, {
+                    children: [
+                        /*#__PURE__*/ _jsxs(Box, {
+                            flexDirection: "column",
+                            borderColor: notice,
+                            borderStyle: "round",
+                            margin: 1,
+                            paddingTop: 1,
+                            paddingRight: 4,
+                            paddingBottom: 1,
+                            paddingLeft: 4,
+                            children: [
+                                /*#__PURE__*/ _jsxs(Text, {
+                                    children: [
+                                        "New version ",
+                                        /*#__PURE__*/ _jsx(Text, {
+                                            color: highlighted,
+                                            children: program.latestVersion
+                                        }),
+                                        " is available!"
+                                    ]
+                                }),
+                                /*#__PURE__*/ _jsxs(Text, {
+                                    children: [
+                                        "Run ",
+                                        /*#__PURE__*/ _jsx(Text, {
+                                            color: highlighted,
+                                            children: `npm install ${program.name} -D`
+                                        }),
+                                        " to update."
+                                    ]
+                                })
+                            ]
+                        }),
+                        /*#__PURE__*/ _jsx(Spacer, {})
+                    ]
+                }) : null,
+                /*#__PURE__*/ _jsx(Box, {
+                    children: children
+                })
+            ]
         })
     });
 };

package/dist/ui/internals/Wrapper.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/ui/internals/Wrapper.tsx"],"sourcesContent":["import {Box} from 'ink';\nimport {useMemo, type FC, type PropsWithChildren} from 'react';\nimport {ErrorBoundary} from 'react-error-boundary';\n\nimport {programContext} from './programContext.js';\nimport {type Program} from '../../program.js';\nimport {Failure} from '../Failure.js';\n\n/**\n * {@link Wrapper} component props.\n */\nexport type WrapperProps = {\n  program: Program;\n};\n\n/**\n * A component that wraps anything {@link Program} tries to render with an error boundary and all neccessary providers.\n */\nexport const Wrapper: FC<PropsWithChildren<WrapperProps>> = ({program, children}) => {\n  let programContextValue = useMemo(\n    () => ({\n      program,\n    }),\n    [program],\n  );\n\n  return (\n    <ErrorBoundary FallbackComponent={Failure}>\n      <programContext.Provider value={programContextValue}>\n        <Box>{children}</Box>\n      </programContext.Provider>\n    </ErrorBoundary>\n  );\n};\n"],"names":["Box","useMemo","ErrorBoundary","programContext","Failure","Wrapper","program","children","programContextValue","FallbackComponent","Provider","value"],"mappings":";AAAA,SAAQA,GAAG,QAAO,MAAM;AACxB,SAAQC,OAAO,QAAwC,QAAQ;AAC/D,SAAQC,aAAa,QAAO,uBAAuB;AAEnD,SAAQC,cAAc,QAAO,sBAAsB;AAEnD,SAAQC,OAAO,QAAO,gBAAgB;AAStC;;CAEC,GACD,OAAO,MAAMC,UAA+C,CAAC,EAACC,OAAO,EAAEC,QAAQ,EAAC;IAC9E,IAAIC,sBAAsBP,QACxB,IAAO,CAAA;YACLK;QACF,CAAA,GACA;QAACA;KAAQ;IAGX,qBACE,KAACJ;QAAcO,mBAAmBL;kBAChC,cAAA,KAACD,eAAeO,QAAQ;YAACC,OAAOH;sBAC9B,cAAA,KAACR;0BAAKO;;;;AAId,EAAE"}
+{"version":3,"sources":["../../../src/ui/internals/Wrapper.tsx"],"sourcesContent":["import {Box, Spacer, Text} from 'ink';\nimport {useMemo, type FC, type PropsWithChildren} from 'react';\nimport {ErrorBoundary} from 'react-error-boundary';\n\nimport {programContext} from './programContext.js';\nimport {type Program} from '../../program.js';\nimport {highlighted, notice} from '../colors.js';\nimport {Failure} from '../Failure.js';\n\n/**\n * {@link Wrapper} component props.\n */\nexport type WrapperProps = {\n  program: Program;\n};\n\n/**\n * A component that wraps anything {@link Program} tries to render with an error boundary and all neccessary providers.\n */\nexport const Wrapper: FC<PropsWithChildren<WrapperProps>> = ({program, children}) => {\n  let programContextValue = useMemo(\n    () => ({\n      program,\n    }),\n    [program],\n  );\n\n  return (\n    <ErrorBoundary FallbackComponent={Failure}>\n      <programContext.Provider value={programContextValue}>\n        {program.latestVersion && program.latestVersion !== program.version ? (\n          <Box>\n            <Box\n              flexDirection=\"column\"\n              borderColor={notice}\n              borderStyle=\"round\"\n              margin={1}\n              paddingTop={1}\n              paddingRight={4}\n              paddingBottom={1}\n              paddingLeft={4}\n            >\n              <Text>\n                New version <Text color={highlighted}>{program.latestVersion}</Text> is available!\n              </Text>\n              <Text>\n                Run <Text color={highlighted}>{`npm install ${program.name} -D`}</Text> to update.\n              </Text>\n            </Box>\n            <Spacer />\n          </Box>\n        ) : null}\n        <Box>{children}</Box>\n      </programContext.Provider>\n    </ErrorBoundary>\n  );\n};\n"],"names":["Box","Spacer","Text","useMemo","ErrorBoundary","programContext","highlighted","notice","Failure","Wrapper","program","children","programContextValue","FallbackComponent","Provider","value","latestVersion","version","flexDirection","borderColor","borderStyle","margin","paddingTop","paddingRight","paddingBottom","paddingLeft","color","name"],"mappings":";AAAA,SAAQA,GAAG,EAAEC,MAAM,EAAEC,IAAI,QAAO,MAAM;AACtC,SAAQC,OAAO,QAAwC,QAAQ;AAC/D,SAAQC,aAAa,QAAO,uBAAuB;AAEnD,SAAQC,cAAc,QAAO,sBAAsB;AAEnD,SAAQC,WAAW,EAAEC,MAAM,QAAO,eAAe;AACjD,SAAQC,OAAO,QAAO,gBAAgB;AAStC;;CAEC,GACD,OAAO,MAAMC,UAA+C,CAAC,EAACC,OAAO,EAAEC,QAAQ,EAAC;IAC9E,IAAIC,sBAAsBT,QACxB,IAAO,CAAA;YACLO;QACF,CAAA,GACA;QAACA;KAAQ;IAGX,qBACE,KAACN;QAAcS,mBAAmBL;kBAChC,cAAA,MAACH,eAAeS,QAAQ;YAACC,OAAOH;;gBAC7BF,QAAQM,aAAa,IAAIN,QAAQM,aAAa,KAAKN,QAAQO,OAAO,iBACjE,MAACjB;;sCACC,MAACA;4BACCkB,eAAc;4BACdC,aAAaZ;4BACba,aAAY;4BACZC,QAAQ;4BACRC,YAAY;4BACZC,cAAc;4BACdC,eAAe;4BACfC,aAAa;;8CAEb,MAACvB;;wCAAK;sDACQ,KAACA;4CAAKwB,OAAOpB;sDAAcI,QAAQM,aAAa;;wCAAQ;;;8CAEtE,MAACd;;wCAAK;sDACA,KAACA;4CAAKwB,OAAOpB;sDAAc,CAAC,YAAY,EAAEI,QAAQiB,IAAI,CAAC,GAAG,CAAC;;wCAAQ;;;;;sCAG3E,KAAC1B;;qBAED;8BACJ,KAACD;8BAAKW;;;;;AAId,EAAE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jakubmazanec/cli",
-  "version": "0.1.3-next.e2c3f48",
+  "version": "0.2.0-unstable.fe83933",
   "description": "TypeScript-first library for building CLIs.",
   "repository": {
     "type": "git",
@@ -32,12 +32,15 @@
     "@jakubmazanec/ts-utils": "^2.1.0",
     "@jakubmazanec/zod-utils": "^1.0.0",
     "chalk": "^5.2.0",
+    "fs-extra": "^10.0.1",
+    "latest-version": "^7.0.0",
     "lodash": "^4.17.21",
     "react-error-boundary": "^4.0.7",
     "zod": "^3.14.4"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",
+    "@types/fs-extra": "^9.0.13",
     "@types/lodash": "^4.14.195",
     "@types/node": "^16.18.3",
     "@types/react": "^18.0.26",

package/src/constants.ts

@@ -1 +1,9 @@
+import path from 'node:path';
+import url from 'node:url';
+
+let directory = path.dirname(url.fileURLToPath(import.meta.url));
+
+export const PACKAGE_PATH = path.resolve(directory, '..');
+export const CACHE_PATH = path.resolve(PACKAGE_PATH, 'node_modules/.cache');
+
 export const DELIMITER = '$ ';

package/src/program/Command.ts

@@ -9,7 +9,6 @@ import {
 import {type CommandAction} from './CommandAction.js';
 import {type CommandOptions} from './CommandOptions.js';
 import {type Program} from './Program.js';
-// import {type ProgramCommand} from './ProgramCommand.js';
 
 /**
  * Command encapsulates piece of a CLI's logic and is executed when {@link Program} instance parses that command from the command line arguments.

package/src/program/Program.ts

@@ -1,12 +1,17 @@
 /* eslint-disable @typescript-eslint/no-explicit-any -- needed */
 import {type ParametersConfig, type Argv, type OptionsConfig} from '@jakubmazanec/args';
+import fs from 'fs-extra';
+import fetchLatestVersion from 'latest-version';
+import path from 'path';
 import {type ComponentType} from 'react';
 import {type FallbackProps} from 'react-error-boundary';
 
 import {type Command} from './Command.js';
+import {type ProgramCreateOptions} from './ProgramCreateOptions.js';
 import {ProgramError} from './ProgramError.js';
 import {type ProgramOptions} from './ProgramOptions.js';
 import {type ProgramStreams} from './ProgramStreams.js';
+import {CACHE_PATH} from '../constants.js';
 import {Wrapper} from '../ui/internals.js';
 import {Failure, Help} from '../ui.js';
 
@@ -17,9 +22,15 @@ export class Program {
   /** Program name. */
   readonly name?: string;
 
+  /** More readable program name. */
+  readonly displayName?: string;
+
   /** Program version. */
   readonly version?: string;
 
+  /** Program latest version. */
+  readonly latestVersion?: string;
+
   /** Program description. */
   readonly description?: string;
 
@@ -42,15 +53,31 @@ export class Program {
   /** Custom error boundary fallback component */
   ErrorBoundaryFallbackComponent: ComponentType<FallbackProps>;
 
-  constructor({name, version, description, bin, ErrorBoundaryFallbackComponent}: ProgramOptions) {
+  private constructor({
+    name,
+    displayName,
+    version,
+    latestVersion,
+    description,
+    bin,
+    ErrorBoundaryFallbackComponent,
+  }: ProgramOptions) {
     if (name) {
       this.name = name;
     }
 
+    if (displayName) {
+      this.displayName = displayName;
+    }
+
     if (version) {
       this.version = version;
     }
 
+    if (latestVersion) {
+      this.latestVersion = latestVersion;
+    }
+
     if (description) {
       this.description = description;
     }
@@ -66,6 +93,54 @@ export class Program {
     }
   }
 
+  static async create({
+    name,
+    version,
+    description,
+    bin,
+    ErrorBoundaryFallbackComponent,
+    checkForUpdate,
+  }: ProgramCreateOptions) {
+    let latestVersion: string | undefined;
+
+    if (checkForUpdate && name) {
+      // first we try to read the cached latest version
+      type CachedLatestVersion = {
+        value: string;
+        datetime: number;
+      };
+
+      let cachePath = path.join(CACHE_PATH, name, 'latest-version.json');
+      let cachedLatestVersion: CachedLatestVersion | undefined;
+
+      try {
+        cachedLatestVersion = (await fs.readJson(cachePath)) as CachedLatestVersion;
+      } catch {
+        // no-op
+      }
+
+      // if there is no cache or the cached value is old, refetch and recache
+      if (!cachedLatestVersion || Date.now() - cachedLatestVersion.datetime > 86_400_00) {
+        latestVersion = await fetchLatestVersion(name);
+
+        await fs.ensureFile(cachePath);
+        await fs.writeJson(cachePath, {
+          value: latestVersion,
+          datetime: Date.now(),
+        });
+      }
+    }
+
+    return new this({
+      name,
+      version,
+      latestVersion,
+      description,
+      bin,
+      ErrorBoundaryFallbackComponent,
+    });
+  }
+
   /**
    * Adds command to the program.
    *

package/src/program/ProgramCreateOptions.ts

@@ -0,0 +1,28 @@
+import {type ComponentType} from 'react';
+import {type FallbackProps} from 'react-error-boundary';
+
+/**
+ * {@link Program.create} options parameter.
+ */
+export type ProgramCreateOptions = {
+  /** Program name. */
+  name?: string | undefined;
+
+  /** More readable program name. */
+  displayName?: string | undefined;
+
+  /** Program version. */
+  version?: string | undefined;
+
+  /** Program description. */
+  description?: string | undefined;
+
+  /** Program executable name. */
+  bin?: string | undefined;
+
+  /** Custom error boundary fallback component */
+  ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps>;
+
+  /** Perform check whether a newer version of the program is available. */
+  checkForUpdate?: boolean;
+};

package/src/program/ProgramOptions.ts

@@ -2,15 +2,21 @@ import {type ComponentType} from 'react';
 import {type FallbackProps} from 'react-error-boundary';
 
 /**
- * {@link Project.constructor | Program constructor} options parameter.
+ * {@link Program.constructor | Program constructor} options parameter.
  */
 export type ProgramOptions = {
   /** Program name. */
   name?: string | undefined;
 
+  /** More readable program name. */
+  displayName?: string | undefined;
+
   /** Program version. */
   version?: string | undefined;
 
+  /** Program latest version. */
+  latestVersion?: string | undefined;
+
   /** Program description. */
   description?: string | undefined;
 
@@ -18,5 +24,8 @@ export type ProgramOptions = {
   bin?: string | undefined;
 
   /** Custom error boundary fallback component */
-  ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps>;
+  ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps> | undefined;
+
+  /** Perform check whether a newer version of the program is available. */
+  checkForUpdate?: boolean;
 };

package/src/program.ts

@@ -4,6 +4,7 @@ export * from './program/CommandArguments.js';
 export * from './program/CommandOptions.js';
 export * from './program/getProgramDetail.js';
 export * from './program/Program.js';
+export * from './program/ProgramCreateOptions.js';
 export * from './program/ProgramDetail.js';
 export * from './program/ProgramError.js';
 export * from './program/ProgramOptions.js';

package/src/ui/Help.tsx

@@ -20,9 +20,9 @@ export type HelpProps = BoxProps & {
 export function Help({program, ...boxProps}: HelpProps) {
   return (
     <Box {...boxProps} flexDirection="column">
-      <Text>{`${chalk[colors.notice](program.name ?? '?')} ${chalk[colors.muted](
-        program.version ?? '?',
-      )}`}</Text>
+      <Text>{`${chalk[colors.notice](program.displayName ?? program.name ?? '?')} ${chalk[
+        colors.muted
+      ](program.version ?? '?')}`}</Text>
       <Text color={colors.body}>{program.description}</Text>
 
       {program.commands.length ? (

package/src/ui/internals/Wrapper.tsx

@@ -1,9 +1,10 @@
-import {Box} from 'ink';
+import {Box, Spacer, Text} from 'ink';
 import {useMemo, type FC, type PropsWithChildren} from 'react';
 import {ErrorBoundary} from 'react-error-boundary';
 
 import {programContext} from './programContext.js';
 import {type Program} from '../../program.js';
+import {highlighted, notice} from '../colors.js';
 import {Failure} from '../Failure.js';
 
 /**
@@ -27,6 +28,28 @@ export const Wrapper: FC<PropsWithChildren<WrapperProps>> = ({program, children}
   return (
     <ErrorBoundary FallbackComponent={Failure}>
       <programContext.Provider value={programContextValue}>
+        {program.latestVersion && program.latestVersion !== program.version ? (
+          <Box>
+            <Box
+              flexDirection="column"
+              borderColor={notice}
+              borderStyle="round"
+              margin={1}
+              paddingTop={1}
+              paddingRight={4}
+              paddingBottom={1}
+              paddingLeft={4}
+            >
+              <Text>
+                New version <Text color={highlighted}>{program.latestVersion}</Text> is available!
+              </Text>
+              <Text>
+                Run <Text color={highlighted}>{`npm install ${program.name} -D`}</Text> to update.
+              </Text>
+            </Box>
+            <Spacer />
+          </Box>
+        ) : null}
         <Box>{children}</Box>
       </programContext.Provider>
     </ErrorBoundary>