@jakubmazanec/cli 0.1.0-a500263 → 0.1.0-c2efc51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/README.md +3 -1
  2. package/dist/program/Command.d.ts +2 -2
  3. package/dist/program/Command.js +4 -4
  4. package/dist/program/Command.js.map +1 -1
  5. package/dist/program/CommandOptions.d.ts +1 -1
  6. package/dist/program/CommandOptions.js.map +1 -1
  7. package/dist/program/Program.d.ts +8 -3
  8. package/dist/program/Program.js +32 -12
  9. package/dist/program/Program.js.map +1 -1
  10. package/dist/program/ProgramOptions.d.ts +5 -1
  11. package/dist/program/ProgramOptions.js +1 -3
  12. package/dist/program/ProgramOptions.js.map +1 -1
  13. package/dist/program/ProgramStreams.d.ts +1 -1
  14. package/dist/program/ProgramStreams.js +1 -1
  15. package/dist/program/ProgramStreams.js.map +1 -1
  16. package/dist/program/getProgramDetail.js.map +1 -1
  17. package/dist/ui/Failure.d.ts +2 -2
  18. package/dist/ui/Failure.js +2 -2
  19. package/dist/ui/Failure.js.map +1 -1
  20. package/dist/ui/Header.d.ts +1 -1
  21. package/dist/ui/Header.js +1 -1
  22. package/dist/ui/Header.js.map +1 -1
  23. package/dist/ui/Help.d.ts +2 -2
  24. package/dist/ui/Help.js +1 -1
  25. package/dist/ui/Help.js.map +1 -1
  26. package/dist/ui/Spinner.js.map +1 -1
  27. package/dist/ui/form/FormRow.js +1 -1
  28. package/dist/ui/form/FormRow.js.map +1 -1
  29. package/dist/ui/form/SelectInput.d.ts +3 -3
  30. package/dist/ui/form/SelectInput.js +20 -29
  31. package/dist/ui/form/SelectInput.js.map +1 -1
  32. package/dist/ui/form/TextInput.d.ts +1 -1
  33. package/dist/ui/form/TextInput.js +5 -8
  34. package/dist/ui/form/TextInput.js.map +1 -1
  35. package/dist/ui/form/createForm.js +1 -1
  36. package/dist/ui/form/createForm.js.map +1 -1
  37. package/dist/ui/getErrorDetail.js +9 -0
  38. package/dist/ui/getErrorDetail.js.map +1 -1
  39. package/dist/ui/icons.js.map +1 -1
  40. package/dist/ui/internals/Wrapper.d.ts +2 -2
  41. package/dist/ui/internals/Wrapper.js +4 -4
  42. package/dist/ui/internals/Wrapper.js.map +1 -1
  43. package/dist/ui/internals/programContext.d.ts +1 -1
  44. package/dist/ui/internals/programContext.js +1 -1
  45. package/dist/ui/internals/programContext.js.map +1 -1
  46. package/dist/ui/internals/rotate.js.map +1 -1
  47. package/dist/ui/useProgram.d.ts +1 -1
  48. package/dist/ui/useProgram.js +5 -5
  49. package/dist/ui/useProgram.js.map +1 -1
  50. package/package.json +8 -7
  51. package/src/program/Command.ts +2 -3
  52. package/src/program/CommandOptions.ts +1 -1
  53. package/src/program/Program.ts +38 -5
  54. package/src/program/ProgramOptions.ts +7 -1
  55. package/src/program/ProgramStreams.ts +1 -1
  56. package/src/ui/Failure.tsx +2 -2
  57. package/src/ui/Header.tsx +1 -1
  58. package/src/ui/Help.tsx +2 -2
  59. package/src/ui/form/SelectInput.tsx +23 -28
  60. package/src/ui/form/TextInput.tsx +5 -10
  61. package/src/ui/getErrorDetail.ts +11 -0
  62. package/src/ui/internals/Wrapper.tsx +5 -5
  63. package/src/ui/internals/programContext.ts +1 -1
  64. package/src/ui/useProgram.ts +3 -3
package/README.md CHANGED
@@ -1,10 +1,12 @@
1
+ <!-- header -->
1
2
  <div align="center">
2
3
 
3
4
  # @jakubmazanec/cli
4
5
 
5
- <!-- description -->TypeScript-first library for building CLIs.<!-- description -->
6
+ TypeScript-first library for building CLIs.
6
7
 
7
8
  </div>
9
+ <!-- header -->
8
10
 
9
11
  ## Installation
10
12
 
@@ -3,7 +3,7 @@ import { type CommandAction } from './CommandAction.js';
3
3
  import { type CommandOptions } from './CommandOptions.js';
4
4
  import { type Program } from './Program.js';
5
5
  /**
6
- * Command encapsulates piece of a CLI's logic and is executed when {@linkcode Program} instance parses that command from the command line arguments.
6
+ * Command encapsulates piece of a CLI's logic and is executed when {@link Program} instance parses that command from the command line arguments.
7
7
  */
8
8
  export declare class Command<A extends string, const B extends ParametersConfig | undefined = undefined, const C extends OptionsConfig | undefined = undefined, D extends boolean = false, E extends boolean = false> {
9
9
  readonly name: A;
@@ -30,7 +30,7 @@ export declare class Command<A extends string, const B extends ParametersConfig
30
30
  allowUnknownParameters: E;
31
31
  }>;
32
32
  /**
33
- * Executes command action with provided parsed arguments and {@linkcode Program} instance.
33
+ * Executes command action with provided parsed arguments and {@link Program} instance.
34
34
  */
