@aomex/console 0.0.2 → 0.0.3
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 +11 -0
- package/dist/index.d.ts +3 -1
- package/dist/index.js +10 -4
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# @aomex/console
|
|
2
2
|
|
|
3
|
+
## 0.0.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`ee5f8ca`](https://github.com/aomex/aomex/commit/ee5f8ca34df085ab9b5ef2a3525cf361ac46440a) Thanks [@geekact](https://github.com/geekact)! - request.query 重命名为 request.options
|
|
8
|
+
|
|
9
|
+
- [`d06c1c1`](https://github.com/aomex/aomex/commit/d06c1c1bdfee8657a74bbcbb06a2880263e85529) Thanks [@geekact](https://github.com/geekact)! - middleware 增加构造函数
|
|
10
|
+
|
|
11
|
+
- Updated dependencies []:
|
|
12
|
+
- @aomex/core@0.0.3
|
|
13
|
+
|
|
3
14
|
## 0.0.2
|
|
4
15
|
|
|
5
16
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -32,7 +32,7 @@ declare class ConsoleApp extends EventEmitter {
|
|
|
32
32
|
declare class ConsoleRequest {
|
|
33
33
|
readonly app: ConsoleApp;
|
|
34
34
|
readonly argv: string[];
|
|
35
|
-
readonly
|
|
35
|
+
readonly options: Record<string, unknown>;
|
|
36
36
|
readonly command: string;
|
|
37
37
|
constructor(app: ConsoleApp, argv: string[]);
|
|
38
38
|
}
|
|
@@ -66,9 +66,11 @@ declare module '@aomex/core' {
|
|
|
66
66
|
}
|
|
67
67
|
declare class ConsoleMiddleware<Props extends object = object> extends Middleware<Props> {
|
|
68
68
|
protected _console_middleware_: 'console-middleware';
|
|
69
|
+
constructor(fn: (ctx: NonReadonly<Props> & ConsoleContext, next: Next) => any);
|
|
69
70
|
toHelp(yargs: YargsInstance): void;
|
|
70
71
|
}
|
|
71
72
|
declare class HelpMiddleware<Props extends object = object> extends ConsoleMiddleware<Props> {
|
|
73
|
+
constructor(fn: (ctx: NonReadonly<Props> & ShowHelp & ConsoleContext, next: Next) => any);
|
|
72
74
|
}
|
|
73
75
|
|
|
74
76
|
declare const version = "{{#version}}";
|
package/dist/index.js
CHANGED
|
@@ -2,11 +2,17 @@
|
|
|
2
2
|
import { Middleware } from "@aomex/core";
|
|
3
3
|
import assert from "node:assert";
|
|
4
4
|
var ConsoleMiddleware = class extends Middleware {
|
|
5
|
+
constructor(fn) {
|
|
6
|
+
super(fn);
|
|
7
|
+
}
|
|
5
8
|
toHelp(yargs2) {
|
|
6
9
|
assert(yargs2);
|
|
7
10
|
}
|
|
8
11
|
};
|
|
9
12
|
var HelpMiddleware = class extends ConsoleMiddleware {
|
|
13
|
+
constructor(fn) {
|
|
14
|
+
super(fn);
|
|
15
|
+
}
|
|
10
16
|
};
|
|
11
17
|
Middleware.register("console", ConsoleMiddleware);
|
|
12
18
|
Middleware.register("help", HelpMiddleware);
|
|
@@ -39,10 +45,10 @@ var ConsoleRequest = class {
|
|
|
39
45
|
this.app = app;
|
|
40
46
|
this.argv = argv;
|
|
41
47
|
const { _: commands, ...query } = parse(argv);
|
|
42
|
-
this.
|
|
48
|
+
this.options = query;
|
|
43
49
|
this.command = String(commands[0] || "");
|
|
44
50
|
}
|
|
45
|
-
|
|
51
|
+
options;
|
|
46
52
|
command;
|
|
47
53
|
};
|
|
48
54
|
|
|
@@ -59,7 +65,7 @@ import { compose, middleware } from "@aomex/core";
|
|
|
59
65
|
import yargs from "yargs";
|
|
60
66
|
|
|
61
67
|
// src/version.ts
|
|
62
|
-
var version = "0.0.
|
|
68
|
+
var version = "0.0.3";
|
|
63
69
|
|
|
64
70
|
// src/middleware/showHelp.ts
|
|
65
71
|
var scriptName = "aomex";
|
|
@@ -67,7 +73,7 @@ var showHelp = (middlewareList) => {
|
|
|
67
73
|
const composeFn = compose(middlewareList);
|
|
68
74
|
return middleware.console(async (ctx, next) => {
|
|
69
75
|
const {
|
|
70
|
-
request: {
|
|
76
|
+
request: { options: options2, command },
|
|
71
77
|
response
|
|
72
78
|
} = ctx;
|
|
73
79
|
if (command === "") {
|
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/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, MiddlewareFn, 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 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> & ShowHelp & ConsoleContext,\n next: Next,\n ) => any,\n ) {\n super(fn as MiddlewareFn);\n }\n}\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 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 { 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: { 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,kBAA2C;AACpD,OAAO,YAAY;AAsBZ,IAAM,oBAAN,cAEG,WAAkB;AAAA,EAG1B,YACE,IACA;AACA,UAAM,EAAE;AAAA,EACV;AAAA,EAEO,OAAOA,QAA4B;AACxC,WAAOA,MAAK;AAAA,EACd;AACF;AAEO,IAAM,iBAAN,cAEG,kBAAyB;AAAA,EACjC,YACE,IAIA;AACA,UAAM,EAAkB;AAAA,EAC1B;AACF;AAEA,WAAW,SAAS,WAAW,iBAAiB;AAChD,WAAW,SAAS,QAAQ,cAAc;;;ACrD1C,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,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;;;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,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,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"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aomex/console",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"homepage": "https://aomex.js.org",
|
|
34
34
|
"license": "MIT",
|
|
35
35
|
"peerDependencies": {
|
|
36
|
-
"@aomex/core": "^0.0.
|
|
36
|
+
"@aomex/core": "^0.0.3"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
39
|
"@aomex/helper": "^0.0.1",
|
|
@@ -42,9 +42,9 @@
|
|
|
42
42
|
"yargs-parser": "^21.1.1"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
+
"@aomex/core": "^0.0.3",
|
|
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": {}
|