@aomex/console 0.0.4 → 0.0.5
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 +12 -0
- package/dist/index.d.ts +2 -6
- package/dist/index.js +9 -12
- package/dist/index.js.map +1 -1
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @aomex/console
|
|
2
2
|
|
|
3
|
+
## 0.0.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`13033a9`](https://github.com/aomex/aomex/commit/13033a924a2fbfc4c8360bb198f4aa66fa8e4e04) Thanks [@geekact](https://github.com/geekact)! - feat(console): 挂载中间件时检测到链条自动创建分割点
|
|
8
|
+
|
|
9
|
+
- [`146b6b5`](https://github.com/aomex/aomex/commit/146b6b5f09d4b9f557c1771686f3585bebf4cfc9) Thanks [@geekact](https://github.com/geekact)! - refactor(helper): 重命名 color 为 chalk
|
|
10
|
+
|
|
11
|
+
- Updated dependencies [[`146b6b5`](https://github.com/aomex/aomex/commit/146b6b5f09d4b9f557c1771686f3585bebf4cfc9), [`e8dee7c`](https://github.com/aomex/aomex/commit/e8dee7c3f064587cd2afb9cb95ab3341f63ccd27)]:
|
|
12
|
+
- @aomex/helper@0.0.3
|
|
13
|
+
- @aomex/core@0.0.5
|
|
14
|
+
|
|
3
15
|
## 0.0.4
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -17,16 +17,12 @@ declare class ConsoleChain<Props extends object = object> extends Chain<Props> {
|
|
|
17
17
|
}
|
|
18
18
|
|
|
19
19
|
interface ConsoleAppOption {
|
|
20
|
-
/**
|
|
21
|
-
* 中间件链条,被放置到中间件列表最前面,并自动创建分割点。
|
|
22
|
-
*/
|
|
23
|
-
globalChain?: ConsoleChain;
|
|
24
20
|
}
|
|
25
21
|
declare class ConsoleApp extends EventEmitter {
|
|
26
|
-
readonly
|
|
22
|
+
readonly chainPoints: string[];
|
|
27
23
|
protected running: boolean;
|
|
28
24
|
protected readonly tokenList: ConsoleMiddlewareToken[];
|
|
29
|
-
constructor(
|
|
25
|
+
constructor(_options?: ConsoleAppOption);
|
|
30
26
|
/**
|
|
31
27
|
* 执行命令。如果不传参数,则自动从`process.argv`中获取
|
|
32
28
|
*/
|
package/dist/index.js
CHANGED
|
@@ -7,7 +7,7 @@ import { compose, middleware } from "@aomex/core";
|
|
|
7
7
|
import yargs from "yargs";
|
|
8
8
|
|
|
9
9
|
// src/info.ts
|
|
10
|
-
var version = "0.0.
|
|
10
|
+
var version = "0.0.5";
|
|
11
11
|
var scriptName = "aomex";
|
|
12
12
|
|
|
13
13
|
// src/middleware/showHelp.ts
|
|
@@ -113,19 +113,13 @@ var ConsoleResponse = class {
|
|
|
113
113
|
};
|
|
114
114
|
|
|
115
115
|
// src/app/app.ts
|
|
116
|
-
import {
|
|
116
|
+
import { chalk } from "@aomex/helper";
|
|
117
117
|
var ConsoleApp = class extends EventEmitter {
|
|
118
|
-
|
|
118
|
+
chainPoints = [];
|
|
119
119
|
running = false;
|
|
120
|
-
tokenList;
|
|
121
|
-
constructor(
|
|
120
|
+
tokenList = [];
|
|
121
|
+
constructor(_options = {}) {
|
|
122
122
|
super();
|
|
123
|
-
if (options2.globalChain) {
|
|
124
|
-
this.globalChainPoint = Chain2.createPoint(options2.globalChain);
|
|
125
|
-
this.tokenList = [options2.globalChain];
|
|
126
|
-
} else {
|
|
127
|
-
this.tokenList = [];
|
|
128
|
-
}
|
|
129
123
|
}
|
|
130
124
|
/**
|
|
131
125
|
* 执行命令。如果不传参数,则自动从`process.argv`中获取
|
|
@@ -166,10 +160,13 @@ var ConsoleApp = class extends EventEmitter {
|
|
|
166
160
|
log(err) {
|
|
167
161
|
const stack = (err.stack || err.toString()).split(EOL).map((item) => " " + item);
|
|
168
162
|
console.error(
|
|
169
|
-
["",
|
|
163
|
+
["", chalk.red(stack.shift()), stack.join(EOL), ""].join(EOL)
|
|
170
164
|
);
|
|
171
165
|
}
|
|
172
166
|
mount(middleware2) {
|
|
167
|
+
if (middleware2 instanceof Chain2) {
|
|
168
|
+
this.chainPoints.push(Chain2.createPoint(middleware2));
|
|
169
|
+
}
|
|
173
170
|
this.tokenList.push(middleware2);
|
|
174
171
|
}
|
|
175
172
|
};
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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"]}
|
|
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 { ConsoleMiddlewareToken } from '../override/chain';\nimport { showHelp } from '../middleware/showHelp';\nimport { HelpMiddleware } from '../override';\nimport { chalk } from '@aomex/helper';\n\nexport interface ConsoleAppOption {}\n\nexport class ConsoleApp extends EventEmitter {\n public readonly chainPoints: string[] = [];\n protected running: boolean = false;\n protected readonly tokenList: ConsoleMiddlewareToken[] = [];\n\n constructor(_options: ConsoleAppOption = {}) {\n super();\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 ['', chalk.red(stack.shift()), stack.join(EOL), ''].join(EOL),\n );\n }\n\n public mount(middleware: ConsoleMiddlewareToken): void {\n if (middleware instanceof Chain) {\n this.chainPoints.push(Chain.createPoint(middleware));\n }\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;AAIf,IAAM,aAAN,cAAyB,aAAa;AAAA,EAC3B,cAAwB,CAAC;AAAA,EAC/B,UAAmB;AAAA,EACV,YAAsC,CAAC;AAAA,EAE1D,YAAY,WAA6B,CAAC,GAAG;AAC3C,UAAM;AAAA,EACR;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,QAAIA,uBAAsBF,QAAO;AAC/B,WAAK,YAAY,KAAKA,OAAM,YAAYE,WAAU,CAAC;AAAA,IACrD;AACA,SAAK,UAAU,KAAKA,WAAU;AAAA,EAChC;AACF;;;AG9EA,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","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.5",
|
|
4
4
|
"description": "",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -33,16 +33,16 @@
|
|
|
33
33
|
"homepage": "https://aomex.js.org",
|
|
34
34
|
"license": "MIT",
|
|
35
35
|
"peerDependencies": {
|
|
36
|
-
"@aomex/core": "^0.0.
|
|
36
|
+
"@aomex/core": "^0.0.5"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@aomex/helper": "^0.0.
|
|
39
|
+
"@aomex/helper": "^0.0.3",
|
|
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.
|
|
45
|
+
"@aomex/core": "^0.0.5",
|
|
46
46
|
"@types/yargs": "^17.0.22",
|
|
47
47
|
"@types/yargs-parser": "^21.0.0",
|
|
48
48
|
"read-pkg-up": "^9.1.0"
|