feat: added env to flags

src/flags.ts

@@ -10,6 +10,10 @@ export type IFlagBase<T, I> = {
   description?: string
   hidden?: boolean
   required?: boolean
+  /**
+   * also accept an environment variable as input
+   */
+  env?: string
   parse(input: I): T
 }
 

src/parse.ts

@@ -172,12 +172,17 @@ export class Parser<T extends ParserInput, TFlags extends OutputFlags<T['flags']
     }
     for (const k of Object.keys(this.input.flags)) {
       const flag = this.input.flags[k]
-      if (flags[k]) continue
-      if (flag.type !== 'option' || !flag.default) continue
-      if (typeof flag.default === 'function') {
-        flags[k] = flag.default({options: flag, flags})
-      } else {
-        flags[k] = flag.default
+      if (flags[k] || flag.type !== 'option') continue
+      if (flag.env) {
+        let input = process.env[flag.env]
+        if (input) flags[k] = flag.parse(input)
+      }
+      if (!flags[k] && flag.default) {
+        if (typeof flag.default === 'function') {
+          flags[k] = flag.default({options: flag, flags})
+        } else {
+          flags[k] = flag.default
+        }
       }
     }
     return flags

test/parse.test.ts

@@ -371,4 +371,15 @@ See more help with --help`)
       }).to.throw('Expected invalidopt to be one of: myopt, myotheropt')
     })
   })
+
+  describe('env', () => {
+    it('accepts as environment variable', () => {
+      process.env.TEST_FOO = '101'
+      const out = parse([], {
+        flags: {foo: flags.string({env: 'TEST_FOO'})},
+      })
+      expect(out.flags.foo).to.equal('101')
+      delete process.env.TEST_FOO
+    })
+  })
 })