@villedemontreal/caporal 3.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (425) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +29 -0
  3. package/dist/src/__tests__/issue-163.spec.d.ts +2 -0
  4. package/dist/src/__tests__/issue-163.spec.d.ts.map +1 -0
  5. package/dist/src/__tests__/issue-163.spec.js +17 -0
  6. package/dist/src/__tests__/issue-163.spec.js.map +1 -0
  7. package/dist/src/argument/__tests__/argument.spec.d.ts +2 -0
  8. package/dist/src/argument/__tests__/argument.spec.d.ts.map +1 -0
  9. package/dist/src/argument/__tests__/argument.spec.js +85 -0
  10. package/dist/src/argument/__tests__/argument.spec.js.map +1 -0
  11. package/dist/src/argument/find.d.ts +8 -0
  12. package/dist/src/argument/find.d.ts.map +1 -0
  13. package/dist/src/argument/find.js +11 -0
  14. package/dist/src/argument/find.js.map +1 -0
  15. package/dist/src/argument/index.d.ts +13 -0
  16. package/dist/src/argument/index.d.ts.map +1 -0
  17. package/dist/src/argument/index.js +27 -0
  18. package/dist/src/argument/index.js.map +1 -0
  19. package/dist/src/argument/synopsis.d.ts +19 -0
  20. package/dist/src/argument/synopsis.d.ts.map +1 -0
  21. package/dist/src/argument/synopsis.js +39 -0
  22. package/dist/src/argument/synopsis.js.map +1 -0
  23. package/dist/src/argument/validate.d.ts +43 -0
  24. package/dist/src/argument/validate.d.ts.map +1 -0
  25. package/dist/src/argument/validate.js +127 -0
  26. package/dist/src/argument/validate.js.map +1 -0
  27. package/dist/src/autocomplete/__fixtures__/prog-autocomplete.d.ts +3 -0
  28. package/dist/src/autocomplete/__fixtures__/prog-autocomplete.d.ts.map +1 -0
  29. package/dist/src/autocomplete/__fixtures__/prog-autocomplete.js +24 -0
  30. package/dist/src/autocomplete/__fixtures__/prog-autocomplete.js.map +1 -0
  31. package/dist/src/autocomplete/__tests__/autocomplete.spec.d.ts +2 -0
  32. package/dist/src/autocomplete/__tests__/autocomplete.spec.d.ts.map +1 -0
  33. package/dist/src/autocomplete/__tests__/autocomplete.spec.js +119 -0
  34. package/dist/src/autocomplete/__tests__/autocomplete.spec.js.map +1 -0
  35. package/dist/src/autocomplete/index.d.ts +20 -0
  36. package/dist/src/autocomplete/index.d.ts.map +1 -0
  37. package/dist/src/autocomplete/index.js +172 -0
  38. package/dist/src/autocomplete/index.js.map +1 -0
  39. package/dist/src/autocomplete/types.d.ts +26 -0
  40. package/dist/src/autocomplete/types.d.ts.map +1 -0
  41. package/dist/src/autocomplete/types.js +3 -0
  42. package/dist/src/autocomplete/types.js.map +1 -0
  43. package/dist/src/command/__fixtures__/example-cmd.d.ts +8 -0
  44. package/dist/src/command/__fixtures__/example-cmd.d.ts.map +1 -0
  45. package/dist/src/command/__fixtures__/example-cmd.js +10 -0
  46. package/dist/src/command/__fixtures__/example-cmd.js.map +1 -0
  47. package/dist/src/command/__tests__/command.spec.d.ts +2 -0
  48. package/dist/src/command/__tests__/command.spec.d.ts.map +1 -0
  49. package/dist/src/command/__tests__/command.spec.js +510 -0
  50. package/dist/src/command/__tests__/command.spec.js.map +1 -0
  51. package/dist/src/command/__tests__/find.spec.d.ts +2 -0
  52. package/dist/src/command/__tests__/find.spec.d.ts.map +1 -0
  53. package/dist/src/command/__tests__/find.spec.js +31 -0
  54. package/dist/src/command/__tests__/find.spec.js.map +1 -0
  55. package/dist/src/command/__tests__/import.spec.d.ts +2 -0
  56. package/dist/src/command/__tests__/import.spec.d.ts.map +1 -0
  57. package/dist/src/command/__tests__/import.spec.js +17 -0
  58. package/dist/src/command/__tests__/import.spec.js.map +1 -0
  59. package/dist/src/command/__tests__/scan.spec.d.ts +2 -0
  60. package/dist/src/command/__tests__/scan.spec.d.ts.map +1 -0
  61. package/dist/src/command/__tests__/scan.spec.js +20 -0
  62. package/dist/src/command/__tests__/scan.spec.js.map +1 -0
  63. package/dist/src/command/find.d.ts +8 -0
  64. package/dist/src/command/find.d.ts.map +1 -0
  65. package/dist/src/command/find.js +47 -0
  66. package/dist/src/command/find.js.map +1 -0
  67. package/dist/src/command/import.d.ts +7 -0
  68. package/dist/src/command/import.d.ts.map +1 -0
  69. package/dist/src/command/import.js +47 -0
  70. package/dist/src/command/import.js.map +1 -0
  71. package/dist/src/command/index.d.ts +211 -0
  72. package/dist/src/command/index.d.ts.map +1 -0
  73. package/dist/src/command/index.js +374 -0
  74. package/dist/src/command/index.js.map +1 -0
  75. package/dist/src/command/scan.d.ts +4 -0
  76. package/dist/src/command/scan.d.ts.map +1 -0
  77. package/dist/src/command/scan.js +31 -0
  78. package/dist/src/command/scan.js.map +1 -0
  79. package/dist/src/command/validate-call.d.ts +8 -0
  80. package/dist/src/command/validate-call.d.ts.map +1 -0
  81. package/dist/src/command/validate-call.js +13 -0
  82. package/dist/src/command/validate-call.js.map +1 -0
  83. package/dist/src/config/index.d.ts +7 -0
  84. package/dist/src/config/index.d.ts.map +1 -0
  85. package/dist/src/config/index.js +24 -0
  86. package/dist/src/config/index.js.map +1 -0
  87. package/dist/src/error/__tests__/fatal.spec.d.ts +2 -0
  88. package/dist/src/error/__tests__/fatal.spec.d.ts.map +1 -0
  89. package/dist/src/error/__tests__/fatal.spec.js +34 -0
  90. package/dist/src/error/__tests__/fatal.spec.js.map +1 -0
  91. package/dist/src/error/action.d.ts +9 -0
  92. package/dist/src/error/action.d.ts.map +1 -0
  93. package/dist/src/error/action.js +16 -0
  94. package/dist/src/error/action.js.map +1 -0
  95. package/dist/src/error/base.d.ts +11 -0
  96. package/dist/src/error/base.d.ts.map +1 -0
  97. package/dist/src/error/base.js +18 -0
  98. package/dist/src/error/base.js.map +1 -0
  99. package/dist/src/error/fatal.d.ts +10 -0
  100. package/dist/src/error/fatal.d.ts.map +1 -0
  101. package/dist/src/error/fatal.js +27 -0
  102. package/dist/src/error/fatal.js.map +1 -0
  103. package/dist/src/error/index.d.ts +18 -0
  104. package/dist/src/error/index.d.ts.map +1 -0
  105. package/dist/src/error/index.js +34 -0
  106. package/dist/src/error/index.js.map +1 -0
  107. package/dist/src/error/invalid-validator.d.ts +10 -0
  108. package/dist/src/error/invalid-validator.d.ts.map +1 -0
  109. package/dist/src/error/invalid-validator.js +15 -0
  110. package/dist/src/error/invalid-validator.js.map +1 -0
  111. package/dist/src/error/missing-argument.d.ts +11 -0
  112. package/dist/src/error/missing-argument.d.ts.map +1 -0
  113. package/dist/src/error/missing-argument.js +20 -0
  114. package/dist/src/error/missing-argument.js.map +1 -0
  115. package/dist/src/error/missing-flag.d.ts +11 -0
  116. package/dist/src/error/missing-flag.d.ts.map +1 -0
  117. package/dist/src/error/missing-flag.js +20 -0
  118. package/dist/src/error/missing-flag.js.map +1 -0
  119. package/dist/src/error/multi-validation.d.ts +10 -0
  120. package/dist/src/error/multi-validation.d.ts.map +1 -0
  121. package/dist/src/error/multi-validation.js +26 -0
  122. package/dist/src/error/multi-validation.js.map +1 -0
  123. package/dist/src/error/no-action.d.ts +10 -0
  124. package/dist/src/error/no-action.d.ts.map +1 -0
  125. package/dist/src/error/no-action.js +22 -0
  126. package/dist/src/error/no-action.js.map +1 -0
  127. package/dist/src/error/option-synopsis-syntax.d.ts +9 -0
  128. package/dist/src/error/option-synopsis-syntax.d.ts.map +1 -0
  129. package/dist/src/error/option-synopsis-syntax.js +15 -0
  130. package/dist/src/error/option-synopsis-syntax.js.map +1 -0
  131. package/dist/src/error/too-many-arguments.d.ts +11 -0
  132. package/dist/src/error/too-many-arguments.d.ts.map +1 -0
  133. package/dist/src/error/too-many-arguments.js +25 -0
  134. package/dist/src/error/too-many-arguments.js.map +1 -0
  135. package/dist/src/error/unknown-command.d.ts +13 -0
  136. package/dist/src/error/unknown-command.d.ts.map +1 -0
  137. package/dist/src/error/unknown-command.js +44 -0
  138. package/dist/src/error/unknown-command.js.map +1 -0
  139. package/dist/src/error/unknown-option.d.ts +13 -0
  140. package/dist/src/error/unknown-option.d.ts.map +1 -0
  141. package/dist/src/error/unknown-option.js +40 -0
  142. package/dist/src/error/unknown-option.js.map +1 -0
  143. package/dist/src/error/validation.d.ts +17 -0
  144. package/dist/src/error/validation.d.ts.map +1 -0
  145. package/dist/src/error/validation.js +49 -0
  146. package/dist/src/error/validation.js.map +1 -0
  147. package/dist/src/help/__tests__/help.spec.d.ts +2 -0
  148. package/dist/src/help/__tests__/help.spec.d.ts.map +1 -0
  149. package/dist/src/help/__tests__/help.spec.js +130 -0
  150. package/dist/src/help/__tests__/help.spec.js.map +1 -0
  151. package/dist/src/help/__tests__/utils.spec.d.ts +2 -0
  152. package/dist/src/help/__tests__/utils.spec.d.ts.map +1 -0
  153. package/dist/src/help/__tests__/utils.spec.js +16 -0
  154. package/dist/src/help/__tests__/utils.spec.js.map +1 -0
  155. package/dist/src/help/index.d.ts +47 -0
  156. package/dist/src/help/index.d.ts.map +1 -0
  157. package/dist/src/help/index.js +131 -0
  158. package/dist/src/help/index.js.map +1 -0
  159. package/dist/src/help/templates/command.d.ts +7 -0
  160. package/dist/src/help/templates/command.d.ts.map +1 -0
  161. package/dist/src/help/templates/command.js +23 -0
  162. package/dist/src/help/templates/command.js.map +1 -0
  163. package/dist/src/help/templates/custom.d.ts +7 -0
  164. package/dist/src/help/templates/custom.d.ts.map +1 -0
  165. package/dist/src/help/templates/custom.js +24 -0
  166. package/dist/src/help/templates/custom.js.map +1 -0
  167. package/dist/src/help/templates/header.d.ts +7 -0
  168. package/dist/src/help/templates/header.d.ts.map +1 -0
  169. package/dist/src/help/templates/header.js +16 -0
  170. package/dist/src/help/templates/header.js.map +1 -0
  171. package/dist/src/help/templates/index.d.ts +10 -0
  172. package/dist/src/help/templates/index.d.ts.map +1 -0
  173. package/dist/src/help/templates/index.js +26 -0
  174. package/dist/src/help/templates/index.js.map +1 -0
  175. package/dist/src/help/templates/program.d.ts +7 -0
  176. package/dist/src/help/templates/program.d.ts.map +1 -0
  177. package/dist/src/help/templates/program.js +18 -0
  178. package/dist/src/help/templates/program.js.map +1 -0
  179. package/dist/src/help/templates/usage.d.ts +7 -0
  180. package/dist/src/help/templates/usage.d.ts.map +1 -0
  181. package/dist/src/help/templates/usage.js +19 -0
  182. package/dist/src/help/templates/usage.js.map +1 -0
  183. package/dist/src/help/types.d.ts +53 -0
  184. package/dist/src/help/types.d.ts.map +1 -0
  185. package/dist/src/help/types.js +3 -0
  186. package/dist/src/help/types.js.map +1 -0
  187. package/dist/src/help/utils.d.ts +9 -0
  188. package/dist/src/help/utils.d.ts.map +1 -0
  189. package/dist/src/help/utils.js +92 -0
  190. package/dist/src/help/utils.js.map +1 -0
  191. package/dist/src/index.d.ts +90 -0
  192. package/dist/src/index.d.ts.map +1 -0
  193. package/dist/src/index.js +111 -0
  194. package/dist/src/index.js.map +1 -0
  195. package/dist/src/logger/__tests__/logger.spec.d.ts +2 -0
  196. package/dist/src/logger/__tests__/logger.spec.d.ts.map +1 -0
  197. package/dist/src/logger/__tests__/logger.spec.js +56 -0
  198. package/dist/src/logger/__tests__/logger.spec.js.map +1 -0
  199. package/dist/src/logger/index.d.ts +6 -0
  200. package/dist/src/logger/index.d.ts.map +1 -0
  201. package/dist/src/logger/index.js +128 -0
  202. package/dist/src/logger/index.js.map +1 -0
  203. package/dist/src/option/__tests__/global.spec.d.ts +2 -0
  204. package/dist/src/option/__tests__/global.spec.d.ts.map +1 -0
  205. package/dist/src/option/__tests__/global.spec.js +121 -0
  206. package/dist/src/option/__tests__/global.spec.js.map +1 -0
  207. package/dist/src/option/__tests__/option.spec.d.ts +2 -0
  208. package/dist/src/option/__tests__/option.spec.d.ts.map +1 -0
  209. package/dist/src/option/__tests__/option.spec.js +111 -0
  210. package/dist/src/option/__tests__/option.spec.js.map +1 -0
  211. package/dist/src/option/find.d.ts +14 -0
  212. package/dist/src/option/find.d.ts.map +1 -0
  213. package/dist/src/option/find.js +17 -0
  214. package/dist/src/option/find.js.map +1 -0
  215. package/dist/src/option/index.d.ts +65 -0
  216. package/dist/src/option/index.d.ts.map +1 -0
  217. package/dist/src/option/index.js +230 -0
  218. package/dist/src/option/index.js.map +1 -0
  219. package/dist/src/option/mapping.d.ts +7 -0
  220. package/dist/src/option/mapping.d.ts.map +1 -0
  221. package/dist/src/option/mapping.js +21 -0
  222. package/dist/src/option/mapping.js.map +1 -0
  223. package/dist/src/option/utils.d.ts +35 -0
  224. package/dist/src/option/utils.d.ts.map +1 -0
  225. package/dist/src/option/utils.js +139 -0
  226. package/dist/src/option/utils.js.map +1 -0
  227. package/dist/src/option/validate.d.ts +15 -0
  228. package/dist/src/option/validate.d.ts.map +1 -0
  229. package/dist/src/option/validate.js +63 -0
  230. package/dist/src/option/validate.js.map +1 -0
  231. package/dist/src/parser/__tests__/parser.spec.d.ts +2 -0
  232. package/dist/src/parser/__tests__/parser.spec.d.ts.map +1 -0
  233. package/dist/src/parser/__tests__/parser.spec.js +343 -0
  234. package/dist/src/parser/__tests__/parser.spec.js.map +1 -0
  235. package/dist/src/parser/index.d.ts +17 -0
  236. package/dist/src/parser/index.d.ts.map +1 -0
  237. package/dist/src/parser/index.js +299 -0
  238. package/dist/src/parser/index.js.map +1 -0
  239. package/dist/src/program/__tests__/program.spec.d.ts +2 -0
  240. package/dist/src/program/__tests__/program.spec.d.ts.map +1 -0
  241. package/dist/src/program/__tests__/program.spec.js +261 -0
  242. package/dist/src/program/__tests__/program.spec.js.map +1 -0
  243. package/dist/src/program/index.d.ts +349 -0
  244. package/dist/src/program/index.d.ts.map +1 -0
  245. package/dist/src/program/index.js +584 -0
  246. package/dist/src/program/index.js.map +1 -0
  247. package/dist/src/types.d.ts +396 -0
  248. package/dist/src/types.d.ts.map +1 -0
  249. package/dist/src/types.js +51 -0
  250. package/dist/src/types.js.map +1 -0
  251. package/dist/src/utils/__tests__/fs.spec.d.ts +2 -0
  252. package/dist/src/utils/__tests__/fs.spec.d.ts.map +1 -0
  253. package/dist/src/utils/__tests__/fs.spec.js +14 -0
  254. package/dist/src/utils/__tests__/fs.spec.js.map +1 -0
  255. package/dist/src/utils/__tests__/levenshtein.spec.d.ts +2 -0
  256. package/dist/src/utils/__tests__/levenshtein.spec.d.ts.map +1 -0
  257. package/dist/src/utils/__tests__/levenshtein.spec.js +18 -0
  258. package/dist/src/utils/__tests__/levenshtein.spec.js.map +1 -0
  259. package/dist/src/utils/__tests__/suggest.spec.d.ts +2 -0
  260. package/dist/src/utils/__tests__/suggest.spec.d.ts.map +1 -0
  261. package/dist/src/utils/__tests__/suggest.spec.js +31 -0
  262. package/dist/src/utils/__tests__/suggest.spec.js.map +1 -0
  263. package/dist/src/utils/colorize.d.ts +2 -0
  264. package/dist/src/utils/colorize.d.ts.map +1 -0
  265. package/dist/src/utils/colorize.js +27 -0
  266. package/dist/src/utils/colorize.js.map +1 -0
  267. package/dist/src/utils/fs.d.ts +2 -0
  268. package/dist/src/utils/fs.d.ts.map +1 -0
  269. package/dist/src/utils/fs.js +19 -0
  270. package/dist/src/utils/fs.js.map +1 -0
  271. package/dist/src/utils/levenshtein.d.ts +6 -0
  272. package/dist/src/utils/levenshtein.d.ts.map +1 -0
  273. package/dist/src/utils/levenshtein.js +32 -0
  274. package/dist/src/utils/levenshtein.js.map +1 -0
  275. package/dist/src/utils/suggest.d.ts +15 -0
  276. package/dist/src/utils/suggest.d.ts.map +1 -0
  277. package/dist/src/utils/suggest.js +49 -0
  278. package/dist/src/utils/suggest.js.map +1 -0
  279. package/dist/src/utils/version.d.ts +2 -0
  280. package/dist/src/utils/version.d.ts.map +1 -0
  281. package/dist/src/utils/version.js +21 -0
  282. package/dist/src/utils/version.js.map +1 -0
  283. package/dist/src/utils/web/autocomplete.d.ts +12 -0
  284. package/dist/src/utils/web/autocomplete.d.ts.map +1 -0
  285. package/dist/src/utils/web/autocomplete.js +12 -0
  286. package/dist/src/utils/web/autocomplete.js.map +1 -0
  287. package/dist/src/utils/web/process.d.ts +15 -0
  288. package/dist/src/utils/web/process.d.ts.map +1 -0
  289. package/dist/src/utils/web/process.js +29 -0
  290. package/dist/src/utils/web/process.js.map +1 -0
  291. package/dist/src/validator/__tests__/array.spec.d.ts +2 -0
  292. package/dist/src/validator/__tests__/array.spec.d.ts.map +1 -0
  293. package/dist/src/validator/__tests__/array.spec.js +34 -0
  294. package/dist/src/validator/__tests__/array.spec.js.map +1 -0
  295. package/dist/src/validator/__tests__/caporal.spec.d.ts +2 -0
  296. package/dist/src/validator/__tests__/caporal.spec.d.ts.map +1 -0
  297. package/dist/src/validator/__tests__/caporal.spec.js +86 -0
  298. package/dist/src/validator/__tests__/caporal.spec.js.map +1 -0
  299. package/dist/src/validator/__tests__/function.spec.d.ts +2 -0
  300. package/dist/src/validator/__tests__/function.spec.d.ts.map +1 -0
  301. package/dist/src/validator/__tests__/function.spec.js +42 -0
  302. package/dist/src/validator/__tests__/function.spec.js.map +1 -0
  303. package/dist/src/validator/__tests__/regexp.spec.d.ts +2 -0
  304. package/dist/src/validator/__tests__/regexp.spec.d.ts.map +1 -0
  305. package/dist/src/validator/__tests__/regexp.spec.js +34 -0
  306. package/dist/src/validator/__tests__/regexp.spec.js.map +1 -0
  307. package/dist/src/validator/__tests__/utils.spec.d.ts +2 -0
  308. package/dist/src/validator/__tests__/utils.spec.d.ts.map +1 -0
  309. package/dist/src/validator/__tests__/utils.spec.js +66 -0
  310. package/dist/src/validator/__tests__/utils.spec.js.map +1 -0
  311. package/dist/src/validator/__tests__/validate.spec.d.ts +2 -0
  312. package/dist/src/validator/__tests__/validate.spec.d.ts.map +1 -0
  313. package/dist/src/validator/__tests__/validate.spec.js +25 -0
  314. package/dist/src/validator/__tests__/validate.spec.js.map +1 -0
  315. package/dist/src/validator/array.d.ts +14 -0
  316. package/dist/src/validator/array.d.ts.map +1 -0
  317. package/dist/src/validator/array.js +29 -0
  318. package/dist/src/validator/array.js.map +1 -0
  319. package/dist/src/validator/caporal.d.ts +25 -0
  320. package/dist/src/validator/caporal.d.ts.map +1 -0
  321. package/dist/src/validator/caporal.js +89 -0
  322. package/dist/src/validator/caporal.js.map +1 -0
  323. package/dist/src/validator/function.d.ts +7 -0
  324. package/dist/src/validator/function.d.ts.map +1 -0
  325. package/dist/src/validator/function.js +27 -0
  326. package/dist/src/validator/function.js.map +1 -0
  327. package/dist/src/validator/regexp.d.ts +14 -0
  328. package/dist/src/validator/regexp.d.ts.map +1 -0
  329. package/dist/src/validator/regexp.js +31 -0
  330. package/dist/src/validator/regexp.js.map +1 -0
  331. package/dist/src/validator/utils.d.ts +14 -0
  332. package/dist/src/validator/utils.d.ts.map +1 -0
  333. package/dist/src/validator/utils.js +81 -0
  334. package/dist/src/validator/utils.js.map +1 -0
  335. package/dist/src/validator/validate.d.ts +7 -0
  336. package/dist/src/validator/validate.d.ts.map +1 -0
  337. package/dist/src/validator/validate.js +29 -0
  338. package/dist/src/validator/validate.js.map +1 -0
  339. package/dist/tsconfig.tsbuildinfo +1 -0
  340. package/package.json +75 -0
  341. package/src/__tests__/issue-163.spec.ts +18 -0
  342. package/src/argument/__tests__/argument.spec.ts +84 -0
  343. package/src/argument/find.ts +11 -0
  344. package/src/argument/index.ts +35 -0
  345. package/src/argument/synopsis.ts +41 -0
  346. package/src/argument/validate.ts +176 -0
  347. package/src/autocomplete/__fixtures__/prog-autocomplete.ts +24 -0
  348. package/src/autocomplete/__tests__/autocomplete.spec.ts +129 -0
  349. package/src/autocomplete/index.ts +225 -0
  350. package/src/autocomplete/types.ts +29 -0
  351. package/src/command/__fixtures__/example-cmd.ts +14 -0
  352. package/src/command/__tests__/command.spec.ts +621 -0
  353. package/src/command/__tests__/find.spec.ts +32 -0
  354. package/src/command/__tests__/import.spec.ts +14 -0
  355. package/src/command/__tests__/scan.spec.ts +16 -0
  356. package/src/command/find.ts +57 -0
  357. package/src/command/import.ts +13 -0
  358. package/src/command/index.ts +458 -0
  359. package/src/command/scan.ts +30 -0
  360. package/src/command/validate-call.ts +19 -0
  361. package/src/config/index.ts +26 -0
  362. package/src/error/__tests__/fatal.spec.ts +38 -0
  363. package/src/error/action.ts +13 -0
  364. package/src/error/base.ts +20 -0
  365. package/src/error/fatal.ts +25 -0
  366. package/src/error/index.ts +17 -0
  367. package/src/error/invalid-validator.ts +12 -0
  368. package/src/error/missing-argument.ts +16 -0
  369. package/src/error/missing-flag.ts +16 -0
  370. package/src/error/multi-validation.ts +22 -0
  371. package/src/error/no-action.ts +19 -0
  372. package/src/error/option-synopsis-syntax.ts +12 -0
  373. package/src/error/too-many-arguments.ts +28 -0
  374. package/src/error/unknown-command.ts +41 -0
  375. package/src/error/unknown-option.ts +40 -0
  376. package/src/error/validation.ts +80 -0
  377. package/src/help/__tests__/__snapshots__/help.spec.ts.snap +334 -0
  378. package/src/help/__tests__/help.spec.ts +144 -0
  379. package/src/help/__tests__/utils.spec.ts +14 -0
  380. package/src/help/index.ts +107 -0
  381. package/src/help/templates/command.ts +27 -0
  382. package/src/help/templates/custom.ts +25 -0
  383. package/src/help/templates/header.ts +19 -0
  384. package/src/help/templates/index.ts +9 -0
  385. package/src/help/templates/program.ts +21 -0
  386. package/src/help/templates/usage.ts +24 -0
  387. package/src/help/types.ts +57 -0
  388. package/src/help/utils.ts +109 -0
  389. package/src/index.ts +93 -0
  390. package/src/logger/__tests__/logger.spec.ts +65 -0
  391. package/src/logger/index.ts +97 -0
  392. package/src/option/__tests__/global.spec.ts +141 -0
  393. package/src/option/__tests__/option.spec.ts +115 -0
  394. package/src/option/find.ts +17 -0
  395. package/src/option/index.ts +280 -0
  396. package/src/option/mapping.ts +17 -0
  397. package/src/option/utils.ts +141 -0
  398. package/src/option/validate.ts +80 -0
  399. package/src/parser/__tests__/parser.spec.ts +371 -0
  400. package/src/parser/index.ts +383 -0
  401. package/src/program/__tests__/program.spec.ts +316 -0
  402. package/src/program/index.ts +676 -0
  403. package/src/types.ts +432 -0
  404. package/src/utils/__tests__/fs.spec.ts +14 -0
  405. package/src/utils/__tests__/levenshtein.spec.ts +16 -0
  406. package/src/utils/__tests__/suggest.spec.ts +30 -0
  407. package/src/utils/colorize.ts +21 -0
  408. package/src/utils/fs.ts +13 -0
  409. package/src/utils/levenshtein.ts +28 -0
  410. package/src/utils/suggest.ts +52 -0
  411. package/src/utils/version.ts +14 -0
  412. package/src/utils/web/autocomplete.ts +19 -0
  413. package/src/utils/web/process.ts +24 -0
  414. package/src/validator/__tests__/array.spec.ts +41 -0
  415. package/src/validator/__tests__/caporal.spec.ts +132 -0
  416. package/src/validator/__tests__/function.spec.ts +52 -0
  417. package/src/validator/__tests__/regexp.spec.ts +38 -0
  418. package/src/validator/__tests__/utils.spec.ts +67 -0
  419. package/src/validator/__tests__/validate.spec.ts +24 -0
  420. package/src/validator/array.ts +31 -0
  421. package/src/validator/caporal.ts +104 -0
  422. package/src/validator/function.ts +31 -0
  423. package/src/validator/regexp.ts +34 -0
  424. package/src/validator/utils.ts +84 -0
  425. package/src/validator/validate.ts +38 -0
