@clerc/plugin-help 0.42.0 → 0.42.1

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.
Files changed (2) hide show
  1. package/dist/index.js +28 -38
  2. package/package.json +2 -2
package/dist/index.js CHANGED
@@ -55,8 +55,8 @@ const primitiveMap = /* @__PURE__ */ new Map([
55
55
  [Number, "number"]
56
56
  ]);
57
57
  function stringifyType(type, hasDefault = false) {
58
- const result = primitiveMap.has(type) ? primitiveMap.get(type) : "value";
59
- return result ? hasDefault ? `[${result}]` : `<${result}>` : "";
58
+ const res = primitiveMap.has(type) ? primitiveMap.get(type) : "value";
59
+ return res ? hasDefault ? `[${res}]` : `<${res}>` : "";
60
60
  }
61
61
  function sortName(a, b) {
62
62
  if (a === Root) {
@@ -161,8 +161,8 @@ const defaultRenderers = {
161
161
  renderDefault: JSON.stringify
162
162
  };
163
163
 
164
- function generateHelp(render2, context, notes, examples, _renderers) {
165
- const { cli } = context;
164
+ function generateHelp(render2, ctx, notes, examples, _renderers) {
165
+ const { cli } = ctx;
166
166
  const { t } = cli.i18n;
167
167
  let sections = [];
168
168
  const renderers = Object.assign(
@@ -177,13 +177,13 @@ function generateHelp(render2, context, notes, examples, _renderers) {
177
177
  yc.magenta(
178
178
  `$ ${cli._scriptName} ${withBrackets(
179
179
  "command",
180
- context.hasRootOrAlias
180
+ ctx.hasRootOrAlias
181
181
  )} [flags]`
182
182
  )
183
183
  ]
184
184
  });
185
185
  const commands = [
186
- ...context.hasRoot ? [cli._commands[Root]] : [],
186
+ ...ctx.hasRoot ? [cli._commands[Root]] : [],
187
187
  ...Object.values(cli._commands)
188
188
  ].map((command) => {
189
189
  var _a;
@@ -220,9 +220,9 @@ function generateHelp(render2, context, notes, examples, _renderers) {
220
220
  sections = renderers.renderSections(sections);
221
221
  return render2(sections);
222
222
  }
223
- function generateSubcommandHelp(render2, context, command) {
223
+ function generateSubcommandHelp(render2, ctx, command) {
224
224
  var _a, _b, _c, _d, _e, _f;
225
- const { cli } = context;
225
+ const { cli } = ctx;
226
226
  const { t } = cli.i18n;
227
227
  const [subcommand] = resolveCommandStrict(cli._commands, command, t);
228
228
  if (!subcommand) {
@@ -314,19 +314,13 @@ const helpPlugin = ({
314
314
  ]
315
315
  ]
316
316
  }
317
- }).on("help", (context) => {
318
- if (context.parameters.command.length > 0) {
317
+ }).on("help", (ctx) => {
318
+ if (ctx.parameters.command.length > 0) {
319
319
  printHelp(
320
- generateSubcommandHelp(
321
- render,
322
- context,
323
- context.parameters.command
324
- )
320
+ generateSubcommandHelp(render, ctx, ctx.parameters.command)
325
321
  );
326
322
  } else {
327
- printHelp(
328
- generateHelp(render, context, notes, examples, renderers)
329
- );
323
+ printHelp(generateHelp(render, ctx, notes, examples, renderers));
330
324
  }
331
325
  });
332
326
  }
@@ -337,38 +331,34 @@ const helpPlugin = ({
337
331
  default: false
338
332
  });
339
333
  }
340
- cli.inspector((context, next) => {
341
- const shouldShowHelp = context.flags.help;
342
- if (!context.hasRootOrAlias && context.raw._.length === 0 && showHelpWhenNoCommand && !shouldShowHelp) {
343
- let string_ = `${t("core.noCommandGiven")}
334
+ cli.inspector((ctx, next) => {
335
+ const shouldShowHelp = ctx.flags.help;
336
+ if (!ctx.hasRootOrAlias && ctx.raw._.length === 0 && showHelpWhenNoCommand && !shouldShowHelp) {
337
+ let str = `${t("core.noCommandGiven")}
344
338
 
345
339
  `;
346
- string_ += generateHelp(render, context, notes, examples, renderers);
347
- string_ += "\n";
348
- printHelp(string_);
340
+ str += generateHelp(render, ctx, notes, examples, renderers);
341
+ str += "\n";
342
+ printHelp(str);
349
343
  process.exit(1);
350
344
  } else if (shouldShowHelp) {
351
- if (context.raw._.length > 0) {
352
- if (context.called === Root) {
353
- printHelp(generateSubcommandHelp(render, context, context.raw._));
345
+ if (ctx.raw._.length > 0) {
346
+ if (ctx.called === Root) {
347
+ printHelp(generateSubcommandHelp(render, ctx, ctx.raw._));
354
348
  } else {
355
- if (context.name === Root) {
349
+ if (ctx.name === Root) {
356
350
  printHelp(
357
- generateHelp(render, context, notes, examples, renderers)
351
+ generateHelp(render, ctx, notes, examples, renderers)
358
352
  );
359
353
  } else {
360
- printHelp(
361
- generateSubcommandHelp(render, context, context.raw._)
362
- );
354
+ printHelp(generateSubcommandHelp(render, ctx, ctx.raw._));
363
355
  }
364
356
  }
365
357
  } else {
366
- if (context.hasRootOrAlias) {
367
- printHelp(generateSubcommandHelp(render, context, Root));
358
+ if (ctx.hasRootOrAlias) {
359
+ printHelp(generateSubcommandHelp(render, ctx, Root));
368
360
  } else {
369
- printHelp(
370
- generateHelp(render, context, notes, examples, renderers)
371
- );
361
+ printHelp(generateHelp(render, ctx, notes, examples, renderers));
372
362
  }
373
363
  }
374
364
  } else {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@clerc/plugin-help",
3
- "version": "0.42.0",
3
+ "version": "0.42.1",
4
4
  "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
5
5
  "type": "module",
6
6
  "description": "Clerc plugin help",
@@ -52,7 +52,7 @@
52
52
  "string-width": "^6.1.0",
53
53
  "text-table": "^0.2.0",
54
54
  "yoctocolors": "^1.0.0",
55
- "@clerc/utils": "0.42.0"
55
+ "@clerc/utils": "0.42.1"
56
56
  },
57
57
  "peerDependencies": {
58
58
  "@clerc/core": "*"