Skip to content

指令路由

像写接口一样写指令!

使用

typescript
// src/cli.ts
import { commanders, ConsoleApp } from '@aomex/console';

const app = new ConsoleApp({
  mount: commanders('./src/commanders'),
});

第一个指令

typescript
// src/commanders/say.ts
import { Commander } from '@aomex/console';

export const commander = new Commander();

commander.create('say', {
  action: (ctx) => {
    console.log('Hello World');
  },
});

在终端执行这个指令看看会输出什么:

bash
npx aomex say

不出意外的话,终端打印了一行文字:Hello World

快速查看指令

我们不妨先补充一下路由的说明文档

typescript
// src/commanders/say.ts
import { Commander } from '@aomex/console';

export const commander = new Commander();

commander.create('say', {
  docs: {
    summary: '打招呼',
    description: '打招呼详情',
  },
  action: (ctx) => {
    console.log('Hello World');
  },
});

接着执行npx aomex -h,可以看到下面一段文字

txt
aomex [指令] [选项]

命令:
  aomex say  打招呼

选项:
  -v, --version  显示aomex版本号     [布尔]
  -h, --help     显示帮助信息         [布尔]