@clerc/plugin-help 0.41.0 → 0.42.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Ray <https://github.com/so1ve>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Ray <https://github.com/so1ve>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -55,8 +55,8 @@ const primitiveMap = /* @__PURE__ */ new Map([
   [Number, "number"]
 ]);
 function stringifyType(type, hasDefault = false) {
-  const res = primitiveMap.has(type) ? primitiveMap.get(type) : "value";
-  return res ? hasDefault ? `[${res}]` : `<${res}>` : "";
+  const result = primitiveMap.has(type) ? primitiveMap.get(type) : "value";
+  return result ? hasDefault ? `[${result}]` : `<${result}>` : "";
 }
 function sortName(a, b) {
   if (a === Root) {
@@ -161,8 +161,8 @@ const defaultRenderers = {
   renderDefault: JSON.stringify
 };
 
-function generateHelp(render2, ctx, notes, examples, _renderers) {
-  const { cli } = ctx;
+function generateHelp(render2, context, notes, examples, _renderers) {
+  const { cli } = context;
   const { t } = cli.i18n;
   let sections = [];
   const renderers = Object.assign(
@@ -177,13 +177,13 @@ function generateHelp(render2, ctx, notes, examples, _renderers) {
       yc.magenta(
         `$ ${cli._scriptName} ${withBrackets(
           "command",
-          ctx.hasRootOrAlias
+          context.hasRootOrAlias
         )} [flags]`
       )
     ]
   });
   const commands = [
-    ...ctx.hasRoot ? [cli._commands[Root]] : [],
+    ...context.hasRoot ? [cli._commands[Root]] : [],
     ...Object.values(cli._commands)
   ].map((command) => {
     var _a;
@@ -220,9 +220,9 @@ function generateHelp(render2, ctx, notes, examples, _renderers) {
   sections = renderers.renderSections(sections);
   return render2(sections);
 }
-function generateSubcommandHelp(render2, ctx, command) {
+function generateSubcommandHelp(render2, context, command) {
   var _a, _b, _c, _d, _e, _f;
-  const { cli } = ctx;
+  const { cli } = context;
   const { t } = cli.i18n;
   const [subcommand] = resolveCommandStrict(cli._commands, command, t);
   if (!subcommand) {
@@ -314,13 +314,19 @@ const helpPlugin = ({
             ]
           ]
         }
-      }).on("help", (ctx) => {
-        if (ctx.parameters.command.length > 0) {
+      }).on("help", (context) => {
+        if (context.parameters.command.length > 0) {
           printHelp(
-            generateSubcommandHelp(render, ctx, ctx.parameters.command)
+            generateSubcommandHelp(
+              render,
+              context,
+              context.parameters.command
+            )
           );
         } else {
-          printHelp(generateHelp(render, ctx, notes, examples, renderers));
+          printHelp(
+            generateHelp(render, context, notes, examples, renderers)
+          );
         }
       });
     }
@@ -331,34 +337,38 @@ const helpPlugin = ({
         default: false
       });
     }
-    cli.inspector((ctx, next) => {
-      const shouldShowHelp = ctx.flags.help;
-      if (!ctx.hasRootOrAlias && ctx.raw._.length === 0 && showHelpWhenNoCommand && !shouldShowHelp) {
-        let str = `${t("core.noCommandGiven")}
+    cli.inspector((context, next) => {
+      const shouldShowHelp = context.flags.help;
+      if (!context.hasRootOrAlias && context.raw._.length === 0 && showHelpWhenNoCommand && !shouldShowHelp) {
+        let string_ = `${t("core.noCommandGiven")}
 
 `;
-        str += generateHelp(render, ctx, notes, examples, renderers);
-        str += "\n";
-        printHelp(str);
+        string_ += generateHelp(render, context, notes, examples, renderers);
+        string_ += "\n";
+        printHelp(string_);
         process.exit(1);
       } else if (shouldShowHelp) {
-        if (ctx.raw._.length > 0) {
-          if (ctx.called === Root) {
-            printHelp(generateSubcommandHelp(render, ctx, ctx.raw._));
+        if (context.raw._.length > 0) {
+          if (context.called === Root) {
+            printHelp(generateSubcommandHelp(render, context, context.raw._));
           } else {
-            if (ctx.name === Root) {
+            if (context.name === Root) {
               printHelp(
-                generateHelp(render, ctx, notes, examples, renderers)
+                generateHelp(render, context, notes, examples, renderers)
               );
             } else {
-              printHelp(generateSubcommandHelp(render, ctx, ctx.raw._));
+              printHelp(
+                generateSubcommandHelp(render, context, context.raw._)
+              );
             }
           }
         } else {
-          if (ctx.hasRootOrAlias) {
-            printHelp(generateSubcommandHelp(render, ctx, Root));
+          if (context.hasRootOrAlias) {
+            printHelp(generateSubcommandHelp(render, context, Root));
           } else {
-            printHelp(generateHelp(render, ctx, notes, examples, renderers));
+            printHelp(
+              generateHelp(render, context, notes, examples, renderers)
+            );
           }
         }
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-help",
-  "version": "0.41.0",
+  "version": "0.42.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc plugin help",
@@ -13,14 +13,14 @@
     "cli",
     "terminal"
   ],
-  "homepage": "https://github.com/so1ve/clerc/tree/main/packages/plugin-help#readme",
+  "homepage": "https://github.com/clercjs/clerc/tree/main/packages/plugin-help#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/so1ve/clerc.git",
+    "url": "git+https://github.com/clercjs/clerc.git",
     "directory": "/"
   },
   "bugs": {
-    "url": "https://github.com/so1ve/clerc/issues"
+    "url": "https://github.com/clercjs/clerc/issues"
   },
   "license": "MIT",
   "sideEffects": false,
@@ -52,7 +52,7 @@
     "string-width": "^6.1.0",
     "text-table": "^0.2.0",
     "yoctocolors": "^1.0.0",
-    "@clerc/utils": "0.41.0"
+    "@clerc/utils": "0.42.0"
   },
   "peerDependencies": {
     "@clerc/core": "*"