Merge pull request #1212 from oclif/mdonnalley/respect-no-cache-defau…

…lt-help fix: add respectNoCacheDefault to help options
oclif · Oct 3, 2024 · f335853 · f335853
2 parents 9ccba39 + 7320fff
commit f335853
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/help/command.ts b/src/help/command.ts
@@ -188,7 +188,8 @@ export class CommandHelp extends HelpFormatter {
       if (noChar) left = left.replace('    ', '')
 
       let right = flag.summary || flag.description || ''
-      if (flag.type === 'option' && flag.default) {
+      const canBeCached = !(this.opts.respectNoCacheDefault === true && flag.noCacheDefault === true)
+      if (flag.type === 'option' && flag.default && canBeCached) {
         right = `${colorize(this.config?.theme?.flagDefaultValue, `[default: ${flag.default}]`)} ${right}`
       }
 

diff --git a/src/interfaces/help.ts b/src/interfaces/help.ts
@@ -24,6 +24,10 @@ export interface HelpOptions {
    */
   hideCommandSummaryInDescription?: boolean
   maxWidth: number
+  /**
+   * Respect the `noCacheDefault` property on flags. Defaults to false.
+   */
+  respectNoCacheDefault?: boolean
   /**
    * Only show the help for the specified sections. Defaults to all sections.
    */