@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,119 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const __1 = require("..");
7
+ const prog_autocomplete_1 = require("../__fixtures__/prog-autocomplete");
8
+ const filter_1 = __importDefault(require("lodash/filter"));
9
+ const vitest_1 = require("vitest");
10
+ /**
11
+ * Helper to cimulate auto comp env
12
+ * @param cl Command line
13
+ * @param opts
14
+ * @param env
15
+ */
16
+ function makeFakeEnv(cl, opts = {}, env = process.env) {
17
+ let cursorPos = cl.indexOf("|");
18
+ if (cursorPos === -1) {
19
+ cursorPos = cl.length;
20
+ }
21
+ cl = cl.replace("|", "");
22
+ const argv = (0, filter_1.default)(cl.split(" "));
23
+ env.COMP_CWORD = String(argv.length);
24
+ env.COMP_LINE = cl;
25
+ env.COMP_POINT = cursorPos === -1 ? "0" : String(cursorPos);
26
+ env = { ...env, ...opts };
27
+ return { env, argv: [process.execPath, __filename, "completion", "--", ...argv] };
28
+ }
29
+ (0, vitest_1.describe)("autocomplete", () => {
30
+ (0, vitest_1.describe)("complete()", () => {
31
+ (0, vitest_1.it)("should auto-complete command name if possible", async () => {
32
+ const argv = "ord|";
33
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv(argv))).resolves.toEqual([
34
+ {
35
+ name: "order",
36
+ description: vitest_1.expect.any(String),
37
+ },
38
+ ]);
39
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv("c|"))).resolves.toEqual([
40
+ {
41
+ name: "cancel",
42
+ description: vitest_1.expect.any(String),
43
+ },
44
+ ]);
45
+ });
46
+ (0, vitest_1.it)("should not auto-complete command name if none are available", async () => {
47
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv("wrong|"))).resolves.toEqual([]);
48
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv("cancel|"))).resolves.not.toContain(vitest_1.expect.objectContaining({
49
+ name: "cancel",
50
+ }));
51
+ });
52
+ (0, vitest_1.it)("should auto-complete arguments values from choices", async () => {
53
+ const argv = "order |";
54
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv(argv))).resolves.toEqual([
55
+ {
56
+ name: "margherita",
57
+ description: vitest_1.expect.any(String),
58
+ },
59
+ {
60
+ name: "caprese",
61
+ description: vitest_1.expect.any(String),
62
+ },
63
+ {
64
+ name: "quattro fromaggi",
65
+ description: vitest_1.expect.any(String),
66
+ },
67
+ {
68
+ name: "--extra-ingredients",
69
+ description: vitest_1.expect.any(String),
70
+ },
71
+ ]);
72
+ });
73
+ (0, vitest_1.it)("should auto-complete arguments values from complete()", async () => {
74
+ const argv = "cancel |";
75
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv(argv))).resolves.toEqual([
76
+ {
77
+ name: "1234",
78
+ description: vitest_1.expect.any(String),
79
+ },
80
+ {
81
+ name: "5678",
82
+ description: vitest_1.expect.any(String),
83
+ },
84
+ {
85
+ name: "--cash-out",
86
+ description: vitest_1.expect.any(String),
87
+ },
88
+ ]);
89
+ });
90
+ (0, vitest_1.it)("should auto-complete partial options values from complete()", async () => {
91
+ const argv = "cancel --ca|";
92
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv(argv))).resolves.toEqual([
93
+ {
94
+ name: "--cash-out",
95
+ description: vitest_1.expect.any(String),
96
+ },
97
+ ]);
98
+ });
99
+ (0, vitest_1.it)("should auto-complete partial long options", async () => {
100
+ const argv = "order --ex";
101
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv(argv))).resolves.toEqual([
102
+ {
103
+ name: "--extra-ingredients",
104
+ description: vitest_1.expect.any(String),
105
+ },
106
+ ]);
107
+ });
108
+ (0, vitest_1.it)("should auto-complete a single dash", async () => {
109
+ const argv = "order -";
110
+ await (0, vitest_1.expect)((0, __1.complete)(prog_autocomplete_1.program, makeFakeEnv(argv))).resolves.toEqual([
111
+ {
112
+ name: "--extra-ingredients",
113
+ description: vitest_1.expect.any(String),
114
+ },
115
+ ]);
116
+ });
117
+ });
118
+ });
119
+ //# sourceMappingURL=autocomplete.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"autocomplete.spec.js","sourceRoot":"","sources":["../../../../src/autocomplete/__tests__/autocomplete.spec.ts"],"names":[],"mappings":";;;;;AAAA,0BAA6B;AAC7B,yEAA2D;AAC3D,2DAAkC;AAClC,mCAA6C;AAE7C;;;;;GAKG;AACH,SAAS,WAAW,CAClB,EAAU,EACV,OAA+B,EAAE,EACjC,GAAG,GAAG,OAAO,CAAC,GAAG;IAEjB,IAAI,SAAS,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC/B,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;QACrB,SAAS,GAAG,EAAE,CAAC,MAAM,CAAA;IACvB,CAAC;IACD,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IACxB,MAAM,IAAI,GAAG,IAAA,gBAAM,EAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IAElC,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACpC,GAAG,CAAC,SAAS,GAAG,EAAE,CAAA;IAClB,GAAG,CAAC,UAAU,GAAG,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IAC3D,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAA;IAEzB,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;AACnF,CAAC;AAED,IAAA,iBAAQ,EAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAA,iBAAQ,EAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,IAAA,WAAE,EAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC7D,MAAM,IAAI,GAAG,MAAM,CAAA;YACnB,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAClE;oBACE,IAAI,EAAE,OAAO;oBACb,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;aACF,CAAC,CAAA;YACF,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAClE;oBACE,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;aACF,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;YAC3E,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC3E,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAC5E,eAAM,CAAC,gBAAgB,CAAC;gBACtB,IAAI,EAAE,QAAQ;aACf,CAAC,CACH,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YAClE,MAAM,IAAI,GAAG,SAAS,CAAA;YACtB,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAClE;oBACE,IAAI,EAAE,YAAY;oBAClB,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;gBACD;oBACE,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;gBACD;oBACE,IAAI,EAAE,kBAAkB;oBACxB,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;gBACD;oBACE,IAAI,EAAE,qBAAqB;oBAC3B,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;aACF,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;YACrE,MAAM,IAAI,GAAG,UAAU,CAAA;YACvB,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAClE;oBACE,IAAI,EAAE,MAAM;oBACZ,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;gBACD;oBACE,IAAI,EAAE,MAAM;oBACZ,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;gBACD;oBACE,IAAI,EAAE,YAAY;oBAClB,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;aACF,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;YAC3E,MAAM,IAAI,GAAG,cAAc,CAAA;YAC3B,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAClE;oBACE,IAAI,EAAE,YAAY;oBAClB,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;aACF,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,IAAI,GAAG,YAAY,CAAA;YACzB,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAClE;oBACE,IAAI,EAAE,qBAAqB;oBAC3B,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;aACF,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,IAAI,GAAG,SAAS,CAAA;YACtB,MAAM,IAAA,eAAM,EAAC,IAAA,YAAQ,EAAC,2BAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAClE;oBACE,IAAI,EAAE,qBAAqB;oBAC3B,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;iBAChC;aACF,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
@@ -0,0 +1,20 @@
1
+ import { Program } from "../program";
2
+ import { Argument, Option } from "../types";
3
+ import { Completer, CompletionItem } from "./types";
4
+ /**
5
+ * Register a completion handler
6
+ *
7
+ * @param {Argument|Option} arg_or_opt argument or option to complete
8
+ * @param {Function} completer
9
+ */
10
+ export declare function registerCompletion(argOrOpt: Argument | Option, completer: Completer): void;
11
+ export declare function installCompletion(program: Program): Promise<void>;
12
+ export declare function uninstallCompletion(program: Program): Promise<void>;
13
+ /**
14
+ * Called by tabtab
15
+ */
16
+ export declare function complete(program: Program, { env, argv }?: {
17
+ env: NodeJS.ProcessEnv;
18
+ argv: string[];
19
+ }): Promise<CompletionItem[] | false>;
20
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/autocomplete/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAO3C,OAAO,EAAe,SAAS,EAAE,cAAc,EAAqB,MAAM,SAAS,CAAA;AAInF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,QAAQ,GAAG,MAAM,EAC3B,SAAS,EAAE,SAAS,GACnB,IAAI,CAEN;AAED,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAKvE;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAIzE;AAED;;GAEG;AACH,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,OAAO,EAChB,EAAE,GAAG,EAAE,IAAI,EAAE;;;CAA2C,GACvD,OAAO,CAAC,cAAc,EAAE,GAAG,KAAK,CAAC,CAkBnC"}
@@ -0,0 +1,172 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.registerCompletion = registerCompletion;
7
+ exports.installCompletion = installCompletion;
8
+ exports.uninstallCompletion = uninstallCompletion;
9
+ exports.complete = complete;
10
+ /**
11
+ * @packageDocumentation
12
+ * @module caporal/autocomplete
13
+ */
14
+ const tabtab_1 = __importDefault(require("tabtab"));
15
+ const parser_1 = require("../parser");
16
+ const validate_1 = require("../argument/validate");
17
+ const option_1 = require("../option");
18
+ const find_1 = require("../command/find");
19
+ const filter_1 = __importDefault(require("lodash/filter"));
20
+ const flatMap_1 = __importDefault(require("lodash/flatMap"));
21
+ const completions = new Map();
22
+ /**
23
+ * Register a completion handler
24
+ *
25
+ * @param {Argument|Option} arg_or_opt argument or option to complete
26
+ * @param {Function} completer
27
+ */
28
+ function registerCompletion(argOrOpt, completer) {
29
+ completions.set(argOrOpt, completer);
30
+ }
31
+ async function installCompletion(program) {
32
+ return tabtab_1.default.install({
33
+ name: program.getBin(),
34
+ completer: program.getBin(),
35
+ });
36
+ }
37
+ async function uninstallCompletion(program) {
38
+ return tabtab_1.default.uninstall({
39
+ name: program.getBin(),
40
+ });
41
+ }
42
+ /**
43
+ * Called by tabtab
44
+ */
45
+ async function complete(program, { env, argv } = { env: process.env, argv: process.argv }) {
46
+ const compEnv = tabtab_1.default.parseEnv(env);
47
+ if (!compEnv.complete) {
48
+ return false;
49
+ }
50
+ const ctx = await getContext(program, compEnv, argv);
51
+ const compPromises = [
52
+ getCompCommands(ctx),
53
+ getCompArgValues(ctx),
54
+ getCompOptNames(ctx),
55
+ getCompOptValues(ctx),
56
+ ];
57
+ const comps = (0, flatMap_1.default)(await Promise.all(compPromises));
58
+ tabtab_1.default.log(comps);
59
+ return comps;
60
+ }
61
+ async function getContext(program, compEnv, argv) {
62
+ const { lastPartial } = compEnv;
63
+ argv = argv.slice(4);
64
+ const currentCmd = await (0, find_1.findCommand)(program, argv);
65
+ const parserResult = (0, parser_1.parseArgv)(currentCmd?.getParserConfig(), argv);
66
+ const lastPartIsOpt = lastPartial.startsWith("-");
67
+ const lastPartIsKnownOpt = Boolean(lastPartIsOpt && currentCmd && getLastPartIsKnownOpt(currentCmd, lastPartial));
68
+ const currentOpt = currentCmd
69
+ ? currentCmd.options.find((o) => o.allNames.includes(lastPartial))
70
+ : undefined;
71
+ const ctx = {
72
+ program,
73
+ currentCmd,
74
+ compEnv,
75
+ parserResult,
76
+ lastPartIsOpt,
77
+ lastPartIsKnownOpt,
78
+ currentOpt,
79
+ };
80
+ return ctx;
81
+ }
82
+ async function getCompCommands(ctx) {
83
+ const { compEnv: { line }, program, currentCmd, } = ctx;
84
+ const commandMatch = (cmd, str) => {
85
+ return cmd.name.startsWith(str) || cmd.getAliases().some((a) => a.startsWith(str));
86
+ };
87
+ let commands = await program.getAllCommands();
88
+ commands = (0, filter_1.default)(commands, (cmd) => commandMatch(cmd, line) && cmd !== currentCmd);
89
+ return commands.map((cmd) => ({
90
+ name: cmd.name,
91
+ description: cmd.description,
92
+ }));
93
+ }
94
+ async function getCompOptNames(ctx) {
95
+ const { compEnv: { lastPartial }, currentCmd, } = ctx;
96
+ if (!currentCmd) {
97
+ return [];
98
+ }
99
+ const matchOptionName = (o) => {
100
+ return Boolean((o.shortNotation != lastPartial && o.shortNotation?.startsWith(lastPartial)) ||
101
+ (o.longNotation != lastPartial && o.longNotation?.startsWith(lastPartial)));
102
+ };
103
+ return (0, filter_1.default)(currentCmd.options, matchOptionName).map((opt) => ({
104
+ name: opt.notation,
105
+ description: opt.description,
106
+ }));
107
+ }
108
+ async function getCompOptValues(ctx) {
109
+ const { currentOpt } = ctx;
110
+ if (!currentOpt) {
111
+ return [];
112
+ }
113
+ // Choices
114
+ if (currentOpt.choices.length) {
115
+ return currentOpt.choices.map((choice) => ({
116
+ name: choice.toString(),
117
+ description: "Value for option " + currentOpt.synopsis,
118
+ }));
119
+ }
120
+ // Promise completion
121
+ const completer = completions.get(currentOpt);
122
+ if (completer) {
123
+ return hanldleCompleter(ctx, completer, currentOpt);
124
+ }
125
+ return [];
126
+ }
127
+ async function getCompArgValues(ctx) {
128
+ const { compEnv: { lastPartial }, parserResult: { args }, currentCmd, lastPartIsOpt, } = ctx;
129
+ if (!currentCmd || lastPartIsOpt) {
130
+ return [];
131
+ }
132
+ const formatedArgs = currentCmd.isProgramCommand()
133
+ ? args
134
+ : (0, validate_1.removeCommandFromArgs)(currentCmd, args);
135
+ const argsCount = formatedArgs.length;
136
+ const arg = currentCmd.args[argsCount];
137
+ if (!arg) {
138
+ return [];
139
+ }
140
+ // Choices
141
+ if (arg.choices.length) {
142
+ return arg.choices
143
+ .map((choice) => ({
144
+ name: choice.toString(),
145
+ description: "Value for argument " + arg.synopsis,
146
+ }))
147
+ .filter((choice) => !lastPartial || choice.name.toString().startsWith(lastPartial));
148
+ }
149
+ // Promise completion
150
+ const completion = completions.get(arg);
151
+ if (completion) {
152
+ return hanldleCompleter(ctx, completion, arg);
153
+ }
154
+ return [];
155
+ }
156
+ async function hanldleCompleter(ctx, completer, argOrOpt) {
157
+ const type = (0, option_1.isOptionObject)(argOrOpt) ? "option" : "argument";
158
+ const res = await completer(ctx);
159
+ return res.map((item) => {
160
+ if (typeof item === "object") {
161
+ return item;
162
+ }
163
+ return {
164
+ name: "" + item,
165
+ description: `Value for ${type} ${argOrOpt.synopsis}`,
166
+ };
167
+ });
168
+ }
169
+ function getLastPartIsKnownOpt(cmd, lastPartial) {
170
+ return cmd.options.some((o) => o.allNames.includes(lastPartial));
171
+ }
172
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/autocomplete/index.ts"],"names":[],"mappings":";;;;;AAyBA,gDAKC;AAED,8CAKC;AAED,kDAIC;AAKD,4BAqBC;AArED;;;GAGG;AACH,oDAA2B;AAC3B,sCAAqC;AAErC,mDAA4D;AAG5D,sCAA0C;AAC1C,0CAA6C;AAC7C,2DAAkC;AAClC,6DAAoC;AAIpC,MAAM,WAAW,GAAgB,IAAI,GAAG,EAAE,CAAA;AAE1C;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,QAA2B,EAC3B,SAAoB;IAEpB,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;AACtC,CAAC;AAEM,KAAK,UAAU,iBAAiB,CAAC,OAAgB;IACtD,OAAO,gBAAM,CAAC,OAAO,CAAC;QACpB,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE;QACtB,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE;KAC5B,CAAC,CAAA;AACJ,CAAC;AAEM,KAAK,UAAU,mBAAmB,CAAC,OAAgB;IACxD,OAAO,gBAAM,CAAC,SAAS,CAAC;QACtB,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE;KACvB,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,QAAQ,CAC5B,OAAgB,EAChB,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;IAExD,MAAM,OAAO,GAAG,gBAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IACpC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;IACpD,MAAM,YAAY,GAAG;QACnB,eAAe,CAAC,GAAG,CAAC;QACpB,gBAAgB,CAAC,GAAG,CAAC;QACrB,eAAe,CAAC,GAAG,CAAC;QACpB,gBAAgB,CAAC,GAAG,CAAC;KACtB,CAAA;IAED,MAAM,KAAK,GAAG,IAAA,iBAAO,EAAC,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAA;IACtD,gBAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IAEjB,OAAO,KAAK,CAAA;AACd,CAAC;AAED,KAAK,UAAU,UAAU,CACvB,OAAgB,EAChB,OAAyB,EACzB,IAAc;IAEd,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAA;IAC/B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACpB,MAAM,UAAU,GAAG,MAAM,IAAA,kBAAW,EAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IACnD,MAAM,YAAY,GAAG,IAAA,kBAAS,EAAC,UAAU,EAAE,eAAe,EAAE,EAAE,IAAI,CAAC,CAAA;IACnE,MAAM,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACjD,MAAM,kBAAkB,GAAG,OAAO,CAChC,aAAa,IAAI,UAAU,IAAI,qBAAqB,CAAC,UAAU,EAAE,WAAW,CAAC,CAC9E,CAAA;IACD,MAAM,UAAU,GAAG,UAAU;QAC3B,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClE,CAAC,CAAC,SAAS,CAAA;IAEb,MAAM,GAAG,GAAG;QACV,OAAO;QACP,UAAU;QACV,OAAO;QACP,YAAY;QACZ,aAAa;QACb,kBAAkB;QAClB,UAAU;KACX,CAAA;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,GAAsB;IACnD,MAAM,EACJ,OAAO,EAAE,EAAE,IAAI,EAAE,EACjB,OAAO,EACP,UAAU,GACX,GAAG,GAAG,CAAA;IACP,MAAM,YAAY,GAAG,CAAC,GAAY,EAAE,GAAW,EAAW,EAAE;QAC1D,OAAO,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;IACpF,CAAC,CAAA;IACD,IAAI,QAAQ,GAAG,MAAM,OAAO,CAAC,cAAc,EAAE,CAAA;IAC7C,QAAQ,GAAG,IAAA,gBAAM,EAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,GAAG,KAAK,UAAU,CAAC,CAAA;IACnF,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC5B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,WAAW,EAAE,GAAG,CAAC,WAAW;KAC7B,CAAC,CAAC,CAAA;AACL,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,GAAsB;IACnD,MAAM,EACJ,OAAO,EAAE,EAAE,WAAW,EAAE,EACxB,UAAU,GACX,GAAG,GAAG,CAAA;IAEP,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,eAAe,GAAG,CAAC,CAAS,EAAW,EAAE;QAC7C,OAAO,OAAO,CACZ,CAAC,CAAC,CAAC,aAAa,IAAI,WAAW,IAAI,CAAC,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAC1E,CAAC,CAAC,CAAC,YAAY,IAAI,WAAW,IAAI,CAAC,CAAC,YAAY,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAC7E,CAAA;IACH,CAAC,CAAA;IAED,OAAO,IAAA,gBAAM,EAAC,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC/D,IAAI,EAAE,GAAG,CAAC,QAAQ;QAClB,WAAW,EAAE,GAAG,CAAC,WAAW;KAC7B,CAAC,CAAC,CAAA;AACL,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,GAAsB;IACpD,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAA;IAC1B,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,UAAU;IACV,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAC9B,OAAO,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACzC,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE;YACvB,WAAW,EAAE,mBAAmB,GAAG,UAAU,CAAC,QAAQ;SACvD,CAAC,CAAC,CAAA;IACL,CAAC;IAED,qBAAqB;IACrB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IAC7C,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,gBAAgB,CAAC,GAAG,EAAE,SAAS,EAAE,UAAU,CAAC,CAAA;IACrD,CAAC;IAED,OAAO,EAAE,CAAA;AACX,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,GAAsB;IACpD,MAAM,EACJ,OAAO,EAAE,EAAE,WAAW,EAAE,EACxB,YAAY,EAAE,EAAE,IAAI,EAAE,EACtB,UAAU,EACV,aAAa,GACd,GAAG,GAAG,CAAA;IAEP,IAAI,CAAC,UAAU,IAAI,aAAa,EAAE,CAAC;QACjC,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,CAAC,gBAAgB,EAAE;QAChD,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,IAAA,gCAAqB,EAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IAE3C,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAA;IACrC,MAAM,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAEtC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,EAAE,CAAA;IACX,CAAC;IAED,UAAU;IACV,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC,OAAO;aACf,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAChB,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE;YACvB,WAAW,EAAE,qBAAqB,GAAG,GAAG,CAAC,QAAQ;SAClD,CAAC,CAAC;aACF,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAA;IACvF,CAAC;IAED,qBAAqB;IACrB,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACvC,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gBAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,CAAC,CAAA;IAC/C,CAAC;IAED,OAAO,EAAE,CAAA;AACX,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,GAAsB,EACtB,SAAoB,EACpB,QAA2B;IAE3B,MAAM,IAAI,GAAG,IAAA,uBAAc,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAA;IAC7D,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,CAAA;IAChC,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACtB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO;YACL,IAAI,EAAE,EAAE,GAAG,IAAI;YACf,WAAW,EAAE,aAAa,IAAI,IAAI,QAAQ,CAAC,QAAQ,EAAE;SACtD,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAY,EAAE,WAAmB;IAC9D,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAA;AAClE,CAAC"}
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @packageDocumentation
3
+ * @module caporal/types
4
+ */
5
+ import type { Argument, Option, Promisable, ParserResult } from "../types";
6
+ import type tabtab from "tabtab";
7
+ import type { Command } from "../command";
8
+ import type { Program } from "../program";
9
+ export interface CompletionItem {
10
+ name: string;
11
+ description: string;
12
+ }
13
+ export interface Completer {
14
+ (ctx: CompletionContext): Promisable<(string | CompletionItem)[]>;
15
+ }
16
+ export interface CompletionContext {
17
+ program: Program;
18
+ currentCmd?: Command;
19
+ compEnv: tabtab.TabtabEnv;
20
+ parserResult: ParserResult;
21
+ lastPartIsOpt: boolean;
22
+ lastPartIsKnownOpt: boolean;
23
+ currentOpt?: Option;
24
+ }
25
+ export type Completions = Map<Argument | Option, Completer>;
26
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/autocomplete/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC1E,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAChC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,iBAAiB,GAAG,UAAU,CAAC,CAAC,MAAM,GAAG,cAAc,CAAC,EAAE,CAAC,CAAA;CAClE;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,EAAE,MAAM,CAAC,SAAS,CAAA;IACzB,YAAY,EAAE,YAAY,CAAA;IAC1B,aAAa,EAAE,OAAO,CAAA;IACtB,kBAAkB,EAAE,OAAO,CAAA;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,GAAG,MAAM,EAAE,SAAS,CAAC,CAAA"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/autocomplete/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @packageDocumentation
3
+ * @ignore
4
+ */
5
+ import type { Command } from "..";
6
+ import type { CreateCommandParameters } from "../../types";
7
+ export default function ({ createCommand }: CreateCommandParameters): Command;
8
+ //# sourceMappingURL=example-cmd.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"example-cmd.d.ts","sourceRoot":"","sources":["../../../../src/command/__fixtures__/example-cmd.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,IAAI,CAAA;AACjC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAE1D,MAAM,CAAC,OAAO,WAAW,EAAE,aAAa,EAAE,EAAE,uBAAuB,GAAG,OAAO,CAK5E"}
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.default = default_1;
4
+ function default_1({ createCommand }) {
5
+ return createCommand("My command").action(({ logger }) => {
6
+ logger.info("Output of my command");
7
+ return "hey";
8
+ });
9
+ }
10
+ //# sourceMappingURL=example-cmd.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"example-cmd.js","sourceRoot":"","sources":["../../../../src/command/__fixtures__/example-cmd.ts"],"names":[],"mappings":";;AAQA,4BAKC;AALD,mBAAyB,EAAE,aAAa,EAA2B;IACjE,OAAO,aAAa,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACvD,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;QACnC,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=command.spec.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"command.spec.d.ts","sourceRoot":"","sources":["../../../../src/command/__tests__/command.spec.ts"],"names":[],"mappings":""}