fix: show hidden options in help

Options with `description: false` will now show up help
yargs · Sep 27, 2017 · 31b784e · 31b784e
1 parent d1b23f3
commit 31b784e
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 2 deletions.
diff --git a/lib/usage.js b/lib/usage.js
@@ -138,6 +138,7 @@ module.exports = function usage (yargs, y18n) {
       .concat(Object.keys(demandedOptions))
       .concat(Object.keys(demandedCommands))
       .concat(Object.keys(options.default))
+      .concat(options.hiddenOptions)
       .reduce((acc, key) => {
         if (key !== '_') acc[key] = true
         return acc

diff --git a/test/usage.js b/test/usage.js
@@ -2523,4 +2523,34 @@ describe('usage tests', () => {
       ])
     })
   })
+
+  describe('hidden options', () => {
+    it('--help should not display options without description', () => {
+      const r = checkUsage(() => yargs('--help')
+          .option('someOption')
+          .argv
+        )
+
+      r.logs[0].split('\n').should.deep.equal([
+        'Options:',
+        '  --help     Show help                                                 [boolean]',
+        '  --version  Show version number                                       [boolean]',
+        ''
+      ])
+    })
+    it('--help should display options with description=false', () => {
+      const r = checkUsage(() => yargs('--help')
+          .option('someOption', {description: false})
+          .argv
+        )
+
+      r.logs[0].split('\n').should.deep.equal([
+        'Options:',
+        '  --help        Show help                                              [boolean]',
+        '  --version     Show version number                                    [boolean]',
+        '  --someOption',
+        ''
+      ])
+    })
+  })
 })
diff --git a/test/yargs.js b/test/yargs.js
@@ -246,6 +246,7 @@ describe('yargs dsl tests', () => {
         config: {},
         configObjects: [],
         envPrefix: 'YARGS', // preserved as global
+        hiddenOptions: [],
         demandedCommands: {},
         demandedOptions: {},
         local: [

diff --git a/yargs.js b/yargs.js
@@ -92,7 +92,8 @@ function Yargs (processArgs, cwd, parentRequire) {
 
     const arrayOptions = [
       'array', 'boolean', 'string', 'requiresArg', 'skipValidation',
-      'count', 'normalize', 'number'
+      'count', 'normalize', 'number',
+      'hiddenOptions'
     ]
 
     const objectOptions = [
@@ -644,9 +645,18 @@ function Yargs (processArgs, cwd, parentRequire) {
         self.skipValidation(key)
       }
 
-      const desc = opt.describe || opt.description || opt.desc
+      let desc;
+      if ('describe' in opt) {
+        desc = opt.describe
+      } else if ('description' in opt) {
+        desc = opt.description
+      } else if ('desc' in opt) {
+        desc = opt.desc
+      }
       if (desc) {
         self.describe(key, desc)
+      } else if (desc === false) {
+        options.hiddenOptions.push(key)
       }
 
       if (opt.requiresArg) {