fix: added enum flag

Author: jdx

package.json

@@ -11,10 +11,10 @@
     "tslib": "^1.9.0"
   },
   "devDependencies": {
+    "@anycli/config": "^0.2.1",
+    "@anycli/tslint": "^0.2.0",
     "@commitlint/cli": "^6.0.2",
-    "@commitlint/config-conventional": "^6.0.2",
-    "@anycli/config": "^0.1.40",
-    "@anycli/tslint": "^0.1.3",
+    "@commitlint/config-conventional": "^6.0.3",
     "@types/chai": "^4.1.2",
     "@types/lodash": "^4.14.98",
     "@types/mocha": "^2.2.47",
@@ -23,9 +23,9 @@
     "@types/node-notifier": "^0.0.28",
     "@types/read-pkg": "^3.0.0",
     "chai": "^4.1.2",
-    "cli-ux": "^3.3.8",
+    "cli-ux": "^3.3.9",
     "eslint": "^4.16.0",
-    "eslint-config-anycli": "^1.2.1",
+    "eslint-config-anycli": "^1.3.0",
     "fancy-test": "^0.6.5",
     "http-call": "^5.0.2",
     "husky": "^0.14.3",
@@ -36,7 +36,7 @@
     "nps-utils": "^1.5.0",
     "ts-node": "^4.1.0",
     "typedoc": "^0.9.0",
-    "typescript": "^2.6.2"
+    "typescript": "^2.7.1"
   },
   "engines": {
     "node": ">=8.0.0"

src/command.ts

@@ -48,21 +48,21 @@ export default abstract class Command {
     return convertToCached(this, opts)
   }
 
-  config: Config.IConfig
-  argv: string[]
-  flags: flags.Output
-  args: args.Output
+  config!: Config.IConfig
+  argv!: string[]
+  flags!: flags.Output
+  args!: args.Output
 
   // prevent setting things that need to be static
-  topic: null
-  command: null
-  description: null
-  hidden: null
-  usage: null
-  help: null
-  aliases: null
-
-  protected debug: (...args: any[]) => void
+  description!: null
+  hidden!: null
+  usage!: null
+  aliases!: null
+  title!: null
+  variableArgs!: null
+  examples!: null
+
+  protected debug!: (...args: any[]) => void
 
   get ctor(): typeof Command {
     return this.constructor as typeof Command

src/flags.ts

@@ -38,6 +38,21 @@ export function build<T>(defaults: Partial<IOptionFlag<T>>): Definition<T> {
   return deps.Parser.flags.build<T>(defaults as any)
 }
 
+export function option<T>(options: {parse: IOptionFlag<T>['parse']} & Partial<IOptionFlag<T>>) {
+  return build<T>({optionType: 'custom', ...options})()
+}
+
+const _enum = <T = string>(opts: flags.EnumFlagOptions<T>) => build<T>({
+  parse(input) {
+    if (!opts.options.includes(input)) throw new Error(`Expected --${this.name}=${input} to be one of: ${opts.options.join(', ')}`)
+    return input
+  },
+  helpValue: `(${opts.options.join('|')})`,
+  ...opts as any,
+  optionType: 'enum',
+})
+export {_enum as enum}
+
 const stringFlag = build({})
 export {stringFlag as string}
 export {boolean} from '@anycli/parser/lib/flags'

tsconfig.json

@@ -3,6 +3,7 @@
     "declaration": true,
     "forceConsistentCasingInFileNames": true,
     "importHelpers": true,
+    "pretty": true,
     "module": "commonjs",
     "noUnusedLocals": true,
     "noUnusedParameters": true,

yarn.lock

@@ -2,9 +2,9 @@
 # yarn lockfile v1
 
 
-"@anycli/config@^0.1.40":
-  version "0.1.41"
-  resolved "https://registry.yarnpkg.com/@anycli/config/-/config-0.1.41.tgz#b18b9a6da0202254a5e52991206419188aa75766"
+"@anycli/config@^0.2.1":
+  version "0.2.1"
+  resolved "https://registry.yarnpkg.com/@anycli/config/-/config-0.2.1.tgz#d32fe5036cd194c34ca32ee6bc5e1a4b0ca3c86f"
   dependencies:
     cli-ux "^3.3.8"
     debug "^3.1.0"
@@ -25,12 +25,12 @@
   version "0.0.3"
   resolved "https://registry.yarnpkg.com/@anycli/screen/-/screen-0.0.3.tgz#f0afd970c3ed725702948a45a874ede1fdd9362e"
 
-"@anycli/tslint@^0.1.3":
-  version "0.1.4"
-  resolved "https://registry.yarnpkg.com/@anycli/tslint/-/tslint-0.1.4.tgz#9c8d73e07198633a1afdca69cda4b5b844ab3a72"
+"@anycli/tslint@^0.2.0":
+  version "0.2.0"
+  resolved "https://registry.yarnpkg.com/@anycli/tslint/-/tslint-0.2.0.tgz#192a612e3664f7a18fe6ed693de94de6d4563882"
   dependencies:
     tslint "^5.9.1"
-    tslint-xo "^0.5.0"
+    tslint-xo "^0.6.0"
 
 "@commitlint/cli@^6.0.2":
   version "6.0.2"
@@ -44,9 +44,9 @@
     lodash.pick "4.4.0"
     meow "3.7.0"
 
-"@commitlint/config-conventional@^6.0.2":
-  version "6.0.2"
-  resolved "https://registry.yarnpkg.com/@commitlint/config-conventional/-/config-conventional-6.0.2.tgz#8ef87a6facb75b3377b2760b0e91097f8ec64db4"
+"@commitlint/config-conventional@^6.0.3":
+  version "6.0.3"
+  resolved "https://registry.yarnpkg.com/@commitlint/config-conventional/-/config-conventional-6.0.3.tgz#561aa85e29a719415602aac25535db0e99dea281"
 
 "@commitlint/core@^6.0.2":
   version "6.0.2"
@@ -534,6 +534,26 @@ cli-ux@^3.3.8:
     strip-ansi "^4.0.0"
     supports-color "^5.1.0"
 
+cli-ux@^3.3.9:
+  version "3.3.9"
+  resolved "https://registry.yarnpkg.com/cli-ux/-/cli-ux-3.3.9.tgz#b3d09bb9057d2ef75cfd492d58359dd923c0a16b"
+  dependencies:
+    "@anycli/screen" "^0.0.3"
+    "@heroku/linewrap" "^1.0.0"
+    ansi-styles "^3.2.0"
+    cardinal "^1.0.0"
+    chalk "^2.3.0"
+    clean-stack "^1.3.0"
+    extract-stack "^1.0.0"
+    fs-extra "^5.0.0"
+    indent-string "^3.2.0"
+    lodash "^4.17.4"
+    node-notifier "^5.2.1"
+    password-prompt "^1.0.4"
+    semver "^5.5.0"
+    strip-ansi "^4.0.0"
+    supports-color "^5.1.0"
+
 cli-width@^2.0.0:
   version "2.2.0"
   resolved "https://registry.yarnpkg.com/cli-width/-/cli-width-2.2.0.tgz#ff19ede8a9a5e579324147b0c11f0fbcbabed639"
@@ -823,11 +843,12 @@ eslint-ast-utils@^1.0.0:
     lodash.get "^4.4.2"
     lodash.zip "^4.2.0"
 
-eslint-config-anycli@^1.2.1:
-  version "1.2.2"
-  resolved "https://registry.yarnpkg.com/eslint-config-anycli/-/eslint-config-anycli-1.2.2.tgz#8d52cf3594056944918806b6e3003ba3228a800b"
+eslint-config-anycli@^1.3.0:
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/eslint-config-anycli/-/eslint-config-anycli-1.3.0.tgz#35f970a1b382aa5ebe1353b96a6855461b4a1de0"
   dependencies:
     eslint-config-xo-space "^0.17.0"
+    eslint-plugin-mocha "^4.11.0"
     eslint-plugin-node "^5.2.1"
     eslint-plugin-unicorn "^3.0.1"
 
@@ -841,6 +862,12 @@ eslint-config-xo@^0.18.0:
   version "0.18.2"
   resolved "https://registry.yarnpkg.com/eslint-config-xo/-/eslint-config-xo-0.18.2.tgz#0a157120875619929e735ffd6b185c41e8a187af"
 
+eslint-plugin-mocha@^4.11.0:
+  version "4.11.0"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-mocha/-/eslint-plugin-mocha-4.11.0.tgz#91193a2f55e20a5e35974054a0089d30198ee578"
+  dependencies:
+    ramda "^0.24.1"
+
 eslint-plugin-node@^5.2.1:
   version "5.2.1"
   resolved "https://registry.yarnpkg.com/eslint-plugin-node/-/eslint-plugin-node-5.2.1.tgz#80df3253c4d7901045ec87fa660a284e32bdca29"
@@ -2029,6 +2056,10 @@ qs@^6.5.1:
   version "6.5.1"
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.1.tgz#349cdf6eef89ec45c12d7d5eb3fc0c870343a6d8"
 
+ramda@^0.24.1:
+  version "0.24.1"
+  resolved "https://registry.yarnpkg.com/ramda/-/ramda-0.24.1.tgz#c3b7755197f35b8dc3502228262c4c91ddb6b857"
+
 read-pkg-up@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/read-pkg-up/-/read-pkg-up-1.0.1.tgz#9d63c13276c065918d57f002a57f40a1b643fb02"
@@ -2529,19 +2560,19 @@ tslint-eslint-rules@^4.1.1:
     tslib "^1.0.0"
     tsutils "^1.4.0"
 
-tslint-microsoft-contrib@^5.0.1:
+tslint-microsoft-contrib@^5.0.2:
   version "5.0.2"
   resolved "https://registry.yarnpkg.com/tslint-microsoft-contrib/-/tslint-microsoft-contrib-5.0.2.tgz#ecc2a797f777a12f0066944cec0c81a9e7c59ee9"
   dependencies:
     tsutils "^2.12.1"
 
-tslint-xo@^0.5.0:
-  version "0.5.0"
-  resolved "https://registry.yarnpkg.com/tslint-xo/-/tslint-xo-0.5.0.tgz#56e591dcd2731de35e7462a0dfa1214731ba9f27"
+tslint-xo@^0.6.0:
+  version "0.6.0"
+  resolved "https://registry.yarnpkg.com/tslint-xo/-/tslint-xo-0.6.0.tgz#95a05b8dcac7aaa1f4d6ca1397a3c4c45a8b848e"
   dependencies:
     tslint-consistent-codestyle "^1.11.0"
     tslint-eslint-rules "^4.1.1"
-    tslint-microsoft-contrib "^5.0.1"
+    tslint-microsoft-contrib "^5.0.2"
 
 tslint@^5.9.1:
   version "5.9.1"
@@ -2628,9 +2659,9 @@ [email protected]:
   version "2.4.1"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.4.1.tgz#c3ccb16ddaa0b2314de031e7e6fee89e5ba346bc"
 
-typescript@^2.6.2:
-  version "2.6.2"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.6.2.tgz#3c5b6fd7f6de0914269027f03c0946758f7673a4"
+typescript@^2.7.1:
+  version "2.7.1"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.7.1.tgz#bb3682c2c791ac90e7c6210b26478a8da085c359"
 
 uglify-js@^2.6:
   version "2.8.29"