@aomex/console 0.0.2 → 0.0.4
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/CHANGELOG.md +31 -0
- package/dist/index.d.ts +22 -11
- package/dist/index.js +82 -66
- package/dist/index.js.map +1 -1
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# @aomex/console
|
|
2
2
|
|
|
3
|
+
## 0.0.4
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`1a2800d`](https://github.com/aomex/aomex/commit/1a2800d3a27f2b45fd5db314c1ca81295831b77d) Thanks [@geekact](https://github.com/geekact)! - feat(console): help 类型的中间件需判断是否存在 cli 属性
|
|
8
|
+
|
|
9
|
+
- [`cd9369f`](https://github.com/aomex/aomex/commit/cd9369f585053b0003a121fe5fee71c44d78587e) Thanks [@geekact](https://github.com/geekact)! - feat(console): 导出 scriptName 变量
|
|
10
|
+
|
|
11
|
+
- [`6a57463`](https://github.com/aomex/aomex/commit/6a57463c1107c38a8b8cf5fa00ff3289bf629c0a) Thanks [@geekact](https://github.com/geekact)! - refactor(middleware): 类型 MiddlewareFn 和 GetMiddlewareProps 迁移到命名空间
|
|
12
|
+
|
|
13
|
+
- [`f6bbf24`](https://github.com/aomex/aomex/commit/f6bbf247a81d20c14598c1046169c2e6e1e48fec) Thanks [@geekact](https://github.com/geekact)! - fix(console): 从错误的字段中过滤中间件
|
|
14
|
+
|
|
15
|
+
- [`6849b03`](https://github.com/aomex/aomex/commit/6849b03dc1e0dc9b707d89dfe98327c9f120dc7f) Thanks [@geekact](https://github.com/geekact)! - feat(middleware): chain.flatten 支持传入数组
|
|
16
|
+
|
|
17
|
+
- [`56a5e1f`](https://github.com/aomex/aomex/commit/56a5e1fffe3e1cec863e52c21d122979d121c630) Thanks [@geekact](https://github.com/geekact)! - fix(console): description 赋值错误
|
|
18
|
+
|
|
19
|
+
- Updated dependencies [[`956bba9`](https://github.com/aomex/aomex/commit/956bba9e5b954f34486ad5f2b45a5277c1f980c9), [`ee021e3`](https://github.com/aomex/aomex/commit/ee021e342814f12777e538c06a19971e1020f201)]:
|
|
20
|
+
- @aomex/helper@0.0.2
|
|
21
|
+
- @aomex/core@0.0.4
|
|
22
|
+
|
|
23
|
+
## 0.0.3
|
|
24
|
+
|
|
25
|
+
### Patch Changes
|
|
26
|
+
|
|
27
|
+
- [`ee5f8ca`](https://github.com/aomex/aomex/commit/ee5f8ca34df085ab9b5ef2a3525cf361ac46440a) Thanks [@geekact](https://github.com/geekact)! - request.query 重命名为 request.options
|
|
28
|
+
|
|
29
|
+
- [`d06c1c1`](https://github.com/aomex/aomex/commit/d06c1c1bdfee8657a74bbcbb06a2880263e85529) Thanks [@geekact](https://github.com/geekact)! - middleware 增加构造函数
|
|
30
|
+
|
|
31
|
+
- Updated dependencies []:
|
|
32
|
+
- @aomex/core@0.0.3
|
|
33
|
+
|
|
3
34
|
## 0.0.2
|
|
4
35
|
|
|
5
36
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Chain, PureMiddlewareToken, Next, Middleware, Validator
|
|
1
|
+
import { Chain, PureMiddlewareToken, Next, Middleware, Validator } from '@aomex/core';
|
|
2
2
|
import { NonReadonly } from '@aomex/helper';
|
|
3
3
|
import { Argv } from 'yargs';
|
|
4
4
|
import EventEmitter from 'node:events';
|
|
@@ -17,13 +17,19 @@ declare class ConsoleChain<Props extends object = object> extends Chain<Props> {
|
|
|
17
17
|
}
|
|
18
18
|
|
|
19
19
|
interface ConsoleAppOption {
|
|
20
|
+
/**
|
|
21
|
+
* 中间件链条,被放置到中间件列表最前面,并自动创建分割点。
|
|
22
|
+
*/
|
|
20
23
|
globalChain?: ConsoleChain;
|
|
21
24
|
}
|
|
22
25
|
declare class ConsoleApp extends EventEmitter {
|
|
23
26
|
readonly globalChainPoint?: string;
|
|
24
27
|
protected running: boolean;
|
|
25
|
-
protected readonly
|
|
28
|
+
protected readonly tokenList: ConsoleMiddlewareToken[];
|
|
26
29
|
constructor(options?: ConsoleAppOption);
|
|
30
|
+
/**
|
|
31
|
+
* 执行命令。如果不传参数,则自动从`process.argv`中获取
|
|
32
|
+
*/
|
|
27
33
|
run(...commands: string[]): Promise<void>;
|
|
28
34
|
log(err: Error): void;
|
|
29
35
|
mount(middleware: ConsoleMiddlewareToken): void;
|
|
@@ -32,7 +38,7 @@ declare class ConsoleApp extends EventEmitter {
|
|
|
32
38
|
declare class ConsoleRequest {
|
|
33
39
|
readonly app: ConsoleApp;
|
|
34
40
|
readonly argv: string[];
|
|
35
|
-
readonly
|
|
41
|
+
readonly options: Record<string, unknown>;
|
|
36
42
|
readonly command: string;
|
|
37
43
|
constructor(app: ConsoleApp, argv: string[]);
|
|
38
44
|
}
|
|
@@ -50,34 +56,39 @@ declare class ConsoleContext {
|
|
|
50
56
|
constructor(app: ConsoleApp, request: ConsoleRequest, response: ConsoleResponse);
|
|
51
57
|
}
|
|
52
58
|
|
|
53
|
-
interface
|
|
54
|
-
cli:
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
59
|
+
interface ShowHelpProps {
|
|
60
|
+
cli: ShowHelp;
|
|
61
|
+
}
|
|
62
|
+
declare class ShowHelp {
|
|
63
|
+
readonly status: 'show-all' | 'show-detail';
|
|
64
|
+
readonly yargs: Argv;
|
|
65
|
+
constructor(status: 'show-all' | 'show-detail', yargs: Argv);
|
|
58
66
|
}
|
|
59
67
|
|
|
60
68
|
type YargsInstance = Argv;
|
|
61
69
|
declare module '@aomex/core' {
|
|
62
70
|
interface MiddlewarePlatform {
|
|
63
71
|
readonly console: <Props extends object = object>(fn: (ctx: NonReadonly<Props> & ConsoleContext, next: Next) => any) => ConsoleMiddleware<Props>;
|
|
64
|
-
readonly help: <Props extends object = object>(fn: (ctx: NonReadonly<Props> &
|
|
72
|
+
readonly help: <Props extends object = object>(fn: (ctx: NonReadonly<Props> & ShowHelpProps & ConsoleContext, next: Next) => any) => HelpMiddleware<object>;
|
|
65
73
|
}
|
|
66
74
|
}
|
|
67
75
|
declare class ConsoleMiddleware<Props extends object = object> extends Middleware<Props> {
|
|
68
76
|
protected _console_middleware_: 'console-middleware';
|
|
77
|
+
constructor(fn: (ctx: NonReadonly<Props> & ConsoleContext, next: Next) => any);
|
|
69
78
|
toHelp(yargs: YargsInstance): void;
|
|
70
79
|
}
|
|
71
80
|
declare class HelpMiddleware<Props extends object = object> extends ConsoleMiddleware<Props> {
|
|
81
|
+
constructor(fn: (ctx: NonReadonly<Props> & ShowHelpProps & ConsoleContext, next: Next) => any);
|
|
72
82
|
}
|
|
73
83
|
|
|
74
84
|
declare const version = "{{#version}}";
|
|
85
|
+
declare const scriptName = "aomex";
|
|
75
86
|
|
|
76
87
|
declare class ConsoleOptionMiddleware<Props extends {
|
|
77
88
|
[key: string]: Validator;
|
|
78
89
|
}> extends ConsoleMiddleware<{
|
|
79
90
|
readonly options: {
|
|
80
|
-
[K in keyof Props]:
|
|
91
|
+
[K in keyof Props]: Validator.Infer<Props[K]>;
|
|
81
92
|
};
|
|
82
93
|
}> {
|
|
83
94
|
protected readonly props: Props;
|
|
@@ -115,4 +126,4 @@ declare const options: <T extends {
|
|
|
115
126
|
[key: string]: P;
|
|
116
127
|
}, P extends Validator<unknown>, Alias extends keyof T>(fields: T, alias?: { [key in Alias]: string | string[]; } | undefined) => ConsoleOptionMiddleware<T>;
|
|
117
128
|
|
|
118
|
-
export { ConsoleApp, ConsoleAppOption, ConsoleChain, ConsoleContext, ConsoleMiddleware, ConsoleMiddlewareToken, ConsoleOptionMiddleware, ConsoleRequest, ConsoleResponse, HelpMiddleware, YargsInstance, options, version };
|
|
129
|
+
export { ConsoleApp, ConsoleAppOption, ConsoleChain, ConsoleContext, ConsoleMiddleware, ConsoleMiddlewareToken, ConsoleOptionMiddleware, ConsoleRequest, ConsoleResponse, HelpMiddleware, YargsInstance, options, scriptName, version };
|
package/dist/index.js
CHANGED
|
@@ -1,15 +1,73 @@
|
|
|
1
1
|
// src/override/middleware.ts
|
|
2
|
-
import { Middleware } from "@aomex/core";
|
|
2
|
+
import { Middleware as Middleware2 } from "@aomex/core";
|
|
3
3
|
import assert from "node:assert";
|
|
4
|
-
|
|
4
|
+
|
|
5
|
+
// src/middleware/showHelp.ts
|
|
6
|
+
import { compose, middleware } from "@aomex/core";
|
|
7
|
+
import yargs from "yargs";
|
|
8
|
+
|
|
9
|
+
// src/info.ts
|
|
10
|
+
var version = "0.0.4";
|
|
11
|
+
var scriptName = "aomex";
|
|
12
|
+
|
|
13
|
+
// src/middleware/showHelp.ts
|
|
14
|
+
var ShowHelp = class {
|
|
15
|
+
constructor(status, yargs2) {
|
|
16
|
+
this.status = status;
|
|
17
|
+
this.yargs = yargs2;
|
|
18
|
+
}
|
|
19
|
+
};
|
|
20
|
+
var showHelp = (middlewareList) => {
|
|
21
|
+
const composeFn = compose(middlewareList);
|
|
22
|
+
return middleware.console(async (ctx, next) => {
|
|
23
|
+
const {
|
|
24
|
+
request: { options: options2, command },
|
|
25
|
+
response
|
|
26
|
+
} = ctx;
|
|
27
|
+
if (command === "") {
|
|
28
|
+
response.commandMatched = true;
|
|
29
|
+
if (options2["version"] || options2["v"]) {
|
|
30
|
+
console.log(version);
|
|
31
|
+
} else {
|
|
32
|
+
const cli = yargs([]).scriptName(scriptName).usage(`${scriptName} [command] [options] [--help|-h]`).describe("version", `Show ${scriptName} version number`).alias("v", "version").alias("h", "help");
|
|
33
|
+
ctx.cli = new ShowHelp("show-all", cli);
|
|
34
|
+
await composeFn(ctx);
|
|
35
|
+
cli.showHelp("log");
|
|
36
|
+
}
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
if (options2["help"] || options2["h"]) {
|
|
40
|
+
const cli = yargs([]).scriptName(scriptName).version(false).help(false);
|
|
41
|
+
ctx.cli = new ShowHelp("show-detail", cli);
|
|
42
|
+
await composeFn(ctx);
|
|
43
|
+
if (!response.commandMatched) {
|
|
44
|
+
throw new Error(`Unable to find usage of command "${command}"`);
|
|
45
|
+
}
|
|
46
|
+
cli.alias("help", "h").describe("help", `Show help for command "${command}"`).showHelp("log");
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
return next();
|
|
50
|
+
});
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
// src/override/middleware.ts
|
|
54
|
+
var ConsoleMiddleware = class extends Middleware2 {
|
|
55
|
+
constructor(fn) {
|
|
56
|
+
super(fn);
|
|
57
|
+
}
|
|
5
58
|
toHelp(yargs2) {
|
|
6
59
|
assert(yargs2);
|
|
7
60
|
}
|
|
8
61
|
};
|
|
9
62
|
var HelpMiddleware = class extends ConsoleMiddleware {
|
|
63
|
+
constructor(fn) {
|
|
64
|
+
super((ctx, next) => {
|
|
65
|
+
return ctx.cli instanceof ShowHelp ? fn(ctx, next) : next();
|
|
66
|
+
});
|
|
67
|
+
}
|
|
10
68
|
};
|
|
11
|
-
|
|
12
|
-
|
|
69
|
+
Middleware2.register("console", ConsoleMiddleware);
|
|
70
|
+
Middleware2.register("help", HelpMiddleware);
|
|
13
71
|
|
|
14
72
|
// src/override/chain.ts
|
|
15
73
|
import { Chain } from "@aomex/core";
|
|
@@ -39,10 +97,10 @@ var ConsoleRequest = class {
|
|
|
39
97
|
this.app = app;
|
|
40
98
|
this.argv = argv;
|
|
41
99
|
const { _: commands, ...query } = parse(argv);
|
|
42
|
-
this.
|
|
100
|
+
this.options = query;
|
|
43
101
|
this.command = String(commands[0] || "");
|
|
44
102
|
}
|
|
45
|
-
|
|
103
|
+
options;
|
|
46
104
|
command;
|
|
47
105
|
};
|
|
48
106
|
|
|
@@ -54,66 +112,27 @@ var ConsoleResponse = class {
|
|
|
54
112
|
commandMatched = false;
|
|
55
113
|
};
|
|
56
114
|
|
|
57
|
-
// src/middleware/showHelp.ts
|
|
58
|
-
import { compose, middleware } from "@aomex/core";
|
|
59
|
-
import yargs from "yargs";
|
|
60
|
-
|
|
61
|
-
// src/version.ts
|
|
62
|
-
var version = "0.0.2";
|
|
63
|
-
|
|
64
|
-
// src/middleware/showHelp.ts
|
|
65
|
-
var scriptName = "aomex";
|
|
66
|
-
var showHelp = (middlewareList) => {
|
|
67
|
-
const composeFn = compose(middlewareList);
|
|
68
|
-
return middleware.console(async (ctx, next) => {
|
|
69
|
-
const {
|
|
70
|
-
request: { query: options2, command },
|
|
71
|
-
response
|
|
72
|
-
} = ctx;
|
|
73
|
-
if (command === "") {
|
|
74
|
-
response.commandMatched = true;
|
|
75
|
-
if (options2["version"] || options2["v"]) {
|
|
76
|
-
console.log(version);
|
|
77
|
-
} else {
|
|
78
|
-
const cli = yargs([]).scriptName(scriptName).usage(`${scriptName} [command] [options] [--help|-h]`).describe("version", `Show ${scriptName} version number`).alias("v", "version").alias("h", "help");
|
|
79
|
-
ctx.cli = { status: "show-all", yargs: cli };
|
|
80
|
-
await composeFn(ctx);
|
|
81
|
-
cli.showHelp("log");
|
|
82
|
-
}
|
|
83
|
-
return;
|
|
84
|
-
}
|
|
85
|
-
if (options2["help"] || options2["h"]) {
|
|
86
|
-
const cli = yargs([]).scriptName(scriptName).version(false).help(false);
|
|
87
|
-
ctx.cli = { status: "show-detail", yargs: cli };
|
|
88
|
-
await composeFn(ctx);
|
|
89
|
-
if (!response.commandMatched) {
|
|
90
|
-
throw new Error(`Unable to find usage of command "${command}"`);
|
|
91
|
-
}
|
|
92
|
-
cli.alias("help", "h").describe("help", `Show help for command "${command}"`).showHelp("log");
|
|
93
|
-
return;
|
|
94
|
-
}
|
|
95
|
-
return next();
|
|
96
|
-
});
|
|
97
|
-
};
|
|
98
|
-
|
|
99
115
|
// src/app/app.ts
|
|
100
116
|
import { color } from "@aomex/helper";
|
|
101
117
|
var ConsoleApp = class extends EventEmitter {
|
|
102
118
|
globalChainPoint;
|
|
103
119
|
running = false;
|
|
104
|
-
|
|
120
|
+
tokenList;
|
|
105
121
|
constructor(options2 = {}) {
|
|
106
122
|
super();
|
|
107
123
|
if (options2.globalChain) {
|
|
108
124
|
this.globalChainPoint = Chain2.createPoint(options2.globalChain);
|
|
109
|
-
this.
|
|
125
|
+
this.tokenList = [options2.globalChain];
|
|
110
126
|
} else {
|
|
111
|
-
this.
|
|
127
|
+
this.tokenList = [];
|
|
112
128
|
}
|
|
113
129
|
}
|
|
130
|
+
/**
|
|
131
|
+
* 执行命令。如果不传参数,则自动从`process.argv`中获取
|
|
132
|
+
*/
|
|
114
133
|
async run(...commands) {
|
|
115
134
|
if (this.running) {
|
|
116
|
-
throw new Error(
|
|
135
|
+
throw new Error('Call "app.run()" multiple times at same time');
|
|
117
136
|
}
|
|
118
137
|
this.running = true;
|
|
119
138
|
const request = new ConsoleRequest(
|
|
@@ -126,20 +145,16 @@ var ConsoleApp = class extends EventEmitter {
|
|
|
126
145
|
this.on("error", this.log);
|
|
127
146
|
}
|
|
128
147
|
try {
|
|
129
|
-
const middlewareList = this.
|
|
130
|
-
|
|
131
|
-
|
|
148
|
+
const middlewareList = Chain2.flatten(this.tokenList);
|
|
149
|
+
const helps = middlewareList.filter(
|
|
150
|
+
(item) => item instanceof HelpMiddleware
|
|
151
|
+
);
|
|
152
|
+
const normals = middlewareList.filter(
|
|
153
|
+
(item) => !(item instanceof HelpMiddleware)
|
|
132
154
|
);
|
|
133
|
-
await compose2([
|
|
134
|
-
showHelp(
|
|
135
|
-
middlewareList.filter((item) => item instanceof HelpMiddleware)
|
|
136
|
-
),
|
|
137
|
-
...this.middlewareList.filter(
|
|
138
|
-
(item) => !(item instanceof HelpMiddleware)
|
|
139
|
-
)
|
|
140
|
-
])(ctx);
|
|
155
|
+
await compose2([showHelp(helps), ...normals])(ctx);
|
|
141
156
|
if (!response.commandMatched) {
|
|
142
|
-
throw new Error(`Command "${request.command}" is not
|
|
157
|
+
throw new Error(`Command "${request.command}" is not found`);
|
|
143
158
|
}
|
|
144
159
|
} catch (e) {
|
|
145
160
|
this.emit("error", e);
|
|
@@ -155,7 +170,7 @@ var ConsoleApp = class extends EventEmitter {
|
|
|
155
170
|
);
|
|
156
171
|
}
|
|
157
172
|
mount(middleware2) {
|
|
158
|
-
this.
|
|
173
|
+
this.tokenList.push(middleware2);
|
|
159
174
|
}
|
|
160
175
|
};
|
|
161
176
|
|
|
@@ -203,7 +218,7 @@ var ConsoleOptionMiddleware = class extends ConsoleMiddleware {
|
|
|
203
218
|
}
|
|
204
219
|
yargs2.option(key, {
|
|
205
220
|
alias: aliases[key],
|
|
206
|
-
description:
|
|
221
|
+
description: schema?.description,
|
|
207
222
|
default: defaultValue,
|
|
208
223
|
deprecated: docs.deprecated,
|
|
209
224
|
type: dateType
|
|
@@ -222,6 +237,7 @@ export {
|
|
|
222
237
|
ConsoleResponse,
|
|
223
238
|
HelpMiddleware,
|
|
224
239
|
options,
|
|
240
|
+
scriptName,
|
|
225
241
|
version
|
|
226
242
|
};
|
|
227
243
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/override/middleware.ts","../src/override/chain.ts","../src/app/context.ts","../src/app/app.ts","../src/app/request.ts","../src/app/response.ts","../src/middleware/showHelp.ts","../src/version.ts","../src/middleware/options.ts"],"sourcesContent":["import { Middleware, type Next } from '@aomex/core';\nimport assert from 'node:assert';\nimport type { NonReadonly } from '@aomex/helper';\nimport type { Argv } from 'yargs';\nimport type { ConsoleContext } from '../app/context';\nimport type { ShowHelp } from '../middleware/showHelp';\n\nexport type YargsInstance = Argv;\n\ndeclare module '@aomex/core' {\n export interface MiddlewarePlatform {\n readonly console: <Props extends object = object>(\n fn: (ctx: NonReadonly<Props> & ConsoleContext, next: Next) => any,\n ) => ConsoleMiddleware<Props>;\n readonly help: <Props extends object = object>(\n fn: (\n ctx: NonReadonly<Props> & ShowHelp & ConsoleContext,\n next: Next,\n ) => any,\n ) => HelpMiddleware<object>;\n }\n}\n\nexport class ConsoleMiddleware<\n Props extends object = object,\n> extends Middleware<Props> {\n protected declare _console_middleware_: 'console-middleware';\n\n public toHelp(yargs: YargsInstance): void {\n assert(yargs);\n }\n}\n\nexport class HelpMiddleware<\n Props extends object = object,\n> extends ConsoleMiddleware<Props> {}\n\nMiddleware.register('console', ConsoleMiddleware);\nMiddleware.register('help', HelpMiddleware);\n","import { Chain, PureMiddlewareToken } from '@aomex/core';\nimport type { ConsoleMiddleware } from './middleware';\n\ndeclare module '@aomex/core' {\n export interface ChainPlatform {\n readonly console: ConsoleChain;\n }\n}\n\nexport type ConsoleMiddlewareToken<P extends object = object> =\n | ConsoleChain<P>\n | ConsoleMiddleware<P>\n | PureMiddlewareToken<P>;\n\nexport class ConsoleChain<Props extends object = object> extends Chain<Props> {\n protected declare _console_chain_: 'console-chain';\n\n declare mount: {\n <P extends object>(\n middleware: ConsoleMiddlewareToken<P> | null,\n ): ConsoleChain<Props & P>;\n };\n}\n\nChain.register('console', ConsoleChain);\n","import type { ConsoleApp } from './app';\nimport type { ConsoleRequest } from './request';\nimport type { ConsoleResponse } from './response';\n\nexport class ConsoleContext {\n constructor(\n public readonly app: ConsoleApp,\n public readonly request: ConsoleRequest,\n public readonly response: ConsoleResponse,\n ) {}\n}\n","import EventEmitter from 'node:events';\nimport { EOL } from 'node:os';\nimport { hideBin } from 'yargs/helpers';\nimport { Chain, compose, Middleware } from '@aomex/core';\nimport { ConsoleRequest } from './request';\nimport { ConsoleResponse } from './response';\nimport { ConsoleContext } from './context';\nimport type { ConsoleChain, ConsoleMiddlewareToken } from '../override/chain';\nimport { showHelp } from '../middleware/showHelp';\nimport { HelpMiddleware } from '../override';\nimport { color } from '@aomex/helper';\n\nexport interface ConsoleAppOption {\n globalChain?: ConsoleChain;\n}\n\nexport class ConsoleApp extends EventEmitter {\n public readonly globalChainPoint?: string;\n protected running: boolean = false;\n protected readonly middlewareList: ConsoleMiddlewareToken[];\n\n constructor(options: ConsoleAppOption = {}) {\n super();\n if (options.globalChain) {\n this.globalChainPoint = Chain.createPoint(options.globalChain);\n this.middlewareList = [options.globalChain];\n } else {\n this.middlewareList = [];\n }\n }\n\n public async run(...commands: string[]): Promise<void> {\n if (this.running) {\n throw new Error('Call app.run() multiple times at same time');\n }\n\n this.running = true;\n const request = new ConsoleRequest(\n this,\n commands.length ? commands : hideBin(process.argv),\n );\n const response = new ConsoleResponse(this);\n const ctx = new ConsoleContext(this, request, response);\n\n if (!this.listenerCount('error')) {\n this.on('error', this.log);\n }\n\n try {\n const middlewareList = this.middlewareList.reduce<Middleware[]>(\n (carry, item) => carry.concat(Chain.flatten(item)),\n [],\n );\n\n await compose([\n showHelp(\n middlewareList.filter((item) => item instanceof HelpMiddleware),\n ),\n ...this.middlewareList.filter(\n (item) => !(item instanceof HelpMiddleware),\n ),\n ])(ctx);\n if (!response.commandMatched) {\n throw new Error(`Command \"${request.command}\" is not matched`);\n }\n } catch (e) {\n this.emit('error', e);\n throw e;\n } finally {\n this.running = false;\n }\n }\n\n public log(err: Error) {\n const stack = (err.stack || err.toString())\n .split(EOL)\n .map((item) => ' ' + item);\n\n console.error(\n ['', color.red(stack.shift()), stack.join(EOL), ''].join(EOL),\n );\n }\n\n public mount(middleware: ConsoleMiddlewareToken): void {\n this.middlewareList.push(middleware);\n }\n}\n","import parse from 'yargs-parser';\nimport type { ConsoleApp } from './app';\n\nexport class ConsoleRequest {\n public readonly query: Record<string, unknown>;\n public readonly command: string;\n\n constructor(public readonly app: ConsoleApp, public readonly argv: string[]) {\n const { _: commands, ...query } = parse(argv);\n this.query = query;\n this.command = String(commands[0] || '');\n }\n}\n","import type { ConsoleApp } from './app';\n\nexport class ConsoleResponse {\n public commandMatched: boolean = false;\n\n constructor(public readonly app: ConsoleApp) {}\n}\n","import { compose, Middleware, middleware } from '@aomex/core';\nimport yargs, { type Argv } from 'yargs';\n\nimport { version } from '../version';\n\nexport interface ShowHelp {\n cli: {\n status: 'show-all' | 'show-detail';\n yargs: Argv;\n };\n}\n\nconst scriptName = 'aomex';\n\nexport const showHelp = (middlewareList: Middleware[]) => {\n const composeFn = compose(middlewareList);\n\n return middleware.console<ShowHelp>(async (ctx, next) => {\n const {\n request: { query: options, command },\n response,\n } = ctx;\n\n if (command === '') {\n response.commandMatched = true;\n if (options['version'] || options['v']) {\n console.log(version);\n } else {\n const cli = yargs([])\n .scriptName(scriptName)\n .usage(`${scriptName} [command] [options] [--help|-h]`)\n .describe('version', `Show ${scriptName} version number`)\n .alias('v', 'version')\n .alias('h', 'help');\n ctx.cli = { status: 'show-all', yargs: cli };\n await composeFn(ctx);\n cli.showHelp('log');\n }\n return;\n }\n\n if (options['help'] || options['h']) {\n const cli = yargs([]).scriptName(scriptName).version(false).help(false);\n ctx.cli = { status: 'show-detail', yargs: cli };\n\n await composeFn(ctx);\n\n if (!response.commandMatched) {\n throw new Error(`Unable to find usage of command \"${command}\"`);\n }\n\n cli\n .alias('help', 'h')\n .describe('help', `Show help for command \"${command}\"`)\n .showHelp('log');\n return;\n }\n\n return next();\n });\n};\n","export const version = '{{#version}}';\n","import type { Options as YargsOptions } from 'yargs';\nimport parse from 'yargs-parser';\nimport { validate, Validator, GetValidatorType, OpenAPI } from '@aomex/core';\nimport { ConsoleMiddleware, YargsInstance } from '../override';\n\nexport class ConsoleOptionMiddleware<\n Props extends { [key: string]: Validator },\n> extends ConsoleMiddleware<{\n readonly options: { [K in keyof Props]: GetValidatorType<Props[K]> };\n}> {\n constructor(\n protected readonly props: Props,\n protected readonly alias?: { [key: string]: string | string[] },\n ) {\n super(async (ctx, next) => {\n let options = ctx.request.options;\n\n if (alias && Object.keys(alias).length) {\n const { _, ...rawOptions } = parse(ctx.request.argv, {\n alias,\n });\n options = rawOptions;\n }\n\n ctx.options = await validate(options, props, { throwIfError: true });\n return next();\n });\n }\n\n public override toHelp(yargs: YargsInstance): void {\n const aliases = this.alias || {};\n\n for (const [key, validator] of Object.entries(this.props)) {\n const docs = Validator.toDocument(validator);\n const schema = docs.schema as OpenAPI.SchemaObject | undefined;\n const defaultValue = schema?.default;\n let dateType: YargsOptions['type'];\n\n switch (schema?.type) {\n case 'array':\n dateType = 'array';\n break;\n case 'integer':\n case 'number':\n dateType = 'number';\n break;\n case 'boolean':\n dateType = 'boolean';\n break;\n case 'string':\n // 命令行只能传递字符串,因此如果有object的规则那也是需要指定`parseFromString()`\n case 'object':\n dateType = 'string';\n break;\n }\n\n yargs.option(key, {\n alias: aliases[key],\n description: docs.description,\n default: defaultValue,\n deprecated: docs.deprecated,\n type: dateType,\n });\n }\n }\n}\n\n/**\n * 验证控制台命令的传入参数,同时可以设置参数别名\n *\n * ```typescript\n * export const commander = new Commander();\n *\n * commander.create('my/schedule', {\n * slots: [\n * options({\n * id: rule.int(),\n * date: rule.datetime('YYYY-MM-DD'),\n * }, {\n * date: ['d'], // 传参形式: --date=xxx 或者 -d=xxx\n * });\n * ],\n * action: async (ctx) => {\n * console.log(ctx.options);\n * }\n * });\n * ```\n *\n */\nexport const options = <\n T extends { [key: string]: P },\n P extends Validator,\n Alias extends keyof T,\n>(\n fields: T,\n alias?: { [key in Alias]: string | string[] },\n) => new ConsoleOptionMiddleware<T>(fields, alias);\n"],"mappings":";AAAA,SAAS,kBAA6B;AACtC,OAAO,YAAY;AAsBZ,IAAM,oBAAN,cAEG,WAAkB;AAAA,EAGnB,OAAOA,QAA4B;AACxC,WAAOA,MAAK;AAAA,EACd;AACF;AAEO,IAAM,iBAAN,cAEG,kBAAyB;AAAC;AAEpC,WAAW,SAAS,WAAW,iBAAiB;AAChD,WAAW,SAAS,QAAQ,cAAc;;;ACtC1C,SAAS,aAAkC;AAcpC,IAAM,eAAN,cAA0D,MAAa;AAQ9E;AAEA,MAAM,SAAS,WAAW,YAAY;;;ACpB/B,IAAM,iBAAN,MAAqB;AAAA,EAC1B,YACkB,KACA,SACA,UAChB;AAHgB;AACA;AACA;AAAA,EACf;AACL;;;ACVA,OAAO,kBAAkB;AACzB,SAAS,WAAW;AACpB,SAAS,eAAe;AACxB,SAAS,SAAAC,QAAO,WAAAC,gBAA2B;;;ACH3C,OAAO,WAAW;AAGX,IAAM,iBAAN,MAAqB;AAAA,EAI1B,YAA4B,KAAiC,MAAgB;AAAjD;AAAiC;AAC3D,UAAM,EAAE,GAAG,UAAU,GAAG,MAAM,IAAI,MAAM,IAAI;AAC5C,SAAK,QAAQ;AACb,SAAK,UAAU,OAAO,SAAS,CAAC,KAAK,EAAE;AAAA,EACzC;AAAA,EAPgB;AAAA,EACA;AAOlB;;;ACVO,IAAM,kBAAN,MAAsB;AAAA,EAG3B,YAA4B,KAAiB;AAAjB;AAAA,EAAkB;AAAA,EAFvC,iBAA0B;AAGnC;;;ACNA,SAAS,SAAqB,kBAAkB;AAChD,OAAO,WAA0B;;;ACD1B,IAAM,UAAU;;;ADYvB,IAAM,aAAa;AAEZ,IAAM,WAAW,CAAC,mBAAiC;AACxD,QAAM,YAAY,QAAQ,cAAc;AAExC,SAAO,WAAW,QAAkB,OAAO,KAAK,SAAS;AACvD,UAAM;AAAA,MACJ,SAAS,EAAE,OAAOC,UAAS,QAAQ;AAAA,MACnC;AAAA,IACF,IAAI;AAEJ,QAAI,YAAY,IAAI;AAClB,eAAS,iBAAiB;AAC1B,UAAIA,SAAQ,SAAS,KAAKA,SAAQ,GAAG,GAAG;AACtC,gBAAQ,IAAI,OAAO;AAAA,MACrB,OAAO;AACL,cAAM,MAAM,MAAM,CAAC,CAAC,EACjB,WAAW,UAAU,EACrB,MAAM,GAAG,4CAA4C,EACrD,SAAS,WAAW,QAAQ,2BAA2B,EACvD,MAAM,KAAK,SAAS,EACpB,MAAM,KAAK,MAAM;AACpB,YAAI,MAAM,EAAE,QAAQ,YAAY,OAAO,IAAI;AAC3C,cAAM,UAAU,GAAG;AACnB,YAAI,SAAS,KAAK;AAAA,MACpB;AACA;AAAA,IACF;AAEA,QAAIA,SAAQ,MAAM,KAAKA,SAAQ,GAAG,GAAG;AACnC,YAAM,MAAM,MAAM,CAAC,CAAC,EAAE,WAAW,UAAU,EAAE,QAAQ,KAAK,EAAE,KAAK,KAAK;AACtE,UAAI,MAAM,EAAE,QAAQ,eAAe,OAAO,IAAI;AAE9C,YAAM,UAAU,GAAG;AAEnB,UAAI,CAAC,SAAS,gBAAgB;AAC5B,cAAM,IAAI,MAAM,oCAAoC,UAAU;AAAA,MAChE;AAEA,UACG,MAAM,QAAQ,GAAG,EACjB,SAAS,QAAQ,0BAA0B,UAAU,EACrD,SAAS,KAAK;AACjB;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACd,CAAC;AACH;;;AHlDA,SAAS,aAAa;AAMf,IAAM,aAAN,cAAyB,aAAa;AAAA,EAC3B;AAAA,EACN,UAAmB;AAAA,EACV;AAAA,EAEnB,YAAYC,WAA4B,CAAC,GAAG;AAC1C,UAAM;AACN,QAAIA,SAAQ,aAAa;AACvB,WAAK,mBAAmBC,OAAM,YAAYD,SAAQ,WAAW;AAC7D,WAAK,iBAAiB,CAACA,SAAQ,WAAW;AAAA,IAC5C,OAAO;AACL,WAAK,iBAAiB,CAAC;AAAA,IACzB;AAAA,EACF;AAAA,EAEA,MAAa,OAAO,UAAmC;AACrD,QAAI,KAAK,SAAS;AAChB,YAAM,IAAI,MAAM,4CAA4C;AAAA,IAC9D;AAEA,SAAK,UAAU;AACf,UAAM,UAAU,IAAI;AAAA,MAClB;AAAA,MACA,SAAS,SAAS,WAAW,QAAQ,QAAQ,IAAI;AAAA,IACnD;AACA,UAAM,WAAW,IAAI,gBAAgB,IAAI;AACzC,UAAM,MAAM,IAAI,eAAe,MAAM,SAAS,QAAQ;AAEtD,QAAI,CAAC,KAAK,cAAc,OAAO,GAAG;AAChC,WAAK,GAAG,SAAS,KAAK,GAAG;AAAA,IAC3B;AAEA,QAAI;AACF,YAAM,iBAAiB,KAAK,eAAe;AAAA,QACzC,CAAC,OAAO,SAAS,MAAM,OAAOC,OAAM,QAAQ,IAAI,CAAC;AAAA,QACjD,CAAC;AAAA,MACH;AAEA,YAAMC,SAAQ;AAAA,QACZ;AAAA,UACE,eAAe,OAAO,CAAC,SAAS,gBAAgB,cAAc;AAAA,QAChE;AAAA,QACA,GAAG,KAAK,eAAe;AAAA,UACrB,CAAC,SAAS,EAAE,gBAAgB;AAAA,QAC9B;AAAA,MACF,CAAC,EAAE,GAAG;AACN,UAAI,CAAC,SAAS,gBAAgB;AAC5B,cAAM,IAAI,MAAM,YAAY,QAAQ,yBAAyB;AAAA,MAC/D;AAAA,IACF,SAAS,GAAP;AACA,WAAK,KAAK,SAAS,CAAC;AACpB,YAAM;AAAA,IACR,UAAE;AACA,WAAK,UAAU;AAAA,IACjB;AAAA,EACF;AAAA,EAEO,IAAI,KAAY;AACrB,UAAM,SAAS,IAAI,SAAS,IAAI,SAAS,GACtC,MAAM,GAAG,EACT,IAAI,CAAC,SAAS,OAAO,IAAI;AAE5B,YAAQ;AAAA,MACN,CAAC,IAAI,MAAM,IAAI,MAAM,MAAM,CAAC,GAAG,MAAM,KAAK,GAAG,GAAG,EAAE,EAAE,KAAK,GAAG;AAAA,IAC9D;AAAA,EACF;AAAA,EAEO,MAAMC,aAA0C;AACrD,SAAK,eAAe,KAAKA,WAAU;AAAA,EACrC;AACF;;;AKrFA,OAAOC,YAAW;AAClB,SAAS,UAAU,iBAA4C;AAGxD,IAAM,0BAAN,cAEG,kBAEP;AAAA,EACD,YACqB,OACA,OACnB;AACA,UAAM,OAAO,KAAK,SAAS;AACzB,UAAIC,WAAU,IAAI,QAAQ;AAE1B,UAAI,SAAS,OAAO,KAAK,KAAK,EAAE,QAAQ;AACtC,cAAM,EAAE,GAAG,GAAG,WAAW,IAAIC,OAAM,IAAI,QAAQ,MAAM;AAAA,UACnD;AAAA,QACF,CAAC;AACD,QAAAD,WAAU;AAAA,MACZ;AAEA,UAAI,UAAU,MAAM,SAASA,UAAS,OAAO,EAAE,cAAc,KAAK,CAAC;AACnE,aAAO,KAAK;AAAA,IACd,CAAC;AAfkB;AACA;AAAA,EAerB;AAAA,EAEgB,OAAOE,QAA4B;AACjD,UAAM,UAAU,KAAK,SAAS,CAAC;AAE/B,eAAW,CAAC,KAAK,SAAS,KAAK,OAAO,QAAQ,KAAK,KAAK,GAAG;AACzD,YAAM,OAAO,UAAU,WAAW,SAAS;AAC3C,YAAM,SAAS,KAAK;AACpB,YAAM,eAAe,QAAQ;AAC7B,UAAI;AAEJ,cAAQ,QAAQ,MAAM;AAAA,QACpB,KAAK;AACH,qBAAW;AACX;AAAA,QACF,KAAK;AAAA,QACL,KAAK;AACH,qBAAW;AACX;AAAA,QACF,KAAK;AACH,qBAAW;AACX;AAAA,QACF,KAAK;AAAA,QAEL,KAAK;AACH,qBAAW;AACX;AAAA,MACJ;AAEA,MAAAA,OAAM,OAAO,KAAK;AAAA,QAChB,OAAO,QAAQ,GAAG;AAAA,QAClB,aAAa,KAAK;AAAA,QAClB,SAAS;AAAA,QACT,YAAY,KAAK;AAAA,QACjB,MAAM;AAAA,MACR,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAwBO,IAAM,UAAU,CAKrB,QACA,UACG,IAAI,wBAA2B,QAAQ,KAAK;","names":["yargs","Chain","compose","options","options","Chain","compose","middleware","parse","options","parse","yargs"]}
|
|
1
|
+
{"version":3,"sources":["../src/override/middleware.ts","../src/middleware/showHelp.ts","../src/info.ts","../src/override/chain.ts","../src/app/context.ts","../src/app/app.ts","../src/app/request.ts","../src/app/response.ts","../src/middleware/options.ts"],"sourcesContent":["import { Middleware, type Next } from '@aomex/core';\nimport assert from 'node:assert';\nimport type { NonReadonly } from '@aomex/helper';\nimport type { Argv } from 'yargs';\nimport type { ConsoleContext } from '../app/context';\nimport { ShowHelp, ShowHelpProps } from '../middleware/showHelp';\n\nexport type YargsInstance = Argv;\n\ndeclare module '@aomex/core' {\n export interface MiddlewarePlatform {\n readonly console: <Props extends object = object>(\n fn: (ctx: NonReadonly<Props> & ConsoleContext, next: Next) => any,\n ) => ConsoleMiddleware<Props>;\n readonly help: <Props extends object = object>(\n fn: (\n ctx: NonReadonly<Props> & ShowHelpProps & ConsoleContext,\n next: Next,\n ) => any,\n ) => HelpMiddleware<object>;\n }\n}\n\nexport class ConsoleMiddleware<\n Props extends object = object,\n> extends Middleware<Props> {\n protected declare _console_middleware_: 'console-middleware';\n\n constructor(\n fn: (ctx: NonReadonly<Props> & ConsoleContext, next: Next) => any,\n ) {\n super(fn);\n }\n\n public toHelp(yargs: YargsInstance): void {\n assert(yargs);\n }\n}\n\nexport class HelpMiddleware<\n Props extends object = object,\n> extends ConsoleMiddleware<Props> {\n constructor(\n fn: (\n ctx: NonReadonly<Props> & ShowHelpProps & ConsoleContext,\n next: Next,\n ) => any,\n ) {\n super((ctx, next) => {\n return (ctx as unknown as ShowHelpProps).cli instanceof ShowHelp\n ? fn(ctx as any, next)\n : next();\n });\n }\n}\n\nMiddleware.register('console', ConsoleMiddleware);\nMiddleware.register('help', HelpMiddleware);\n","import { compose, Middleware, middleware } from '@aomex/core';\nimport yargs, { type Argv } from 'yargs';\n\nimport { scriptName, version } from '../info';\n\nexport interface ShowHelpProps {\n cli: ShowHelp;\n}\n\nexport class ShowHelp {\n constructor(\n public readonly status: 'show-all' | 'show-detail',\n public readonly yargs: Argv,\n ) {}\n}\n\nexport const showHelp = (middlewareList: Middleware[]) => {\n const composeFn = compose(middlewareList);\n\n return middleware.console<ShowHelpProps>(async (ctx, next) => {\n const {\n request: { options, command },\n response,\n } = ctx;\n\n if (command === '') {\n response.commandMatched = true;\n if (options['version'] || options['v']) {\n console.log(version);\n } else {\n const cli = yargs([])\n .scriptName(scriptName)\n .usage(`${scriptName} [command] [options] [--help|-h]`)\n .describe('version', `Show ${scriptName} version number`)\n .alias('v', 'version')\n .alias('h', 'help');\n ctx.cli = new ShowHelp('show-all', cli);\n await composeFn(ctx);\n cli.showHelp('log');\n }\n return;\n }\n\n if (options['help'] || options['h']) {\n const cli = yargs([]).scriptName(scriptName).version(false).help(false);\n ctx.cli = new ShowHelp('show-detail', cli);\n\n await composeFn(ctx);\n\n if (!response.commandMatched) {\n throw new Error(`Unable to find usage of command \"${command}\"`);\n }\n\n cli\n .alias('help', 'h')\n .describe('help', `Show help for command \"${command}\"`)\n .showHelp('log');\n return;\n }\n\n return next();\n });\n};\n","export const version = '{{#version}}';\nexport const scriptName = 'aomex';\n","import { Chain, PureMiddlewareToken } from '@aomex/core';\nimport type { ConsoleMiddleware } from './middleware';\n\ndeclare module '@aomex/core' {\n export interface ChainPlatform {\n readonly console: ConsoleChain;\n }\n}\n\nexport type ConsoleMiddlewareToken<P extends object = object> =\n | ConsoleChain<P>\n | ConsoleMiddleware<P>\n | PureMiddlewareToken<P>;\n\nexport class ConsoleChain<Props extends object = object> extends Chain<Props> {\n protected declare _console_chain_: 'console-chain';\n\n declare mount: {\n <P extends object>(\n middleware: ConsoleMiddlewareToken<P> | null,\n ): ConsoleChain<Props & P>;\n };\n}\n\nChain.register('console', ConsoleChain);\n","import type { ConsoleApp } from './app';\nimport type { ConsoleRequest } from './request';\nimport type { ConsoleResponse } from './response';\n\nexport class ConsoleContext {\n constructor(\n public readonly app: ConsoleApp,\n public readonly request: ConsoleRequest,\n public readonly response: ConsoleResponse,\n ) {}\n}\n","import EventEmitter from 'node:events';\nimport { EOL } from 'node:os';\nimport { hideBin } from 'yargs/helpers';\nimport { Chain, compose } from '@aomex/core';\nimport { ConsoleRequest } from './request';\nimport { ConsoleResponse } from './response';\nimport { ConsoleContext } from './context';\nimport type { ConsoleChain, ConsoleMiddlewareToken } from '../override/chain';\nimport { showHelp } from '../middleware/showHelp';\nimport { HelpMiddleware } from '../override';\nimport { color } from '@aomex/helper';\n\nexport interface ConsoleAppOption {\n /**\n * 中间件链条,被放置到中间件列表最前面,并自动创建分割点。\n */\n globalChain?: ConsoleChain;\n}\n\nexport class ConsoleApp extends EventEmitter {\n public readonly globalChainPoint?: string;\n protected running: boolean = false;\n protected readonly tokenList: ConsoleMiddlewareToken[];\n\n constructor(options: ConsoleAppOption = {}) {\n super();\n if (options.globalChain) {\n this.globalChainPoint = Chain.createPoint(options.globalChain);\n this.tokenList = [options.globalChain];\n } else {\n this.tokenList = [];\n }\n }\n\n /**\n * 执行命令。如果不传参数,则自动从`process.argv`中获取\n */\n public async run(...commands: string[]): Promise<void> {\n if (this.running) {\n throw new Error('Call \"app.run()\" multiple times at same time');\n }\n\n this.running = true;\n const request = new ConsoleRequest(\n this,\n commands.length ? commands : hideBin(process.argv),\n );\n const response = new ConsoleResponse(this);\n const ctx = new ConsoleContext(this, request, response);\n\n if (!this.listenerCount('error')) {\n this.on('error', this.log);\n }\n\n try {\n const middlewareList = Chain.flatten(this.tokenList);\n const helps = middlewareList.filter(\n (item) => item instanceof HelpMiddleware,\n );\n const normals = middlewareList.filter(\n (item) => !(item instanceof HelpMiddleware),\n );\n\n await compose([showHelp(helps), ...normals])(ctx);\n if (!response.commandMatched) {\n throw new Error(`Command \"${request.command}\" is not found`);\n }\n } catch (e) {\n this.emit('error', e);\n throw e;\n } finally {\n this.running = false;\n }\n }\n\n public log(err: Error) {\n const stack = (err.stack || err.toString())\n .split(EOL)\n .map((item) => ' ' + item);\n console.error(\n ['', color.red(stack.shift()), stack.join(EOL), ''].join(EOL),\n );\n }\n\n public mount(middleware: ConsoleMiddlewareToken): void {\n this.tokenList.push(middleware);\n }\n}\n","import parse from 'yargs-parser';\nimport type { ConsoleApp } from './app';\n\nexport class ConsoleRequest {\n public readonly options: Record<string, unknown>;\n public readonly command: string;\n\n constructor(public readonly app: ConsoleApp, public readonly argv: string[]) {\n const { _: commands, ...query } = parse(argv);\n this.options = query;\n this.command = String(commands[0] || '');\n }\n}\n","import type { ConsoleApp } from './app';\n\nexport class ConsoleResponse {\n public commandMatched: boolean = false;\n\n constructor(public readonly app: ConsoleApp) {}\n}\n","import type { Options as YargsOptions } from 'yargs';\nimport parse from 'yargs-parser';\nimport { validate, Validator, OpenAPI } from '@aomex/core';\nimport { ConsoleMiddleware, YargsInstance } from '../override';\n\nexport class ConsoleOptionMiddleware<\n Props extends { [key: string]: Validator },\n> extends ConsoleMiddleware<{\n readonly options: { [K in keyof Props]: Validator.Infer<Props[K]> };\n}> {\n constructor(\n protected readonly props: Props,\n protected readonly alias?: { [key: string]: string | string[] },\n ) {\n super(async (ctx, next) => {\n let options = ctx.request.options;\n\n if (alias && Object.keys(alias).length) {\n const { _, ...rawOptions } = parse(ctx.request.argv, {\n alias,\n });\n options = rawOptions;\n }\n\n ctx.options = await validate(options, props, { throwIfError: true });\n return next();\n });\n }\n\n public override toHelp(yargs: YargsInstance): void {\n const aliases = this.alias || {};\n\n for (const [key, validator] of Object.entries(this.props)) {\n const docs = Validator.toDocument(validator);\n const schema = docs.schema as OpenAPI.SchemaObject | undefined;\n const defaultValue = schema?.default;\n let dateType: YargsOptions['type'];\n\n switch (schema?.type) {\n case 'array':\n dateType = 'array';\n break;\n case 'integer':\n case 'number':\n dateType = 'number';\n break;\n case 'boolean':\n dateType = 'boolean';\n break;\n case 'string':\n // 命令行只能传递字符串,因此如果有object的规则那也是需要指定`parseFromString()`\n case 'object':\n dateType = 'string';\n break;\n }\n\n yargs.option(key, {\n alias: aliases[key],\n description: schema?.description,\n default: defaultValue,\n deprecated: docs.deprecated,\n type: dateType,\n });\n }\n }\n}\n\n/**\n * 验证控制台命令的传入参数,同时可以设置参数别名\n *\n * ```typescript\n * export const commander = new Commander();\n *\n * commander.create('my/schedule', {\n * slots: [\n * options({\n * id: rule.int(),\n * date: rule.datetime('YYYY-MM-DD'),\n * }, {\n * date: ['d'], // 传参形式: --date=xxx 或者 -d=xxx\n * });\n * ],\n * action: async (ctx) => {\n * console.log(ctx.options);\n * }\n * });\n * ```\n *\n */\nexport const options = <\n T extends { [key: string]: P },\n P extends Validator,\n Alias extends keyof T,\n>(\n fields: T,\n alias?: { [key in Alias]: string | string[] },\n) => new ConsoleOptionMiddleware<T>(fields, alias);\n"],"mappings":";AAAA,SAAS,cAAAA,mBAA6B;AACtC,OAAO,YAAY;;;ACDnB,SAAS,SAAqB,kBAAkB;AAChD,OAAO,WAA0B;;;ACD1B,IAAM,UAAU;AAChB,IAAM,aAAa;;;ADQnB,IAAM,WAAN,MAAe;AAAA,EACpB,YACkB,QACAC,QAChB;AAFgB;AACA,iBAAAA;AAAA,EACf;AACL;AAEO,IAAM,WAAW,CAAC,mBAAiC;AACxD,QAAM,YAAY,QAAQ,cAAc;AAExC,SAAO,WAAW,QAAuB,OAAO,KAAK,SAAS;AAC5D,UAAM;AAAA,MACJ,SAAS,EAAE,SAAAC,UAAS,QAAQ;AAAA,MAC5B;AAAA,IACF,IAAI;AAEJ,QAAI,YAAY,IAAI;AAClB,eAAS,iBAAiB;AAC1B,UAAIA,SAAQ,SAAS,KAAKA,SAAQ,GAAG,GAAG;AACtC,gBAAQ,IAAI,OAAO;AAAA,MACrB,OAAO;AACL,cAAM,MAAM,MAAM,CAAC,CAAC,EACjB,WAAW,UAAU,EACrB,MAAM,GAAG,4CAA4C,EACrD,SAAS,WAAW,QAAQ,2BAA2B,EACvD,MAAM,KAAK,SAAS,EACpB,MAAM,KAAK,MAAM;AACpB,YAAI,MAAM,IAAI,SAAS,YAAY,GAAG;AACtC,cAAM,UAAU,GAAG;AACnB,YAAI,SAAS,KAAK;AAAA,MACpB;AACA;AAAA,IACF;AAEA,QAAIA,SAAQ,MAAM,KAAKA,SAAQ,GAAG,GAAG;AACnC,YAAM,MAAM,MAAM,CAAC,CAAC,EAAE,WAAW,UAAU,EAAE,QAAQ,KAAK,EAAE,KAAK,KAAK;AACtE,UAAI,MAAM,IAAI,SAAS,eAAe,GAAG;AAEzC,YAAM,UAAU,GAAG;AAEnB,UAAI,CAAC,SAAS,gBAAgB;AAC5B,cAAM,IAAI,MAAM,oCAAoC,UAAU;AAAA,MAChE;AAEA,UACG,MAAM,QAAQ,GAAG,EACjB,SAAS,QAAQ,0BAA0B,UAAU,EACrD,SAAS,KAAK;AACjB;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACd,CAAC;AACH;;;ADvCO,IAAM,oBAAN,cAEGC,YAAkB;AAAA,EAG1B,YACE,IACA;AACA,UAAM,EAAE;AAAA,EACV;AAAA,EAEO,OAAOC,QAA4B;AACxC,WAAOA,MAAK;AAAA,EACd;AACF;AAEO,IAAM,iBAAN,cAEG,kBAAyB;AAAA,EACjC,YACE,IAIA;AACA,UAAM,CAAC,KAAK,SAAS;AACnB,aAAQ,IAAiC,eAAe,WACpD,GAAG,KAAY,IAAI,IACnB,KAAK;AAAA,IACX,CAAC;AAAA,EACH;AACF;AAEAD,YAAW,SAAS,WAAW,iBAAiB;AAChDA,YAAW,SAAS,QAAQ,cAAc;;;AGzD1C,SAAS,aAAkC;AAcpC,IAAM,eAAN,cAA0D,MAAa;AAQ9E;AAEA,MAAM,SAAS,WAAW,YAAY;;;ACpB/B,IAAM,iBAAN,MAAqB;AAAA,EAC1B,YACkB,KACA,SACA,UAChB;AAHgB;AACA;AACA;AAAA,EACf;AACL;;;ACVA,OAAO,kBAAkB;AACzB,SAAS,WAAW;AACpB,SAAS,eAAe;AACxB,SAAS,SAAAE,QAAO,WAAAC,gBAAe;;;ACH/B,OAAO,WAAW;AAGX,IAAM,iBAAN,MAAqB;AAAA,EAI1B,YAA4B,KAAiC,MAAgB;AAAjD;AAAiC;AAC3D,UAAM,EAAE,GAAG,UAAU,GAAG,MAAM,IAAI,MAAM,IAAI;AAC5C,SAAK,UAAU;AACf,SAAK,UAAU,OAAO,SAAS,CAAC,KAAK,EAAE;AAAA,EACzC;AAAA,EAPgB;AAAA,EACA;AAOlB;;;ACVO,IAAM,kBAAN,MAAsB;AAAA,EAG3B,YAA4B,KAAiB;AAAjB;AAAA,EAAkB;AAAA,EAFvC,iBAA0B;AAGnC;;;AFIA,SAAS,aAAa;AASf,IAAM,aAAN,cAAyB,aAAa;AAAA,EAC3B;AAAA,EACN,UAAmB;AAAA,EACV;AAAA,EAEnB,YAAYC,WAA4B,CAAC,GAAG;AAC1C,UAAM;AACN,QAAIA,SAAQ,aAAa;AACvB,WAAK,mBAAmBC,OAAM,YAAYD,SAAQ,WAAW;AAC7D,WAAK,YAAY,CAACA,SAAQ,WAAW;AAAA,IACvC,OAAO;AACL,WAAK,YAAY,CAAC;AAAA,IACpB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAa,OAAO,UAAmC;AACrD,QAAI,KAAK,SAAS;AAChB,YAAM,IAAI,MAAM,8CAA8C;AAAA,IAChE;AAEA,SAAK,UAAU;AACf,UAAM,UAAU,IAAI;AAAA,MAClB;AAAA,MACA,SAAS,SAAS,WAAW,QAAQ,QAAQ,IAAI;AAAA,IACnD;AACA,UAAM,WAAW,IAAI,gBAAgB,IAAI;AACzC,UAAM,MAAM,IAAI,eAAe,MAAM,SAAS,QAAQ;AAEtD,QAAI,CAAC,KAAK,cAAc,OAAO,GAAG;AAChC,WAAK,GAAG,SAAS,KAAK,GAAG;AAAA,IAC3B;AAEA,QAAI;AACF,YAAM,iBAAiBC,OAAM,QAAQ,KAAK,SAAS;AACnD,YAAM,QAAQ,eAAe;AAAA,QAC3B,CAAC,SAAS,gBAAgB;AAAA,MAC5B;AACA,YAAM,UAAU,eAAe;AAAA,QAC7B,CAAC,SAAS,EAAE,gBAAgB;AAAA,MAC9B;AAEA,YAAMC,SAAQ,CAAC,SAAS,KAAK,GAAG,GAAG,OAAO,CAAC,EAAE,GAAG;AAChD,UAAI,CAAC,SAAS,gBAAgB;AAC5B,cAAM,IAAI,MAAM,YAAY,QAAQ,uBAAuB;AAAA,MAC7D;AAAA,IACF,SAAS,GAAP;AACA,WAAK,KAAK,SAAS,CAAC;AACpB,YAAM;AAAA,IACR,UAAE;AACA,WAAK,UAAU;AAAA,IACjB;AAAA,EACF;AAAA,EAEO,IAAI,KAAY;AACrB,UAAM,SAAS,IAAI,SAAS,IAAI,SAAS,GACtC,MAAM,GAAG,EACT,IAAI,CAAC,SAAS,OAAO,IAAI;AAC5B,YAAQ;AAAA,MACN,CAAC,IAAI,MAAM,IAAI,MAAM,MAAM,CAAC,GAAG,MAAM,KAAK,GAAG,GAAG,EAAE,EAAE,KAAK,GAAG;AAAA,IAC9D;AAAA,EACF;AAAA,EAEO,MAAMC,aAA0C;AACrD,SAAK,UAAU,KAAKA,WAAU;AAAA,EAChC;AACF;;;AGtFA,OAAOC,YAAW;AAClB,SAAS,UAAU,iBAA0B;AAGtC,IAAM,0BAAN,cAEG,kBAEP;AAAA,EACD,YACqB,OACA,OACnB;AACA,UAAM,OAAO,KAAK,SAAS;AACzB,UAAIC,WAAU,IAAI,QAAQ;AAE1B,UAAI,SAAS,OAAO,KAAK,KAAK,EAAE,QAAQ;AACtC,cAAM,EAAE,GAAG,GAAG,WAAW,IAAIC,OAAM,IAAI,QAAQ,MAAM;AAAA,UACnD;AAAA,QACF,CAAC;AACD,QAAAD,WAAU;AAAA,MACZ;AAEA,UAAI,UAAU,MAAM,SAASA,UAAS,OAAO,EAAE,cAAc,KAAK,CAAC;AACnE,aAAO,KAAK;AAAA,IACd,CAAC;AAfkB;AACA;AAAA,EAerB;AAAA,EAEgB,OAAOE,QAA4B;AACjD,UAAM,UAAU,KAAK,SAAS,CAAC;AAE/B,eAAW,CAAC,KAAK,SAAS,KAAK,OAAO,QAAQ,KAAK,KAAK,GAAG;AACzD,YAAM,OAAO,UAAU,WAAW,SAAS;AAC3C,YAAM,SAAS,KAAK;AACpB,YAAM,eAAe,QAAQ;AAC7B,UAAI;AAEJ,cAAQ,QAAQ,MAAM;AAAA,QACpB,KAAK;AACH,qBAAW;AACX;AAAA,QACF,KAAK;AAAA,QACL,KAAK;AACH,qBAAW;AACX;AAAA,QACF,KAAK;AACH,qBAAW;AACX;AAAA,QACF,KAAK;AAAA,QAEL,KAAK;AACH,qBAAW;AACX;AAAA,MACJ;AAEA,MAAAA,OAAM,OAAO,KAAK;AAAA,QAChB,OAAO,QAAQ,GAAG;AAAA,QAClB,aAAa,QAAQ;AAAA,QACrB,SAAS;AAAA,QACT,YAAY,KAAK;AAAA,QACjB,MAAM;AAAA,MACR,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAwBO,IAAM,UAAU,CAKrB,QACA,UACG,IAAI,wBAA2B,QAAQ,KAAK;","names":["Middleware","yargs","options","Middleware","yargs","Chain","compose","options","Chain","compose","middleware","parse","options","parse","yargs"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aomex/console",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
4
4
|
"description": "",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -33,18 +33,18 @@
|
|
|
33
33
|
"homepage": "https://aomex.js.org",
|
|
34
34
|
"license": "MIT",
|
|
35
35
|
"peerDependencies": {
|
|
36
|
-
"@aomex/core": "^0.0.
|
|
36
|
+
"@aomex/core": "^0.0.4"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@aomex/helper": "^0.0.
|
|
39
|
+
"@aomex/helper": "^0.0.2",
|
|
40
40
|
"cosmiconfig": "^8.0.0",
|
|
41
41
|
"yargs": "^17.6.2",
|
|
42
42
|
"yargs-parser": "^21.1.1"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
+
"@aomex/core": "^0.0.4",
|
|
45
46
|
"@types/yargs": "^17.0.22",
|
|
46
47
|
"@types/yargs-parser": "^21.0.0",
|
|
47
|
-
"@aomex/core": "^0.0.2",
|
|
48
48
|
"read-pkg-up": "^9.1.0"
|
|
49
49
|
},
|
|
50
50
|
"scripts": {}
|