feat: custom builtin command help

yjl9903 · Mar 27, 2023 · ff5ec6e · ff5ec6e
1 parent 30deba0
commit ff5ec6e
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 8 deletions.
diff --git a/packages/breadc/src/breadc.ts b/packages/breadc/src/breadc.ts
@@ -9,10 +9,15 @@ import { makeHelpCommand, makeVersionCommand } from './builtin';
 export function breadc(name: string, config: AppOption = {}) {
   let defaultCommand: Command | undefined = undefined;
   const allCommands: Command[] = [];
-  const globalOptions: Option[] = [
-    makeHelpCommand(name, config, allCommands),
-    makeVersionCommand(name, config)
-  ];
+  const globalOptions: Option[] = [];
+
+  if (config.builtin?.version !== false) {
+    globalOptions.push(makeVersionCommand(name, config));
+  }
+  if (config.builtin?.help !== false) {
+    globalOptions.push(makeHelpCommand(name, config, allCommands));
+  }
+
   const container = makePluginContainer(config.plugins);
 
   const root = makeTreeNode({

diff --git a/packages/breadc/src/builtin.ts b/packages/breadc/src/builtin.ts
@@ -5,13 +5,24 @@ import { makeTreeNode, TreeNode } from './parser';
 import { AppOption, Command, Option } from './types';
 
 export function makeVersionCommand(name: string, config: AppOption): Option {
+  let description = 'Print version';
+  if (typeof config.builtin?.version === 'object') {
+    if (config.builtin.version.description) {
+      description = config.builtin.version.description;
+    }
+  }
+
   const node = makeTreeNode({
     next() {
       return false;
     },
     finish() {
       return () => {
-        const text = `${name}/${config.version ? config.version : 'unknown'}`;
+        const text =
+          typeof config.builtin?.version === 'object' &&
+          config.builtin.version.content
+            ? config.builtin.version.content
+            : `${name}/${config.version ? config.version : 'unknown'}`;
         console.log(text);
         return text;
       };
@@ -25,7 +36,7 @@ export function makeVersionCommand(name: string, config: AppOption): Option {
     type: 'boolean',
     initial: undefined,
     order: 999999999 + 1,
-    description: 'Print version',
+    description,
     parse() {
       return node;
     }
@@ -93,6 +104,13 @@ export function makeHelpCommand(
     return [...alias.values()];
   }
 
+  let description = 'Print help';
+  if (typeof config.builtin?.help === 'object') {
+    if (config.builtin.help.description) {
+      description = config.builtin.help.description;
+    }
+  }
+
   const node = makeTreeNode({
     next() {
       return false;
@@ -162,7 +180,7 @@ export function makeHelpCommand(
     short: 'h',
     type: 'boolean',
     initial: undefined,
-    description: 'Print help',
+    description,
     order: 999999999,
     parse(cursor, _token, context) {
       context.meta.__cursor__ = cursor;

diff --git a/packages/breadc/src/types/breadc.ts b/packages/breadc/src/types/breadc.ts
@@ -20,7 +20,11 @@ export interface AppOption {
 
   plugins?: Partial<Plugin>[];
 
-  // logger?: Partial<Logger> | LoggerFn;
+  builtin?: {
+    version?: false | Partial<{ description: string; content: string }>;
+
+    help?: false | Partial<{ description: string }>;
+  };
 }
 
 export interface Breadc<GlobalOption extends object = {}> {

diff --git a/packages/breadc/test/command.test.ts b/packages/breadc/test/command.test.ts
@@ -132,6 +132,23 @@ describe('Version Command', () => {
       '"cli/1.0.0"'
     );
   });
+
+  it('should print custom version', async () => {
+    const cli = breadc('cli', {
+      builtin: {
+        version: {
+          content: 'Hello, this is version'
+        }
+      }
+    });
+
+    expect(await cli.run(['-v'])).toMatchInlineSnapshot(
+      '"Hello, this is version"'
+    );
+    expect(await cli.run(['--version'])).toMatchInlineSnapshot(
+      '"Hello, this is version"'
+    );
+  });
 });
 
 describe('Help command', () => {
@@ -358,4 +375,23 @@ describe('Help command', () => {
       "
     `);
   });
+
+  it('should print custom help', async () => {
+    const cli = breadc('cli', {
+      builtin: {
+        version: { description: '输出版本' },
+        help: { description: '输出帮助' }
+      }
+    });
+    expect(await cli.run(['-h'])).toMatchInlineSnapshot(`
+      "cli/unknown
+
+      Usage: cli [OPTIONS]
+
+      Options:
+        -h, --help     输出帮助
+        -v, --version  输出版本
+      "
+    `);
+  });
 });