@aomex/console 3.30.7 → 3.30.8-alpha.1030873.0
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/index.d.ts +379 -331
- package/dist/index.js +739 -747
- package/dist/index.js.map +1 -1
- package/package.json +17 -15
package/dist/index.d.ts
CHANGED
|
@@ -1,328 +1,381 @@
|
|
|
1
|
-
import { Middleware, MixinMiddleware, Next, Validator } from
|
|
2
|
-
import {
|
|
3
|
-
import EventEmitter from
|
|
4
|
-
import {
|
|
5
|
-
import
|
|
6
|
-
import {
|
|
7
|
-
|
|
8
|
-
declare const version = "{{#version}}";
|
|
9
|
-
declare const scriptName = "aomex";
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
}): Record<string, unknown>;
|
|
1
|
+
import { CombinedServices, I18nLanguage, Middleware, MixinMiddleware, Next, PromisifiedService, Validator } from "@aomex/common";
|
|
2
|
+
import { styleText } from "node:util";
|
|
3
|
+
import EventEmitter from "node:events";
|
|
4
|
+
import { NonReadonly, Union2Intersection } from "@aomex/internal-tools";
|
|
5
|
+
import { GlobPathOptions } from "@aomex/internal-file-import";
|
|
6
|
+
import { BaseLoggerService } from "@aomex/logger";
|
|
7
|
+
import tableCJS from "table";
|
|
8
|
+
export declare const version = "{{#version}}";
|
|
9
|
+
export declare const scriptName = "aomex";
|
|
10
|
+
export declare class ConsoleInput {
|
|
11
|
+
readonly app: ConsoleApp;
|
|
12
|
+
readonly argv: string[];
|
|
13
|
+
readonly options: Record<string, unknown>;
|
|
14
|
+
readonly command: string;
|
|
15
|
+
constructor(app: ConsoleApp, argv: string[]);
|
|
16
|
+
parseArgv(alias?: {
|
|
17
|
+
[key: string]: string | string[];
|
|
18
|
+
}): Record<string, unknown>;
|
|
20
19
|
}
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
20
|
+
export declare class ConsoleContext {
|
|
21
|
+
readonly app: ConsoleApp;
|
|
22
|
+
readonly input: ConsoleInput;
|
|
23
|
+
commandMatched: boolean;
|
|
24
|
+
constructor(app: ConsoleApp, input: ConsoleInput);
|
|
25
|
+
/** 与构造时传入的 `logger` 相同,取自 app */
|
|
26
|
+
get logger(): ConsoleApp.Logger;
|
|
27
27
|
}
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
* 全局中间件
|
|
33
|
-
* ```typescript
|
|
34
|
-
*
|
|
35
|
-
* const app = new ConsoleApp({ mount: [md1, md2] });
|
|
36
|
-
*
|
|
37
|
-
* declare module '@aomex/console' {
|
|
38
|
-
* namespace ConsoleApp {
|
|
39
|
-
* type T = ConsoleApp.Infer<typeof app>;
|
|
40
|
-
* interface Props extends T {}
|
|
41
|
-
* }
|
|
42
|
-
* }
|
|
43
|
-
* ```
|
|
44
|
-
*/
|
|
45
|
-
mount?: T;
|
|
46
|
-
language?: 'zh_CN' | 'en_US' | (string & {});
|
|
47
|
-
}
|
|
48
|
-
type Infer<T> = T extends ConsoleApp<infer U> ? U extends any[] ? Union2Intersection<Middleware.CollectArrayType<U[number]>> : unknown : unknown;
|
|
49
|
-
interface Props {
|
|
50
|
-
}
|
|
28
|
+
export interface ConsoleErrorProperties {
|
|
29
|
+
/** 业务/系统错误码,如 `COMMAND_NOT_FOUND` */
|
|
30
|
+
code?: string;
|
|
31
|
+
cause?: unknown;
|
|
51
32
|
}
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
33
|
+
/**
|
|
34
|
+
* CLI 指令异常。`app.on('error')` 收到的均为本类实例。
|
|
35
|
+
*
|
|
36
|
+
* 业务侧用 `new ConsoleError` 创建;其它错误经 {@link ConsoleError.from} 转换。
|
|
37
|
+
*/
|
|
38
|
+
export declare class ConsoleError extends Error {
|
|
39
|
+
code?: string;
|
|
40
|
+
constructor(message?: string, properties?: ConsoleErrorProperties);
|
|
41
|
+
/** 是否为自制 {@link ConsoleError}(覆盖 `Error.isError`,类型收窄为本类) */
|
|
42
|
+
static isError(value: unknown): value is ConsoleError;
|
|
43
|
+
/**
|
|
44
|
+
* 将任意错误转为自制 {@link ConsoleError}。
|
|
45
|
+
*
|
|
46
|
+
* - 已是本类实例:原样返回
|
|
47
|
+
* - `Error`:迁移 `message` / `cause` / `name` / `stack`,以及字符串 `code`(Node `ErrnoException`)
|
|
48
|
+
* - 其余(含 plain object):不猜测字段,落成默认实例或仅用字符串 message
|
|
49
|
+
*/
|
|
50
|
+
static from(error: unknown): ConsoleError;
|
|
51
|
+
}
|
|
52
|
+
export declare namespace ConsoleApp {
|
|
53
|
+
type Logger = PromisifiedService<BaseLoggerService>;
|
|
54
|
+
interface Option<T extends ConsoleMiddlewareToken[] | []> {
|
|
60
55
|
/**
|
|
61
|
-
*
|
|
56
|
+
* 全局中间件
|
|
62
57
|
* ```typescript
|
|
63
|
-
*
|
|
64
|
-
* app
|
|
58
|
+
*
|
|
59
|
+
* const app = new ConsoleApp({
|
|
60
|
+
* services,
|
|
61
|
+
* logger: services.logger,
|
|
62
|
+
* language: 'zh-CN',
|
|
63
|
+
* mount: [md1, md2],
|
|
64
|
+
* });
|
|
65
|
+
*
|
|
66
|
+
* declare module '@aomex/console' {
|
|
67
|
+
* namespace ConsoleApp {
|
|
68
|
+
* type T = ConsoleApp.Infer<typeof app>;
|
|
69
|
+
* interface Props extends T {}
|
|
70
|
+
* }
|
|
71
|
+
* }
|
|
65
72
|
* ```
|
|
66
73
|
*/
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
}
|
|
99
|
-
interface ParameterItem {
|
|
100
|
-
/**
|
|
101
|
-
* 名称
|
|
102
|
-
*/
|
|
103
|
-
name: string;
|
|
104
|
-
/**
|
|
105
|
-
* 别名
|
|
106
|
-
*/
|
|
107
|
-
alias?: string[];
|
|
108
|
-
/**
|
|
109
|
-
* 描述
|
|
110
|
-
*/
|
|
111
|
-
description?: string;
|
|
112
|
-
/**
|
|
113
|
-
* 是否必传
|
|
114
|
-
*/
|
|
115
|
-
required?: boolean;
|
|
116
|
-
/**
|
|
117
|
-
* 是否已废弃
|
|
118
|
-
*/
|
|
119
|
-
deprecated?: boolean;
|
|
120
|
-
/**
|
|
121
|
-
* 参数类型
|
|
122
|
-
*/
|
|
123
|
-
type?: 'array' | 'count' | 'boolean' | 'number' | 'string';
|
|
124
|
-
/**
|
|
125
|
-
* 默认值
|
|
126
|
-
*/
|
|
127
|
-
defaultValue?: any;
|
|
128
|
-
}
|
|
129
|
-
}
|
|
130
|
-
interface ConsoleHelpInjector {
|
|
131
|
-
onDocument?: (doc: ConsoleDocument.Document, opts: {
|
|
132
|
-
app: ConsoleApp;
|
|
133
|
-
/**
|
|
134
|
-
* 继续收集(local)中间件的相同事件
|
|
135
|
-
*/
|
|
136
|
-
children: (middlewareList: Middleware[]) => Promise<void>;
|
|
137
|
-
/**
|
|
138
|
-
* onDocument周期结束后,立即开始收集具体的指令
|
|
139
|
-
*/
|
|
140
|
-
collectCommand: (commandName: string, middlewareList: Middleware[]) => void;
|
|
141
|
-
}) => void | Promise<void>;
|
|
142
|
-
postDocument?: (doc: ConsoleDocument.Document, opts: {
|
|
143
|
-
app: ConsoleApp;
|
|
144
|
-
/**
|
|
145
|
-
* 继续收集(local)中间件的相同事件
|
|
146
|
-
*/
|
|
147
|
-
children: (middlewareList: Middleware[]) => Promise<void>;
|
|
148
|
-
}) => void | Promise<void>;
|
|
149
|
-
onCommandItem?: (commandItem: ConsoleDocument.CommandItem, opts: {
|
|
150
|
-
doc: ConsoleDocument.Document;
|
|
151
|
-
commandName: string;
|
|
152
|
-
app: ConsoleApp;
|
|
153
|
-
/**
|
|
154
|
-
* 继续收集(local)中间件的相同事件
|
|
155
|
-
*/
|
|
156
|
-
children: (middlewareList: Middleware[]) => Promise<void>;
|
|
157
|
-
}) => void | Promise<void>;
|
|
158
|
-
postCommandItem?: ConsoleHelpInjector['onCommandItem'];
|
|
74
|
+
mount?: T;
|
|
75
|
+
/**
|
|
76
|
+
* `combineServices` 的返回值(单个或数组)。
|
|
77
|
+
* 关停:进程 beforeExit / SIGINT / SIGTERM 时自动销毁。
|
|
78
|
+
*/
|
|
79
|
+
services: CombinedServices | readonly CombinedServices[];
|
|
80
|
+
/**
|
|
81
|
+
* 经 `combineServices` 处理后的 logger(通常为 `services.logger`)。
|
|
82
|
+
* 默认 `error` 监听 / `ctx.logger` 均走此实例。
|
|
83
|
+
*
|
|
84
|
+
* ```ts
|
|
85
|
+
* const services = await combineServices(
|
|
86
|
+
* { logger: () => import('./logger.service.js') },
|
|
87
|
+
* { eager: ['logger'] },
|
|
88
|
+
* );
|
|
89
|
+
* new ConsoleApp({
|
|
90
|
+
* services,
|
|
91
|
+
* logger: services.logger,
|
|
92
|
+
* language: 'zh-CN',
|
|
93
|
+
* });
|
|
94
|
+
* ```
|
|
95
|
+
*/
|
|
96
|
+
logger: Logger;
|
|
97
|
+
/**
|
|
98
|
+
* 全局语言,只能是内置规范码(如 `zh-CN` / `en-US`)。
|
|
99
|
+
* 异步语言包会在执行指令前按需加载。
|
|
100
|
+
*/
|
|
101
|
+
language: I18nLanguage;
|
|
102
|
+
}
|
|
103
|
+
type Infer<T> = T extends ConsoleApp<infer U> ? U extends any[] ? Union2Intersection<Middleware.CollectArrayType<U[number]>> : unknown : unknown;
|
|
104
|
+
interface Props {}
|
|
159
105
|
}
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
106
|
+
export declare class ConsoleApp<T extends ConsoleMiddlewareToken[] | [] = any[]> extends EventEmitter<{
|
|
107
|
+
error: [err: ConsoleError, ctx: ConsoleContext & ConsoleApp.Props, level: number];
|
|
108
|
+
}> {
|
|
109
|
+
protected readonly options: ConsoleApp.Option<T>;
|
|
110
|
+
level: number;
|
|
111
|
+
protected readonly middlewareList: Middleware[];
|
|
112
|
+
protected readonly logger: ConsoleApp.Logger;
|
|
113
|
+
constructor(options: ConsoleApp.Option<T>);
|
|
114
|
+
protected bindServicesShutdown(services: CombinedServices[]): void;
|
|
115
|
+
/**
|
|
116
|
+
* 执行指令。如果不传参数,则使用内置的`process.argv`
|
|
117
|
+
* ```typescript
|
|
118
|
+
* app.run('schedule:a')
|
|
119
|
+
* app.run('schedule:a', '-f', '--type', 'all')
|
|
120
|
+
* ```
|
|
121
|
+
*/
|
|
122
|
+
run(...commands: string[]): Promise<0 | 1>;
|
|
163
123
|
}
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
124
|
+
export type ConsoleMiddlewareToken<P extends object = object> = ConsoleMiddleware<P> | MixinMiddleware<P>;
|
|
125
|
+
declare module '@aomex/common' {
|
|
126
|
+
interface MiddlewarePlatform<Deps extends object = object> {
|
|
127
|
+
readonly console: <Props extends object = object>(fn: ConsoleMiddlewareArguments<Middleware.MergeDeps<Props, Deps>>['fn'] | ConsoleMiddlewareArguments<Middleware.MergeDeps<Props, Deps>>) => object extends Deps ? ConsoleMiddleware<Props> : ConsoleMiddleware<Props> & {
|
|
128
|
+
_contextType: Middleware.WithDeps<ConsoleContext, Deps>;
|
|
129
|
+
};
|
|
130
|
+
}
|
|
169
131
|
}
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
}) => Promise<ConsoleDocument.Document>;
|
|
176
|
-
|
|
177
|
-
/**
|
|
178
|
-
* 终端输出实用函数
|
|
179
|
-
*/
|
|
180
|
-
declare class Terminal {
|
|
132
|
+
export declare namespace ConsoleDocument {
|
|
133
|
+
interface Document {
|
|
134
|
+
[commandName: string]: CommandItem;
|
|
135
|
+
}
|
|
136
|
+
interface CommandItem {
|
|
181
137
|
/**
|
|
182
|
-
*
|
|
138
|
+
* 是否展示在指令列表。默认值:`true`
|
|
183
139
|
*/
|
|
184
|
-
|
|
140
|
+
showInHelp?: boolean;
|
|
185
141
|
/**
|
|
186
|
-
*
|
|
142
|
+
* 总结,在指令列表中展示
|
|
187
143
|
*/
|
|
188
|
-
|
|
144
|
+
summary?: string;
|
|
189
145
|
/**
|
|
190
|
-
*
|
|
146
|
+
* 详细描述,在指令详情中展示
|
|
191
147
|
*/
|
|
192
|
-
|
|
148
|
+
description?: string;
|
|
193
149
|
/**
|
|
194
|
-
*
|
|
150
|
+
* 参数
|
|
195
151
|
*/
|
|
196
|
-
|
|
152
|
+
parameters?: ParameterItem[];
|
|
153
|
+
}
|
|
154
|
+
interface ParameterItem {
|
|
197
155
|
/**
|
|
198
|
-
*
|
|
199
|
-
* ```typescript
|
|
200
|
-
* terminal.table([
|
|
201
|
-
* ['编号', '姓名', '性别'],
|
|
202
|
-
* [1, '张三', '男'],
|
|
203
|
-
* [2, '李四', '男'],
|
|
204
|
-
* [3, '翠花', '女'],
|
|
205
|
-
* ]);
|
|
206
|
-
* ```
|
|
207
|
-
* @link https://www.npmjs.com/package/table
|
|
156
|
+
* 名称
|
|
208
157
|
*/
|
|
209
|
-
|
|
158
|
+
name: string;
|
|
210
159
|
/**
|
|
211
|
-
*
|
|
212
|
-
* ```typescript
|
|
213
|
-
* const table = terminal.generateTable([
|
|
214
|
-
* ['编号', '姓名', '性别'],
|
|
215
|
-
* [1, '张三', '男'],
|
|
216
|
-
* [2, '李四', '男'],
|
|
217
|
-
* [3, '翠花', '女'],
|
|
218
|
-
* ]);
|
|
219
|
-
* ```
|
|
220
|
-
* @link https://www.npmjs.com/package/table
|
|
160
|
+
* 别名
|
|
221
161
|
*/
|
|
222
|
-
|
|
162
|
+
alias?: string[];
|
|
223
163
|
/**
|
|
224
|
-
*
|
|
164
|
+
* 描述
|
|
225
165
|
*/
|
|
226
|
-
|
|
166
|
+
description?: string;
|
|
227
167
|
/**
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
* 文字可包含一些内置的占位符:
|
|
231
|
-
* - `%loading%` 加载动画
|
|
232
|
-
* - `%prepare%` 灰色准备小图标 ◼
|
|
233
|
-
* - `%success%` 绿色成功小图标 ✔
|
|
234
|
-
* - `%info%` 蓝色信息小图标 ℹ
|
|
235
|
-
* - `%warning%` 黄色警告小图标 ⚠
|
|
236
|
-
* - `%error%` 红色错误小图标 ✖️
|
|
237
|
-
* - `%skip%` 灰色跳过小图标 ↓
|
|
238
|
-
*
|
|
239
|
-
* ```typescript
|
|
240
|
-
* const session = terminal.applySession();
|
|
241
|
-
*
|
|
242
|
-
* session.update('%loading% 加载中\n 猜猜我是谁');
|
|
243
|
-
* await sleep(1000);
|
|
244
|
-
* session.update('%success% 成功\n 猜中了');
|
|
245
|
-
* session.commit();
|
|
246
|
-
* ```
|
|
168
|
+
* 是否必传
|
|
247
169
|
*/
|
|
248
|
-
|
|
249
|
-
/**
|
|
250
|
-
* 替换当前输出的文字
|
|
251
|
-
*/
|
|
252
|
-
update: (text: string) => void;
|
|
253
|
-
/**
|
|
254
|
-
* 持久化已经输出的文字,进入下一个session
|
|
255
|
-
*/
|
|
256
|
-
commit: () => void;
|
|
257
|
-
};
|
|
170
|
+
required?: boolean;
|
|
258
171
|
/**
|
|
259
|
-
*
|
|
260
|
-
* ```typescript
|
|
261
|
-
* const { error, context } = await terminal.runTasks([
|
|
262
|
-
* {
|
|
263
|
-
* title: 'Task 1',
|
|
264
|
-
* task: async (ctx, task) => {}
|
|
265
|
-
* },
|
|
266
|
-
* {
|
|
267
|
-
* title: 'Task 2',
|
|
268
|
-
* task: async (ctx, task) => {}
|
|
269
|
-
* }
|
|
270
|
-
* ]);
|
|
271
|
-
* ```
|
|
272
|
-
*
|
|
273
|
-
* 默认是依次执行,若要批量执行则设置concurrent=true
|
|
274
|
-
* ```typescript
|
|
275
|
-
* await terminal.runTasks([], { concurrent: true });
|
|
276
|
-
* ```
|
|
172
|
+
* 是否已废弃
|
|
277
173
|
*/
|
|
278
|
-
|
|
279
|
-
error: Error | null;
|
|
280
|
-
context: Context;
|
|
281
|
-
}>;
|
|
282
|
-
runTasks<Context extends object = {}>(tasks: TaskItem<Context>[], opts: {
|
|
283
|
-
concurrent: false;
|
|
284
|
-
}): Promise<{
|
|
285
|
-
error: Error | null;
|
|
286
|
-
context: Context;
|
|
287
|
-
}>;
|
|
288
|
-
runTasks<Context extends object = {}>(tasks: TaskItem<Context>[], opts: {
|
|
289
|
-
concurrent: true;
|
|
290
|
-
}): Promise<{
|
|
291
|
-
errors: Error[] | null;
|
|
292
|
-
context: Context;
|
|
293
|
-
}>;
|
|
174
|
+
deprecated?: boolean;
|
|
294
175
|
/**
|
|
295
|
-
*
|
|
296
|
-
* - 文字颜色、背景色
|
|
297
|
-
* - 粗体、斜体
|
|
298
|
-
* - 下划线、删除线、上划线、双下划线
|
|
299
|
-
*
|
|
300
|
-
* ```typescript
|
|
301
|
-
* const errorMsg = terminal.style('red', '一些错误的内容');
|
|
302
|
-
* const warnMsg = terminal.style(['yellow', 'bold'], '严重警告文字');
|
|
303
|
-
* ```
|
|
176
|
+
* 参数类型
|
|
304
177
|
*/
|
|
305
|
-
|
|
178
|
+
type?: 'array' | 'count' | 'boolean' | 'number' | 'string';
|
|
306
179
|
/**
|
|
307
|
-
*
|
|
308
|
-
* ```typescript
|
|
309
|
-
* terminal.stripStyle('\u001B[4mUnicorn\u001B[0m'); // Unicorn
|
|
310
|
-
* ```
|
|
180
|
+
* 默认值
|
|
311
181
|
*/
|
|
312
|
-
|
|
182
|
+
defaultValue?: any;
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
export interface ConsoleHelpInjector {
|
|
186
|
+
onDocument?: (doc: ConsoleDocument.Document, opts: {
|
|
187
|
+
app: ConsoleApp;
|
|
188
|
+
/**
|
|
189
|
+
* 继续收集(local)中间件的相同事件
|
|
190
|
+
*/
|
|
191
|
+
children: (middlewareList: Middleware[]) => Promise<void>;
|
|
192
|
+
/**
|
|
193
|
+
* onDocument周期结束后,立即开始收集具体的指令
|
|
194
|
+
*/
|
|
195
|
+
collectCommand: (commandName: string, middlewareList: Middleware[]) => void;
|
|
196
|
+
}) => void | Promise<void>;
|
|
197
|
+
postDocument?: (doc: ConsoleDocument.Document, opts: {
|
|
198
|
+
app: ConsoleApp;
|
|
199
|
+
/**
|
|
200
|
+
* 继续收集(local)中间件的相同事件
|
|
201
|
+
*/
|
|
202
|
+
children: (middlewareList: Middleware[]) => Promise<void>;
|
|
203
|
+
}) => void | Promise<void>;
|
|
204
|
+
onCommandItem?: (commandItem: ConsoleDocument.CommandItem, opts: {
|
|
205
|
+
doc: ConsoleDocument.Document;
|
|
206
|
+
commandName: string;
|
|
207
|
+
app: ConsoleApp;
|
|
208
|
+
/**
|
|
209
|
+
* 继续收集(local)中间件的相同事件
|
|
210
|
+
*/
|
|
211
|
+
children: (middlewareList: Middleware[]) => Promise<void>;
|
|
212
|
+
}) => void | Promise<void>;
|
|
213
|
+
postCommandItem?: ConsoleHelpInjector['onCommandItem'];
|
|
214
|
+
}
|
|
215
|
+
interface ConsoleMiddlewareArguments<T extends object> {
|
|
216
|
+
fn: (ctx: NonReadonly<T> & ConsoleContext, next: Next) => any;
|
|
217
|
+
help?: ConsoleHelpInjector;
|
|
218
|
+
}
|
|
219
|
+
export declare class ConsoleMiddleware<Props extends object = object> extends Middleware<Props> {
|
|
220
|
+
_contextType: ConsoleContext;
|
|
221
|
+
protected _console_middleware_: 'console-middleware';
|
|
222
|
+
private readonly helpInjector;
|
|
223
|
+
constructor(args: ConsoleMiddlewareArguments<Props>['fn'] | ConsoleMiddlewareArguments<Props>);
|
|
224
|
+
protected help(): ConsoleHelpInjector;
|
|
225
|
+
}
|
|
226
|
+
export declare const collectConsoleDocument: (data: {
|
|
227
|
+
document: ConsoleDocument.Document;
|
|
228
|
+
middlewareList: Middleware[];
|
|
229
|
+
app: ConsoleApp;
|
|
230
|
+
}) => Promise<ConsoleDocument.Document>;
|
|
231
|
+
/**
|
|
232
|
+
* 终端输出实用函数
|
|
233
|
+
*/
|
|
234
|
+
declare class Terminal {
|
|
235
|
+
/**
|
|
236
|
+
* 打印文字,同`console.log`
|
|
237
|
+
*/
|
|
238
|
+
print(...messages: any[]): void;
|
|
239
|
+
/**
|
|
240
|
+
* 打印黄色警告信息,开头显示小图标 ⚠
|
|
241
|
+
*/
|
|
242
|
+
printWarning(...messages: any[]): void;
|
|
243
|
+
/**
|
|
244
|
+
* 打印红色错误信息,开头显示小图标 ✖️
|
|
245
|
+
*/
|
|
246
|
+
printError(...messages: any[]): void;
|
|
247
|
+
/**
|
|
248
|
+
* 打印绿色成功信息,开头显示小图标 ✔
|
|
249
|
+
*/
|
|
250
|
+
printSuccess(...messages: any[]): void;
|
|
251
|
+
/**
|
|
252
|
+
* 打印二维数组,呈现形式为表格
|
|
253
|
+
* ```typescript
|
|
254
|
+
* terminal.table([
|
|
255
|
+
* ['编号', '姓名', '性别'],
|
|
256
|
+
* [1, '张三', '男'],
|
|
257
|
+
* [2, '李四', '男'],
|
|
258
|
+
* [3, '翠花', '女'],
|
|
259
|
+
* ]);
|
|
260
|
+
* ```
|
|
261
|
+
* @link https://www.npmjs.com/package/table
|
|
262
|
+
*/
|
|
263
|
+
printTable(data: unknown[][], config?: tableCJS.TableUserConfig): void;
|
|
264
|
+
/**
|
|
265
|
+
* 使用二维数组生成表格字符串
|
|
266
|
+
* ```typescript
|
|
267
|
+
* const table = terminal.generateTable([
|
|
268
|
+
* ['编号', '姓名', '性别'],
|
|
269
|
+
* [1, '张三', '男'],
|
|
270
|
+
* [2, '李四', '男'],
|
|
271
|
+
* [3, '翠花', '女'],
|
|
272
|
+
* ]);
|
|
273
|
+
* ```
|
|
274
|
+
* @link https://www.npmjs.com/package/table
|
|
275
|
+
*/
|
|
276
|
+
generateTable(data: unknown[][], config?: tableCJS.TableUserConfig): string;
|
|
277
|
+
/**
|
|
278
|
+
* 清除终端屏幕文字,鼠标移到第一行开头
|
|
279
|
+
*/
|
|
280
|
+
clearScreen(): void;
|
|
281
|
+
/**
|
|
282
|
+
* 持续刷新终端文字。
|
|
283
|
+
*
|
|
284
|
+
* 文字可包含一些内置的占位符:
|
|
285
|
+
* - `%loading%` 加载动画
|
|
286
|
+
* - `%prepare%` 灰色准备小图标 ◼
|
|
287
|
+
* - `%success%` 绿色成功小图标 ✔
|
|
288
|
+
* - `%info%` 蓝色信息小图标 ℹ
|
|
289
|
+
* - `%warning%` 黄色警告小图标 ⚠
|
|
290
|
+
* - `%error%` 红色错误小图标 ✖️
|
|
291
|
+
* - `%skip%` 灰色跳过小图标 ↓
|
|
292
|
+
*
|
|
293
|
+
* ```typescript
|
|
294
|
+
* const session = terminal.applySession();
|
|
295
|
+
*
|
|
296
|
+
* session.update('%loading% 加载中\n 猜猜我是谁');
|
|
297
|
+
* await sleep(1000);
|
|
298
|
+
* session.update('%success% 成功\n 猜中了');
|
|
299
|
+
* session.commit();
|
|
300
|
+
* ```
|
|
301
|
+
*/
|
|
302
|
+
createSession(): {
|
|
303
|
+
/**
|
|
304
|
+
* 替换当前输出的文字
|
|
305
|
+
*/
|
|
306
|
+
update: (text: string) => void;
|
|
307
|
+
/**
|
|
308
|
+
* 持久化已经输出的文字,进入下一个session
|
|
309
|
+
*/
|
|
310
|
+
commit: () => void;
|
|
311
|
+
};
|
|
312
|
+
/**
|
|
313
|
+
* 依次或批量执行任务列表
|
|
314
|
+
* ```typescript
|
|
315
|
+
* const { error, context } = await terminal.runTasks([
|
|
316
|
+
* {
|
|
317
|
+
* title: 'Task 1',
|
|
318
|
+
* task: async (ctx, task) => {}
|
|
319
|
+
* },
|
|
320
|
+
* {
|
|
321
|
+
* title: 'Task 2',
|
|
322
|
+
* task: async (ctx, task) => {}
|
|
323
|
+
* }
|
|
324
|
+
* ]);
|
|
325
|
+
* ```
|
|
326
|
+
*
|
|
327
|
+
* 默认是依次执行,若要批量执行则设置concurrent=true
|
|
328
|
+
* ```typescript
|
|
329
|
+
* await terminal.runTasks([], { concurrent: true });
|
|
330
|
+
* ```
|
|
331
|
+
*/
|
|
332
|
+
runTasks<Context extends object = {}>(tasks: TaskItem<Context>[]): Promise<{
|
|
333
|
+
error: Error | null;
|
|
334
|
+
context: Context;
|
|
335
|
+
}>;
|
|
336
|
+
runTasks<Context extends object = {}>(tasks: TaskItem<Context>[], opts: {
|
|
337
|
+
concurrent: false;
|
|
338
|
+
}): Promise<{
|
|
339
|
+
error: Error | null;
|
|
340
|
+
context: Context;
|
|
341
|
+
}>;
|
|
342
|
+
runTasks<Context extends object = {}>(tasks: TaskItem<Context>[], opts: {
|
|
343
|
+
concurrent: true;
|
|
344
|
+
}): Promise<{
|
|
345
|
+
errors: Error[] | null;
|
|
346
|
+
context: Context;
|
|
347
|
+
}>;
|
|
348
|
+
/**
|
|
349
|
+
* 为字符串设置样式:
|
|
350
|
+
* - 文字颜色、背景色
|
|
351
|
+
* - 粗体、斜体
|
|
352
|
+
* - 下划线、删除线、上划线、双下划线
|
|
353
|
+
*
|
|
354
|
+
* ```typescript
|
|
355
|
+
* const errorMsg = terminal.style('red', '一些错误的内容');
|
|
356
|
+
* const warnMsg = terminal.style(['yellow', 'bold'], '严重警告文字');
|
|
357
|
+
* ```
|
|
358
|
+
*/
|
|
359
|
+
style(color: Parameters<typeof styleText>[0], string: string): string;
|
|
360
|
+
/**
|
|
361
|
+
* 去除ansi字符
|
|
362
|
+
* ```typescript
|
|
363
|
+
* terminal.stripStyle('\u001B[4mUnicorn\u001B[0m'); // Unicorn
|
|
364
|
+
* ```
|
|
365
|
+
*/
|
|
366
|
+
stripStyle(string: string): string;
|
|
313
367
|
}
|
|
314
368
|
type TaskStatus = 'success' | 'error' | 'skip' | 'warning' | 'loading';
|
|
315
369
|
interface TaskItem<Context> {
|
|
370
|
+
title: string;
|
|
371
|
+
skip?: boolean | ((ctx: Context) => boolean | Promise<boolean>);
|
|
372
|
+
task: (ctx: Context, task: {
|
|
316
373
|
title: string;
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
suffix: string;
|
|
321
|
-
status: TaskStatus;
|
|
322
|
-
}) => Promise<any>;
|
|
374
|
+
suffix: string;
|
|
375
|
+
status: TaskStatus;
|
|
376
|
+
}) => Promise<any>;
|
|
323
377
|
}
|
|
324
|
-
declare const terminal: Terminal;
|
|
325
|
-
|
|
378
|
+
export declare const terminal: Terminal;
|
|
326
379
|
/**
|
|
327
380
|
* 接收并验证命令行的选项,并且保证类型安全
|
|
328
381
|
*
|
|
@@ -345,56 +398,51 @@ declare const terminal: Terminal;
|
|
|
345
398
|
* ```
|
|
346
399
|
*
|
|
347
400
|
*/
|
|
348
|
-
declare const options: <T extends {
|
|
349
|
-
|
|
401
|
+
export declare const options: <T extends {
|
|
402
|
+
[key: string]: P;
|
|
350
403
|
}, P extends Validator, Alias extends keyof T>(fields: T, aliasList?: { [key in Alias]: string | string[]; }) => ConsoleMiddleware<{
|
|
351
|
-
|
|
404
|
+
readonly options: Validator.Infer<T>;
|
|
352
405
|
}>;
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
*/
|
|
358
|
-
disable?: boolean;
|
|
359
|
-
docs?: Builder.Docs;
|
|
360
|
-
mount?: T;
|
|
361
|
-
action: (ctx: Builder.Context<Props, T>) => any;
|
|
406
|
+
export declare namespace Builder {
|
|
407
|
+
type Interface<Props extends object | unknown, T extends ConsoleMiddlewareToken[] | []> = Props & Union2Intersection<Middleware.CollectArrayType<T[number]>>;
|
|
408
|
+
type Context<Props extends object | unknown, T extends ConsoleMiddlewareToken[] | []> = Props & Union2Intersection<Middleware.CollectArrayType<T[number]>> & ConsoleContext;
|
|
409
|
+
type Docs = Omit<ConsoleDocument.CommandItem, 'parameters'>;
|
|
362
410
|
}
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
411
|
+
export interface BuilderOptions<Props extends object | unknown, T extends ConsoleMiddlewareToken[] | []> {
|
|
412
|
+
/**
|
|
413
|
+
* 禁用当前路由。默认 `false`
|
|
414
|
+
*/
|
|
415
|
+
disabled?: boolean;
|
|
416
|
+
docs?: Builder.Docs;
|
|
417
|
+
mount?: T;
|
|
418
|
+
action: (ctx: Builder.Context<Props, T>) => any;
|
|
367
419
|
}
|
|
368
|
-
declare class Builder<Props extends object | unknown = object, T extends ConsoleMiddlewareToken[] | [] = []> {
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
420
|
+
export declare class Builder<Props extends object | unknown = object, T extends ConsoleMiddlewareToken[] | [] = []> {
|
|
421
|
+
readonly docs: Builder.Docs;
|
|
422
|
+
readonly commands: string[];
|
|
423
|
+
protected readonly middlewareList: ConsoleMiddlewareToken[];
|
|
424
|
+
constructor(prefix: string, commands: string[], options: BuilderOptions<Props, T>);
|
|
425
|
+
match(command: string): boolean;
|
|
374
426
|
}
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
mount?: T;
|
|
427
|
+
export interface CommanderOptions<T extends ConsoleMiddlewareToken[] | []> {
|
|
428
|
+
prefix?: string;
|
|
429
|
+
mount?: T;
|
|
379
430
|
}
|
|
380
|
-
declare class Commander<T extends ConsoleMiddlewareToken[] | [] = any[], Props extends object | unknown = ConsoleApp.Props & Union2Intersection<Middleware.CollectArrayType<T[number]>>> {
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
431
|
+
export declare class Commander<T extends ConsoleMiddlewareToken[] | [] = any[], Props extends object | unknown = ConsoleApp.Props & Union2Intersection<Middleware.CollectArrayType<T[number]>>> {
|
|
432
|
+
protected readonly opts: CommanderOptions<T>;
|
|
433
|
+
protected readonly middlewareList: ConsoleMiddlewareToken[];
|
|
434
|
+
protected readonly prefix: string;
|
|
435
|
+
protected readonly builders: Builder[];
|
|
436
|
+
constructor(opts?: CommanderOptions<T>);
|
|
437
|
+
create<T extends ConsoleMiddlewareToken<object>[] | []>(commandName: string | string[], options: BuilderOptions<Props, T>): Builder.Interface<Props, T>;
|
|
438
|
+
protected toMiddleware(): ConsoleMiddleware;
|
|
388
439
|
}
|
|
389
|
-
|
|
390
|
-
declare const commanders: (options: GlobPathOptions | Commander[]) => ConsoleMiddleware;
|
|
391
|
-
|
|
440
|
+
export declare const commanders: (options: GlobPathOptions | Commander[]) => ConsoleMiddleware;
|
|
392
441
|
declare global {
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
}
|
|
442
|
+
namespace NodeJS {
|
|
443
|
+
interface ProcessEnv {
|
|
444
|
+
AOMEX_CLI_MODE?: '1';
|
|
397
445
|
}
|
|
446
|
+
}
|
|
398
447
|
}
|
|
399
|
-
|
|
400
|
-
export { Builder, type BuilderOptions, Commander, type CommanderOptions, ConsoleApp, ConsoleContext, ConsoleDocument, type ConsoleHelpInjector, ConsoleInput, ConsoleMiddleware, type ConsoleMiddlewareToken, collectConsoleDocument, commanders, options, scriptName, terminal, version };
|
|
448
|
+
export {};
|