parse.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446
  1. var optimist = require('../index');
  2. var path = require('path');
  3. var test = require('tap').test;
  4. var $0 = 'node ./' + path.relative(process.cwd(), __filename);
  5. test('short boolean', function (t) {
  6. var parse = optimist.parse([ '-b' ]);
  7. t.same(parse, { b : true, _ : [], $0 : $0 });
  8. t.same(typeof parse.b, 'boolean');
  9. t.end();
  10. });
  11. test('long boolean', function (t) {
  12. t.same(
  13. optimist.parse([ '--bool' ]),
  14. { bool : true, _ : [], $0 : $0 }
  15. );
  16. t.end();
  17. });
  18. test('bare', function (t) {
  19. t.same(
  20. optimist.parse([ 'foo', 'bar', 'baz' ]),
  21. { _ : [ 'foo', 'bar', 'baz' ], $0 : $0 }
  22. );
  23. t.end();
  24. });
  25. test('short group', function (t) {
  26. t.same(
  27. optimist.parse([ '-cats' ]),
  28. { c : true, a : true, t : true, s : true, _ : [], $0 : $0 }
  29. );
  30. t.end();
  31. });
  32. test('short group next', function (t) {
  33. t.same(
  34. optimist.parse([ '-cats', 'meow' ]),
  35. { c : true, a : true, t : true, s : 'meow', _ : [], $0 : $0 }
  36. );
  37. t.end();
  38. });
  39. test('short capture', function (t) {
  40. t.same(
  41. optimist.parse([ '-h', 'localhost' ]),
  42. { h : 'localhost', _ : [], $0 : $0 }
  43. );
  44. t.end();
  45. });
  46. test('short captures', function (t) {
  47. t.same(
  48. optimist.parse([ '-h', 'localhost', '-p', '555' ]),
  49. { h : 'localhost', p : 555, _ : [], $0 : $0 }
  50. );
  51. t.end();
  52. });
  53. test('long capture sp', function (t) {
  54. t.same(
  55. optimist.parse([ '--pow', 'xixxle' ]),
  56. { pow : 'xixxle', _ : [], $0 : $0 }
  57. );
  58. t.end();
  59. });
  60. test('long capture eq', function (t) {
  61. t.same(
  62. optimist.parse([ '--pow=xixxle' ]),
  63. { pow : 'xixxle', _ : [], $0 : $0 }
  64. );
  65. t.end()
  66. });
  67. test('long captures sp', function (t) {
  68. t.same(
  69. optimist.parse([ '--host', 'localhost', '--port', '555' ]),
  70. { host : 'localhost', port : 555, _ : [], $0 : $0 }
  71. );
  72. t.end();
  73. });
  74. test('long captures eq', function (t) {
  75. t.same(
  76. optimist.parse([ '--host=localhost', '--port=555' ]),
  77. { host : 'localhost', port : 555, _ : [], $0 : $0 }
  78. );
  79. t.end();
  80. });
  81. test('mixed short bool and capture', function (t) {
  82. t.same(
  83. optimist.parse([ '-h', 'localhost', '-fp', '555', 'script.js' ]),
  84. {
  85. f : true, p : 555, h : 'localhost',
  86. _ : [ 'script.js' ], $0 : $0,
  87. }
  88. );
  89. t.end();
  90. });
  91. test('short and long', function (t) {
  92. t.same(
  93. optimist.parse([ '-h', 'localhost', '-fp', '555', 'script.js' ]),
  94. {
  95. f : true, p : 555, h : 'localhost',
  96. _ : [ 'script.js' ], $0 : $0,
  97. }
  98. );
  99. t.end();
  100. });
  101. test('no', function (t) {
  102. t.same(
  103. optimist.parse([ '--no-moo' ]),
  104. { moo : false, _ : [], $0 : $0 }
  105. );
  106. t.end();
  107. });
  108. test('multi', function (t) {
  109. t.same(
  110. optimist.parse([ '-v', 'a', '-v', 'b', '-v', 'c' ]),
  111. { v : ['a','b','c'], _ : [], $0 : $0 }
  112. );
  113. t.end();
  114. });
  115. test('comprehensive', function (t) {
  116. t.same(
  117. optimist.parse([
  118. '--name=meowmers', 'bare', '-cats', 'woo',
  119. '-h', 'awesome', '--multi=quux',
  120. '--key', 'value',
  121. '-b', '--bool', '--no-meep', '--multi=baz',
  122. '--', '--not-a-flag', 'eek'
  123. ]),
  124. {
  125. c : true,
  126. a : true,
  127. t : true,
  128. s : 'woo',
  129. h : 'awesome',
  130. b : true,
  131. bool : true,
  132. key : 'value',
  133. multi : [ 'quux', 'baz' ],
  134. meep : false,
  135. name : 'meowmers',
  136. _ : [ 'bare', '--not-a-flag', 'eek' ],
  137. $0 : $0
  138. }
  139. );
  140. t.end();
  141. });
  142. test('nums', function (t) {
  143. var argv = optimist.parse([
  144. '-x', '1234',
  145. '-y', '5.67',
  146. '-z', '1e7',
  147. '-w', '10f',
  148. '--hex', '0xdeadbeef',
  149. '789',
  150. ]);
  151. t.same(argv, {
  152. x : 1234,
  153. y : 5.67,
  154. z : 1e7,
  155. w : '10f',
  156. hex : 0xdeadbeef,
  157. _ : [ 789 ],
  158. $0 : $0
  159. });
  160. t.same(typeof argv.x, 'number');
  161. t.same(typeof argv.y, 'number');
  162. t.same(typeof argv.z, 'number');
  163. t.same(typeof argv.w, 'string');
  164. t.same(typeof argv.hex, 'number');
  165. t.same(typeof argv._[0], 'number');
  166. t.end();
  167. });
  168. test('flag boolean', function (t) {
  169. var parse = optimist([ '-t', 'moo' ]).boolean(['t']).argv;
  170. t.same(parse, { t : true, _ : [ 'moo' ], $0 : $0 });
  171. t.same(typeof parse.t, 'boolean');
  172. t.end();
  173. });
  174. test('flag boolean value', function (t) {
  175. var parse = optimist(['--verbose', 'false', 'moo', '-t', 'true'])
  176. .boolean(['t', 'verbose']).default('verbose', true).argv;
  177. t.same(parse, {
  178. verbose: false,
  179. t: true,
  180. _: ['moo'],
  181. $0 : $0
  182. });
  183. t.same(typeof parse.verbose, 'boolean');
  184. t.same(typeof parse.t, 'boolean');
  185. t.end();
  186. });
  187. test('flag boolean default false', function (t) {
  188. var parse = optimist(['moo'])
  189. .boolean(['t', 'verbose'])
  190. .default('verbose', false)
  191. .default('t', false).argv;
  192. t.same(parse, {
  193. verbose: false,
  194. t: false,
  195. _: ['moo'],
  196. $0 : $0
  197. });
  198. t.same(typeof parse.verbose, 'boolean');
  199. t.same(typeof parse.t, 'boolean');
  200. t.end();
  201. });
  202. test('boolean groups', function (t) {
  203. var parse = optimist([ '-x', '-z', 'one', 'two', 'three' ])
  204. .boolean(['x','y','z']).argv;
  205. t.same(parse, {
  206. x : true,
  207. y : false,
  208. z : true,
  209. _ : [ 'one', 'two', 'three' ],
  210. $0 : $0
  211. });
  212. t.same(typeof parse.x, 'boolean');
  213. t.same(typeof parse.y, 'boolean');
  214. t.same(typeof parse.z, 'boolean');
  215. t.end();
  216. });
  217. test('newlines in params' , function (t) {
  218. var args = optimist.parse([ '-s', "X\nX" ])
  219. t.same(args, { _ : [], s : "X\nX", $0 : $0 });
  220. // reproduce in bash:
  221. // VALUE="new
  222. // line"
  223. // node program.js --s="$VALUE"
  224. args = optimist.parse([ "--s=X\nX" ])
  225. t.same(args, { _ : [], s : "X\nX", $0 : $0 });
  226. t.end();
  227. });
  228. test('strings' , function (t) {
  229. var s = optimist([ '-s', '0001234' ]).string('s').argv.s;
  230. t.same(s, '0001234');
  231. t.same(typeof s, 'string');
  232. var x = optimist([ '-x', '56' ]).string('x').argv.x;
  233. t.same(x, '56');
  234. t.same(typeof x, 'string');
  235. t.end();
  236. });
  237. test('stringArgs', function (t) {
  238. var s = optimist([ ' ', ' ' ]).string('_').argv._;
  239. t.same(s.length, 2);
  240. t.same(typeof s[0], 'string');
  241. t.same(s[0], ' ');
  242. t.same(typeof s[1], 'string');
  243. t.same(s[1], ' ');
  244. t.end();
  245. });
  246. test('slashBreak', function (t) {
  247. t.same(
  248. optimist.parse([ '-I/foo/bar/baz' ]),
  249. { I : '/foo/bar/baz', _ : [], $0 : $0 }
  250. );
  251. t.same(
  252. optimist.parse([ '-xyz/foo/bar/baz' ]),
  253. { x : true, y : true, z : '/foo/bar/baz', _ : [], $0 : $0 }
  254. );
  255. t.end();
  256. });
  257. test('alias', function (t) {
  258. var argv = optimist([ '-f', '11', '--zoom', '55' ])
  259. .alias('z', 'zoom')
  260. .argv
  261. ;
  262. t.equal(argv.zoom, 55);
  263. t.equal(argv.z, argv.zoom);
  264. t.equal(argv.f, 11);
  265. t.end();
  266. });
  267. test('multiAlias', function (t) {
  268. var argv = optimist([ '-f', '11', '--zoom', '55' ])
  269. .alias('z', [ 'zm', 'zoom' ])
  270. .argv
  271. ;
  272. t.equal(argv.zoom, 55);
  273. t.equal(argv.z, argv.zoom);
  274. t.equal(argv.z, argv.zm);
  275. t.equal(argv.f, 11);
  276. t.end();
  277. });
  278. test('boolean default true', function (t) {
  279. var argv = optimist.options({
  280. sometrue: {
  281. boolean: true,
  282. default: true
  283. }
  284. }).argv;
  285. t.equal(argv.sometrue, true);
  286. t.end();
  287. });
  288. test('boolean default false', function (t) {
  289. var argv = optimist.options({
  290. somefalse: {
  291. boolean: true,
  292. default: false
  293. }
  294. }).argv;
  295. t.equal(argv.somefalse, false);
  296. t.end();
  297. });
  298. test('nested dotted objects', function (t) {
  299. var argv = optimist([
  300. '--foo.bar', '3', '--foo.baz', '4',
  301. '--foo.quux.quibble', '5', '--foo.quux.o_O',
  302. '--beep.boop'
  303. ]).argv;
  304. t.same(argv.foo, {
  305. bar : 3,
  306. baz : 4,
  307. quux : {
  308. quibble : 5,
  309. o_O : true
  310. },
  311. });
  312. t.same(argv.beep, { boop : true });
  313. t.end();
  314. });
  315. test('boolean and alias with chainable api', function (t) {
  316. var aliased = [ '-h', 'derp' ];
  317. var regular = [ '--herp', 'derp' ];
  318. var opts = {
  319. herp: { alias: 'h', boolean: true }
  320. };
  321. var aliasedArgv = optimist(aliased)
  322. .boolean('herp')
  323. .alias('h', 'herp')
  324. .argv;
  325. var propertyArgv = optimist(regular)
  326. .boolean('herp')
  327. .alias('h', 'herp')
  328. .argv;
  329. var expected = {
  330. herp: true,
  331. h: true,
  332. '_': [ 'derp' ],
  333. '$0': $0,
  334. };
  335. t.same(aliasedArgv, expected);
  336. t.same(propertyArgv, expected);
  337. t.end();
  338. });
  339. test('boolean and alias with options hash', function (t) {
  340. var aliased = [ '-h', 'derp' ];
  341. var regular = [ '--herp', 'derp' ];
  342. var opts = {
  343. herp: { alias: 'h', boolean: true }
  344. };
  345. var aliasedArgv = optimist(aliased)
  346. .options(opts)
  347. .argv;
  348. var propertyArgv = optimist(regular).options(opts).argv;
  349. var expected = {
  350. herp: true,
  351. h: true,
  352. '_': [ 'derp' ],
  353. '$0': $0,
  354. };
  355. t.same(aliasedArgv, expected);
  356. t.same(propertyArgv, expected);
  357. t.end();
  358. });
  359. test('boolean and alias using explicit true', function (t) {
  360. var aliased = [ '-h', 'true' ];
  361. var regular = [ '--herp', 'true' ];
  362. var opts = {
  363. herp: { alias: 'h', boolean: true }
  364. };
  365. var aliasedArgv = optimist(aliased)
  366. .boolean('h')
  367. .alias('h', 'herp')
  368. .argv;
  369. var propertyArgv = optimist(regular)
  370. .boolean('h')
  371. .alias('h', 'herp')
  372. .argv;
  373. var expected = {
  374. herp: true,
  375. h: true,
  376. '_': [ ],
  377. '$0': $0,
  378. };
  379. t.same(aliasedArgv, expected);
  380. t.same(propertyArgv, expected);
  381. t.end();
  382. });
  383. // regression, see https://github.com/substack/node-optimist/issues/71
  384. test('boolean and --x=true', function(t) {
  385. var parsed = optimist(['--boool', '--other=true']).boolean('boool').argv;
  386. t.same(parsed.boool, true);
  387. t.same(parsed.other, 'true');
  388. parsed = optimist(['--boool', '--other=false']).boolean('boool').argv;
  389. t.same(parsed.boool, true);
  390. t.same(parsed.other, 'false');
  391. t.end();
  392. });