parser.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520
  1. // fancy-pants parsing of argv, originally forked
  2. // from minimist: https://www.npmjs.com/package/minimist
  3. var camelCase = require('camelcase')
  4. var path = require('path')
  5. function increment (orig) {
  6. return orig !== undefined ? orig + 1 : 0
  7. }
  8. module.exports = function (args, opts, y18n) {
  9. if (!opts) opts = {}
  10. var __ = y18n.__
  11. var error = null
  12. var flags = { arrays: {}, bools: {}, strings: {}, counts: {}, normalize: {}, configs: {}, defaulted: {} }
  13. ;[].concat(opts['array']).filter(Boolean).forEach(function (key) {
  14. flags.arrays[key] = true
  15. })
  16. ;[].concat(opts['boolean']).filter(Boolean).forEach(function (key) {
  17. flags.bools[key] = true
  18. })
  19. ;[].concat(opts.string).filter(Boolean).forEach(function (key) {
  20. flags.strings[key] = true
  21. })
  22. ;[].concat(opts.count).filter(Boolean).forEach(function (key) {
  23. flags.counts[key] = true
  24. })
  25. ;[].concat(opts.normalize).filter(Boolean).forEach(function (key) {
  26. flags.normalize[key] = true
  27. })
  28. Object.keys(opts.config).forEach(function (k) {
  29. flags.configs[k] = opts.config[k]
  30. })
  31. var aliases = {}
  32. var newAliases = {}
  33. extendAliases(opts.key)
  34. extendAliases(opts.alias)
  35. extendAliases(opts.default)
  36. var defaults = opts['default'] || {}
  37. Object.keys(defaults).forEach(function (key) {
  38. if (/-/.test(key) && !opts.alias[key]) {
  39. aliases[key] = aliases[key] || []
  40. }
  41. (aliases[key] || []).forEach(function (alias) {
  42. defaults[alias] = defaults[key]
  43. })
  44. })
  45. var argv = { _: [] }
  46. Object.keys(flags.bools).forEach(function (key) {
  47. setArg(key, !(key in defaults) ? false : defaults[key])
  48. setDefaulted(key)
  49. })
  50. var notFlags = []
  51. if (args.indexOf('--') !== -1) {
  52. notFlags = args.slice(args.indexOf('--') + 1)
  53. args = args.slice(0, args.indexOf('--'))
  54. }
  55. for (var i = 0; i < args.length; i++) {
  56. var arg = args[i]
  57. var broken
  58. var key
  59. var letters
  60. var m
  61. var next
  62. var value
  63. // -- seperated by =
  64. if (arg.match(/^--.+=/)) {
  65. // Using [\s\S] instead of . because js doesn't support the
  66. // 'dotall' regex modifier. See:
  67. // http://stackoverflow.com/a/1068308/13216
  68. m = arg.match(/^--([^=]+)=([\s\S]*)$/)
  69. // nargs format = '--f=monkey washing cat'
  70. if (checkAllAliases(m[1], opts.narg)) {
  71. args.splice(i + 1, m[1], m[2])
  72. i = eatNargs(i, m[1], args)
  73. // arrays format = '--f=a b c'
  74. } else if (checkAllAliases(m[1], flags.arrays) && args.length > i + 1) {
  75. args.splice(i + 1, m[1], m[2])
  76. i = eatArray(i, m[1], args)
  77. } else {
  78. setArg(m[1], m[2])
  79. }
  80. } else if (arg.match(/^--no-.+/)) {
  81. key = arg.match(/^--no-(.+)/)[1]
  82. setArg(key, false)
  83. // -- seperated by space.
  84. } else if (arg.match(/^--.+/)) {
  85. key = arg.match(/^--(.+)/)[1]
  86. // nargs format = '--foo a b c'
  87. if (checkAllAliases(key, opts.narg)) {
  88. i = eatNargs(i, key, args)
  89. // array format = '--foo a b c'
  90. } else if (checkAllAliases(key, flags.arrays) && args.length > i + 1) {
  91. i = eatArray(i, key, args)
  92. } else {
  93. next = args[i + 1]
  94. if (next !== undefined && !next.match(/^-/) &&
  95. !checkAllAliases(key, flags.bools) &&
  96. !checkAllAliases(key, flags.counts)) {
  97. setArg(key, next)
  98. i++
  99. } else if (/^(true|false)$/.test(next)) {
  100. setArg(key, next)
  101. i++
  102. } else {
  103. setArg(key, defaultForType(guessType(key, flags)))
  104. }
  105. }
  106. // dot-notation flag seperated by '='.
  107. } else if (arg.match(/^-.\..+=/)) {
  108. m = arg.match(/^-([^=]+)=([\s\S]*)$/)
  109. setArg(m[1], m[2])
  110. // dot-notation flag seperated by space.
  111. } else if (arg.match(/^-.\..+/)) {
  112. next = args[i + 1]
  113. key = arg.match(/^-(.\..+)/)[1]
  114. if (next !== undefined && !next.match(/^-/) &&
  115. !checkAllAliases(key, flags.bools) &&
  116. !checkAllAliases(key, flags.counts)) {
  117. setArg(key, next)
  118. i++
  119. } else {
  120. setArg(key, defaultForType(guessType(key, flags)))
  121. }
  122. } else if (arg.match(/^-[^-]+/)) {
  123. letters = arg.slice(1, -1).split('')
  124. broken = false
  125. for (var j = 0; j < letters.length; j++) {
  126. next = arg.slice(j + 2)
  127. if (letters[j + 1] && letters[j + 1] === '=') {
  128. value = arg.slice(j + 3)
  129. key = letters[j]
  130. // nargs format = '-f=monkey washing cat'
  131. if (checkAllAliases(letters[j], opts.narg)) {
  132. args.splice(i + 1, 0, value)
  133. i = eatNargs(i, key, args)
  134. // array format = '-f=a b c'
  135. } else if (checkAllAliases(key, flags.arrays) && args.length > i + 1) {
  136. args.splice(i + 1, 0, value)
  137. i = eatArray(i, key, args)
  138. } else {
  139. setArg(key, value)
  140. }
  141. broken = true
  142. break
  143. }
  144. if (next === '-') {
  145. setArg(letters[j], next)
  146. continue
  147. }
  148. if (/[A-Za-z]/.test(letters[j]) &&
  149. /-?\d+(\.\d*)?(e-?\d+)?$/.test(next)) {
  150. setArg(letters[j], next)
  151. broken = true
  152. break
  153. }
  154. if (letters[j + 1] && letters[j + 1].match(/\W/)) {
  155. setArg(letters[j], arg.slice(j + 2))
  156. broken = true
  157. break
  158. } else {
  159. setArg(letters[j], defaultForType(guessType(letters[j], flags)))
  160. }
  161. }
  162. key = arg.slice(-1)[0]
  163. if (!broken && key !== '-') {
  164. // nargs format = '-f a b c'
  165. if (checkAllAliases(key, opts.narg)) {
  166. i = eatNargs(i, key, args)
  167. // array format = '-f a b c'
  168. } else if (checkAllAliases(key, flags.arrays) && args.length > i + 1) {
  169. i = eatArray(i, key, args)
  170. } else {
  171. if (args[i + 1] && !/^(-|--)[^-]/.test(args[i + 1]) &&
  172. !checkAllAliases(key, flags.bools) &&
  173. !checkAllAliases(key, flags.counts)) {
  174. setArg(key, args[i + 1])
  175. i++
  176. } else if (args[i + 1] && /true|false/.test(args[i + 1])) {
  177. setArg(key, args[i + 1])
  178. i++
  179. } else {
  180. setArg(key, defaultForType(guessType(key, flags)))
  181. }
  182. }
  183. }
  184. } else {
  185. argv._.push(
  186. flags.strings['_'] || !isNumber(arg) ? arg : Number(arg)
  187. )
  188. }
  189. }
  190. // order of precedence:
  191. // 1. command line arg
  192. // 2. value from config file
  193. // 3. value from env var
  194. // 4. configured default value
  195. applyEnvVars(opts, argv, true) // special case: check env vars that point to config file
  196. setConfig(argv)
  197. applyEnvVars(opts, argv, false)
  198. applyDefaultsAndAliases(argv, aliases, defaults)
  199. Object.keys(flags.counts).forEach(function (key) {
  200. setArg(key, defaults[key])
  201. })
  202. notFlags.forEach(function (key) {
  203. argv._.push(key)
  204. })
  205. // how many arguments should we consume, based
  206. // on the nargs option?
  207. function eatNargs (i, key, args) {
  208. var toEat = checkAllAliases(key, opts.narg)
  209. if (args.length - (i + 1) < toEat) error = Error(__('Not enough arguments following: %s', key))
  210. for (var ii = i + 1; ii < (toEat + i + 1); ii++) {
  211. setArg(key, args[ii])
  212. }
  213. return (i + toEat)
  214. }
  215. // if an option is an array, eat all non-hyphenated arguments
  216. // following it... YUM!
  217. // e.g., --foo apple banana cat becomes ["apple", "banana", "cat"]
  218. function eatArray (i, key, args) {
  219. for (var ii = i + 1; ii < args.length; ii++) {
  220. if (/^-/.test(args[ii])) break
  221. i = ii
  222. setArg(key, args[ii])
  223. }
  224. return i
  225. }
  226. function setArg (key, val) {
  227. unsetDefaulted(key)
  228. // handle parsing boolean arguments --foo=true --bar false.
  229. if (checkAllAliases(key, flags.bools) || checkAllAliases(key, flags.counts)) {
  230. if (typeof val === 'string') val = val === 'true'
  231. }
  232. if (/-/.test(key) && !(aliases[key] && aliases[key].length)) {
  233. var c = camelCase(key)
  234. aliases[key] = [c]
  235. newAliases[c] = true
  236. }
  237. var value = !checkAllAliases(key, flags.strings) && isNumber(val) ? Number(val) : val
  238. if (checkAllAliases(key, flags.counts)) {
  239. value = increment
  240. }
  241. var splitKey = key.split('.')
  242. setKey(argv, splitKey, value)
  243. // alias references an inner-value within
  244. // a dot-notation object. see #279.
  245. if (~key.indexOf('.') && aliases[key]) {
  246. aliases[key].forEach(function (x) {
  247. x = x.split('.')
  248. setKey(argv, x, value)
  249. })
  250. }
  251. ;(aliases[splitKey[0]] || []).forEach(function (x) {
  252. x = x.split('.')
  253. // handle populating dot notation for both
  254. // the key and its aliases.
  255. if (splitKey.length > 1) {
  256. var a = [].concat(splitKey)
  257. a.shift() // nuke the old key.
  258. x = x.concat(a)
  259. }
  260. setKey(argv, x, value)
  261. })
  262. var keys = [key].concat(aliases[key] || [])
  263. for (var i = 0, l = keys.length; i < l; i++) {
  264. if (flags.normalize[keys[i]]) {
  265. keys.forEach(function (key) {
  266. argv.__defineSetter__(key, function (v) {
  267. val = path.normalize(v)
  268. })
  269. argv.__defineGetter__(key, function () {
  270. return typeof val === 'string' ? path.normalize(val) : val
  271. })
  272. })
  273. break
  274. }
  275. }
  276. }
  277. // set args from config.json file, this should be
  278. // applied last so that defaults can be applied.
  279. function setConfig (argv) {
  280. var configLookup = {}
  281. // expand defaults/aliases, in-case any happen to reference
  282. // the config.json file.
  283. applyDefaultsAndAliases(configLookup, aliases, defaults)
  284. Object.keys(flags.configs).forEach(function (configKey) {
  285. var configPath = argv[configKey] || configLookup[configKey]
  286. if (configPath) {
  287. try {
  288. var config = null
  289. var resolvedConfigPath = path.resolve(process.cwd(), configPath)
  290. if (typeof flags.configs[configKey] === 'function') {
  291. try {
  292. config = flags.configs[configKey](resolvedConfigPath)
  293. } catch (e) {
  294. config = e
  295. }
  296. if (config instanceof Error) {
  297. error = config
  298. return
  299. }
  300. } else {
  301. config = require(resolvedConfigPath)
  302. }
  303. Object.keys(config).forEach(function (key) {
  304. // setting arguments via CLI takes precedence over
  305. // values within the config file.
  306. if (argv[key] === undefined || (flags.defaulted[key])) {
  307. delete argv[key]
  308. setArg(key, config[key])
  309. }
  310. })
  311. } catch (ex) {
  312. if (argv[configKey]) error = Error(__('Invalid JSON config file: %s', configPath))
  313. }
  314. }
  315. })
  316. }
  317. function applyEnvVars (opts, argv, configOnly) {
  318. if (typeof opts.envPrefix === 'undefined') return
  319. var prefix = typeof opts.envPrefix === 'string' ? opts.envPrefix : ''
  320. Object.keys(process.env).forEach(function (envVar) {
  321. if (prefix === '' || envVar.lastIndexOf(prefix, 0) === 0) {
  322. var key = camelCase(envVar.substring(prefix.length))
  323. if (((configOnly && flags.configs[key]) || !configOnly) && (!(key in argv) || flags.defaulted[key])) {
  324. setArg(key, process.env[envVar])
  325. }
  326. }
  327. })
  328. }
  329. function applyDefaultsAndAliases (obj, aliases, defaults) {
  330. Object.keys(defaults).forEach(function (key) {
  331. if (!hasKey(obj, key.split('.'))) {
  332. setKey(obj, key.split('.'), defaults[key])
  333. ;(aliases[key] || []).forEach(function (x) {
  334. if (hasKey(obj, x.split('.'))) return
  335. setKey(obj, x.split('.'), defaults[key])
  336. })
  337. }
  338. })
  339. }
  340. function hasKey (obj, keys) {
  341. var o = obj
  342. keys.slice(0, -1).forEach(function (key) {
  343. o = (o[key] || {})
  344. })
  345. var key = keys[keys.length - 1]
  346. if (typeof o !== 'object') return false
  347. else return key in o
  348. }
  349. function setKey (obj, keys, value) {
  350. var o = obj
  351. keys.slice(0, -1).forEach(function (key) {
  352. if (o[key] === undefined) o[key] = {}
  353. o = o[key]
  354. })
  355. var key = keys[keys.length - 1]
  356. if (value === increment) {
  357. o[key] = increment(o[key])
  358. } else if (o[key] === undefined && checkAllAliases(key, flags.arrays)) {
  359. o[key] = Array.isArray(value) ? value : [value]
  360. } else if (o[key] === undefined || typeof o[key] === 'boolean') {
  361. o[key] = value
  362. } else if (Array.isArray(o[key])) {
  363. o[key].push(value)
  364. } else {
  365. o[key] = [ o[key], value ]
  366. }
  367. }
  368. // extend the aliases list with inferred aliases.
  369. function extendAliases (obj) {
  370. Object.keys(obj || {}).forEach(function (key) {
  371. // short-circuit if we've already added a key
  372. // to the aliases array, for example it might
  373. // exist in both 'opts.default' and 'opts.key'.
  374. if (aliases[key]) return
  375. aliases[key] = [].concat(opts.alias[key] || [])
  376. // For "--option-name", also set argv.optionName
  377. aliases[key].concat(key).forEach(function (x) {
  378. if (/-/.test(x)) {
  379. var c = camelCase(x)
  380. aliases[key].push(c)
  381. newAliases[c] = true
  382. }
  383. })
  384. aliases[key].forEach(function (x) {
  385. aliases[x] = [key].concat(aliases[key].filter(function (y) {
  386. return x !== y
  387. }))
  388. })
  389. })
  390. }
  391. // check if a flag is set for any of a key's aliases.
  392. function checkAllAliases (key, flag) {
  393. var isSet = false
  394. var toCheck = [].concat(aliases[key] || [], key)
  395. toCheck.forEach(function (key) {
  396. if (flag[key]) isSet = flag[key]
  397. })
  398. return isSet
  399. }
  400. function setDefaulted (key) {
  401. [].concat(aliases[key] || [], key).forEach(function (k) {
  402. flags.defaulted[k] = true
  403. })
  404. }
  405. function unsetDefaulted (key) {
  406. [].concat(aliases[key] || [], key).forEach(function (k) {
  407. delete flags.defaulted[k]
  408. })
  409. }
  410. // return a default value, given the type of a flag.,
  411. // e.g., key of type 'string' will default to '', rather than 'true'.
  412. function defaultForType (type) {
  413. var def = {
  414. boolean: true,
  415. string: '',
  416. array: []
  417. }
  418. return def[type]
  419. }
  420. // given a flag, enforce a default type.
  421. function guessType (key, flags) {
  422. var type = 'boolean'
  423. if (flags.strings && flags.strings[key]) type = 'string'
  424. else if (flags.arrays && flags.arrays[key]) type = 'array'
  425. return type
  426. }
  427. function isNumber (x) {
  428. if (typeof x === 'number') return true
  429. if (/^0x[0-9a-f]+$/i.test(x)) return true
  430. return /^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/.test(x)
  431. }
  432. return {
  433. argv: argv,
  434. aliases: aliases,
  435. error: error,
  436. newAliases: newAliases
  437. }
  438. }