oclif / core

Node.js Open CLI Framework. Built by Salesforce.

Home Page:https://oclif.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Arg summary missing in help text

cristiand391 opened this issue · comments

Describe the bug
When defining an arg summary it doesn' show up in help text

To Reproduce

  1. Clone https://github.com/cristiand391/sf-plugin-api
  2. Change description to summary here: https://github.com/cristiand391/sf-plugin-api/blob/11387c27ddf12f8598ba00fcbf29e3da5fd99ff1/src/commands/org/api.ts#L65
  3. run ./bin/dev org api --help

with description:
Screenshot 2023-09-12 at 10 08 41

with summary:
Screenshot 2023-09-12 at 10 09 00

Expected behavior
summary should work, like it does in flags.

Environment (please complete the following information):

  • OS & version: macos ventura
  • Shell/terminal & version: zsh/alacritty

@cristiand391 this does not seem to be a bug because ArgProps do not have a summary attribute

export type ArgProps = {
name: string
/**
* A description of flag usage. If summary is provided, the description
* is assumed to be a longer description and will be shown in a separate
* section within help.
*/
description?: string
/**
* If true, the flag will not be shown in the help.
*/
hidden?: boolean
/**
* If true, the flag will be required.
*/
required?: boolean
options?: string[]
ignoreStdin?: boolean
/**
* If true, the value returned by defaultHelp will not be cached in the oclif.manifest.json.
* This is helpful if the default value contains sensitive data that shouldn't be published to npm.
*/
noCacheDefault?: boolean
}