@@ -0,0 +1,121 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ /* eslint-disable no-console */
4
+ const index_1 = require("../../index");
5
+ const program_1 = require("../../program");
6
+ const logger_1 = require("../../logger");
7
+ const __1 = require("..");
8
+ const vitest_1 = require("vitest");
9
+ let prog = index_1.program;
10
+ (0, vitest_1.describe)("option / global", () => {
11
+ const logSpy = vitest_1.vi.spyOn(console, "log");
12
+ // @ts-expect-error TS says _stdout does note exist on console but it does
13
+ const logStdoutSpy = vitest_1.vi.spyOn(console._stdout, "write"); // winston use this
14
+ const loggerInfoSpy = vitest_1.vi.spyOn(logger_1.logger, "info");
15
+ (0, vitest_1.beforeEach)(() => {
16
+ prog = new program_1.Program();
17
+ prog.name("test-prog");
18
+ prog.bin("test-prog");
19
+ prog.version("xyz");
20
+ logSpy.mockClear();
21
+ logStdoutSpy.mockClear();
22
+ logger_1.logger.level = "info";
23
+ logger_1.logger.colorsEnabled = true;
24
+ (0, __1.resetGlobalOptions)();
25
+ });
26
+ (0, vitest_1.afterAll)(() => {
27
+ logger_1.logger.colorsEnabled = true;
28
+ });
29
+ (0, vitest_1.it)("-V should show program version and exit", async () => {
30
+ await prog.run(["-V"]);
31
+ (0, vitest_1.expect)(logSpy).toHaveBeenLastCalledWith("xyz");
32
+ });
33
+ (0, vitest_1.it)("--version should show program version and exit", async () => {
34
+ await prog.run(["--version"]);
35
+ (0, vitest_1.expect)(logSpy).toHaveBeenLastCalledWith("xyz");
36
+ });
37
+ (0, vitest_1.it)("--no-color should disable colors in output", async () => {
38
+ const action = function ({ logger }) {
39
+ logger.info("Hey!");
40
+ };
41
+ prog.argument("[first-arg]", "First argument").action(action);
42
+ await prog.run(["--no-color", "foo"]);
43
+ (0, vitest_1.expect)(loggerInfoSpy).toHaveBeenLastCalledWith("Hey!");
44
+ });
45
+ (0, vitest_1.it)("--color false should disable colors in output", async () => {
46
+ const action = function ({ logger }) {
47
+ logger.info("Joe!");
48
+ };
49
+ prog.argument("[first-arg]", "First argument").action(action);
50
+ await prog.run(["--color", "false", "foo"]);
51
+ (0, vitest_1.expect)(loggerInfoSpy).toHaveBeenLastCalledWith("Joe!");
52
+ });
53
+ (0, vitest_1.it)("-v should enable verbosity", async () => {
54
+ const action = function ({ logger }) {
55
+ logger.info("my-info");
56
+ logger.debug("my-debug");
57
+ };
58
+ prog.argument("[first-arg]", "First argument").action(action);
59
+ await prog.run(["foo"]);
60
+ (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(vitest_1.expect.stringContaining("my-info"));
61
+ await prog.run(["foo", "-v"]);
62
+ (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(vitest_1.expect.stringContaining("my-debug"));
63
+ });
64
+ (0, vitest_1.it)("--verbose should enable verbosity", async () => {
65
+ const action = function ({ logger }) {
66
+ logger.info("my-info");
67
+ logger.debug("my-debug");
68
+ };
69
+ prog.argument("[first-arg]", "First argument").action(action);
70
+ await prog.run(["foo"]);
71
+ (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(vitest_1.expect.stringContaining("my-info"));
72
+ await prog.run(["foo", "--verbose"]);
73
+ (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(vitest_1.expect.stringContaining("my-debug"));
74
+ });
75
+ (0, vitest_1.it)("--quiet should make the program only output warnings and errors", async () => {
76
+ const action = function ({ logger }) {
77
+ logger.info("my-info");
78
+ logger.debug("my-debug");
79
+ logger.warn("my-warn");
80
+ logger.error("my-error");
81
+ };
82
+ prog.argument("[first-arg]", "First argument").action(action);
83
+ await prog.run(["foo", "--quiet"]);
84
+ (0, vitest_1.expect)(logStdoutSpy).not.toHaveBeenCalledWith(vitest_1.expect.stringContaining("my-info"));
85
+ (0, vitest_1.expect)(logStdoutSpy).not.toHaveBeenCalledWith(vitest_1.expect.stringContaining("my-debug"));
86
+ (0, vitest_1.expect)(logStdoutSpy).toHaveBeenCalledWith(vitest_1.expect.stringContaining("my-warn"));
87
+ (0, vitest_1.expect)(logStdoutSpy).toHaveBeenCalledWith(vitest_1.expect.stringContaining("my-error"));
88
+ });
89
+ (0, vitest_1.it)("--silent should output nothing", async () => {
90
+ const action = function ({ logger }) {
91
+ logger.info("my-info");
92
+ logger.debug("my-debug");
93
+ logger.warn("my-warn");
94
+ logger.error("my-error");
95
+ };
96
+ prog.argument("[first-arg]", "First argument").action(action);
97
+ await prog.run(["foo", "--silent"]);
98
+ (0, vitest_1.expect)(logStdoutSpy).not.toHaveBeenCalled();
99
+ });
100
+ (0, vitest_1.it)("disableGlobalOption() should disable a global option by name or notation", async () => {
101
+ // by notation
102
+ (0, vitest_1.expect)((0, __1.findGlobalOption)("version")).toBeTruthy();
103
+ const result = (0, __1.disableGlobalOption)("-V");
104
+ (0, vitest_1.expect)(result).toBe(true);
105
+ (0, vitest_1.expect)((0, __1.findGlobalOption)("version")).toBeUndefined();
106
+ // by name
107
+ (0, vitest_1.expect)((0, __1.findGlobalOption)("help")).toBeTruthy();
108
+ const result2 = (0, __1.disableGlobalOption)("help");
109
+ (0, vitest_1.expect)(result2).toBe(true);
110
+ (0, vitest_1.expect)((0, __1.findGlobalOption)("help")).toBeUndefined();
111
+ });
112
+ (0, vitest_1.it)("disableGlobalOption() should return false for an unknown global option", async () => {
113
+ // by notation
114
+ const result = (0, __1.disableGlobalOption)("--unknown");
115
+ (0, vitest_1.expect)(result).toBe(false);
116
+ // by name
117
+ const result2 = (0, __1.disableGlobalOption)("unknown");
118
+ (0, vitest_1.expect)(result2).toBe(false);
119
+ });
120
+ });
121
+ //# sourceMappingURL=global.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"global.spec.js","sourceRoot":"","sources":["../../../../src/option/__tests__/global.spec.ts"],"names":[],"mappings":";;AAAA,+BAA+B;AAC/B,uCAAqC;AACrC,2CAAuC;AACvC,yCAAqC;AAErC,0BAA8E;AAC9E,mCAAuE;AAEvE,IAAI,IAAI,GAAG,eAAO,CAAA;AAElB,IAAA,iBAAQ,EAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,MAAM,MAAM,GAAG,WAAE,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IACvC,0EAA0E;IAC1E,MAAM,YAAY,GAAG,WAAE,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA,CAAC,mBAAmB;IAC3E,MAAM,aAAa,GAAG,WAAE,CAAC,KAAK,CAAC,eAAM,EAAE,MAAM,CAAC,CAAA;IAE9C,IAAA,mBAAU,EAAC,GAAG,EAAE;QACd,IAAI,GAAG,IAAI,iBAAO,EAAE,CAAA;QACpB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACtB,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QACrB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACnB,MAAM,CAAC,SAAS,EAAE,CAAA;QAClB,YAAY,CAAC,SAAS,EAAE,CAAA;QACxB,eAAM,CAAC,KAAK,GAAG,MAAM,CAAA;QACrB,eAAM,CAAC,aAAa,GAAG,IAAI,CAAA;QAC3B,IAAA,sBAAkB,GAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,IAAA,iBAAQ,EAAC,GAAG,EAAE;QACZ,eAAM,CAAC,aAAa,GAAG,IAAI,CAAA;IAC7B,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QACtB,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAA;IAChD,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAA;QAC7B,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAA;IAChD,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,MAAM,GAAW,UAAU,EAAE,MAAM,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACrB,CAAC,CAAA;QACD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC7D,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAA;QACrC,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAA;IACxD,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,MAAM,GAAW,UAAU,EAAE,MAAM,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACrB,CAAC,CAAA;QACD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC7D,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;QAC3C,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAA;IACxD,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAW,UAAU,EAAE,MAAM,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACtB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC1B,CAAC,CAAA;QACD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAE7D,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;QACvB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAAC,eAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAA;QAEjF,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;QAC7B,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAAC,eAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAA;IACpF,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,MAAM,GAAW,UAAU,EAAE,MAAM,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACtB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC1B,CAAC,CAAA;QACD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAE7D,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;QACvB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAAC,eAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAA;QAEjF,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAA;QACpC,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAAC,eAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAA;IACpF,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,MAAM,GAAW,UAAU,EAAE,MAAM,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACtB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YACxB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACtB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC1B,CAAC,CAAA;QACD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAE7D,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAA;QAClC,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,eAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAA;QACjF,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,eAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAA;QAClF,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,eAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAA;QAC7E,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,eAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAA;IAChF,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,MAAM,GAAW,UAAU,EAAE,MAAM,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACtB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YACxB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACtB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC1B,CAAC,CAAA;QACD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAE7D,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAA;QACnC,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAA;IAC7C,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,cAAc;QACd,IAAA,eAAM,EAAC,IAAA,oBAAgB,EAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;QAChD,MAAM,MAAM,GAAG,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAA;QACxC,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACzB,IAAA,eAAM,EAAC,IAAA,oBAAgB,EAAC,SAAS,CAAC,CAAC,CAAC,aAAa,EAAE,CAAA;QAEnD,UAAU;QACV,IAAA,eAAM,EAAC,IAAA,oBAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;QAC7C,MAAM,OAAO,GAAG,IAAA,uBAAmB,EAAC,MAAM,CAAC,CAAA;QAC3C,IAAA,eAAM,EAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1B,IAAA,eAAM,EAAC,IAAA,oBAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,aAAa,EAAE,CAAA;IAClD,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,wEAAwE,EAAE,KAAK,IAAI,EAAE;QACtF,cAAc;QACd,MAAM,MAAM,GAAG,IAAA,uBAAmB,EAAC,WAAW,CAAC,CAAA;QAC/C,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAE1B,UAAU;QACV,MAAM,OAAO,GAAG,IAAA,uBAAmB,EAAC,SAAS,CAAC,CAAA;QAC9C,IAAA,eAAM,EAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC7B,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=option.spec.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"option.spec.d.ts","sourceRoot":"","sources":["../../../../src/option/__tests__/option.spec.ts"],"names":[],"mappings":""}
@@ -0,0 +1,111 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const __1 = require("..");
4
+ const error_1 = require("../../error");
5
+ const vitest_1 = require("vitest");
6
+ (0, vitest_1.describe)("createOption()", () => {
7
+ (0, vitest_1.it)("should create a basic short option", () => {
8
+ const opt = (0, __1.createOption)("-f <file>", "My simple option");
9
+ (0, vitest_1.expect)(opt).toMatchObject({
10
+ allNames: ["f"],
11
+ allNotations: ["-f"],
12
+ shortName: "f",
13
+ shortNotation: "-f",
14
+ description: "My simple option",
15
+ choices: [],
16
+ name: "f",
17
+ valueType: 1,
18
+ boolean: false,
19
+ valueRequired: true,
20
+ required: false,
21
+ synopsis: "-f <file>",
22
+ variadic: false,
23
+ visible: true,
24
+ });
25
+ });
26
+ (0, vitest_1.it)("should create a basic long option", () => {
27
+ const opt = (0, __1.createOption)("--file <file>", "My simple option");
28
+ (0, vitest_1.expect)(opt).toMatchObject({
29
+ allNames: ["file"],
30
+ allNotations: ["--file"],
31
+ longName: "file",
32
+ longNotation: "--file",
33
+ description: "My simple option",
34
+ choices: [],
35
+ name: "file",
36
+ valueType: 1,
37
+ boolean: false,
38
+ valueRequired: true,
39
+ required: false,
40
+ synopsis: "--file <file>",
41
+ variadic: false,
42
+ visible: true,
43
+ });
44
+ });
45
+ (0, vitest_1.it)("should create a short option without value", () => {
46
+ const opt = (0, __1.createOption)("-f", "My simple option");
47
+ (0, vitest_1.expect)(opt).toMatchObject({
48
+ allNames: ["f"],
49
+ allNotations: ["-f"],
50
+ shortName: "f",
51
+ shortNotation: "-f",
52
+ description: "My simple option",
53
+ choices: [],
54
+ name: "f",
55
+ boolean: true,
56
+ valueRequired: false,
57
+ valueType: 2,
58
+ default: false,
59
+ required: false,
60
+ synopsis: "-f",
61
+ variadic: false,
62
+ visible: true,
63
+ });
64
+ });
65
+ (0, vitest_1.it)("should create a short option with optional value", () => {
66
+ const opt = (0, __1.createOption)("-p [mean]", "My simple option");
67
+ (0, vitest_1.expect)(opt).toMatchObject({
68
+ allNames: ["p"],
69
+ allNotations: ["-p"],
70
+ shortName: "p",
71
+ shortNotation: "-p",
72
+ description: "My simple option",
73
+ choices: [],
74
+ name: "p",
75
+ boolean: false,
76
+ valueRequired: false,
77
+ valueType: 0,
78
+ required: false,
79
+ synopsis: "-p [mean]",
80
+ variadic: false,
81
+ visible: true,
82
+ });
83
+ });
84
+ (0, vitest_1.it)("should set choices if validator is an array", () => {
85
+ const opt = (0, __1.createOption)("-p [mean]", "My simple option", {
86
+ validator: ["card", "cash"],
87
+ });
88
+ (0, vitest_1.expect)(opt).toMatchObject({
89
+ allNames: ["p"],
90
+ allNotations: ["-p"],
91
+ shortName: "p",
92
+ shortNotation: "-p",
93
+ description: "My simple option",
94
+ choices: ["card", "cash"],
95
+ name: "p",
96
+ boolean: false,
97
+ typeHint: 'one of "card","cash"',
98
+ valueRequired: false,
99
+ validator: ["card", "cash"],
100
+ valueType: 0,
101
+ required: false,
102
+ synopsis: "-p [mean]",
103
+ variadic: false,
104
+ visible: true,
105
+ });
106
+ });
107
+ vitest_1.it.each([["bad synopsis"], ["another"], ["---fooo"]])("should throw for a malformed synopsis '%s'", (a) => {
108
+ (0, vitest_1.expect)(() => (0, __1.createOption)(a, "My simple option")).toThrowError(error_1.OptionSynopsisSyntaxError);
109
+ });
110
+ });
111
+ //# sourceMappingURL=option.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"option.spec.js","sourceRoot":"","sources":["../../../../src/option/__tests__/option.spec.ts"],"names":[],"mappings":";;AAAA,0BAAiC;AACjC,uCAAuD;AACvD,mCAA6C;AAE7C,IAAA,iBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,GAAG,GAAG,IAAA,gBAAY,EAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;QACzD,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,QAAQ,EAAE,CAAC,GAAG,CAAC;YACf,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,SAAS,EAAE,GAAG;YACd,aAAa,EAAE,IAAI;YACnB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,GAAG;YACT,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,IAAI;YACnB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,GAAG,GAAG,IAAA,gBAAY,EAAC,eAAe,EAAE,kBAAkB,CAAC,CAAA;QAC7D,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,QAAQ,EAAE,CAAC,MAAM,CAAC;YAClB,YAAY,EAAE,CAAC,QAAQ,CAAC;YACxB,QAAQ,EAAE,MAAM;YAChB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,IAAI;YACnB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,eAAe;YACzB,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,GAAG,GAAG,IAAA,gBAAY,EAAC,IAAI,EAAE,kBAAkB,CAAC,CAAA;QAClD,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,QAAQ,EAAE,CAAC,GAAG,CAAC;YACf,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,SAAS,EAAE,GAAG;YACd,aAAa,EAAE,IAAI;YACnB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,IAAI;YACb,aAAa,EAAE,KAAK;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,GAAG,GAAG,IAAA,gBAAY,EAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;QACzD,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,QAAQ,EAAE,CAAC,GAAG,CAAC;YACf,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,SAAS,EAAE,GAAG;YACd,aAAa,EAAE,IAAI;YACnB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,KAAK;YACpB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,GAAG,GAAG,IAAA,gBAAY,EAAC,WAAW,EAAE,kBAAkB,EAAE;YACxD,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;SAC5B,CAAC,CAAA;QACF,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,QAAQ,EAAE,CAAC,GAAG,CAAC;YACf,YAAY,EAAE,CAAC,IAAI,CAAC;YACpB,SAAS,EAAE,GAAG;YACd,aAAa,EAAE,IAAI;YACnB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;YACzB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,sBAAsB;YAChC,aAAa,EAAE,KAAK;YACpB,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;YAC3B,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,WAAW;YACrB,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,WAAE,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CACnD,4CAA4C,EAC5C,CAAC,CAAC,EAAE,EAAE;QACJ,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAA,gBAAY,EAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,YAAY,CAC5D,iCAAyB,CAC1B,CAAA;IACH,CAAC,CACF,CAAA;AACH,CAAC,CAAC,CAAA"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * @packageDocumentation
3
+ * @internal
4
+ */
5
+ import type { Command } from "../command";
6
+ import type { Option } from "../types";
7
+ /**
8
+ * Find an option from its name for a given command
9
+ *
10
+ * @param cmd Command object
11
+ * @param name Option name, short or long, camel-cased
12
+ */
13
+ export declare function findOption(cmd: Command, name: string): Option | undefined;
14
+ //# sourceMappingURL=find.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../src/option/find.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEzE"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /**
3
+ * @packageDocumentation
4
+ * @internal
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.findOption = findOption;
8
+ /**
9
+ * Find an option from its name for a given command
10
+ *
11
+ * @param cmd Command object
12
+ * @param name Option name, short or long, camel-cased
13
+ */
14
+ function findOption(cmd, name) {
15
+ return cmd.options.find((o) => o.allNames.find((opt) => opt === name));
16
+ }
17
+ //# sourceMappingURL=find.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"find.js","sourceRoot":"","sources":["../../../src/option/find.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAWH,gCAEC;AARD;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,GAAY,EAAE,IAAY;IACnD,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAA;AACxE,CAAC"}
@@ -0,0 +1,65 @@
1
+ /**
2
+ * @packageDocumentation
3
+ * @module caporal/option
4
+ */
5
+ import { Option, CreateOptionProgramOpts, CreateOptionCommandOpts, Action, GlobalOptions, ParserProcessedResult } from "../types";
6
+ import type { Command } from "../command";
7
+ import type { Program } from "../program";
8
+ /**
9
+ * Create an Option object
10
+ *
11
+ * @internal
12
+ * @param synopsis
13
+ * @param description
14
+ * @param options
15
+ */
16
+ export declare function createOption(synopsis: string, description: string, options?: CreateOptionProgramOpts | CreateOptionCommandOpts): Option;
17
+ export { showHelp };
18
+ /**
19
+ * Display help. Return false to prevent further processing.
20
+ *
21
+ * @internal
22
+ */
23
+ declare const showHelp: Action;
24
+ /**
25
+ * Get the list of registered global flags
26
+ *
27
+ * @internal
28
+ */
29
+ export declare function getGlobalOptions(): GlobalOptions;
30
+ export declare function resetGlobalOptions(): GlobalOptions;
31
+ /**
32
+ * Disable a global option
33
+ *
34
+ * @param name Can be the option short/long name or notation
35
+ */
36
+ export declare function disableGlobalOption(name: string): boolean;
37
+ /**
38
+ * Add a global option to the program.
39
+ * A global option is available at the program level,
40
+ * and associated with one given {@link Action}.
41
+ *
42
+ * @param a {@link Option} instance, for example created using {@link createOption()}
43
+ */
44
+ export declare function addGlobalOption(opt: Option, action?: Action): GlobalOptions;
45
+ /**
46
+ * Process global options, if any
47
+ * @internal
48
+ */
49
+ export declare function processGlobalOptions(parsed: ParserProcessedResult, program: Program, command?: Command): Promise<boolean>;
50
+ /**
51
+ * Find a global Option action from the option name (short or long)
52
+ *
53
+ * @param name Short or long name
54
+ * @internal
55
+ */
56
+ export declare function findGlobalOptAction(name: string): Action | undefined;
57
+ /**
58
+ * Find a global Option by it's name (short or long)
59
+ *
60
+ * @param name Short or long name
61
+ * @internal
62
+ */
63
+ export declare function findGlobalOption(name: string): Option | undefined;
64
+ export declare function isOptionObject(obj: unknown): obj is Option;
65
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/option/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,MAAM,EAEN,uBAAuB,EACvB,uBAAuB,EACvB,MAAM,EAEN,aAAa,EACb,qBAAqB,EACtB,MAAM,UAAU,CAAA;AAIjB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAIzC;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,uBAAuB,GAAG,uBAA4B,GAC9D,MAAM,CA6BR;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA;AAEnB;;;;GAIG;AACH,QAAA,MAAM,QAAQ,EAAE,MAyDb,CAAA;AASH;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,CAKhD;AA8CD,wBAAgB,kBAAkB,IAAI,aAAa,CAElD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQzD;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,CAE3E;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,qBAAqB,EAC7B,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,OAAO,CAAC,CAYlB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOjE;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,CAE1D"}
@@ -0,0 +1,230 @@
1
+ "use strict";
2
+ /**
3
+ * @packageDocumentation
4
+ * @module caporal/option
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.showHelp = void 0;
8
+ exports.createOption = createOption;
9
+ exports.getGlobalOptions = getGlobalOptions;
10
+ exports.resetGlobalOptions = resetGlobalOptions;
11
+ exports.disableGlobalOption = disableGlobalOption;
12
+ exports.addGlobalOption = addGlobalOption;
13
+ exports.processGlobalOptions = processGlobalOptions;
14
+ exports.findGlobalOptAction = findGlobalOptAction;
15
+ exports.findGlobalOption = findGlobalOption;
16
+ exports.isOptionObject = isOptionObject;
17
+ const types_1 = require("../types");
18
+ const utils_1 = require("../validator/utils");
19
+ const utils_2 = require("./utils");
20
+ const logger_1 = require("../logger");
21
+ const help_1 = require("../help");
22
+ const autocomplete_1 = require("../autocomplete");
23
+ /**
24
+ * Create an Option object
25
+ *
26
+ * @internal
27
+ * @param synopsis
28
+ * @param description
29
+ * @param options
30
+ */
31
+ function createOption(synopsis, description, options = {}) {
32
+ // eslint-disable-next-line prefer-const
33
+ let { validator, required, hidden } = options;
34
+ // force casting
35
+ required = Boolean(required);
36
+ (0, utils_1.checkValidator)(validator);
37
+ const syno = (0, utils_2.parseOptionSynopsis)(synopsis);
38
+ let boolean = syno.valueType === types_1.OptionValueType.None || (0, utils_1.isBoolValidator)(validator);
39
+ if (validator && !(0, utils_1.isBoolValidator)(validator)) {
40
+ boolean = false;
41
+ }
42
+ const opt = {
43
+ kind: "option",
44
+ default: boolean == true ? Boolean(options.default) : options.default,
45
+ description,
46
+ choices: Array.isArray(validator) ? validator : [],
47
+ ...syno,
48
+ required,
49
+ visible: !hidden,
50
+ boolean,
51
+ validator,
52
+ };
53
+ opt.typeHint = (0, utils_1.getTypeHint)(opt);
54
+ return opt;
55
+ }
56
+ /**
57
+ * Display help. Return false to prevent further processing.
58
+ *
59
+ * @internal
60
+ */
61
+ const showHelp = async ({ program, command }) => {
62
+ const help = await (0, help_1.getHelp)(program, command);
63
+ // eslint-disable-next-line no-console
64
+ console.log(help);
65
+ program.emit("help", help);
66
+ return false;
67
+ },
68
+ /**
69
+ * Display program version. Return false to prevent further processing.
70
+ *
71
+ * @internal
72
+ */
73
+ showVersion = ({ program }) => {
74
+ // eslint-disable-next-line no-console
75
+ console.log(program.getVersion());
76
+ program.emit("version", program.getVersion());
77
+ return false;
78
+ },
79
+ /**
80
+ * Disable colors in output
81
+ *
82
+ * @internal
83
+ */
84
+ disableColors = ({ logger }) => {
85
+ logger.disableColors();
86
+ },
87
+ /**
88
+ * Set verbosity to the maximum
89
+ *
90
+ * @internal
91
+ */
92
+ setVerbose = ({ logger }) => {
93
+ logger.level = "silly";
94
+ },
95
+ /**
96
+ * Makes the program quiet, eg displaying logs with level >= warning
97
+ */
98
+ setQuiet = ({ logger }) => {
99
+ logger.level = "warn";
100
+ },
101
+ /**
102
+ * Makes the program totally silent
103
+ */
104
+ setSilent = ({ logger }) => {
105
+ logger.silent = true;
106
+ },
107
+ /**
108
+ * Install completion
109
+ */
110
+ installComp = ({ program }) => {
111
+ return (0, autocomplete_1.installCompletion)(program);
112
+ },
113
+ /**
114
+ * Uninstall completion
115
+ */
116
+ uninstallComp = ({ program }) => {
117
+ return (0, autocomplete_1.uninstallCompletion)(program);
118
+ };
119
+ exports.showHelp = showHelp;
120
+ /**
121
+ * Global options container
122
+ *
123
+ * @internal
124
+ */
125
+ let globalOptions;
126
+ /**
127
+ * Get the list of registered global flags
128
+ *
129
+ * @internal
130
+ */
131
+ function getGlobalOptions() {
132
+ if (globalOptions === undefined) {
133
+ globalOptions = setupGlobalOptions();
134
+ }
135
+ return globalOptions;
136
+ }
137
+ /**
138
+ * Set up the global flags
139
+ *
140
+ * @internal
141
+ */
142
+ function setupGlobalOptions() {
143
+ const help = createOption("-h, --help", "Display global help or command-related help."), verbose = createOption("-v, --verbose", "Verbose mode: will also output debug messages."), quiet = createOption("--quiet", "Quiet mode - only displays warn and error messages."), silent = createOption("--silent", "Silent mode: does not output anything, giving no indication of success or failure other than the exit code."), version = createOption("-V, --version", "Display version."), color = createOption("--no-color", "Disable use of colors in output."), installCompOpt = createOption("--install-completion", "Install completion for your shell.", { hidden: true }), uninstallCompOpt = createOption("--uninstall-completion", "Uninstall completion for your shell.", { hidden: true });
144
+ return new Map([
145
+ [help, showHelp],
146
+ [version, showVersion],
147
+ [color, disableColors],
148
+ [verbose, setVerbose],
149
+ [quiet, setQuiet],
150
+ [silent, setSilent],
151
+ [installCompOpt, installComp],
152
+ [uninstallCompOpt, uninstallComp],
153
+ ]);
154
+ }
155
+ function resetGlobalOptions() {
156
+ return (globalOptions = setupGlobalOptions());
157
+ }
158
+ /**
159
+ * Disable a global option
160
+ *
161
+ * @param name Can be the option short/long name or notation
162
+ */
163
+ function disableGlobalOption(name) {
164
+ const opts = getGlobalOptions();
165
+ for (const [opt] of opts) {
166
+ if (opt.allNames.includes(name) || opt.allNotations.includes(name)) {
167
+ return opts.delete(opt);
168
+ }
169
+ }
170
+ return false;
171
+ }
172
+ /**
173
+ * Add a global option to the program.
174
+ * A global option is available at the program level,
175
+ * and associated with one given {@link Action}.
176
+ *
177
+ * @param a {@link Option} instance, for example created using {@link createOption()}
178
+ */
179
+ function addGlobalOption(opt, action) {
180
+ return getGlobalOptions().set(opt, action);
181
+ }
182
+ /**
183
+ * Process global options, if any
184
+ * @internal
185
+ */
186
+ async function processGlobalOptions(parsed, program, command) {
187
+ const { options } = parsed;
188
+ const actionsParams = { ...parsed, logger: logger_1.logger, program, command };
189
+ const promises = Object.entries(options).map(([opt]) => {
190
+ const action = findGlobalOptAction(opt);
191
+ if (action) {
192
+ return action(actionsParams);
193
+ }
194
+ return undefined;
195
+ });
196
+ const results = await Promise.all(promises);
197
+ return results.some((r) => r === false);
198
+ }
199
+ /**
200
+ * Find a global Option action from the option name (short or long)
201
+ *
202
+ * @param name Short or long name
203
+ * @internal
204
+ */
205
+ function findGlobalOptAction(name) {
206
+ for (const [opt, action] of getGlobalOptions()) {
207
+ if (opt.allNames.includes(name)) {
208
+ return action;
209
+ }
210
+ }
211
+ return undefined;
212
+ }
213
+ /**
214
+ * Find a global Option by it's name (short or long)
215
+ *
216
+ * @param name Short or long name
217
+ * @internal
218
+ */
219
+ function findGlobalOption(name) {
220
+ for (const [opt] of getGlobalOptions()) {
221
+ if (opt.allNames.includes(name)) {
222
+ return opt;
223
+ }
224
+ }
225
+ return undefined;
226
+ }
227
+ function isOptionObject(obj) {
228
+ return typeof obj == "object" && obj !== null && obj.kind == "option";
229
+ }
230
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/option/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA4BH,oCAiCC;AAgFD,4CAKC;AA8CD,gDAEC;AAOD,kDAQC;AASD,0CAEC;AAMD,oDAgBC;AAQD,kDAOC;AAQD,4CAOC;AAED,wCAEC;AAlRD,oCASiB;AACjB,8CAAiF;AACjF,mCAA6C;AAC7C,sCAAkC;AAGlC,kCAAiC;AACjC,kDAAwE;AAExE;;;;;;;GAOG;AACH,SAAgB,YAAY,CAC1B,QAAgB,EAChB,WAAmB,EACnB,UAA6D,EAAE;IAE/D,wCAAwC;IACxC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;IAE7C,gBAAgB;IAChB,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE5B,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAA;IACzB,MAAM,IAAI,GAAG,IAAA,2BAAmB,EAAC,QAAQ,CAAC,CAAA;IAC1C,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,KAAK,uBAAe,CAAC,IAAI,IAAI,IAAA,uBAAe,EAAC,SAAS,CAAC,CAAA;IACnF,IAAI,SAAS,IAAI,CAAC,IAAA,uBAAe,EAAC,SAAS,CAAC,EAAE,CAAC;QAC7C,OAAO,GAAG,KAAK,CAAA;IACjB,CAAC;IAED,MAAM,GAAG,GAAW;QAClB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO;QACrE,WAAW;QACX,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;QAClD,GAAG,IAAI;QACP,QAAQ;QACR,OAAO,EAAE,CAAC,MAAM;QAChB,OAAO;QACP,SAAS;KACV,CAAA;IAED,GAAG,CAAC,QAAQ,GAAG,IAAA,mBAAW,EAAC,GAAG,CAAC,CAAA;IAE/B,OAAO,GAAG,CAAA;AACZ,CAAC;AAID;;;;GAIG;AACH,MAAM,QAAQ,GAAW,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAoB,EAAE,EAAE;IACtE,MAAM,IAAI,GAAG,MAAM,IAAA,cAAO,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC5C,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACjB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAC1B,OAAO,KAAK,CAAA;AACd,CAAC;AACD;;;;GAIG;AACH,WAAW,GAAW,CAAC,EAAE,OAAO,EAAoB,EAAE,EAAE;IACtD,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IACjC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAC7C,OAAO,KAAK,CAAA;AACd,CAAC;AACD;;;;GAIG;AACH,aAAa,GAAW,CAAC,EAAE,MAAM,EAAoB,EAAE,EAAE;IACvD,MAAM,CAAC,aAAa,EAAE,CAAA;AACxB,CAAC;AACD;;;;GAIG;AACH,UAAU,GAAW,CAAC,EAAE,MAAM,EAAoB,EAAE,EAAE;IACpD,MAAM,CAAC,KAAK,GAAG,OAAO,CAAA;AACxB,CAAC;AACD;;GAEG;AACH,QAAQ,GAAW,CAAC,EAAE,MAAM,EAAoB,EAAE,EAAE;IAClD,MAAM,CAAC,KAAK,GAAG,MAAM,CAAA;AACvB,CAAC;AACD;;GAEG;AACH,SAAS,GAAW,CAAC,EAAE,MAAM,EAAoB,EAAE,EAAE;IACnD,MAAM,CAAC,MAAM,GAAG,IAAI,CAAA;AACtB,CAAC;AACD;;GAEG;AACH,WAAW,GAAW,CAAC,EAAE,OAAO,EAAoB,EAAE,EAAE;IACtD,OAAO,IAAA,gCAAiB,EAAC,OAAO,CAAC,CAAA;AACnC,CAAC;AACD;;GAEG;AACH,aAAa,GAAW,CAAC,EAAE,OAAO,EAAoB,EAAE,EAAE;IACxD,OAAO,IAAA,kCAAmB,EAAC,OAAO,CAAC,CAAA;AACrC,CAAC,CAAA;AAhEM,4BAAQ;AAkEjB;;;;GAIG;AACH,IAAI,aAAwC,CAAA;AAE5C;;;;GAIG;AACH,SAAgB,gBAAgB;IAC9B,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,aAAa,GAAG,kBAAkB,EAAE,CAAA;IACtC,CAAC;IACD,OAAO,aAAa,CAAA;AACtB,CAAC;AAED;;;;GAIG;AACH,SAAS,kBAAkB;IACzB,MAAM,IAAI,GAAG,YAAY,CAAC,YAAY,EAAE,8CAA8C,CAAC,EACrF,OAAO,GAAG,YAAY,CACpB,eAAe,EACf,gDAAgD,CACjD,EACD,KAAK,GAAG,YAAY,CAClB,SAAS,EACT,qDAAqD,CACtD,EACD,MAAM,GAAG,YAAY,CACnB,UAAU,EACV,6GAA6G,CAC9G,EACD,OAAO,GAAG,YAAY,CAAC,eAAe,EAAE,kBAAkB,CAAC,EAC3D,KAAK,GAAG,YAAY,CAAC,YAAY,EAAE,kCAAkC,CAAC,EACtE,cAAc,GAAG,YAAY,CAC3B,sBAAsB,EACtB,oCAAoC,EACpC,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,EACD,gBAAgB,GAAG,YAAY,CAC7B,wBAAwB,EACxB,sCAAsC,EACtC,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;IAEH,OAAO,IAAI,GAAG,CAAC;QACb,CAAC,IAAI,EAAE,QAAQ,CAAC;QAChB,CAAC,OAAO,EAAE,WAAW,CAAC;QACtB,CAAC,KAAK,EAAE,aAAa,CAAC;QACtB,CAAC,OAAO,EAAE,UAAU,CAAC;QACrB,CAAC,KAAK,EAAE,QAAQ,CAAC;QACjB,CAAC,MAAM,EAAE,SAAS,CAAC;QACnB,CAAC,cAAc,EAAE,WAAW,CAAC;QAC7B,CAAC,gBAAgB,EAAE,aAAa,CAAC;KAClC,CAAC,CAAA;AACJ,CAAC;AAED,SAAgB,kBAAkB;IAChC,OAAO,CAAC,aAAa,GAAG,kBAAkB,EAAE,CAAC,CAAA;AAC/C,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,IAAY;IAC9C,MAAM,IAAI,GAAG,gBAAgB,EAAE,CAAA;IAC/B,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACnE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACzB,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,GAAW,EAAE,MAAe;IAC1D,OAAO,gBAAgB,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;AAC5C,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAA6B,EAC7B,OAAgB,EAChB,OAAiB;IAEjB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;IAC1B,MAAM,aAAa,GAAG,EAAE,GAAG,MAAM,EAAE,MAAM,EAAN,eAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAA;IAC7D,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE;QACrD,MAAM,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC,aAAa,CAAC,CAAA;QAC9B,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC,CAAC,CAAA;IACF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAC3C,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAA;AACzC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,IAAY;IAC9C,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,gBAAgB,EAAE,EAAE,CAAC;QAC/C,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,MAAM,CAAA;QACf,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,gBAAgB,EAAE,EAAE,CAAC;QACvC,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,GAAG,CAAA;QACZ,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAgB,cAAc,CAAC,GAAY;IACzC,OAAO,OAAO,GAAG,IAAI,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAK,GAAc,CAAC,IAAI,IAAI,QAAQ,CAAA;AACnF,CAAC"}
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @packageDocumentation
3
+ * @internal
4
+ */
5
+ import type { Command } from "../command";
6
+ export declare function getOptsMapping(cmd: Command): Record<string, string>;
7
+ //# sourceMappingURL=mapping.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mapping.d.ts","sourceRoot":"","sources":["../../../src/option/mapping.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAMzC,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAKnE"}
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ /**
3
+ * @packageDocumentation
4
+ * @internal
5
+ */
6
+ var __importDefault = (this && this.__importDefault) || function (mod) {
7
+ return (mod && mod.__esModule) ? mod : { "default": mod };
8
+ };
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.getOptsMapping = getOptsMapping;
11
+ const map_1 = __importDefault(require("lodash/map"));
12
+ const zipObject_1 = __importDefault(require("lodash/zipObject"));
13
+ const invert_1 = __importDefault(require("lodash/invert"));
14
+ const pickBy_1 = __importDefault(require("lodash/pickBy"));
15
+ function getOptsMapping(cmd) {
16
+ const names = (0, map_1.default)(cmd.options, "name");
17
+ const aliases = (0, map_1.default)(cmd.options, (o) => o.shortName || o.longName);
18
+ const result = (0, zipObject_1.default)(names, aliases);
19
+ return (0, pickBy_1.default)({ ...result, ...(0, invert_1.default)(result) });
20
+ }
21
+ //# sourceMappingURL=mapping.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../../src/option/mapping.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAQH,wCAKC;AAVD,qDAA4B;AAC5B,iEAAwC;AACxC,2DAAkC;AAClC,2DAAkC;AAElC,SAAgB,cAAc,CAAC,GAAY;IACzC,MAAM,KAAK,GAAG,IAAA,aAAG,EAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACtC,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAA;IAClE,MAAM,MAAM,GAAG,IAAA,mBAAS,EAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACxC,OAAO,IAAA,gBAAM,EAAC,EAAE,GAAG,MAAM,EAAE,GAAG,IAAA,gBAAM,EAAC,MAAM,CAAC,EAAE,CAA2B,CAAA;AAC3E,CAAC"}