@clerc/plugin-help 0.22.1 → 0.24.0

package/dist/index.d.ts

@@ -24,7 +24,11 @@ interface HelpPluginOptions {
      * Banner
      */
     banner?: string;
+    /**
+     * Render type
+     */
+    renderer?: "cliffy" | "typer";
 }
-declare const helpPlugin: ({ command, showHelpWhenNoCommand, notes, examples, banner, }?: HelpPluginOptions) => _clerc_core.Plugin<Clerc<{}>, Clerc<{}>>;
+declare const helpPlugin: ({ command, showHelpWhenNoCommand, notes, examples, banner, renderer, }?: HelpPluginOptions) => _clerc_core.Plugin<Clerc<{}>, Clerc<{}>>;
 
 export { HelpPluginOptions, helpPlugin };

package/dist/index.js

@@ -1,6 +1,7 @@
 import { definePlugin, Root, withBrackets, resolveCommand, NoSuchCommandError, formatCommandName } from '@clerc/core';
 import { toArray, gracefulFlagName } from '@clerc/utils';
 import pc from 'picocolors';
+import boxen from 'boxen';
 import getFuncName from 'get-func-name';
 import { Table } from '@clerc/toolkit';
 
@@ -35,7 +36,7 @@ const stringifyType = (type) => {
   return Array.isArray(type) ? `Array<${getFuncName(type[0])}>` : getFuncName(type);
 };
 