35
35
  run(parsedArgs: Arguments<{
36
36
  commands: readonly [A];
@@ -1,9 +1,9 @@
1
1
  import { parseArguments } from '@jakubmazanec/args';
2
2
  // import {type ProgramCommand} from './ProgramCommand.js';
3
3
  /**
4
- * Command encapsulates piece of a CLI's logic and is executed when {@linkcode Program} instance parses that command from the command line arguments.
4
+ * Command encapsulates piece of a CLI's logic and is executed when {@link Program} instance parses that command from the command line arguments.
5
5
  */ export class Command {
6
- /* implements ProgramCommand*/ name;
6
+ name;
7
7
  description;
8
8
  parameters;
9
9
  options;
@@ -14,7 +14,7 @@ import { parseArguments } from '@jakubmazanec/args';
14
14
  * @param name Command name, ie. space-separated words consisting only of letters, numbers (but not at the start of the word) or dashes.
15
15
  * @param action Function that runs when command is executed.
16
16
  * @param options Additionl command options.
17
- */ constructor(name, action, { description , parameters , options , allowUnknownOptions , allowUnknownParameters }){
17
+ */ constructor(name, action, { description, parameters, options, allowUnknownOptions, allowUnknownParameters }){
18
18
  this.name = name;
19
19
  this.action = action;
20
20
  if (description) {
@@ -55,7 +55,7 @@ import { parseArguments } from '@jakubmazanec/args';
55
55
  });
56
56
  }
57
57
  /**
58
- * Executes command action with provided parsed arguments and {@linkcode Program} instance.
58
+ * Executes command action with provided parsed arguments and {@link Program} instance.
59
59
  */ async run(parsedArgs, program) {
60
60
  await this.action(parsedArgs, program);
61
61
  }
@@ -1 +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 {@linkcode 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 /* implements ProgramCommand*/\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 {@linkcode 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;IAOX,4BAA4B,GAC5B,AAASC,KAAQ;IACRC,YAAqB;IACrBC,WAAkD;IAClDC,QAA4C;IAC5CC,oBAAuB;IACvBC,uBAA0B;IAClBC,OAAqC;IAEtD;;;;GAIC,GACDC,YACEP,IAAO,EACPM,MAAoC,EACpC,EACEL,YAAW,EACXC,WAAU,EACVC,QAAO,EACPC,oBAAmB,EACnBC,uBAAsB,EAC+B,CACvD;QACA,IAAI,CAACL,OAAOA;QACZ,IAAI,CAACM,SAASA;QAEd,IAAIL,aAAa;YACf,IAAI,CAACA,cAAcA;QACrB;QAEA,IAAIC,YAAY;YACd,IAAI,CAACA,aAAaA;QACpB,OAAO;YACL,IAAI,CAACA,aAAa;QACpB;QAEA,IAAIC,SAAS;YACX,IAAI,CAACA,UAAUA;QACjB,OAAO;YACL,IAAI,CAACA,UAAU;QACjB;QAEA,IAAIC,qBAAqB;YACvB,IAAI,CAACA,sBAAsBA;QAC7B,OAAO;YACL,IAAI,CAACA,sBAAsB;QAC7B;QAEA,IAAIC,wBAAwB;YAC1B,IAAI,CAACA,yBAAyBA;QAChC,OAAO;YACL,IAAI,CAACA,yBAAyB;QAChC;IACF;IAEA;;GAEC,GACDP,eAAeU,IAAU,EAMtB;QACD,OAAOV,eAAeU,MAAM;YAC1BC,UAAU;gBAAC,IAAI,CAACT;aAAK;YACrBE,YAAY,IAAI,CAACA,cAAcQ;YAC/BP,SAAS,IAAI,CAACA,WAAWO;YACzBN,qBAAqB,IAAI,CAACA;YAC1BC,wBAAwB,IAAI,CAACA;QAC/B;IAOF;IAEA;;GAEC,GACD,MAAMM,IACJC,UAME,EACFC,OAAgB,EACD;QACf,MAAM,IAAI,CAACP,OAAOM,YAAYC;IAChC;AACF"}
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"}
@@ -1,6 +1,6 @@
1
1
  import { type OptionsConfig, type ParametersConfig } from '@jakubmazanec/args';
2
2
  /**
3
- * New command options.
3
+ * {@link Command.constructor | Command constructor} options parameter.
4
4
  */
5
5
  export type CommandOptions<B extends ParametersConfig, C extends OptionsConfig, D extends boolean, E extends boolean> = {
6
6
  description?: string;
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/program/CommandOptions.ts"],"sourcesContent":["import {type OptionsConfig, type ParametersConfig} from '@jakubmazanec/args';\n\n/**\n * New command options.\n */\nexport type CommandOptions<\n B extends ParametersConfig,\n C extends OptionsConfig,\n D extends boolean,\n E extends boolean,\n> = {\n description?: string;\n parameters?: B | undefined;\n options?: C | undefined;\n allowUnknownOptions?: D | undefined;\n allowUnknownParameters?: E | undefined;\n};\n"],"names":[],"mappings":"AAAA,WAgBE"}
1
+ {"version":3,"sources":["../../src/program/CommandOptions.ts"],"sourcesContent":["import {type OptionsConfig, type ParametersConfig} from '@jakubmazanec/args';\n\n/**\n * {@link Command.constructor | Command constructor} options parameter.\n */\nexport type CommandOptions<\n B extends ParametersConfig,\n C extends OptionsConfig,\n D extends boolean,\n E extends boolean,\n> = {\n description?: string;\n parameters?: B | undefined;\n options?: C | undefined;\n allowUnknownOptions?: D | undefined;\n allowUnknownParameters?: E | undefined;\n};\n"],"names":[],"mappings":"AAAA,WAgBE"}
@@ -1,10 +1,11 @@
1
- /// <reference types="react" resolution-mode="require"/>
2
1
  import { type ParametersConfig, type Argv, type OptionsConfig } from '@jakubmazanec/args';
2
+ import { type ComponentType } from 'react';
3
+ import { type FallbackProps } from 'react-error-boundary';
3
4
  import { type Command } from './Command.js';
4
5
  import { type ProgramOptions } from './ProgramOptions.js';
5
6
  import { type ProgramStreams } from './ProgramStreams.js';
6
7
  /**
7
- * Program manages and executes {@linkcode Program} instances attached to it based on parsing command line arguments.
8
+ * Program manages and executes {@link Command} instances attached to it based on parsing command line arguments.
8
9
  */
9
10
  export declare class Program {
10
11
  /** Program name. */
@@ -19,7 +20,9 @@ export declare class Program {
19
20
  readonly commands: Array<Command<string, ParametersConfig | undefined, OptionsConfig | undefined, boolean, boolean>>;
20
21
  protected isRendering: boolean;
21
22
  readonly streams: ProgramStreams;
22
- constructor({ name, version, description, bin }: ProgramOptions);
23
+ /** Custom error boundary fallback component */
24
+ ErrorBoundaryFallbackComponent: ComponentType<FallbackProps>;
25
+ constructor({ name, version, description, bin, ErrorBoundaryFallbackComponent }: ProgramOptions);
23
26
  /**
24
27
  * Adds command to the program.
25
28
  *
@@ -29,6 +32,8 @@ export declare class Program {
29
32
  addCommand(command: Command<any, any, any, any, any>): this;
30
33
  /**
31
34
  * Renders a React element using Ink and outputs to the configured streams.
35
+ *
36
+ * @param element The React element to render.
32
37
  */
33
38
  renderElement(element: React.ReactElement): Promise<void>;
34
39
  /**
@@ -2,7 +2,7 @@
2
2
  import { Wrapper } from '../ui/internals.js';
3
3
  import { Failure, Help } from '../ui.js';
4
4
  /**
5
- * Program manages and executes {@linkcode Program} instances attached to it based on parsing command line arguments.
5
+ * Program manages and executes {@link Command} instances attached to it based on parsing command line arguments.
6
6
  */ export class Program {
7
7
  /** Program name. */ name;
8
8
  /** Program version. */ version;
@@ -15,7 +15,8 @@ import { Failure, Help } from '../ui.js';
15
15
  stdin: process.stdin,
16
16
  stdout: process.stdout
17
17
  };
18
- constructor({ name , version , description , bin }){
18
+ /** Custom error boundary fallback component */ ErrorBoundaryFallbackComponent;
19
+ constructor({ name, version, description, bin, ErrorBoundaryFallbackComponent }){
19
20
  if (name) {
20
21
  this.name = name;
21
22
  }
@@ -28,6 +29,11 @@ import { Failure, Help } from '../ui.js';
28
29
  if (bin) {
29
30
  this.bin = bin;
30
31
  }
32
+ if (ErrorBoundaryFallbackComponent) {
33
+ this.ErrorBoundaryFallbackComponent = ErrorBoundaryFallbackComponent;
34
+ } else {
35
+ this.ErrorBoundaryFallbackComponent = Failure;
36
+ }
31
37
  }
32
38
  /**
33
39
  * Adds command to the program.
@@ -41,15 +47,17 @@ import { Failure, Help } from '../ui.js';
41
47
  }
42
48
  /**
43
49
  * Renders a React element using Ink and outputs to the configured streams.
50
+ *
51
+ * @param element The React element to render.
44
52
  */ async renderElement(element) {
45
53
  if (this.isRendering) {
46
54
  throw new ProgramError('NO_NESTED_RENDER');
47
55
  } else {
48
56
  this.isRendering = true;
49
57
  }
50
- let { render } = await import('ink');
51
- let { createElement } = await import('react');
52
- let { stdin , stdout , stderr } = this.streams;
58
+ let { render } = await import('ink');
59
+ let { createElement } = await import('react');
60
+ let { stdin, stdout, stderr } = this.streams;
53
61
  try {
54
62
  render(createElement(Wrapper, {
55
63
  program: this
@@ -62,8 +70,9 @@ import { Failure, Help } from '../ui.js';
62
70
  });
63
71
  } catch (error) {
64
72
  if (error instanceof Error) {
65
- await this.renderElement(createElement(Failure, {
66
- error
73
+ await this.renderElement(createElement(this.ErrorBoundaryFallbackComponent, {
74
+ error,
75
+ resetErrorBoundary: ()=>{}
67
76
  }));
68
77
  }
69
78
  } finally{
@@ -81,20 +90,31 @@ import { Failure, Help } from '../ui.js';
81
90
  if (parsedArgs.command) {
82
91
  hasCommandRun = true;
83
92
  if (parsedArgs.errors.length) {
84
- let { createElement } = await import('react');
93
+ let { createElement } = await import('react');
85
94
  for (let error of parsedArgs.errors){
86
- await this.renderElement(createElement(Failure, {
87
- error
95
+ await this.renderElement(createElement(this.ErrorBoundaryFallbackComponent, {
96
+ error,
97
+ resetErrorBoundary: ()=>{}
88
98
  }));
89
99
  }
90
100
  } else {
91
- await command.run(parsedArgs, this);
101
+ try {
102
+ await command.run(parsedArgs, this);
103
+ } catch (error) {
104
+ let { createElement } = await import('react');
105
+ if (error instanceof Error) {
106
+ await this.renderElement(createElement(this.ErrorBoundaryFallbackComponent, {
107
+ error,
108
+ resetErrorBoundary: ()=>{}
109
+ }));
110
+ }
111
+ }
92
112
  break;
93
113
  }
94
114
  }
95
115
  }
96
116
  if (!hasCommandRun) {
97
- let { createElement } = await import('react');
117
+ let { createElement } = await import('react');
98
118
  await this.renderElement(createElement(Help, {
99
119
  program: this
100
120
  }));
@@ -1 +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';\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 {@linkcode Program} 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 constructor({name, version, description, bin}: 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\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 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(createElement(Failure, {error}));\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 await this.renderElement(createElement(Failure, {error}));\n }\n } else {\n await command.run(parsedArgs, this);\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","constructor","addCommand","command","push","renderElement","element","render","createElement","program","exitOnCtrlC","patchConsole","error","Error","run","argv","hasCommandRun","parsedArgs","parseArguments","errors","length"],"mappings":"AAAA,+DAA+D,GAI/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;QAChBE,OAAOD,QAAQC;QACfC,QAAQF,QAAQE;IAClB,EAAE;IAEFC,YAAY,EAACX,KAAI,EAAEC,QAAO,EAAEC,YAAW,EAAEC,IAAG,EAAiB,CAAE;QAC7D,IAAIH,MAAM;YACR,IAAI,CAACA,OAAOA;QACd;QAEA,IAAIC,SAAS;YACX,IAAI,CAACA,UAAUA;QACjB;QAEA,IAAIC,aAAa;YACf,IAAI,CAACA,cAAcA;QACrB;QAEA,IAAIC,KAAK;YACP,IAAI,CAACA,MAAMA;QACb;IACF;IAEA;;;;;GAKC,GACDS,WAAWC,OAAyC,EAAQ;QAC1D,iLAAiL;QACjL,IAAI,CAACT,SAASU,KAAKD;QAEnB,OAAO,IAAI;IACb;IAEA;;GAEC,GACD,MAAME,cAAcC,OAA2B,EAAiB;QAC9D,IAAI,IAAI,CAACX,aAAa;YACpB,MAAM,IAAIV,aAAa;QACzB,OAAO;YACL,IAAI,CAACU,cAAc;QACrB;QAEA,IAAI,EAACY,OAAM,EAAC,GAAG,MAAM,MAAM,CAAC;QAC5B,IAAI,EAACC,cAAa,EAAC,GAAG,MAAM,MAAM,CAAC;QACnC,IAAI,EAACT,MAAK,EAAEC,OAAM,EAAEH,OAAM,EAAC,GAAG,IAAI,CAACD;QAEnC,IAAI;YACFW,OAAOC,cAActB,SAAS;gBAACuB,SAAS,IAAI;YAAA,GAAGH,UAAU;gBACvDI,aAAa;gBACbC,cAAc;gBACdd;gBACAE;gBACAC;YACF;QACF,EAAE,OAAOY,OAAgB;YACvB,IAAIA,iBAAiBC,OAAO;gBAC1B,MAAM,IAAI,CAACR,cAAcG,cAAcrB,SAAS;oBAACyB;gBAAK;YACxD;QACF,SAAU;YACR,IAAI,CAACjB,cAAc;QACrB;IACF;IAEA;;;;GAIC,GACD,MAAMmB,IAAIC,IAAU,EAAiB;QACnC,IAAIC,gBAAgB;QAEpB,KAAK,IAAIb,WAAW,IAAI,CAACT,SAAU;YACjC,IAAIuB,aAAad,QAAQe,eAAeH;YAExC,IAAIE,WAAWd,SAAS;gBACtBa,gBAAgB;gBAEhB,IAAIC,WAAWE,OAAOC,QAAQ;oBAC5B,IAAI,EAACZ,cAAa,EAAC,GAAG,MAAM,MAAM,CAAC;oBAEnC,KAAK,IAAII,SAASK,WAAWE,OAAQ;wBACnC,MAAM,IAAI,CAACd,cAAcG,cAAcrB,SAAS;4BAACyB;wBAAK;oBACxD;gBACF,OAAO;oBACL,MAAMT,QAAQW,IAAIG,YAAY,IAAI;oBAElC;gBACF;YACF;QACF;QAEA,IAAI,CAACD,eAAe;YAClB,IAAI,EAACR,cAAa,EAAC,GAAG,MAAM,MAAM,CAAC;YAEnC,MAAM,IAAI,CAACH,cAAcG,cAAcpB,MAAM;gBAACqB,SAAS,IAAI;YAAA;QAC7D;IACF;AACF"}
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 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 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"],"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;wBACnC,MAAM,IAAI,CAACf,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;4BAC1B,MAAM,IAAI,CAACR,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"}
@@ -1,5 +1,7 @@
1
+ import { type ComponentType } from 'react';
2
+ import { type FallbackProps } from 'react-error-boundary';
1
3
  /**
2
- * Options for creating new {@linkcode Program} instance.
4
+ * {@link Project.constructor | Program constructor} options parameter.
3
5
  */
4
6
  export type ProgramOptions = {
5
7
  /** Program name. */
@@ -10,4 +12,6 @@ export type ProgramOptions = {
10
12
  description?: string | undefined;
11
13
  /** Program executable name. */
12
14
  bin?: string | undefined;
15
+ /** Custom error boundary fallback component */
16
+ ErrorBoundaryFallbackComponent?: ComponentType<FallbackProps>;
13
17
  };
@@ -1,5 +1,3 @@
1
- /**
2
- * Options for creating new {@linkcode Program} instance.
3
- */ export { };
1
+ export { };
4
2
 
5
3
  //# sourceMappingURL=ProgramOptions.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/program/ProgramOptions.ts"],"sourcesContent":["/**\n * Options for creating new {@linkcode Program} instance.\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"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAYE"}
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"}
@@ -1,6 +1,6 @@
1
1
  /// <reference types="node" resolution-mode="require"/>
2
2
  /**
3
- * {@linkcode Program} streams;
3
+ * {@link Program} streams;
4
4
  */
5
5
  export type ProgramStreams = {
6
6
  stderr: NodeJS.WriteStream;
@@ -1,5 +1,5 @@
1
1
  /**
2
- * {@linkcode Program} streams;
2
+ * {@link Program} streams;
3
3
  */ export { };
4
4
 
5
5
  //# sourceMappingURL=ProgramStreams.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/program/ProgramStreams.ts"],"sourcesContent":["/**\n * {@linkcode Program} streams;\n */\nexport type ProgramStreams = {\n stderr: NodeJS.WriteStream;\n stdin: NodeJS.ReadStream;\n stdout: NodeJS.WriteStream;\n};\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAIE"}
1
+ {"version":3,"sources":["../../src/program/ProgramStreams.ts"],"sourcesContent":["/**\n * {@link Program} streams;\n */\nexport type ProgramStreams = {\n stderr: NodeJS.WriteStream;\n stdin: NodeJS.ReadStream;\n stdout: NodeJS.WriteStream;\n};\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAIE"}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/program/getProgramDetail.ts"],"sourcesContent":["import {type PackageJson} from '@jakubmazanec/zod-utils';\n\nimport {type ProgramDetail} from './ProgramDetail.js';\n\n/**\n * Creates detailed information about a {@lincode Program}.\n */\nexport function getProgramDetail(packageJson: PackageJson) {\n let programDetail: ProgramDetail = {};\n\n if (packageJson.name) {\n programDetail.name = packageJson.name;\n }\n\n if (packageJson.version) {\n programDetail.version = packageJson.version;\n }\n\n if (packageJson.description) {\n programDetail.description = packageJson.description;\n }\n\n if (packageJson.bin && typeof packageJson.bin !== 'string') {\n let bins = Object.entries(packageJson.bin);\n\n if (bins.length === 1) {\n let firstBin = bins[0] as [string, string];\n\n [programDetail.bin] = firstBin;\n }\n }\n\n if (typeof packageJson.bin === 'string' && packageJson.name) {\n programDetail.bin = packageJson.name;\n }\n\n return programDetail;\n}\n"],"names":["getProgramDetail","packageJson","programDetail","name","version","description","bin","bins","Object","entries","length","firstBin"],"mappings":"AAIA;;CAEC,GACD,OAAO,SAASA,iBAAiBC,WAAwB;IACvD,IAAIC,gBAA+B,CAAC;IAEpC,IAAID,YAAYE,MAAM;QACpBD,cAAcC,OAAOF,YAAYE;IACnC;IAEA,IAAIF,YAAYG,SAAS;QACvBF,cAAcE,UAAUH,YAAYG;IACtC;IAEA,IAAIH,YAAYI,aAAa;QAC3BH,cAAcG,cAAcJ,YAAYI;IAC1C;IAEA,IAAIJ,YAAYK,OAAO,OAAOL,YAAYK,QAAQ,UAAU;QAC1D,IAAIC,OAAOC,OAAOC,QAAQR,YAAYK;QAEtC,IAAIC,KAAKG,WAAW,GAAG;YACrB,IAAIC,WAAWJ,IAAI,CAAC,EAAE;YAEtB,CAACL,cAAcI,IAAI,GAAGK;QACxB;IACF;IAEA,IAAI,OAAOV,YAAYK,QAAQ,YAAYL,YAAYE,MAAM;QAC3DD,cAAcI,MAAML,YAAYE;IAClC;IAEA,OAAOD;AACT"}
1
+ {"version":3,"sources":["../../src/program/getProgramDetail.ts"],"sourcesContent":["import {type PackageJson} from '@jakubmazanec/zod-utils';\n\nimport {type ProgramDetail} from './ProgramDetail.js';\n\n/**\n * Creates detailed information about a {@lincode Program}.\n */\nexport function getProgramDetail(packageJson: PackageJson) {\n let programDetail: ProgramDetail = {};\n\n if (packageJson.name) {\n programDetail.name = packageJson.name;\n }\n\n if (packageJson.version) {\n programDetail.version = packageJson.version;\n }\n\n if (packageJson.description) {\n programDetail.description = packageJson.description;\n }\n\n if (packageJson.bin && typeof packageJson.bin !== 'string') {\n let bins = Object.entries(packageJson.bin);\n\n if (bins.length === 1) {\n let firstBin = bins[0] as [string, string];\n\n [programDetail.bin] = firstBin;\n }\n }\n\n if (typeof packageJson.bin === 'string' && packageJson.name) {\n programDetail.bin = packageJson.name;\n }\n\n return programDetail;\n}\n"],"names":["getProgramDetail","packageJson","programDetail","name","version","description","bin","bins","Object","entries","length","firstBin"],"mappings":"AAIA;;CAEC,GACD,OAAO,SAASA,iBAAiBC,WAAwB;IACvD,IAAIC,gBAA+B,CAAC;IAEpC,IAAID,YAAYE,IAAI,EAAE;QACpBD,cAAcC,IAAI,GAAGF,YAAYE,IAAI;IACvC;IAEA,IAAIF,YAAYG,OAAO,EAAE;QACvBF,cAAcE,OAAO,GAAGH,YAAYG,OAAO;IAC7C;IAEA,IAAIH,YAAYI,WAAW,EAAE;QAC3BH,cAAcG,WAAW,GAAGJ,YAAYI,WAAW;IACrD;IAEA,IAAIJ,YAAYK,GAAG,IAAI,OAAOL,YAAYK,GAAG,KAAK,UAAU;QAC1D,IAAIC,OAAOC,OAAOC,OAAO,CAACR,YAAYK,GAAG;QAEzC,IAAIC,KAAKG,MAAM,KAAK,GAAG;YACrB,IAAIC,WAAWJ,IAAI,CAAC,EAAE;YAEtB,CAACL,cAAcI,GAAG,CAAC,GAAGK;QACxB;IACF;IAEA,IAAI,OAAOV,YAAYK,GAAG,KAAK,YAAYL,YAAYE,IAAI,EAAE;QAC3DD,cAAcI,GAAG,GAAGL,YAAYE,IAAI;IACtC;IAEA,OAAOD;AACT"}
@@ -1,10 +1,10 @@
1
1
  import { type BoxProps } from 'ink';
2
2
  import { type ErrorDetail } from './ErrorDetail.js';
3
3
  /**
4
- * {@linkcode Failure} component props.
4
+ * {@link Failure} component props.
5
5
  */
6
6
  export type FailureProps = BoxProps & {
7
- /** Error that describes a failure state. Function {@linkcode getErrorDetail} is used for getting all the information from the error; you can use it to implement own retrieval logic and pass the result as `errorDetail` prop. */
7
+ /** Error that describes a failure state. Function {@link getErrorDetail} is used for getting all the information from the error; you can use it to implement own retrieval logic and pass the result as `errorDetail` prop. */
8
8
  error: Error;
9
9
  /** Information about the failure state. Overrides information retireved from `error` prop. */
10
10
  errorDetail?: ErrorDetail;
@@ -6,8 +6,8 @@ import { Header } from './Header.js';
6
6
  import * as icons from './icons.js';
7
7
  /**
8
8
  * A component that renders a failure state.
9
- */ export function Failure({ error , errorDetail , ...boxProps }) {
10
- let { label , description , stack , cause } = errorDetail ?? getErrorDetail(error);
9
+ */ export function Failure({ error, errorDetail, ...boxProps }) {
10
+ let { label, description, stack, cause } = errorDetail ?? getErrorDetail(error);
11
11
  return /*#__PURE__*/ _jsxs(Box, {
12
12
  ...boxProps,
13
13
  flexDirection: "column",
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/ui/Failure.tsx"],"sourcesContent":["import {Box, Text, type BoxProps} from 'ink';\n\nimport * as colors from './colors.js';\nimport {type ErrorDetail} from './ErrorDetail.js';\nimport {getErrorDetail} from './getErrorDetail.js';\nimport {Header} from './Header.js';\nimport * as icons from './icons.js';\n\n/**\n * {@linkcode Failure} component props.\n */\nexport type FailureProps = BoxProps & {\n /** Error that describes a failure state. Function {@linkcode getErrorDetail} is used for getting all the information from the error; you can use it to implement own retrieval logic and pass the result as `errorDetail` prop. */\n error: Error;\n\n /** Information about the failure state. Overrides information retireved from `error` prop. */\n errorDetail?: ErrorDetail;\n};\n\n/**\n * A component that renders a failure state.\n */\nexport function Failure({error, errorDetail, ...boxProps}: FailureProps) {\n let {label, description, stack, cause} = errorDetail ?? getErrorDetail(error);\n\n return (\n <Box {...boxProps} flexDirection=\"column\">\n <Header icon={icons.error}>\n <Text color={colors.highlighted}>{label}</Text>\n </Header>\n\n {description ? (\n <Box flexDirection=\"column\" marginLeft={2}>\n <Text color={colors.failure}>{description}</Text>\n </Box>\n ) : null}\n\n {stack ? (\n <Box flexDirection=\"column\" marginTop={1} marginLeft={2}>\n <Text color={colors.muted}>{stack}</Text>\n </Box>\n ) : null}\n\n {cause ? (\n <>\n <Box flexDirection=\"column\" marginTop={1} marginLeft={2}>\n <Text color={colors.muted}>{cause.description}</Text>\n </Box>\n\n {cause.stack ? (\n <Box flexDirection=\"column\" marginTop={1} marginLeft={2}>\n <Text color={colors.muted}>{cause.stack}</Text>\n </Box>\n ) : null}\n </>\n ) : null}\n </Box>\n );\n}\n"],"names":["Box","Text","colors","getErrorDetail","Header","icons","Failure","error","errorDetail","boxProps","label","description","stack","cause","flexDirection","icon","color","highlighted","marginLeft","failure","marginTop","muted"],"mappings":";AAAA,SAAQA,GAAG,EAAEC,IAAI,QAAsB,MAAM;AAE7C,YAAYC,YAAY,cAAc;AAEtC,SAAQC,cAAc,QAAO,sBAAsB;AACnD,SAAQC,MAAM,QAAO,cAAc;AACnC,YAAYC,WAAW,aAAa;AAapC;;CAEC,GACD,OAAO,SAASC,QAAQ,EAACC,MAAK,EAAEC,YAAW,EAAE,GAAGC,UAAuB;IACrE,IAAI,EAACC,MAAK,EAAEC,YAAW,EAAEC,MAAK,EAAEC,MAAK,EAAC,GAAGL,eAAeL,eAAeI;IAEvE,qBACE,MAACP;QAAK,GAAGS,QAAQ;QAAEK,eAAc;;0BAC/B,KAACV;gBAAOW,MAAMV,MAAME;0BAClB,cAAA,KAACN;oBAAKe,OAAOd,OAAOe;8BAAcP;;;YAGnCC,4BACC,KAACX;gBAAIc,eAAc;gBAASI,YAAY;0BACtC,cAAA,KAACjB;oBAAKe,OAAOd,OAAOiB;8BAAUR;;iBAE9B;YAEHC,sBACC,KAACZ;gBAAIc,eAAc;gBAASM,WAAW;gBAAGF,YAAY;0BACpD,cAAA,KAACjB;oBAAKe,OAAOd,OAAOmB;8BAAQT;;iBAE5B;YAEHC,sBACC;;kCACE,KAACb;wBAAIc,eAAc;wBAASM,WAAW;wBAAGF,YAAY;kCACpD,cAAA,KAACjB;4BAAKe,OAAOd,OAAOmB;sCAAQR,MAAMF;;;oBAGnCE,MAAMD,sBACL,KAACZ;wBAAIc,eAAc;wBAASM,WAAW;wBAAGF,YAAY;kCACpD,cAAA,KAACjB;4BAAKe,OAAOd,OAAOmB;sCAAQR,MAAMD;;yBAElC;;iBAEJ;;;AAGV"}
1
+ {"version":3,"sources":["../../src/ui/Failure.tsx"],"sourcesContent":["import {Box, Text, type BoxProps} from 'ink';\n\nimport * as colors from './colors.js';\nimport {type ErrorDetail} from './ErrorDetail.js';\nimport {getErrorDetail} from './getErrorDetail.js';\nimport {Header} from './Header.js';\nimport * as icons from './icons.js';\n\n/**\n * {@link Failure} component props.\n */\nexport type FailureProps = BoxProps & {\n /** Error that describes a failure state. Function {@link getErrorDetail} is used for getting all the information from the error; you can use it to implement own retrieval logic and pass the result as `errorDetail` prop. */\n error: Error;\n\n /** Information about the failure state. Overrides information retireved from `error` prop. */\n errorDetail?: ErrorDetail;\n};\n\n/**\n * A component that renders a failure state.\n */\nexport function Failure({error, errorDetail, ...boxProps}: FailureProps) {\n let {label, description, stack, cause} = errorDetail ?? getErrorDetail(error);\n\n return (\n <Box {...boxProps} flexDirection=\"column\">\n <Header icon={icons.error}>\n <Text color={colors.highlighted}>{label}</Text>\n </Header>\n\n {description ? (\n <Box flexDirection=\"column\" marginLeft={2}>\n <Text color={colors.failure}>{description}</Text>\n </Box>\n ) : null}\n\n {stack ? (\n <Box flexDirection=\"column\" marginTop={1} marginLeft={2}>\n <Text color={colors.muted}>{stack}</Text>\n </Box>\n ) : null}\n\n {cause ? (\n <>\n <Box flexDirection=\"column\" marginTop={1} marginLeft={2}>\n <Text color={colors.muted}>{cause.description}</Text>\n </Box>\n\n {cause.stack ? (\n <Box flexDirection=\"column\" marginTop={1} marginLeft={2}>\n <Text color={colors.muted}>{cause.stack}</Text>\n </Box>\n ) : null}\n </>\n ) : null}\n </Box>\n );\n}\n"],"names":["Box","Text","colors","getErrorDetail","Header","icons","Failure","error","errorDetail","boxProps","label","description","stack","cause","flexDirection","icon","color","highlighted","marginLeft","failure","marginTop","muted"],"mappings":";AAAA,SAAQA,GAAG,EAAEC,IAAI,QAAsB,MAAM;AAE7C,YAAYC,YAAY,cAAc;AAEtC,SAAQC,cAAc,QAAO,sBAAsB;AACnD,SAAQC,MAAM,QAAO,cAAc;AACnC,YAAYC,WAAW,aAAa;AAapC;;CAEC,GACD,OAAO,SAASC,QAAQ,EAACC,KAAK,EAAEC,WAAW,EAAE,GAAGC,UAAuB;IACrE,IAAI,EAACC,KAAK,EAAEC,WAAW,EAAEC,KAAK,EAAEC,KAAK,EAAC,GAAGL,eAAeL,eAAeI;IAEvE,qBACE,MAACP;QAAK,GAAGS,QAAQ;QAAEK,eAAc;;0BAC/B,KAACV;gBAAOW,MAAMV,MAAME,KAAK;0BACvB,cAAA,KAACN;oBAAKe,OAAOd,OAAOe,WAAW;8BAAGP;;;YAGnCC,4BACC,KAACX;gBAAIc,eAAc;gBAASI,YAAY;0BACtC,cAAA,KAACjB;oBAAKe,OAAOd,OAAOiB,OAAO;8BAAGR;;iBAE9B;YAEHC,sBACC,KAACZ;gBAAIc,eAAc;gBAASM,WAAW;gBAAGF,YAAY;0BACpD,cAAA,KAACjB;oBAAKe,OAAOd,OAAOmB,KAAK;8BAAGT;;iBAE5B;YAEHC,sBACC;;kCACE,KAACb;wBAAIc,eAAc;wBAASM,WAAW;wBAAGF,YAAY;kCACpD,cAAA,KAACjB;4BAAKe,OAAOd,OAAOmB,KAAK;sCAAGR,MAAMF,WAAW;;;oBAG9CE,MAAMD,KAAK,iBACV,KAACZ;wBAAIc,eAAc;wBAASM,WAAW;wBAAGF,YAAY;kCACpD,cAAA,KAACjB;4BAAKe,OAAOd,OAAOmB,KAAK;sCAAGR,MAAMD,KAAK;;yBAEvC;;iBAEJ;;;AAGV"}
@@ -1,7 +1,7 @@
1
1
  import { type BoxProps } from 'ink';
2
2
  import { type PropsWithChildren } from 'react';
3
3
  /**
4
- * {@linkcode Header} component props.
4
+ * {@link Header} component props.
5
5
  */
6
6
  export type HeaderProps = BoxProps & {
7
7
  /** Icon (recommended is 1 character) to render before the header itself. */
package/dist/ui/Header.js CHANGED
@@ -3,7 +3,7 @@ import { Box, Text } from 'ink';
3
3
  import { Spinner } from './Spinner.js';
4
4
  /**
5
5
  * Header component.
6
- */ export function Header({ children , icon , showSpinner =false , ...boxProps }) {
6
+ */ export function Header({ children, icon, showSpinner = false, ...boxProps }) {
7
7
  return /*#__PURE__*/ _jsxs(Box, {
8
8
  ...boxProps,
9
9
  children: [
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/ui/Header.tsx"],"sourcesContent":["import {Box, type BoxProps, Text} from 'ink';\nimport {type PropsWithChildren} from 'react';\n\nimport {Spinner} from './Spinner.js';\n\n/**\n * {@linkcode Header} component props.\n */\nexport type HeaderProps = BoxProps & {\n /** Icon (recommended is 1 character) to render before the header itself. */\n icon?: string;\n\n /** Show spinner instead of the icon. */\n showSpinner?: boolean;\n};\n\n/**\n * Header component.\n */\nexport function Header({\n children,\n icon,\n showSpinner = false,\n ...boxProps\n}: PropsWithChildren<HeaderProps>) {\n return (\n <Box {...boxProps}>\n {icon || showSpinner ? (\n <Box marginRight={1}>\n {showSpinner ? <Spinner /> : null}\n {!showSpinner && icon ? <Text>{icon}</Text> : null}\n </Box>\n ) : null}\n <Box>{children}</Box>\n </Box>\n );\n}\n"],"names":["Box","Text","Spinner","Header","children","icon","showSpinner","boxProps","marginRight"],"mappings":";AAAA,SAAQA,GAAG,EAAiBC,IAAI,QAAO,MAAM;AAG7C,SAAQC,OAAO,QAAO,eAAe;AAarC;;CAEC,GACD,OAAO,SAASC,OAAO,EACrBC,SAAQ,EACRC,KAAI,EACJC,aAAc,MAAK,EACnB,GAAGC,UAC4B;IAC/B,qBACE,MAACP;QAAK,GAAGO,QAAQ;;YACdF,QAAQC,4BACP,MAACN;gBAAIQ,aAAa;;oBACfF,4BAAc,KAACJ,eAAa;oBAC5B,CAACI,eAAeD,qBAAO,KAACJ;kCAAMI;yBAAe;;iBAE9C;0BACJ,KAACL;0BAAKI;;;;AAGZ"}
1
+ {"version":3,"sources":["../../src/ui/Header.tsx"],"sourcesContent":["import {Box, type BoxProps, Text} from 'ink';\nimport {type PropsWithChildren} from 'react';\n\nimport {Spinner} from './Spinner.js';\n\n/**\n * {@link Header} component props.\n */\nexport type HeaderProps = BoxProps & {\n /** Icon (recommended is 1 character) to render before the header itself. */\n icon?: string;\n\n /** Show spinner instead of the icon. */\n showSpinner?: boolean;\n};\n\n/**\n * Header component.\n */\nexport function Header({\n children,\n icon,\n showSpinner = false,\n ...boxProps\n}: PropsWithChildren<HeaderProps>) {\n return (\n <Box {...boxProps}>\n {icon || showSpinner ? (\n <Box marginRight={1}>\n {showSpinner ? <Spinner /> : null}\n {!showSpinner && icon ? <Text>{icon}</Text> : null}\n </Box>\n ) : null}\n <Box>{children}</Box>\n </Box>\n );\n}\n"],"names":["Box","Text","Spinner","Header","children","icon","showSpinner","boxProps","marginRight"],"mappings":";AAAA,SAAQA,GAAG,EAAiBC,IAAI,QAAO,MAAM;AAG7C,SAAQC,OAAO,QAAO,eAAe;AAarC;;CAEC,GACD,OAAO,SAASC,OAAO,EACrBC,QAAQ,EACRC,IAAI,EACJC,cAAc,KAAK,EACnB,GAAGC,UAC4B;IAC/B,qBACE,MAACP;QAAK,GAAGO,QAAQ;;YACdF,QAAQC,4BACP,MAACN;gBAAIQ,aAAa;;oBACfF,4BAAc,KAACJ,eAAa;oBAC5B,CAACI,eAAeD,qBAAO,KAACJ;kCAAMI;yBAAe;;iBAE9C;0BACJ,KAACL;0BAAKI;;;;AAGZ"}
package/dist/ui/Help.d.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  import { type BoxProps } from 'ink';
2
2
  import { type Program } from '../program.js';
3
3
  /**
4
- * {@linkcode Help} component props.
4
+ * {@link Help} component props.
5
5
  */
6
6
  export type HelpProps = BoxProps & {
7
- /** {@linkcode Program} instance. */
7
+ /** {@link Program} instance. */
8
8
  program: Program;
9
9
  };
10
10
  /**
package/dist/ui/Help.js CHANGED
@@ -6,7 +6,7 @@ import { Header } from './Header.js';
6
6
  import * as icons from './icons.js';
7
7
  /**
8
8
  * A component that renders help information.
9
- */ export function Help({ program , ...boxProps }) {
9
+ */ export function Help({ program, ...boxProps }) {
10
10
  return /*#__PURE__*/ _jsxs(Box, {
11
11
  ...boxProps,
12
12
  flexDirection: "column",
@@ -1 +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 * {@linkcode Help} component props.\n */\nexport type HelpProps = BoxProps & {\n /** {@linkcode 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,QAAO,EAAE,GAAGC,UAAoB;IACpD,qBACE,MAACP;QAAK,GAAGO,QAAQ;QAAEC,eAAc;;0BAC/B,KAACP;0BAAM,CAAC,EAAEF,KAAK,CAACG,OAAOO,OAAO,CAACH,QAAQI,QAAQ,KAAK,CAAC,EAAEX,KAAK,CAACG,OAAOS,MAAM,CACxEL,QAAQM,WAAW,KACnB,CAAC;;0BACH,KAACX;gBAAKY,OAAOX,OAAOY;0BAAOR,QAAQS;;YAElCT,QAAQU,SAASC,uBAChB;;kCACE,KAACd;wBAAOe,MAAMd,MAAMe;wBAAMC,WAAW;kCACnC,cAAA,KAACnB;4BAAKY,OAAOX,OAAOmB;sCAAa;;;oBAElCf,QAAQU,SAASM,IAAI,CAACC;wBACrB,IAAIC,OAAO,CAAC,EAAEzB,KAAK,CAACG,OAAOS,MAAM,CAACL,QAAQmB,OAAO,KAAK,CAAC,EAAEF,QAAQb,KAAK,CAAC;wBAEvE,IAAIa,QAAQG,YAAY;4BACtB,IAAIH,QAAQG,WAAWC,KAAK,CAACC,kBAAoB,CAAC,CAACA,gBAAgBC,WAAW;gCAC5EL,QAAQ,CAAC,CAAC,EAAEzB,KAAK,CAACG,OAAOS,MAAM,CAAC,gBAAgB,CAAC;4BACnD,OAAO;gCACLa,QAAQ,CAAC,CAAC,EAAEzB,KAAK,CAACG,OAAOS,MAAM,CAAC,kBAAkB,CAAC;4BACrD;wBACF;wBAEA,IAAIY,QAAQO,SAAS;4BACnB,IACEC,OAAOC,QAAQT,QAAQO,SAASH,KAAK,CAAC,GAAGM,aAAa,GAAK,CAAC,CAACA,aAAaJ,WAC1E;gCACAL,QAAQ,CAAC,CAAC,EAAEzB,KAAK,CAACG,OAAOS,MAAM,CAAC,aAAa,CAAC;4BAChD,OAAO;gCACLa,QAAQ,CAAC,CAAC,EAAEzB,KAAK,CAACG,OAAOS,MAAM,CAAC,eAAe,CAAC;4BAClD;wBACF;wBAEA,IAAIY,QAAQR,aAAa;4BACvBS,QAAQ,CAAC,CAAC,EAAED,QAAQR,YAAY,CAAC;wBACnC;wBAEA,qBACE,KAACf;4BAAuBkC,YAAY;4BAAG1B,eAAc;sCACnD,cAAA,KAACP;0CAAMuB;;2BADCD,QAAQb;oBAItB;;iBAEA;;;AAGV"}
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"}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/ui/Spinner.tsx"],"sourcesContent":["import {Text} from 'ink';\nimport {useState, useEffect} from 'react';\n\nconst SPINNER = {\n interval: 80,\n frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'],\n};\n\n/**\n * Spinner component.\n */\nexport function Spinner() {\n let [frame, setFrame] = useState(0);\n\n useEffect(() => {\n let timer = setInterval(() => {\n setFrame((previousFrame) => {\n let isLastFrame = previousFrame === SPINNER.frames.length - 1;\n\n return isLastFrame ? 0 : previousFrame + 1;\n });\n }, SPINNER.interval);\n\n return () => {\n clearInterval(timer);\n };\n }, []);\n\n return <Text>{SPINNER.frames[frame]}</Text>;\n}\n"],"names":["Text","useState","useEffect","SPINNER","interval","frames","Spinner","frame","setFrame","timer","setInterval","previousFrame","isLastFrame","length","clearInterval"],"mappings":";AAAA,SAAQA,IAAI,QAAO,MAAM;AACzB,SAAQC,QAAQ,EAAEC,SAAS,QAAO,QAAQ;AAE1C,MAAMC,UAAU;IACdC,UAAU;IACVC,QAAQ;QAAC;QAAK;QAAK;QAAK;QAAK;QAAK;QAAK;QAAK;QAAK;QAAK;KAAI;AAC5D;AAEA;;CAEC,GACD,OAAO,SAASC;IACd,IAAI,CAACC,OAAOC,SAAS,GAAGP,SAAS;IAEjCC,UAAU;QACR,IAAIO,QAAQC,YAAY;YACtBF,SAAS,CAACG;gBACR,IAAIC,cAAcD,kBAAkBR,QAAQE,OAAOQ,SAAS;gBAE5D,OAAOD,cAAc,IAAID,gBAAgB;YAC3C;QACF,GAAGR,QAAQC;QAEX,OAAO;YACLU,cAAcL;QAChB;IACF,GAAG,EAAE;IAEL,qBAAO,KAACT;kBAAMG,QAAQE,MAAM,CAACE,MAAM;;AACrC"}
1
+ {"version":3,"sources":["../../src/ui/Spinner.tsx"],"sourcesContent":["import {Text} from 'ink';\nimport {useState, useEffect} from 'react';\n\nconst SPINNER = {\n interval: 80,\n frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'],\n};\n\n/**\n * Spinner component.\n */\nexport function Spinner() {\n let [frame, setFrame] = useState(0);\n\n useEffect(() => {\n let timer = setInterval(() => {\n setFrame((previousFrame) => {\n let isLastFrame = previousFrame === SPINNER.frames.length - 1;\n\n return isLastFrame ? 0 : previousFrame + 1;\n });\n }, SPINNER.interval);\n\n return () => {\n clearInterval(timer);\n };\n }, []);\n\n return <Text>{SPINNER.frames[frame]}</Text>;\n}\n"],"names":["Text","useState","useEffect","SPINNER","interval","frames","Spinner","frame","setFrame","timer","setInterval","previousFrame","isLastFrame","length","clearInterval"],"mappings":";AAAA,SAAQA,IAAI,QAAO,MAAM;AACzB,SAAQC,QAAQ,EAAEC,SAAS,QAAO,QAAQ;AAE1C,MAAMC,UAAU;IACdC,UAAU;IACVC,QAAQ;QAAC;QAAK;QAAK;QAAK;QAAK;QAAK;QAAK;QAAK;QAAK;QAAK;KAAI;AAC5D;AAEA;;CAEC,GACD,OAAO,SAASC;IACd,IAAI,CAACC,OAAOC,SAAS,GAAGP,SAAS;IAEjCC,UAAU;QACR,IAAIO,QAAQC,YAAY;YACtBF,SAAS,CAACG;gBACR,IAAIC,cAAcD,kBAAkBR,QAAQE,MAAM,CAACQ,MAAM,GAAG;gBAE5D,OAAOD,cAAc,IAAID,gBAAgB;YAC3C;QACF,GAAGR,QAAQC,QAAQ;QAEnB,OAAO;YACLU,cAAcL;QAChB;IACF,GAAG,EAAE;IAEL,qBAAO,KAACT;kBAAMG,QAAQE,MAAM,CAACE,MAAM;;AACrC"}
@@ -4,7 +4,7 @@ import { SelectInput } from './SelectInput.js';
4
4
  import { TextInput } from './TextInput.js';
5
5
  /**
6
6
  * Form row component.
7
- */ export function FormRow({ rowName , config , rows , value , focus , isComplete , onChange , onComplete , ...boxProps }) {
7
+ */ export function FormRow({ rowName, config, rows, value, focus, isComplete, onChange, onComplete, ...boxProps }) {
8
8
  // TODO: Each input component handles values and events differently; the APIs should be adjusted.
9
9
  let handleChange = useCallback((newValue)=>{
10
10
  onChange(newValue, rowName);
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/ui/form/FormRow.tsx"],"sourcesContent":["import {type BoxProps} from 'ink';\nimport {useCallback} from 'react';\n\nimport {type FormConfig} from './FormConfig.js';\nimport {type FormProps} from './FormProps.js';\nimport {type FormRowConfig} from './FormRowConfig.js';\nimport {SelectInput} from './SelectInput.js';\nimport {TextInput} from './TextInput.js';\n\n/**\n * Form row component props.\n */\ntype FormRowProps<C extends FormConfig> = BoxProps & {\n /** Form row configuration. */\n config: FormRowConfig;\n\n // TODO: Should all rows props be passed to each row?\n /** Props of all form rows. */\n rows: FormProps<C>['rows'] | null;\n\n /** Row name. */\n rowName: keyof C['rows'];\n\n /** Value. */\n value: unknown;\n\n /** Should component listen to Listen to user's input? Useful in case there are multiple input components at the same time and input must be \"routed\" to a specific component. */\n focus: boolean;\n\n /** Handler function that is called when value changes. */\n onChange: (value: unknown, inputName: keyof C['rows']) => void;\n\n /** Handler function that is called when the value is accepted. */\n onComplete: (value: unknown, inputName: keyof C['rows']) => void;\n\n /** Indicates whether value has been accepted. Component in the row then doesn't accept more input. */\n isComplete: boolean;\n};\n\n/**\n * Form row component.\n */\nexport function FormRow<C extends FormConfig>({\n rowName,\n config,\n rows,\n value,\n focus,\n isComplete,\n onChange,\n onComplete,\n ...boxProps\n}: FormRowProps<C>) {\n // TODO: Each input component handles values and events differently; the APIs should be adjusted.\n let handleChange = useCallback(\n (newValue: unknown) => {\n onChange(newValue, rowName);\n },\n [rowName, onChange],\n );\n\n let handleFinish = useCallback(\n (newValue: unknown) => {\n onComplete(newValue, rowName);\n },\n [rowName, onComplete],\n );\n\n let handleSelectFinish = useCallback(\n (item: {value: unknown}) => {\n onComplete(item.value, rowName);\n },\n [rowName, onComplete],\n );\n\n switch (config.type) {\n case 'text': {\n return (\n <TextInput\n key={String(rowName)}\n label={config.label ?? ''}\n validate={config.validate}\n value={value as string}\n focus={focus}\n isComplete={isComplete}\n onChange={handleChange}\n onSubmit={handleFinish}\n {...boxProps}\n />\n );\n }\n case 'select': {\n return (\n <SelectInput\n key={String(rowName)}\n label={config.label ?? ''}\n items={\n rows\n ? (\n (\n rows as {\n [key: string]: unknown;\n }\n )[rowName as string] as {choices: Array<{value: string; label: string}>}\n ).choices\n : []\n }\n focus={focus}\n isComplete={isComplete}\n onSelect={handleSelectFinish}\n {...boxProps}\n />\n );\n }\n default: {\n return null;\n }\n }\n}\n"],"names":["useCallback","SelectInput","TextInput","FormRow","rowName","config","rows","value","focus","isComplete","onChange","onComplete","boxProps","handleChange","newValue","handleFinish","handleSelectFinish","item","type","label","validate","onSubmit","String","items","choices","onSelect"],"mappings":";AACA,SAAQA,WAAW,QAAO,QAAQ;AAKlC,SAAQC,WAAW,QAAO,mBAAmB;AAC7C,SAAQC,SAAS,QAAO,iBAAiB;AAgCzC;;CAEC,GACD,OAAO,SAASC,QAA8B,EAC5CC,QAAO,EACPC,OAAM,EACNC,KAAI,EACJC,MAAK,EACLC,MAAK,EACLC,WAAU,EACVC,SAAQ,EACRC,WAAU,EACV,GAAGC,UACa;IAChB,iGAAiG;IACjG,IAAIC,eAAeb,YACjB,CAACc;QACCJ,SAASI,UAAUV;IACrB,GACA;QAACA;QAASM;KAAS;IAGrB,IAAIK,eAAef,YACjB,CAACc;QACCH,WAAWG,UAAUV;IACvB,GACA;QAACA;QAASO;KAAW;IAGvB,IAAIK,qBAAqBhB,YACvB,CAACiB;QACCN,WAAWM,KAAKV,OAAOH;IACzB,GACA;QAACA;QAASO;KAAW;IAGvB,OAAQN,OAAOa;QACb,KAAK;YAAQ;gBACX,qBACE,KAAChB;oBAECiB,OAAOd,OAAOc,SAAS;oBACvBC,UAAUf,OAAOe;oBACjBb,OAAOA;oBACPC,OAAOA;oBACPC,YAAYA;oBACZC,UAAUG;oBACVQ,UAAUN;oBACT,GAAGH,QAAQ;mBARPU,OAAOlB;YAWlB;QACA,KAAK;YAAU;gBACb,qBACE,KAACH;oBAECkB,OAAOd,OAAOc,SAAS;oBACvBI,OACEjB,OACI,AACE,AACEA,IAGD,CAACF,QAAkB,CACpBoB,UACF,EAAE;oBAERhB,OAAOA;oBACPC,YAAYA;oBACZgB,UAAUT;oBACT,GAAGJ,QAAQ;mBAhBPU,OAAOlB;YAmBlB;QACA;YAAS;gBACP,OAAO;YACT;IACF;AACF"}
1
+ {"version":3,"sources":["../../../src/ui/form/FormRow.tsx"],"sourcesContent":["import {type BoxProps} from 'ink';\nimport {useCallback} from 'react';\n\nimport {type FormConfig} from './FormConfig.js';\nimport {type FormProps} from './FormProps.js';\nimport {type FormRowConfig} from './FormRowConfig.js';\nimport {SelectInput} from './SelectInput.js';\nimport {TextInput} from './TextInput.js';\n\n/**\n * Form row component props.\n */\ntype FormRowProps<C extends FormConfig> = BoxProps & {\n /** Form row configuration. */\n config: FormRowConfig;\n\n // TODO: Should all rows props be passed to each row?\n /** Props of all form rows. */\n rows: FormProps<C>['rows'] | null;\n\n /** Row name. */\n rowName: keyof C['rows'];\n\n /** Value. */\n value: unknown;\n\n /** Should component listen to Listen to user's input? Useful in case there are multiple input components at the same time and input must be \"routed\" to a specific component. */\n focus: boolean;\n\n /** Handler function that is called when value changes. */\n onChange: (value: unknown, inputName: keyof C['rows']) => void;\n\n /** Handler function that is called when the value is accepted. */\n onComplete: (value: unknown, inputName: keyof C['rows']) => void;\n\n /** Indicates whether value has been accepted. Component in the row then doesn't accept more input. */\n isComplete: boolean;\n};\n\n/**\n * Form row component.\n */\nexport function FormRow<C extends FormConfig>({\n rowName,\n config,\n rows,\n value,\n focus,\n isComplete,\n onChange,\n onComplete,\n ...boxProps\n}: FormRowProps<C>) {\n // TODO: Each input component handles values and events differently; the APIs should be adjusted.\n let handleChange = useCallback(\n (newValue: unknown) => {\n onChange(newValue, rowName);\n },\n [rowName, onChange],\n );\n\n let handleFinish = useCallback(\n (newValue: unknown) => {\n onComplete(newValue, rowName);\n },\n [rowName, onComplete],\n );\n\n let handleSelectFinish = useCallback(\n (item: {value: unknown}) => {\n onComplete(item.value, rowName);\n },\n [rowName, onComplete],\n );\n\n switch (config.type) {\n case 'text': {\n return (\n <TextInput\n key={String(rowName)}\n label={config.label ?? ''}\n validate={config.validate}\n value={value as string}\n focus={focus}\n isComplete={isComplete}\n onChange={handleChange}\n onSubmit={handleFinish}\n {...boxProps}\n />\n );\n }\n case 'select': {\n return (\n <SelectInput\n key={String(rowName)}\n label={config.label ?? ''}\n items={\n rows\n ? (\n (\n rows as {\n [key: string]: unknown;\n }\n )[rowName as string] as {choices: Array<{value: string; label: string}>}\n ).choices\n : []\n }\n focus={focus}\n isComplete={isComplete}\n onSelect={handleSelectFinish}\n {...boxProps}\n />\n );\n }\n default: {\n return null;\n }\n }\n}\n"],"names":["useCallback","SelectInput","TextInput","FormRow","rowName","config","rows","value","focus","isComplete","onChange","onComplete","boxProps","handleChange","newValue","handleFinish","handleSelectFinish","item","type","label","validate","onSubmit","String","items","choices","onSelect"],"mappings":";AACA,SAAQA,WAAW,QAAO,QAAQ;AAKlC,SAAQC,WAAW,QAAO,mBAAmB;AAC7C,SAAQC,SAAS,QAAO,iBAAiB;AAgCzC;;CAEC,GACD,OAAO,SAASC,QAA8B,EAC5CC,OAAO,EACPC,MAAM,EACNC,IAAI,EACJC,KAAK,EACLC,KAAK,EACLC,UAAU,EACVC,QAAQ,EACRC,UAAU,EACV,GAAGC,UACa;IAChB,iGAAiG;IACjG,IAAIC,eAAeb,YACjB,CAACc;QACCJ,SAASI,UAAUV;IACrB,GACA;QAACA;QAASM;KAAS;IAGrB,IAAIK,eAAef,YACjB,CAACc;QACCH,WAAWG,UAAUV;IACvB,GACA;QAACA;QAASO;KAAW;IAGvB,IAAIK,qBAAqBhB,YACvB,CAACiB;QACCN,WAAWM,KAAKV,KAAK,EAAEH;IACzB,GACA;QAACA;QAASO;KAAW;IAGvB,OAAQN,OAAOa,IAAI;QACjB,KAAK;YAAQ;gBACX,qBACE,KAAChB;oBAECiB,OAAOd,OAAOc,KAAK,IAAI;oBACvBC,UAAUf,OAAOe,QAAQ;oBACzBb,OAAOA;oBACPC,OAAOA;oBACPC,YAAYA;oBACZC,UAAUG;oBACVQ,UAAUN;oBACT,GAAGH,QAAQ;mBARPU,OAAOlB;YAWlB;QACA,KAAK;YAAU;gBACb,qBACE,KAACH;oBAECkB,OAAOd,OAAOc,KAAK,IAAI;oBACvBI,OACEjB,OACI,AACE,AACEA,IAGD,CAACF,QAAkB,CACpBoB,OAAO,GACT,EAAE;oBAERhB,OAAOA;oBACPC,YAAYA;oBACZgB,UAAUT;oBACT,GAAGJ,QAAQ;mBAhBPU,OAAOlB;YAmBlB;QACA;YAAS;gBACP,OAAO;YACT;IACF;AACF"}
@@ -2,14 +2,14 @@
2
2
  import { type BoxProps } from 'ink';
3
3
  import { type SelectInputItem } from './SelectInputItem.js';
4
4
  /**
5
- * Select input component props.
5
+ * {@linkcode SelectInput} component props.
6
6
  */
7
7
  type SelectInputProps = BoxProps & {
8
8
  /** Text to display as a label. */
9
9
  label: string;
10
10
  /** Items to display in a list. */
11
11
  items: SelectInputItem[];
12
- /** Should component listen to Listen to user's input? Useful in case there are multiple input components at the same time and input must be "routed" to a specific component. */
12
+ /** Should component listen to user's input? Useful in case there are multiple input components at the same time and input must be handled only by a specific component. */
13
13
  focus?: boolean | undefined;
14
14
  /** Index of initially selected item. */
15
15
  initialIndex?: number | undefined;
@@ -25,5 +25,5 @@ type SelectInputProps = BoxProps & {
25
25
  /**
26
26
  * Select input component.
27
27
  */
28
- export declare function SelectInput({ label, items, focus, initialIndex, limit: customLimit, onSelect, onHighlight, marginTop, isComplete, ...boxProps }: SelectInputProps): JSX.Element;
28
+ export declare function SelectInput({ label, items, focus, initialIndex, limit: userDefinedLimit, onSelect, onHighlight, isComplete, ...boxProps }: SelectInputProps): JSX.Element;
29
29
  export {};