@jakubmazanec/cli 0.1.0-c5ebb6f → 0.1.0-dee6883
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.
- package/dist/program/Command.d.ts +2 -2
- package/dist/program/Command.js +3 -3
- package/dist/program/Command.js.map +1 -1
- package/dist/program/CommandOptions.d.ts +1 -1
- package/dist/program/CommandOptions.js.map +1 -1
- package/dist/program/Program.d.ts +8 -3
- package/dist/program/Program.js +19 -8
- package/dist/program/Program.js.map +1 -1
- package/dist/program/ProgramOptions.d.ts +5 -1
- package/dist/program/ProgramOptions.js +1 -3
- package/dist/program/ProgramOptions.js.map +1 -1
- package/dist/program/ProgramStreams.d.ts +1 -1
- package/dist/program/ProgramStreams.js +1 -1
- package/dist/program/ProgramStreams.js.map +1 -1
- package/dist/ui/Failure.d.ts +2 -2
- package/dist/ui/Failure.js.map +1 -1
- package/dist/ui/Header.d.ts +1 -1
- package/dist/ui/Header.js.map +1 -1
- package/dist/ui/Help.d.ts +2 -2
- package/dist/ui/Help.js.map +1 -1
- package/dist/ui/form/SelectInput.d.ts +3 -3
- package/dist/ui/form/SelectInput.js +20 -29
- package/dist/ui/form/SelectInput.js.map +1 -1
- package/dist/ui/form/TextInput.d.ts +1 -1
- package/dist/ui/form/TextInput.js +4 -7
- package/dist/ui/form/TextInput.js.map +1 -1
- package/dist/ui/getErrorDetail.js +9 -0
- package/dist/ui/getErrorDetail.js.map +1 -1
- package/dist/ui/internals/Wrapper.d.ts +2 -2
- package/dist/ui/internals/Wrapper.js +1 -1
- package/dist/ui/internals/Wrapper.js.map +1 -1
- package/dist/ui/internals/programContext.d.ts +1 -1
- package/dist/ui/internals/programContext.js +1 -1
- package/dist/ui/internals/programContext.js.map +1 -1
- package/dist/ui/useProgram.d.ts +1 -1
- package/dist/ui/useProgram.js +1 -1
- package/dist/ui/useProgram.js.map +1 -1
- package/package.json +8 -7
- package/src/program/Command.ts +2 -3
- package/src/program/CommandOptions.ts +1 -1
- package/src/program/Program.ts +30 -5
- package/src/program/ProgramOptions.ts +7 -1
- package/src/program/ProgramStreams.ts +1 -1
- package/src/ui/Failure.tsx +2 -2
- package/src/ui/Header.tsx +1 -1
- package/src/ui/Help.tsx +2 -2
- package/src/ui/form/SelectInput.tsx +23 -28
- package/src/ui/form/TextInput.tsx +5 -10
- package/src/ui/getErrorDetail.ts +11 -0
- package/src/ui/internals/Wrapper.tsx +2 -2
- package/src/ui/internals/programContext.ts +1 -1
- package/src/ui/useProgram.ts +1 -1
|
@@ -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 {@
|
|
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 {@
|
|
33
|
+
* Executes command action with provided parsed arguments and {@link Program} instance.
|
|
34
34
|
*/
|
|
35
35
|
run(parsedArgs: Arguments<{
|
|
36
36
|
commands: readonly [A];
|
package/dist/program/Command.js
CHANGED
|
@@ -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 {@
|
|
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
|
-
|
|
6
|
+
name;
|
|
7
7
|
description;
|
|
8
8
|
parameters;
|
|
9
9
|
options;
|
|
@@ -55,7 +55,7 @@ import { parseArguments } from '@jakubmazanec/args';
|
|
|
55
55
|
});
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
* Executes command action with provided parsed arguments and {@
|
|
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 {@
|
|
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
|
-
*
|
|
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 *
|
|
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 {@
|
|
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
|
-
|
|
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
|
/**
|
package/dist/program/Program.js
CHANGED
|
@@ -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 {@
|
|
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
|
-
|
|
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,6 +47,8 @@ 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');
|
|
@@ -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(
|
|
66
|
-
error
|
|
73
|
+
await this.renderElement(createElement(this.ErrorBoundaryFallbackComponent, {
|
|
74
|
+
error,
|
|
75
|
+
resetErrorBoundary: ()=>{}
|
|
67
76
|
}));
|
|
68
77
|
}
|
|
69
78
|
} finally{
|
|
@@ -83,8 +92,9 @@ import { Failure, Help } from '../ui.js';
|
|
|
83
92
|
if (parsedArgs.errors.length) {
|
|
84
93
|
let { createElement } = await import('react');
|
|
85
94
|
for (let error of parsedArgs.errors){
|
|
86
|
-
await this.renderElement(createElement(
|
|
87
|
-
error
|
|
95
|
+
await this.renderElement(createElement(this.ErrorBoundaryFallbackComponent, {
|
|
96
|
+
error,
|
|
97
|
+
resetErrorBoundary: ()=>{}
|
|
88
98
|
}));
|
|
89
99
|
}
|
|
90
100
|
} else {
|
|
@@ -93,8 +103,9 @@ import { Failure, Help } from '../ui.js';
|
|
|
93
103
|
} catch (error) {
|
|
94
104
|
let { createElement } = await import('react');
|
|
95
105
|
if (error instanceof Error) {
|
|
96
|
-
await this.renderElement(createElement(
|
|
97
|
-
error
|
|
106
|
+
await this.renderElement(createElement(this.ErrorBoundaryFallbackComponent, {
|
|
107
|
+
error,
|
|
108
|
+
resetErrorBoundary: ()=>{}
|
|
98
109
|
}));
|
|
99
110
|
}
|
|
100
111
|
}
|
|
@@ -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 {@
|
|
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
|
-
*
|
|
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 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/program/ProgramOptions.ts"],"sourcesContent":["
|
|
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 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/program/ProgramStreams.ts"],"sourcesContent":["/**\n * {@
|
|
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"}
|
package/dist/ui/Failure.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { type BoxProps } from 'ink';
|
|
2
2
|
import { type ErrorDetail } from './ErrorDetail.js';
|
|
3
3
|
/**
|
|
4
|
-
* {@
|
|
4
|
+
* {@link Failure} component props.
|
|
5
5
|
*/
|
|
6
6
|
export type FailureProps = BoxProps & {
|
|
7
|
-
/** Error that describes a failure state. Function {@
|
|
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;
|
package/dist/ui/Failure.js.map
CHANGED
|
@@ -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 * {@
|
|
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"}
|
package/dist/ui/Header.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type BoxProps } from 'ink';
|
|
2
2
|
import { type PropsWithChildren } from 'react';
|
|
3
3
|
/**
|
|
4
|
-
* {@
|
|
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.map
CHANGED
|
@@ -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 * {@
|
|
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
|
-
* {@
|
|
4
|
+
* {@link Help} component props.
|
|
5
5
|
*/
|
|
6
6
|
export type HelpProps = BoxProps & {
|
|
7
|
-
/** {@
|
|
7
|
+
/** {@link Program} instance. */
|
|
8
8
|
program: Program;
|
|
9
9
|
};
|
|
10
10
|
/**
|
package/dist/ui/Help.js.map
CHANGED
|
@@ -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 * {@
|
|
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"}
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
import { type BoxProps } from 'ink';
|
|
3
3
|
import { type SelectInputItem } from './SelectInputItem.js';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
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
|
|
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:
|
|
28
|
+
export declare function SelectInput({ label, items, focus, initialIndex, limit: userDefinedLimit, onSelect, onHighlight, isComplete, ...boxProps }: SelectInputProps): JSX.Element;
|
|
29
29
|
export {};
|
|
@@ -1,38 +1,38 @@
|
|
|
1
1
|
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
2
|
import { Box, Text, useInput } from 'ink';
|
|
3
3
|
import _ from 'lodash';
|
|
4
|
-
import { useState, useEffect, useRef
|
|
4
|
+
import { useState, useEffect, useRef } from 'react';
|
|
5
5
|
import * as colors from '../colors.js';
|
|
6
6
|
import * as icons from '../icons.js';
|
|
7
7
|
import { rotate } from '../internals.js';
|
|
8
8
|
/**
|
|
9
9
|
* Select input component.
|
|
10
|
-
*/ export function SelectInput({ label, items = [], focus = true, initialIndex = 0, limit:
|
|
10
|
+
*/ export function SelectInput({ label, items = [], focus = true, initialIndex = 0, limit: userDefinedLimit, onSelect, onHighlight, isComplete, ...boxProps }) {
|
|
11
11
|
var _items_selectedIndex, _items_selectedIndex1;
|
|
12
|
-
let [
|
|
12
|
+
let [rotatedIndex, setRotatedIndex] = useState(0);
|
|
13
13
|
let [selectedIndex, setSelectedIndex] = useState(initialIndex);
|
|
14
|
-
let hasLimit = typeof
|
|
15
|
-
let limit = hasLimit ? Math.min(
|
|
14
|
+
let hasLimit = typeof userDefinedLimit === 'number' && items.length > userDefinedLimit;
|
|
15
|
+
let limit = hasLimit ? Math.min(userDefinedLimit, items.length) : items.length;
|
|
16
16
|
let previousItems = useRef(items);
|
|
17
17
|
useEffect(()=>{
|
|
18
18
|
if (!_.isEqual(previousItems.current.map((item)=>item.value), items.map((item)=>item.value))) {
|
|
19
|
-
|
|
19
|
+
setRotatedIndex(0);
|
|
20
20
|
setSelectedIndex(0);
|
|
21
21
|
}
|
|
22
22
|
previousItems.current = items;
|
|
23
23
|
}, [
|
|
24
24
|
items
|
|
25
25
|
]);
|
|
26
|
-
|
|
26
|
+
useInput((input, key)=>{
|
|
27
27
|
if (input === 'k' || key.upArrow) {
|
|
28
28
|
let lastIndex = (hasLimit ? limit : items.length) - 1;
|
|
29
|
-
let
|
|
29
|
+
let isAtFirstIndex = selectedIndex === 0;
|
|
30
30
|
let nextIndex = hasLimit ? selectedIndex : lastIndex;
|
|
31
|
-
let
|
|
32
|
-
let nextSelectedIndex =
|
|
33
|
-
|
|
31
|
+
let nextRotatedIndex = isAtFirstIndex ? rotatedIndex + 1 : rotatedIndex;
|
|
32
|
+
let nextSelectedIndex = isAtFirstIndex ? nextIndex : selectedIndex - 1;
|
|
33
|
+
setRotatedIndex(nextRotatedIndex);
|
|
34
34
|
setSelectedIndex(nextSelectedIndex);
|
|
35
|
-
let slicedItems = hasLimit ? rotate(items,
|
|
35
|
+
let slicedItems = hasLimit ? rotate(items, nextRotatedIndex).slice(0, limit) : items;
|
|
36
36
|
if (typeof onHighlight === 'function') {
|
|
37
37
|
onHighlight(slicedItems[nextSelectedIndex]);
|
|
38
38
|
}
|
|
@@ -40,34 +40,25 @@ import { rotate } from '../internals.js';
|
|
|
40
40
|
if (input === 'j' || key.downArrow) {
|
|
41
41
|
let isAtLastIndex = selectedIndex === (hasLimit ? limit : items.length) - 1;
|
|
42
42
|
let nextIndex = hasLimit ? selectedIndex : 0;
|
|
43
|
-
let
|
|
43
|
+
let nextRotatedIndex = isAtLastIndex ? rotatedIndex - 1 : rotatedIndex;
|
|
44
44
|
let nextSelectedIndex = isAtLastIndex ? nextIndex : selectedIndex + 1;
|
|
45
|
-
|
|
45
|
+
setRotatedIndex(nextRotatedIndex);
|
|
46
46
|
setSelectedIndex(nextSelectedIndex);
|
|
47
|
-
let slicedItems = hasLimit ? rotate(items,
|
|
47
|
+
let slicedItems = hasLimit ? rotate(items, nextRotatedIndex).slice(0, limit) : items;
|
|
48
48
|
if (typeof onHighlight === 'function') {
|
|
49
49
|
onHighlight(slicedItems[nextSelectedIndex]);
|
|
50
50
|
}
|
|
51
51
|
}
|
|
52
52
|
if (key.return) {
|
|
53
|
-
let slicedItems = hasLimit ? rotate(items,
|
|
53
|
+
let slicedItems = hasLimit ? rotate(items, rotatedIndex).slice(0, limit) : items;
|
|
54
54
|
if (typeof onSelect === 'function') {
|
|
55
55
|
onSelect(slicedItems[selectedIndex]);
|
|
56
56
|
}
|
|
57
57
|
}
|
|
58
|
-
},
|
|
59
|
-
hasLimit,
|
|
60
|
-
limit,
|
|
61
|
-
rotateIndex,
|
|
62
|
-
selectedIndex,
|
|
63
|
-
items,
|
|
64
|
-
onSelect,
|
|
65
|
-
onHighlight
|
|
66
|
-
]);
|
|
67
|
-
useInput(inputHandler, {
|
|
58
|
+
}, {
|
|
68
59
|
isActive: focus
|
|
69
60
|
});
|
|
70
|
-
let
|
|
61
|
+
let visibleItems = hasLimit ? rotate(items, rotatedIndex).slice(0, limit) : items;
|
|
71
62
|
return /*#__PURE__*/ _jsxs(Box, {
|
|
72
63
|
...boxProps,
|
|
73
64
|
children: [
|
|
@@ -92,7 +83,7 @@ import { rotate } from '../internals.js';
|
|
|
92
83
|
children: ((_items_selectedIndex = items[selectedIndex]) === null || _items_selectedIndex === void 0 ? void 0 : _items_selectedIndex.label) ?? String((_items_selectedIndex1 = items[selectedIndex]) === null || _items_selectedIndex1 === void 0 ? void 0 : _items_selectedIndex1.value)
|
|
93
84
|
}) : /*#__PURE__*/ _jsx(Box, {
|
|
94
85
|
flexDirection: "column",
|
|
95
|
-
children:
|
|
86
|
+
children: visibleItems.map((item, index)=>{
|
|
96
87
|
let isSelected = index === selectedIndex;
|
|
97
88
|
return /*#__PURE__*/ _jsxs(Box, {
|
|
98
89
|
children: [
|
|
@@ -108,7 +99,7 @@ import { rotate } from '../internals.js';
|
|
|
108
99
|
}),
|
|
109
100
|
/*#__PURE__*/ _jsx(Text, {
|
|
110
101
|
color: isSelected ? colors.highlighted : colors.muted,
|
|
111
|
-
children:
|
|
102
|
+
children: item.label
|
|
112
103
|
})
|
|
113
104
|
]
|
|
114
105
|
}, item.value);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/ui/form/SelectInput.tsx"],"sourcesContent":["import {Box, type BoxProps, Text, useInput, type Key} from 'ink';\nimport _ from 'lodash';\nimport {useState, useEffect, useRef
|
|
1
|
+
{"version":3,"sources":["../../../src/ui/form/SelectInput.tsx"],"sourcesContent":["import {Box, type BoxProps, Text, useInput, type Key} from 'ink';\nimport _ from 'lodash';\nimport {useState, useEffect, useRef} from 'react';\n\nimport {type SelectInputItem} from './SelectInputItem.js';\nimport * as colors from '../colors.js';\nimport * as icons from '../icons.js';\nimport {rotate} from '../internals.js';\n\n/**\n * {@linkcode SelectInput} component props.\n */\ntype SelectInputProps = BoxProps & {\n /** Text to display as a label. */\n label: string;\n\n /** Items to display in a list. */\n items: SelectInputItem[];\n\n /** 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. */\n focus?: boolean | undefined;\n\n /** Index of initially selected item. */\n initialIndex?: number | undefined;\n\n /** Number of items to display. */\n limit?: number | undefined;\n\n /** Handler function that is called when item is selected. */\n onSelect?: ((item: SelectInputItem) => void) | undefined;\n\n /** Handler function that is called when item is highlighted. */\n onHighlight?: ((item: SelectInputItem) => void) | undefined;\n\n /** Indicates whether value has been accepted. Component then doesn't accept more input. */\n isComplete?: boolean | undefined;\n};\n\n/**\n * Select input component.\n */\nexport function SelectInput({\n label,\n items = [],\n focus = true,\n initialIndex = 0,\n limit: userDefinedLimit,\n onSelect,\n onHighlight,\n isComplete,\n ...boxProps\n}: SelectInputProps): JSX.Element {\n let [rotatedIndex, setRotatedIndex] = useState(0);\n let [selectedIndex, setSelectedIndex] = useState(initialIndex);\n let hasLimit = typeof userDefinedLimit === 'number' && items.length > userDefinedLimit;\n let limit = hasLimit ? Math.min(userDefinedLimit as number, items.length) : items.length;\n let previousItems = useRef<SelectInputItem[]>(items);\n\n useEffect(() => {\n if (\n !_.isEqual(\n previousItems.current.map((item) => item.value),\n items.map((item) => item.value),\n )\n ) {\n setRotatedIndex(0);\n setSelectedIndex(0);\n }\n\n previousItems.current = items;\n }, [items]);\n\n useInput(\n (input: string, key: Key) => {\n if (input === 'k' || key.upArrow) {\n let lastIndex = (hasLimit ? limit : items.length) - 1;\n let isAtFirstIndex = selectedIndex === 0;\n let nextIndex = hasLimit ? selectedIndex : lastIndex;\n let nextRotatedIndex = isAtFirstIndex ? rotatedIndex + 1 : rotatedIndex;\n let nextSelectedIndex = isAtFirstIndex ? nextIndex : selectedIndex - 1;\n\n setRotatedIndex(nextRotatedIndex);\n setSelectedIndex(nextSelectedIndex);\n\n let slicedItems = hasLimit ? rotate(items, nextRotatedIndex).slice(0, limit) : items;\n\n if (typeof onHighlight === 'function') {\n onHighlight(slicedItems[nextSelectedIndex] as SelectInputItem);\n }\n }\n\n if (input === 'j' || key.downArrow) {\n let isAtLastIndex = selectedIndex === (hasLimit ? limit : items.length) - 1;\n let nextIndex = hasLimit ? selectedIndex : 0;\n let nextRotatedIndex = isAtLastIndex ? rotatedIndex - 1 : rotatedIndex;\n let nextSelectedIndex = isAtLastIndex ? nextIndex : selectedIndex + 1;\n\n setRotatedIndex(nextRotatedIndex);\n setSelectedIndex(nextSelectedIndex);\n\n let slicedItems = hasLimit ? rotate(items, nextRotatedIndex).slice(0, limit) : items;\n\n if (typeof onHighlight === 'function') {\n onHighlight(slicedItems[nextSelectedIndex] as SelectInputItem);\n }\n }\n\n if (key.return) {\n let slicedItems = hasLimit ? rotate(items, rotatedIndex).slice(0, limit) : items;\n\n if (typeof onSelect === 'function') {\n onSelect(slicedItems[selectedIndex] as SelectInputItem);\n }\n }\n },\n {isActive: focus},\n );\n\n let visibleItems: SelectInputItem[] = hasLimit\n ? rotate(items, rotatedIndex).slice(0, limit)\n : items;\n\n return (\n <Box {...boxProps}>\n <Box marginRight={1}>\n <Text>{isComplete ? icons.success : icons.question}</Text>\n </Box>\n\n <Box flexDirection=\"column\">\n <Box marginRight={1}>\n <Text color={colors.highlighted}>{label}</Text>\n </Box>\n {isComplete ? (\n <Text color={colors.body}>\n {items[selectedIndex]?.label ?? String(items[selectedIndex]?.value)}\n </Text>\n ) : (\n <Box flexDirection=\"column\">\n {visibleItems.map((item, index) => {\n let isSelected = index === selectedIndex;\n\n return (\n <Box key={item.value}>\n <Box marginRight={1}>\n {isSelected ? (\n <Text color={colors.selected}>{icons.selectedCircle}</Text>\n ) : (\n <Text color={colors.unselected}>{icons.unselectedCircle}</Text>\n )}\n </Box>\n <Text color={isSelected ? colors.highlighted : colors.muted}>{item.label}</Text>\n </Box>\n );\n })}\n </Box>\n )}\n </Box>\n </Box>\n );\n}\n"],"names":["Box","Text","useInput","_","useState","useEffect","useRef","colors","icons","rotate","SelectInput","label","items","focus","initialIndex","limit","userDefinedLimit","onSelect","onHighlight","isComplete","boxProps","rotatedIndex","setRotatedIndex","selectedIndex","setSelectedIndex","hasLimit","length","Math","min","previousItems","isEqual","current","map","item","value","input","key","upArrow","lastIndex","isAtFirstIndex","nextIndex","nextRotatedIndex","nextSelectedIndex","slicedItems","slice","downArrow","isAtLastIndex","return","isActive","visibleItems","marginRight","success","question","flexDirection","color","highlighted","body","String","index","isSelected","selected","selectedCircle","unselected","unselectedCircle","muted"],"mappings":";AAAA,SAAQA,GAAG,EAAiBC,IAAI,EAAEC,QAAQ,QAAiB,MAAM;AACjE,OAAOC,OAAO,SAAS;AACvB,SAAQC,QAAQ,EAAEC,SAAS,EAAEC,MAAM,QAAO,QAAQ;AAGlD,YAAYC,YAAY,eAAe;AACvC,YAAYC,WAAW,cAAc;AACrC,SAAQC,MAAM,QAAO,kBAAkB;AA+BvC;;CAEC,GACD,OAAO,SAASC,YAAY,EAC1BC,KAAK,EACLC,QAAQ,EAAE,EACVC,QAAQ,IAAI,EACZC,eAAe,CAAC,EAChBC,OAAOC,gBAAgB,EACvBC,QAAQ,EACRC,WAAW,EACXC,UAAU,EACV,GAAGC,UACc;QAmFNR,sBAAsCA;IAlFjD,IAAI,CAACS,cAAcC,gBAAgB,GAAGlB,SAAS;IAC/C,IAAI,CAACmB,eAAeC,iBAAiB,GAAGpB,SAASU;IACjD,IAAIW,WAAW,OAAOT,qBAAqB,YAAYJ,MAAMc,MAAM,GAAGV;IACtE,IAAID,QAAQU,WAAWE,KAAKC,GAAG,CAACZ,kBAA4BJ,MAAMc,MAAM,IAAId,MAAMc,MAAM;IACxF,IAAIG,gBAAgBvB,OAA0BM;IAE9CP,UAAU;QACR,IACE,CAACF,EAAE2B,OAAO,CACRD,cAAcE,OAAO,CAACC,GAAG,CAAC,CAACC,OAASA,KAAKC,KAAK,GAC9CtB,MAAMoB,GAAG,CAAC,CAACC,OAASA,KAAKC,KAAK,IAEhC;YACAZ,gBAAgB;YAChBE,iBAAiB;QACnB;QAEAK,cAAcE,OAAO,GAAGnB;IAC1B,GAAG;QAACA;KAAM;IAEVV,SACE,CAACiC,OAAeC;QACd,IAAID,UAAU,OAAOC,IAAIC,OAAO,EAAE;YAChC,IAAIC,YAAY,AAACb,CAAAA,WAAWV,QAAQH,MAAMc,MAAM,AAAD,IAAK;YACpD,IAAIa,iBAAiBhB,kBAAkB;YACvC,IAAIiB,YAAYf,WAAWF,gBAAgBe;YAC3C,IAAIG,mBAAmBF,iBAAiBlB,eAAe,IAAIA;YAC3D,IAAIqB,oBAAoBH,iBAAiBC,YAAYjB,gBAAgB;YAErED,gBAAgBmB;YAChBjB,iBAAiBkB;YAEjB,IAAIC,cAAclB,WAAWhB,OAAOG,OAAO6B,kBAAkBG,KAAK,CAAC,GAAG7B,SAASH;YAE/E,IAAI,OAAOM,gBAAgB,YAAY;gBACrCA,YAAYyB,WAAW,CAACD,kBAAkB;YAC5C;QACF;QAEA,IAAIP,UAAU,OAAOC,IAAIS,SAAS,EAAE;YAClC,IAAIC,gBAAgBvB,kBAAkB,AAACE,CAAAA,WAAWV,QAAQH,MAAMc,MAAM,AAAD,IAAK;YAC1E,IAAIc,YAAYf,WAAWF,gBAAgB;YAC3C,IAAIkB,mBAAmBK,gBAAgBzB,eAAe,IAAIA;YAC1D,IAAIqB,oBAAoBI,gBAAgBN,YAAYjB,gBAAgB;YAEpED,gBAAgBmB;YAChBjB,iBAAiBkB;YAEjB,IAAIC,cAAclB,WAAWhB,OAAOG,OAAO6B,kBAAkBG,KAAK,CAAC,GAAG7B,SAASH;YAE/E,IAAI,OAAOM,gBAAgB,YAAY;gBACrCA,YAAYyB,WAAW,CAACD,kBAAkB;YAC5C;QACF;QAEA,IAAIN,IAAIW,MAAM,EAAE;YACd,IAAIJ,cAAclB,WAAWhB,OAAOG,OAAOS,cAAcuB,KAAK,CAAC,GAAG7B,SAASH;YAE3E,IAAI,OAAOK,aAAa,YAAY;gBAClCA,SAAS0B,WAAW,CAACpB,cAAc;YACrC;QACF;IACF,GACA;QAACyB,UAAUnC;IAAK;IAGlB,IAAIoC,eAAkCxB,WAClChB,OAAOG,OAAOS,cAAcuB,KAAK,CAAC,GAAG7B,SACrCH;IAEJ,qBACE,MAACZ;QAAK,GAAGoB,QAAQ;;0BACf,KAACpB;gBAAIkD,aAAa;0BAChB,cAAA,KAACjD;8BAAMkB,aAAaX,MAAM2C,OAAO,GAAG3C,MAAM4C,QAAQ;;;0BAGpD,MAACpD;gBAAIqD,eAAc;;kCACjB,KAACrD;wBAAIkD,aAAa;kCAChB,cAAA,KAACjD;4BAAKqD,OAAO/C,OAAOgD,WAAW;sCAAG5C;;;oBAEnCQ,2BACC,KAAClB;wBAAKqD,OAAO/C,OAAOiD,IAAI;kCACrB5C,EAAAA,uBAAAA,KAAK,CAACW,cAAc,cAApBX,2CAAAA,qBAAsBD,KAAK,KAAI8C,QAAO7C,wBAAAA,KAAK,CAACW,cAAc,cAApBX,4CAAAA,sBAAsBsB,KAAK;uCAGpE,KAAClC;wBAAIqD,eAAc;kCAChBJ,aAAajB,GAAG,CAAC,CAACC,MAAMyB;4BACvB,IAAIC,aAAaD,UAAUnC;4BAE3B,qBACE,MAACvB;;kDACC,KAACA;wCAAIkD,aAAa;kDACfS,2BACC,KAAC1D;4CAAKqD,OAAO/C,OAAOqD,QAAQ;sDAAGpD,MAAMqD,cAAc;2DAEnD,KAAC5D;4CAAKqD,OAAO/C,OAAOuD,UAAU;sDAAGtD,MAAMuD,gBAAgB;;;kDAG3D,KAAC9D;wCAAKqD,OAAOK,aAAapD,OAAOgD,WAAW,GAAGhD,OAAOyD,KAAK;kDAAG/B,KAAKtB,KAAK;;;+BARhEsB,KAAKC,KAAK;wBAWxB;;;;;;AAMZ"}
|
|
@@ -9,7 +9,7 @@ export type TextInputProps = BoxProps & {
|
|
|
9
9
|
placeholder?: string | undefined;
|
|
10
10
|
/** Value. */
|
|
11
11
|
value: string;
|
|
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
|
|
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 handled only by a specific component. */
|
|
13
13
|
focus?: boolean | undefined;
|
|
14
14
|
/** Replace all chars and mask the value. Useful for password inputs. */
|
|
15
15
|
mask?: string | undefined;
|
|
@@ -35,18 +35,15 @@ import * as icons from '../icons.js';
|
|
|
35
35
|
let value = mask ? mask.repeat(originalValue.length) : originalValue;
|
|
36
36
|
let renderedValue = value;
|
|
37
37
|
let renderedPlaceholder = placeholder ? chalk[colors.muted](placeholder) : undefined;
|
|
38
|
-
// fake mouse cursor; dealing with with actual cursor and ANSI escape codes is inconvinient
|
|
39
38
|
if (showCursor && focus) {
|
|
40
39
|
renderedPlaceholder = placeholder.length > 0 ? chalk.inverse(placeholder[0]) + chalk[colors.muted](placeholder.slice(1)) : chalk.inverse(' ');
|
|
41
40
|
renderedValue = value.length > 0 ? '' : chalk.inverse(' ');
|
|
42
|
-
let i
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
renderedValue += chalk.inverse(char);
|
|
41
|
+
for (let [i, character] of Object.entries(value)){
|
|
42
|
+
if (Number(i) >= state.cursorOffset && Number(i) <= state.cursorOffset) {
|
|
43
|
+
renderedValue += chalk.inverse(character);
|
|
46
44
|
} else {
|
|
47
|
-
renderedValue +=
|
|
45
|
+
renderedValue += character;
|
|
48
46
|
}
|
|
49
|
-
i += 1;
|
|
50
47
|
}
|
|
51
48
|
if (value.length > 0 && state.cursorOffset === value.length) {
|
|
52
49
|
renderedValue += chalk.inverse(' ');
|