-const render = (sections) => {
+const renderCliffy = (sections) => {
   const rendered = [];
   for (const section of sections) {
     if (section.type === "block" || !section.type) {
@@ -43,7 +44,25 @@ const render = (sections) => {
       const formattedBody = section.body.map((line) => indent + line);
       formattedBody.unshift("");
       const body = formattedBody.join("\n");
-      rendered.push(table([pc.bold(section.title)], [body]).toString());
+      rendered.push(table([pc.bold(`${section.title}:`)], [body]).toString());
+    } else if (section.type === "inline") {
+      const formattedBody = section.items.map((item) => [pc.bold(item.title), item.body]);
+      const tableGenerated = table(...formattedBody);
+      rendered.push(tableGenerated.toString());
+    }
+    rendered.push("");
+  }
+  return rendered.join("\n");
+};
+const renderTyper = (sections) => {
+  const rendered = [];
+  for (const section of sections) {
+    if (section.type === "block" || !section.type) {
+      rendered.push(boxen(section.body.join("\n\n"), {
+        title: section.title,
+        borderStyle: "round",
+        padding: 0.5
+      }));
     } else if (section.type === "inline") {
       const formattedBody = section.items.map((item) => [pc.bold(item.title), item.body]);
       const tableGenerated = table(...formattedBody);
@@ -58,13 +77,13 @@ const DELIMITER = pc.yellow("-");
 const NO_DESCRIPTION = "(No description)";
 const NAME = "Name:";
 const VERSION = "Version:";
-const COMMANDS = "Commands:";
-const SUBCOMMAND = "Subcommand:";
-const FLAGS = "Flags:";
-const DESCRIPTION = "Description:";
-const USAGE = "Usage:";
-const EXAMPLES = "Examples:";
-const NOTES = "Notes:";
+const COMMANDS = "Commands";
+const SUBCOMMAND = "Subcommand";
+const FLAGS = "Flags";
+const DESCRIPTION = "Description";
+const USAGE = "Usage";
+const EXAMPLES = "Examples";
+const NOTES = "Notes";
 const print = (s) => {
   process.stdout.write(s);
 };
@@ -101,7 +120,7 @@ const generateExamples = (sections, examples) => {
     body: splitTable(...examplesFormatted)
   });
 };
-const generateHelp = (ctx, notes, examples) => {
+const generateHelp = (render, ctx, notes, examples) => {
   const { cli } = ctx;
   const sections = [];
   generateCliDetail(sections, cli);
@@ -138,7 +157,7 @@ const generateHelp = (ctx, notes, examples) => {
   }
   return render(sections);
 };
-const generateSubcommandHelp = (ctx, command) => {
+const generateSubcommandHelp = (render, ctx, command) => {
   var _a;
   const { cli } = ctx;
   const subcommand = resolveCommand(cli._commands, command);
@@ -191,9 +210,11 @@ const helpPlugin = ({
   showHelpWhenNoCommand = true,
   notes,
   examples,
-  banner
+  banner,
+  renderer
 } = {}) => definePlugin({
   setup: (cli) => {
+    const render = renderer === "cliffy" || !renderer ? renderCliffy : renderTyper;
     const printHelp = (s) => {
       banner && print(`${banner}
 `);
@@ -216,9 +237,9 @@ const helpPlugin = ({
         ]
       }).on("help", (ctx) => {
         if (ctx.parameters.command.length) {
-          printHelp(generateSubcommandHelp(ctx, ctx.parameters.command));
+          printHelp(generateSubcommandHelp(render, ctx, ctx.parameters.command));
         } else {
-          printHelp(generateHelp(ctx, notes, examples));
+          printHelp(generateHelp(render, ctx, notes, examples));
         }
       });
     }
@@ -226,7 +247,7 @@ const helpPlugin = ({
       const helpFlag = ctx.raw.mergedFlags.h || ctx.raw.mergedFlags.help;
       if (!ctx.hasRootOrAlias && !ctx.raw._.length && showHelpWhenNoCommand && !helpFlag) {
         let str = "No command given.\n\n";
-        str += generateHelp(ctx, notes, examples);
+        str += generateHelp(render, ctx, notes, examples);
         str += "\n";
         printHelp(str);
         process.exit(1);
@@ -234,13 +255,13 @@ const helpPlugin = ({
         if (ctx.raw._.length) {
           if (ctx.called !== Root) {
             if (ctx.name === Root) {
-              printHelp(generateHelp(ctx, notes, examples));
+              printHelp(generateHelp(render, ctx, notes, examples));
             } else {
-              printHelp(generateSubcommandHelp(ctx, ctx.raw._));
+              printHelp(generateSubcommandHelp(render, ctx, ctx.raw._));
             }
           }
         } else {
-          printHelp(generateHelp(ctx, notes, examples));
+          printHelp(generateHelp(render, ctx, notes, examples));
         }
       } else {
         next();

package/dist/index.mjs

@@ -1,6 +1,7 @@
 import { definePlugin, Root, withBrackets, resolveCommand, NoSuchCommandError, formatCommandName } from '@clerc/core';
 import { toArray, gracefulFlagName } from '@clerc/utils';
 import pc from 'picocolors';
+import boxen from 'boxen';
 import getFuncName from 'get-func-name';
 import { Table } from '@clerc/toolkit';
 
@@ -35,7 +36,7 @@ const stringifyType = (type) => {
   return Array.isArray(type) ? `Array<${getFuncName(type[0])}>` : getFuncName(type);
 };
 
-const render = (sections) => {
+const renderCliffy = (sections) => {
   const rendered = [];
   for (const section of sections) {
     if (section.type === "block" || !section.type) {
@@ -43,7 +44,25 @@ const render = (sections) => {
       const formattedBody = section.body.map((line) => indent + line);
       formattedBody.unshift("");
       const body = formattedBody.join("\n");
-      rendered.push(table([pc.bold(section.title)], [body]).toString());
+      rendered.push(table([pc.bold(`${section.title}:`)], [body]).toString());
+    } else if (section.type === "inline") {
+      const formattedBody = section.items.map((item) => [pc.bold(item.title), item.body]);
+      const tableGenerated = table(...formattedBody);
+      rendered.push(tableGenerated.toString());
+    }
+    rendered.push("");
+  }
+  return rendered.join("\n");
+};
+const renderTyper = (sections) => {
+  const rendered = [];
+  for (const section of sections) {
+    if (section.type === "block" || !section.type) {
+      rendered.push(boxen(section.body.join("\n\n"), {
+        title: section.title,
+        borderStyle: "round",
+        padding: 0.5
+      }));
     } else if (section.type === "inline") {
       const formattedBody = section.items.map((item) => [pc.bold(item.title), item.body]);
       const tableGenerated = table(...formattedBody);
@@ -58,13 +77,13 @@ const DELIMITER = pc.yellow("-");
 const NO_DESCRIPTION = "(No description)";
 const NAME = "Name:";
 const VERSION = "Version:";
-const COMMANDS = "Commands:";
-const SUBCOMMAND = "Subcommand:";
-const FLAGS = "Flags:";
-const DESCRIPTION = "Description:";
-const USAGE = "Usage:";
-const EXAMPLES = "Examples:";
-const NOTES = "Notes:";
+const COMMANDS = "Commands";
+const SUBCOMMAND = "Subcommand";
+const FLAGS = "Flags";
+const DESCRIPTION = "Description";
+const USAGE = "Usage";
+const EXAMPLES = "Examples";
+const NOTES = "Notes";
 const print = (s) => {
   process.stdout.write(s);
 };
@@ -101,7 +120,7 @@ const generateExamples = (sections, examples) => {
     body: splitTable(...examplesFormatted)
   });
 };
-const generateHelp = (ctx, notes, examples) => {
+const generateHelp = (render, ctx, notes, examples) => {
   const { cli } = ctx;
   const sections = [];
   generateCliDetail(sections, cli);
@@ -138,7 +157,7 @@ const generateHelp = (ctx, notes, examples) => {
   }
   return render(sections);
 };
-const generateSubcommandHelp = (ctx, command) => {
+const generateSubcommandHelp = (render, ctx, command) => {
   var _a;
   const { cli } = ctx;
   const subcommand = resolveCommand(cli._commands, command);
@@ -191,9 +210,11 @@ const helpPlugin = ({
   showHelpWhenNoCommand = true,
   notes,
   examples,
-  banner
+  banner,
+  renderer
 } = {}) => definePlugin({
   setup: (cli) => {
+    const render = renderer === "cliffy" || !renderer ? renderCliffy : renderTyper;
     const printHelp = (s) => {
       banner && print(`${banner}
 `);
@@ -216,9 +237,9 @@ const helpPlugin = ({
         ]
       }).on("help", (ctx) => {
         if (ctx.parameters.command.length) {
-          printHelp(generateSubcommandHelp(ctx, ctx.parameters.command));
+          printHelp(generateSubcommandHelp(render, ctx, ctx.parameters.command));
         } else {
-          printHelp(generateHelp(ctx, notes, examples));
+          printHelp(generateHelp(render, ctx, notes, examples));
         }
       });
     }
@@ -226,7 +247,7 @@ const helpPlugin = ({
       const helpFlag = ctx.raw.mergedFlags.h || ctx.raw.mergedFlags.help;
       if (!ctx.hasRootOrAlias && !ctx.raw._.length && showHelpWhenNoCommand && !helpFlag) {
         let str = "No command given.\n\n";
-        str += generateHelp(ctx, notes, examples);
+        str += generateHelp(render, ctx, notes, examples);
         str += "\n";
         printHelp(str);
         process.exit(1);
@@ -234,13 +255,13 @@ const helpPlugin = ({
         if (ctx.raw._.length) {
           if (ctx.called !== Root) {
             if (ctx.name === Root) {
-              printHelp(generateHelp(ctx, notes, examples));
+              printHelp(generateHelp(render, ctx, notes, examples));
             } else {
-              printHelp(generateSubcommandHelp(ctx, ctx.raw._));
+              printHelp(generateSubcommandHelp(render, ctx, ctx.raw._));
             }
           }
         } else {
-          printHelp(generateHelp(ctx, notes, examples));
+          printHelp(generateHelp(render, ctx, notes, examples));
         }
       } else {
         next();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-help",
-  "version": "0.22.1",
+  "version": "0.24.0",
   "author": "Ray <nn_201312@163.com> (https://github.com/so1ve)",
   "description": "Clerc plugin help",
   "keywords": [
@@ -51,13 +51,14 @@
     "@clerc/core": "*"
   },
   "dependencies": {
+    "boxen": "^7.0.1",
     "get-func-name": "^2.0.0",
     "picocolors": "^1.0.0",
-    "@clerc/toolkit": "0.22.1",
-    "@clerc/utils": "0.22.1"
+    "@clerc/toolkit": "0.24.0",
+    "@clerc/utils": "0.24.0"
   },
   "devDependencies": {
-    "@clerc/core": "0.22.1"
+    "@clerc/core": "0.24.0"
   },
   "scripts": {
     "build": "puild",