zod-args-parser 2.0.0-alpha.0 → 2.0.0-beta.0

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 (510) hide show
  1. package/README.md +525 -588
  2. package/lib/cjs/autocomplete-scripts/bash-autocomplete-script.cjs +2 -0
  3. package/lib/cjs/autocomplete-scripts/bash-autocomplete-script.cjs.map +1 -0
  4. package/lib/cjs/autocomplete-scripts/powershell-autocomplete-script.cjs +2 -0
  5. package/lib/cjs/autocomplete-scripts/powershell-autocomplete-script.cjs.map +1 -0
  6. package/lib/cjs/autocomplete-scripts/zsh-autocomplete-script.cjs +42 -0
  7. package/lib/cjs/autocomplete-scripts/zsh-autocomplete-script.cjs.map +1 -0
  8. package/lib/cjs/coerce/coerce-methods.cjs +2 -0
  9. package/lib/cjs/coerce/coerce-methods.cjs.map +1 -0
  10. package/lib/cjs/coerce/string-to-array.cjs +2 -0
  11. package/lib/cjs/coerce/string-to-array.cjs.map +1 -0
  12. package/lib/cjs/coerce/string-to-primitive.cjs +2 -0
  13. package/lib/cjs/coerce/string-to-primitive.cjs.map +1 -0
  14. package/lib/cjs/coerce/string-to-set.cjs +2 -0
  15. package/lib/cjs/coerce/string-to-set.cjs.map +1 -0
  16. package/lib/cjs/definitions/define-arguments.cjs +2 -0
  17. package/lib/cjs/definitions/define-arguments.cjs.map +1 -0
  18. package/lib/cjs/definitions/define-cli.cjs +2 -0
  19. package/lib/cjs/definitions/define-cli.cjs.map +1 -0
  20. package/lib/cjs/definitions/define-options.cjs +2 -0
  21. package/lib/cjs/definitions/define-options.cjs.map +1 -0
  22. package/lib/cjs/definitions/define-subcommand.cjs +2 -0
  23. package/lib/cjs/definitions/define-subcommand.cjs.map +1 -0
  24. package/lib/cjs/definitions/validate-cli-definition.cjs +2 -0
  25. package/lib/cjs/definitions/validate-cli-definition.cjs.map +1 -0
  26. package/lib/cjs/help-message/format-arguments.cjs +2 -0
  27. package/lib/cjs/help-message/format-arguments.cjs.map +1 -0
  28. package/lib/cjs/help-message/format-options.cjs +2 -0
  29. package/lib/cjs/help-message/format-options.cjs.map +1 -0
  30. package/lib/cjs/help-message/format-subcommands.cjs +2 -0
  31. package/lib/cjs/help-message/format-subcommands.cjs.map +1 -0
  32. package/lib/cjs/help-message/generate-for-cli.cjs +2 -0
  33. package/lib/cjs/help-message/generate-for-cli.cjs.map +1 -0
  34. package/lib/cjs/help-message/generate-for-subcommand.cjs +2 -0
  35. package/lib/cjs/help-message/generate-for-subcommand.cjs.map +1 -0
  36. package/lib/cjs/help-message/print-help.cjs +2 -0
  37. package/lib/cjs/help-message/print-help.cjs.map +1 -0
  38. package/lib/cjs/help-message/set-defaults.cjs +2 -0
  39. package/lib/cjs/help-message/set-defaults.cjs.map +1 -0
  40. package/lib/cjs/help-message/styles.cjs +2 -0
  41. package/lib/cjs/help-message/styles.cjs.map +1 -0
  42. package/lib/cjs/help-message/terminal-markdown.cjs +2 -0
  43. package/lib/cjs/help-message/terminal-markdown.cjs.map +1 -0
  44. package/lib/cjs/index.cjs +2 -0
  45. package/lib/cjs/index.cjs.map +1 -0
  46. package/lib/cjs/markdown/generate-markdown.cjs +2 -0
  47. package/lib/cjs/markdown/generate-markdown.cjs.map +1 -0
  48. package/lib/cjs/metadata/arguments-metadata.cjs +2 -0
  49. package/lib/cjs/metadata/arguments-metadata.cjs.map +1 -0
  50. package/lib/cjs/metadata/cli-metadata.cjs +2 -0
  51. package/lib/cjs/metadata/cli-metadata.cjs.map +1 -0
  52. package/lib/cjs/metadata/options-metadata.cjs +2 -0
  53. package/lib/cjs/metadata/options-metadata.cjs.map +1 -0
  54. package/lib/cjs/metadata/subcommands-metadata.cjs +2 -0
  55. package/lib/cjs/metadata/subcommands-metadata.cjs.map +1 -0
  56. package/lib/cjs/parse/context/cli-context-builder.cjs +2 -0
  57. package/lib/cjs/parse/context/cli-context-builder.cjs.map +1 -0
  58. package/lib/cjs/parse/context/object-context-builder.cjs +2 -0
  59. package/lib/cjs/parse/context/object-context-builder.cjs.map +1 -0
  60. package/lib/cjs/parse/parser-utilities.cjs +2 -0
  61. package/lib/cjs/parse/parser-utilities.cjs.map +1 -0
  62. package/lib/cjs/parse/safe-parse.cjs +2 -0
  63. package/lib/cjs/parse/safe-parse.cjs.map +1 -0
  64. package/lib/cjs/parse/validation/validate-context.cjs +2 -0
  65. package/lib/cjs/parse/validation/validate-context.cjs.map +1 -0
  66. package/lib/cjs/parse/validation/validators/arguments.cjs +2 -0
  67. package/lib/cjs/parse/validation/validators/arguments.cjs.map +1 -0
  68. package/lib/cjs/parse/validation/validators/conflict.cjs +2 -0
  69. package/lib/cjs/parse/validation/validators/conflict.cjs.map +1 -0
  70. package/lib/cjs/parse/validation/validators/exclusive.cjs +2 -0
  71. package/lib/cjs/parse/validation/validators/exclusive.cjs.map +1 -0
  72. package/lib/cjs/parse/validation/validators/explicitly-passed.cjs +2 -0
  73. package/lib/cjs/parse/validation/validators/explicitly-passed.cjs.map +1 -0
  74. package/lib/cjs/parse/validation/validators/options.cjs +2 -0
  75. package/lib/cjs/parse/validation/validators/options.cjs.map +1 -0
  76. package/lib/cjs/parse/validation/validators/requires.cjs +2 -0
  77. package/lib/cjs/parse/validation/validators/requires.cjs.map +1 -0
  78. package/lib/cjs/utilities.cjs +2 -0
  79. package/lib/cjs/utilities.cjs.map +1 -0
  80. package/lib/esm/autocomplete-scripts/bash-autocomplete-script.js +2 -0
  81. package/lib/esm/autocomplete-scripts/bash-autocomplete-script.js.map +1 -0
  82. package/lib/esm/autocomplete-scripts/powershell-autocomplete-script.js +2 -0
  83. package/lib/esm/autocomplete-scripts/powershell-autocomplete-script.js.map +1 -0
  84. package/lib/esm/autocomplete-scripts/zsh-autocomplete-script.js +42 -0
  85. package/lib/esm/autocomplete-scripts/zsh-autocomplete-script.js.map +1 -0
  86. package/lib/esm/coerce/coerce-methods.js +2 -0
  87. package/lib/esm/coerce/coerce-methods.js.map +1 -0
  88. package/lib/esm/coerce/string-to-array.js +2 -0
  89. package/lib/esm/coerce/string-to-array.js.map +1 -0
  90. package/lib/esm/coerce/string-to-primitive.js +2 -0
  91. package/lib/esm/coerce/string-to-primitive.js.map +1 -0
  92. package/lib/esm/coerce/string-to-set.js +2 -0
  93. package/lib/esm/coerce/string-to-set.js.map +1 -0
  94. package/lib/esm/definitions/define-arguments.js +2 -0
  95. package/lib/esm/definitions/define-arguments.js.map +1 -0
  96. package/lib/esm/definitions/define-cli.js +2 -0
  97. package/lib/esm/definitions/define-cli.js.map +1 -0
  98. package/lib/esm/definitions/define-options.js +2 -0
  99. package/lib/esm/definitions/define-options.js.map +1 -0
  100. package/lib/esm/definitions/define-subcommand.js +2 -0
  101. package/lib/esm/definitions/define-subcommand.js.map +1 -0
  102. package/lib/esm/definitions/validate-cli-definition.js +2 -0
  103. package/lib/esm/definitions/validate-cli-definition.js.map +1 -0
  104. package/lib/esm/help-message/format-arguments.js +2 -0
  105. package/lib/esm/help-message/format-arguments.js.map +1 -0
  106. package/lib/esm/help-message/format-options.js +2 -0
  107. package/lib/esm/help-message/format-options.js.map +1 -0
  108. package/lib/esm/help-message/format-subcommands.js +2 -0
  109. package/lib/esm/help-message/format-subcommands.js.map +1 -0
  110. package/lib/esm/help-message/generate-for-cli.js +2 -0
  111. package/lib/esm/help-message/generate-for-cli.js.map +1 -0
  112. package/lib/esm/help-message/generate-for-subcommand.js +2 -0
  113. package/lib/esm/help-message/generate-for-subcommand.js.map +1 -0
  114. package/lib/esm/help-message/print-help.js +2 -0
  115. package/lib/esm/help-message/print-help.js.map +1 -0
  116. package/lib/esm/help-message/set-defaults.js +2 -0
  117. package/lib/esm/help-message/set-defaults.js.map +1 -0
  118. package/lib/esm/help-message/styles.js +2 -0
  119. package/lib/esm/help-message/styles.js.map +1 -0
  120. package/lib/esm/help-message/terminal-markdown.js +2 -0
  121. package/lib/esm/help-message/terminal-markdown.js.map +1 -0
  122. package/lib/esm/index.js +2 -0
  123. package/lib/esm/index.js.map +1 -0
  124. package/lib/esm/markdown/generate-markdown.js +2 -0
  125. package/lib/esm/markdown/generate-markdown.js.map +1 -0
  126. package/lib/esm/metadata/arguments-metadata.js +2 -0
  127. package/lib/esm/metadata/arguments-metadata.js.map +1 -0
  128. package/lib/esm/metadata/cli-metadata.js +2 -0
  129. package/lib/esm/metadata/cli-metadata.js.map +1 -0
  130. package/lib/esm/metadata/options-metadata.js +2 -0
  131. package/lib/esm/metadata/options-metadata.js.map +1 -0
  132. package/lib/esm/metadata/subcommands-metadata.js +2 -0
  133. package/lib/esm/metadata/subcommands-metadata.js.map +1 -0
  134. package/lib/esm/parse/context/cli-context-builder.js +2 -0
  135. package/lib/esm/parse/context/cli-context-builder.js.map +1 -0
  136. package/lib/esm/parse/context/object-context-builder.js +2 -0
  137. package/lib/esm/parse/context/object-context-builder.js.map +1 -0
  138. package/lib/esm/parse/parser-utilities.js +2 -0
  139. package/lib/esm/parse/parser-utilities.js.map +1 -0
  140. package/lib/esm/parse/safe-parse.js +2 -0
  141. package/lib/esm/parse/safe-parse.js.map +1 -0
  142. package/lib/esm/parse/validation/validate-context.js +2 -0
  143. package/lib/esm/parse/validation/validate-context.js.map +1 -0
  144. package/lib/esm/parse/validation/validators/arguments.js +2 -0
  145. package/lib/esm/parse/validation/validators/arguments.js.map +1 -0
  146. package/lib/esm/parse/validation/validators/conflict.js +2 -0
  147. package/lib/esm/parse/validation/validators/conflict.js.map +1 -0
  148. package/lib/esm/parse/validation/validators/exclusive.js +2 -0
  149. package/lib/esm/parse/validation/validators/exclusive.js.map +1 -0
  150. package/lib/esm/parse/validation/validators/explicitly-passed.js +2 -0
  151. package/lib/esm/parse/validation/validators/explicitly-passed.js.map +1 -0
  152. package/lib/esm/parse/validation/validators/options.js +2 -0
  153. package/lib/esm/parse/validation/validators/options.js.map +1 -0
  154. package/lib/esm/parse/validation/validators/requires.js +2 -0
  155. package/lib/esm/parse/validation/validators/requires.js.map +1 -0
  156. package/lib/esm/utilities.js +2 -0
  157. package/lib/esm/utilities.js.map +1 -0
  158. package/lib/iife/index.js +2 -0
  159. package/lib/iife/index.js.map +1 -0
  160. package/lib/mjs/autocomplete-scripts/bash-autocomplete-script.mjs +2 -0
  161. package/lib/mjs/autocomplete-scripts/bash-autocomplete-script.mjs.map +1 -0
  162. package/lib/mjs/autocomplete-scripts/powershell-autocomplete-script.mjs +2 -0
  163. package/lib/mjs/autocomplete-scripts/powershell-autocomplete-script.mjs.map +1 -0
  164. package/lib/mjs/autocomplete-scripts/zsh-autocomplete-script.mjs +42 -0
  165. package/lib/mjs/autocomplete-scripts/zsh-autocomplete-script.mjs.map +1 -0
  166. package/lib/mjs/coerce/coerce-methods.mjs +2 -0
  167. package/lib/mjs/coerce/coerce-methods.mjs.map +1 -0
  168. package/lib/mjs/coerce/string-to-array.mjs +2 -0
  169. package/lib/mjs/coerce/string-to-array.mjs.map +1 -0
  170. package/lib/mjs/coerce/string-to-primitive.mjs +2 -0
  171. package/lib/mjs/coerce/string-to-primitive.mjs.map +1 -0
  172. package/lib/mjs/coerce/string-to-set.mjs +2 -0
  173. package/lib/mjs/coerce/string-to-set.mjs.map +1 -0
  174. package/lib/mjs/definitions/define-arguments.mjs +2 -0
  175. package/lib/mjs/definitions/define-arguments.mjs.map +1 -0
  176. package/lib/mjs/definitions/define-cli.mjs +2 -0
  177. package/lib/mjs/definitions/define-cli.mjs.map +1 -0
  178. package/lib/mjs/definitions/define-options.mjs +2 -0
  179. package/lib/mjs/definitions/define-options.mjs.map +1 -0
  180. package/lib/mjs/definitions/define-subcommand.mjs +2 -0
  181. package/lib/mjs/definitions/define-subcommand.mjs.map +1 -0
  182. package/lib/mjs/definitions/validate-cli-definition.mjs +2 -0
  183. package/lib/mjs/definitions/validate-cli-definition.mjs.map +1 -0
  184. package/lib/mjs/help-message/format-arguments.mjs +2 -0
  185. package/lib/mjs/help-message/format-arguments.mjs.map +1 -0
  186. package/lib/mjs/help-message/format-options.mjs +2 -0
  187. package/lib/mjs/help-message/format-options.mjs.map +1 -0
  188. package/lib/mjs/help-message/format-subcommands.mjs +2 -0
  189. package/lib/mjs/help-message/format-subcommands.mjs.map +1 -0
  190. package/lib/mjs/help-message/generate-for-cli.mjs +2 -0
  191. package/lib/mjs/help-message/generate-for-cli.mjs.map +1 -0
  192. package/lib/mjs/help-message/generate-for-subcommand.mjs +2 -0
  193. package/lib/mjs/help-message/generate-for-subcommand.mjs.map +1 -0
  194. package/lib/mjs/help-message/print-help.mjs +2 -0
  195. package/lib/mjs/help-message/print-help.mjs.map +1 -0
  196. package/lib/mjs/help-message/set-defaults.mjs +2 -0
  197. package/lib/mjs/help-message/set-defaults.mjs.map +1 -0
  198. package/lib/mjs/help-message/styles.mjs +2 -0
  199. package/lib/mjs/help-message/styles.mjs.map +1 -0
  200. package/lib/mjs/help-message/terminal-markdown.mjs +2 -0
  201. package/lib/mjs/help-message/terminal-markdown.mjs.map +1 -0
  202. package/lib/mjs/index.mjs +2 -0
  203. package/lib/mjs/index.mjs.map +1 -0
  204. package/lib/mjs/markdown/generate-markdown.mjs +2 -0
  205. package/lib/mjs/markdown/generate-markdown.mjs.map +1 -0
  206. package/lib/mjs/metadata/arguments-metadata.mjs +2 -0
  207. package/lib/mjs/metadata/arguments-metadata.mjs.map +1 -0
  208. package/lib/mjs/metadata/cli-metadata.mjs +2 -0
  209. package/lib/mjs/metadata/cli-metadata.mjs.map +1 -0
  210. package/lib/mjs/metadata/options-metadata.mjs +2 -0
  211. package/lib/mjs/metadata/options-metadata.mjs.map +1 -0
  212. package/lib/mjs/metadata/subcommands-metadata.mjs +2 -0
  213. package/lib/mjs/metadata/subcommands-metadata.mjs.map +1 -0
  214. package/lib/mjs/parse/context/cli-context-builder.mjs +2 -0
  215. package/lib/mjs/parse/context/cli-context-builder.mjs.map +1 -0
  216. package/lib/mjs/parse/context/object-context-builder.mjs +2 -0
  217. package/lib/mjs/parse/context/object-context-builder.mjs.map +1 -0
  218. package/lib/mjs/parse/parser-utilities.mjs +2 -0
  219. package/lib/mjs/parse/parser-utilities.mjs.map +1 -0
  220. package/lib/mjs/parse/safe-parse.mjs +2 -0
  221. package/lib/mjs/parse/safe-parse.mjs.map +1 -0
  222. package/lib/mjs/parse/validation/validate-context.mjs +2 -0
  223. package/lib/mjs/parse/validation/validate-context.mjs.map +1 -0
  224. package/lib/mjs/parse/validation/validators/arguments.mjs +2 -0
  225. package/lib/mjs/parse/validation/validators/arguments.mjs.map +1 -0
  226. package/lib/mjs/parse/validation/validators/conflict.mjs +2 -0
  227. package/lib/mjs/parse/validation/validators/conflict.mjs.map +1 -0
  228. package/lib/mjs/parse/validation/validators/exclusive.mjs +2 -0
  229. package/lib/mjs/parse/validation/validators/exclusive.mjs.map +1 -0
  230. package/lib/mjs/parse/validation/validators/explicitly-passed.mjs +2 -0
  231. package/lib/mjs/parse/validation/validators/explicitly-passed.mjs.map +1 -0
  232. package/lib/mjs/parse/validation/validators/options.mjs +2 -0
  233. package/lib/mjs/parse/validation/validators/options.mjs.map +1 -0
  234. package/lib/mjs/parse/validation/validators/requires.mjs +2 -0
  235. package/lib/mjs/parse/validation/validators/requires.mjs.map +1 -0
  236. package/lib/mjs/utilities.mjs +2 -0
  237. package/lib/mjs/utilities.mjs.map +1 -0
  238. package/lib/typescript/autocomplete-scripts/bash-autocomplete-script.d.ts +2 -2
  239. package/lib/typescript/autocomplete-scripts/bash-autocomplete-script.d.ts.map +1 -1
  240. package/lib/typescript/autocomplete-scripts/powershell-autocomplete-script.d.ts +2 -2
  241. package/lib/typescript/autocomplete-scripts/powershell-autocomplete-script.d.ts.map +1 -1
  242. package/lib/typescript/autocomplete-scripts/zsh-autocomplete-script.d.ts +2 -2
  243. package/lib/typescript/autocomplete-scripts/zsh-autocomplete-script.d.ts.map +1 -1
  244. package/lib/typescript/coerce/coerce-methods.d.ts +20 -0
  245. package/lib/typescript/coerce/coerce-methods.d.ts.map +1 -0
  246. package/lib/typescript/coerce/string-to-array.d.ts +6 -0
  247. package/lib/typescript/coerce/string-to-array.d.ts.map +1 -0
  248. package/lib/typescript/coerce/string-to-primitive.d.ts +5 -0
  249. package/lib/typescript/coerce/string-to-primitive.d.ts.map +1 -0
  250. package/lib/typescript/coerce/string-to-set.d.ts +6 -0
  251. package/lib/typescript/coerce/string-to-set.d.ts.map +1 -0
  252. package/lib/typescript/definitions/define-arguments.d.ts +7 -0
  253. package/lib/typescript/definitions/define-arguments.d.ts.map +1 -0
  254. package/lib/typescript/definitions/define-cli.d.ts +24 -0
  255. package/lib/typescript/definitions/define-cli.d.ts.map +1 -0
  256. package/lib/typescript/definitions/define-options.d.ts +7 -0
  257. package/lib/typescript/definitions/define-options.d.ts.map +1 -0
  258. package/lib/typescript/definitions/define-subcommand.d.ts +17 -0
  259. package/lib/typescript/definitions/define-subcommand.d.ts.map +1 -0
  260. package/lib/typescript/definitions/validate-cli-definition.d.ts +4 -0
  261. package/lib/typescript/definitions/validate-cli-definition.d.ts.map +1 -0
  262. package/lib/typescript/help-message/format-arguments.d.ts +3 -3
  263. package/lib/typescript/help-message/format-arguments.d.ts.map +1 -1
  264. package/lib/typescript/help-message/format-options.d.ts +3 -3
  265. package/lib/typescript/help-message/format-options.d.ts.map +1 -1
  266. package/lib/typescript/help-message/format-subcommands.d.ts +3 -3
  267. package/lib/typescript/help-message/format-subcommands.d.ts.map +1 -1
  268. package/lib/typescript/help-message/generate-for-cli.d.ts +8 -0
  269. package/lib/typescript/help-message/generate-for-cli.d.ts.map +1 -0
  270. package/lib/typescript/help-message/generate-for-subcommand.d.ts +4 -0
  271. package/lib/typescript/help-message/generate-for-subcommand.d.ts.map +1 -0
  272. package/lib/typescript/help-message/print-help.d.ts +5 -0
  273. package/lib/typescript/help-message/print-help.d.ts.map +1 -0
  274. package/lib/typescript/help-message/set-defaults.d.ts +4 -0
  275. package/lib/typescript/help-message/set-defaults.d.ts.map +1 -0
  276. package/lib/typescript/help-message/styles.d.ts +30 -106
  277. package/lib/typescript/help-message/styles.d.ts.map +1 -1
  278. package/lib/typescript/help-message/terminal-markdown.d.ts +3 -0
  279. package/lib/typescript/help-message/terminal-markdown.d.ts.map +1 -0
  280. package/lib/typescript/index.d.ts +23 -35
  281. package/lib/typescript/index.d.ts.map +1 -1
  282. package/lib/typescript/markdown/generate-markdown.d.ts +2 -2
  283. package/lib/typescript/markdown/generate-markdown.d.ts.map +1 -1
  284. package/lib/typescript/metadata/arguments-metadata.d.ts +4 -0
  285. package/lib/typescript/metadata/arguments-metadata.d.ts.map +1 -0
  286. package/lib/typescript/metadata/cli-metadata.d.ts +4 -0
  287. package/lib/typescript/metadata/cli-metadata.d.ts.map +1 -0
  288. package/lib/typescript/metadata/options-metadata.d.ts +4 -0
  289. package/lib/typescript/metadata/options-metadata.d.ts.map +1 -0
  290. package/lib/typescript/metadata/subcommands-metadata.d.ts +4 -0
  291. package/lib/typescript/metadata/subcommands-metadata.d.ts.map +1 -0
  292. package/lib/typescript/parse/context/cli-context-builder.d.ts +9 -0
  293. package/lib/typescript/parse/context/cli-context-builder.d.ts.map +1 -0
  294. package/lib/typescript/parse/context/object-context-builder.d.ts +6 -0
  295. package/lib/typescript/parse/context/object-context-builder.d.ts.map +1 -0
  296. package/lib/typescript/{parser/parse/parser-helpers.d.ts → parse/parser-utilities.d.ts} +18 -9
  297. package/lib/typescript/parse/parser-utilities.d.ts.map +1 -0
  298. package/lib/typescript/parse/safe-parse.d.ts +5 -0
  299. package/lib/typescript/parse/safe-parse.d.ts.map +1 -0
  300. package/lib/typescript/parse/validation/validate-context.d.ts +6 -0
  301. package/lib/typescript/parse/validation/validate-context.d.ts.map +1 -0
  302. package/lib/typescript/parse/validation/validators/arguments.d.ts +12 -0
  303. package/lib/typescript/parse/validation/validators/arguments.d.ts.map +1 -0
  304. package/lib/typescript/parse/validation/validators/conflict.d.ts +16 -0
  305. package/lib/typescript/parse/validation/validators/conflict.d.ts.map +1 -0
  306. package/lib/typescript/parse/validation/validators/exclusive.d.ts +16 -0
  307. package/lib/typescript/parse/validation/validators/exclusive.d.ts.map +1 -0
  308. package/lib/typescript/parse/validation/validators/explicitly-passed.d.ts +5 -0
  309. package/lib/typescript/parse/validation/validators/explicitly-passed.d.ts.map +1 -0
  310. package/lib/typescript/parse/validation/validators/options.d.ts +12 -0
  311. package/lib/typescript/parse/validation/validators/options.d.ts.map +1 -0
  312. package/lib/typescript/parse/validation/validators/requires.d.ts +18 -0
  313. package/lib/typescript/parse/validation/validators/requires.d.ts.map +1 -0
  314. package/lib/typescript/types/context-types.d.ts +135 -0
  315. package/lib/typescript/types/context-types.d.ts.map +1 -0
  316. package/lib/typescript/types/definitions-types.d.ts +294 -0
  317. package/lib/typescript/types/definitions-types.d.ts.map +1 -0
  318. package/lib/typescript/types/help-message-types.d.ts +134 -0
  319. package/lib/typescript/types/help-message-types.d.ts.map +1 -0
  320. package/lib/typescript/types/io-types.d.ts +96 -0
  321. package/lib/typescript/types/io-types.d.ts.map +1 -0
  322. package/lib/typescript/types/metadata-types.d.ts +75 -0
  323. package/lib/typescript/types/metadata-types.d.ts.map +1 -0
  324. package/lib/typescript/types/schema-types.d.ts +6 -0
  325. package/lib/typescript/types/schema-types.d.ts.map +1 -0
  326. package/lib/typescript/types/types.d.ts +61 -0
  327. package/lib/typescript/types/types.d.ts.map +1 -0
  328. package/lib/typescript/types/utilities-types.d.ts +17 -0
  329. package/lib/typescript/types/utilities-types.d.ts.map +1 -0
  330. package/lib/typescript/utilities.d.ts +24 -10
  331. package/lib/typescript/utilities.d.ts.map +1 -1
  332. package/package.json +29 -26
  333. package/src/autocomplete-scripts/bash-autocomplete-script.ts +13 -9
  334. package/src/autocomplete-scripts/powershell-autocomplete-script.ts +21 -13
  335. package/src/autocomplete-scripts/zsh-autocomplete-script.ts +27 -23
  336. package/src/coerce/coerce-methods.ts +75 -0
  337. package/src/coerce/string-to-array.ts +18 -0
  338. package/src/coerce/string-to-primitive.ts +31 -0
  339. package/src/coerce/string-to-set.ts +15 -0
  340. package/src/definitions/define-arguments.ts +10 -0
  341. package/src/definitions/define-cli.ts +105 -0
  342. package/src/definitions/define-options.ts +12 -0
  343. package/src/definitions/define-subcommand.ts +57 -0
  344. package/src/definitions/validate-cli-definition.ts +331 -0
  345. package/src/help-message/format-arguments.ts +57 -33
  346. package/src/help-message/format-options.ts +59 -34
  347. package/src/help-message/format-subcommands.ts +43 -21
  348. package/src/help-message/generate-for-cli.ts +114 -0
  349. package/src/help-message/generate-for-subcommand.ts +32 -0
  350. package/src/help-message/print-help.ts +13 -0
  351. package/src/help-message/set-defaults.ts +34 -0
  352. package/src/help-message/styles.ts +148 -103
  353. package/src/help-message/terminal-markdown.ts +147 -0
  354. package/src/index.ts +28 -97
  355. package/src/markdown/generate-markdown.ts +47 -58
  356. package/src/metadata/arguments-metadata.ts +28 -0
  357. package/src/metadata/cli-metadata.ts +26 -0
  358. package/src/metadata/options-metadata.ts +38 -0
  359. package/src/metadata/subcommands-metadata.ts +35 -0
  360. package/src/parse/context/cli-context-builder.ts +246 -0
  361. package/src/parse/context/object-context-builder.ts +63 -0
  362. package/src/{parser/parse/parser-helpers.ts → parse/parser-utilities.ts} +46 -25
  363. package/src/parse/safe-parse.ts +76 -0
  364. package/src/parse/validation/validate-context.ts +23 -0
  365. package/src/parse/validation/validators/arguments.ts +59 -0
  366. package/src/parse/validation/validators/conflict.ts +68 -0
  367. package/src/parse/validation/validators/exclusive.ts +70 -0
  368. package/src/parse/validation/validators/explicitly-passed.ts +15 -0
  369. package/src/parse/validation/validators/options.ts +59 -0
  370. package/src/parse/validation/validators/requires.ts +82 -0
  371. package/src/types/context-types.ts +171 -0
  372. package/src/types/definitions-types.ts +340 -0
  373. package/src/types/help-message-types.ts +153 -0
  374. package/src/types/io-types.ts +131 -0
  375. package/src/types/metadata-types.ts +104 -0
  376. package/src/types/schema-types.ts +9 -0
  377. package/src/types/types.ts +72 -0
  378. package/src/types/utilities-types.ts +26 -0
  379. package/src/utilities.ts +200 -23
  380. package/lib/commonjs/autocomplete-scripts/bash-autocomplete-script.cjs +0 -42
  381. package/lib/commonjs/autocomplete-scripts/bash-autocomplete-script.cjs.map +0 -1
  382. package/lib/commonjs/autocomplete-scripts/powershell-autocomplete-script.cjs +0 -31
  383. package/lib/commonjs/autocomplete-scripts/powershell-autocomplete-script.cjs.map +0 -1
  384. package/lib/commonjs/autocomplete-scripts/zsh-autocomplete-script.cjs +0 -41
  385. package/lib/commonjs/autocomplete-scripts/zsh-autocomplete-script.cjs.map +0 -1
  386. package/lib/commonjs/help-message/format-arguments.cjs +0 -1
  387. package/lib/commonjs/help-message/format-arguments.cjs.map +0 -1
  388. package/lib/commonjs/help-message/format-cli.cjs +0 -1
  389. package/lib/commonjs/help-message/format-cli.cjs.map +0 -1
  390. package/lib/commonjs/help-message/format-options.cjs +0 -1
  391. package/lib/commonjs/help-message/format-options.cjs.map +0 -1
  392. package/lib/commonjs/help-message/format-subcommands.cjs +0 -1
  393. package/lib/commonjs/help-message/format-subcommands.cjs.map +0 -1
  394. package/lib/commonjs/help-message/styles.cjs +0 -1
  395. package/lib/commonjs/help-message/styles.cjs.map +0 -1
  396. package/lib/commonjs/index.cjs +0 -1
  397. package/lib/commonjs/index.cjs.map +0 -1
  398. package/lib/commonjs/markdown/generate-markdown.cjs +0 -1
  399. package/lib/commonjs/markdown/generate-markdown.cjs.map +0 -1
  400. package/lib/commonjs/metadata/get-arguments-metadata.cjs +0 -1
  401. package/lib/commonjs/metadata/get-arguments-metadata.cjs.map +0 -1
  402. package/lib/commonjs/metadata/get-cli-metadata.cjs +0 -1
  403. package/lib/commonjs/metadata/get-cli-metadata.cjs.map +0 -1
  404. package/lib/commonjs/metadata/get-options-metadata.cjs +0 -1
  405. package/lib/commonjs/metadata/get-options-metadata.cjs.map +0 -1
  406. package/lib/commonjs/metadata/get-subcommands-metadata.cjs +0 -1
  407. package/lib/commonjs/metadata/get-subcommands-metadata.cjs.map +0 -1
  408. package/lib/commonjs/parser/parse/parse.cjs +0 -1
  409. package/lib/commonjs/parser/parse/parse.cjs.map +0 -1
  410. package/lib/commonjs/parser/parse/parser-helpers.cjs +0 -1
  411. package/lib/commonjs/parser/parse/parser-helpers.cjs.map +0 -1
  412. package/lib/commonjs/parser/safe-parse.cjs +0 -1
  413. package/lib/commonjs/parser/safe-parse.cjs.map +0 -1
  414. package/lib/commonjs/parser/unsafe-parse.cjs +0 -1
  415. package/lib/commonjs/parser/unsafe-parse.cjs.map +0 -1
  416. package/lib/commonjs/parser/validate/validate-type.cjs +0 -1
  417. package/lib/commonjs/parser/validate/validate-type.cjs.map +0 -1
  418. package/lib/commonjs/parser/validate/validate.cjs +0 -1
  419. package/lib/commonjs/parser/validate/validate.cjs.map +0 -1
  420. package/lib/commonjs/utilities.cjs +0 -1
  421. package/lib/commonjs/utilities.cjs.map +0 -1
  422. package/lib/commonjs/zod-utilities.cjs +0 -1
  423. package/lib/commonjs/zod-utilities.cjs.map +0 -1
  424. package/lib/module/autocomplete-scripts/bash-autocomplete-script.mjs +0 -42
  425. package/lib/module/autocomplete-scripts/bash-autocomplete-script.mjs.map +0 -1
  426. package/lib/module/autocomplete-scripts/powershell-autocomplete-script.mjs +0 -31
  427. package/lib/module/autocomplete-scripts/powershell-autocomplete-script.mjs.map +0 -1
  428. package/lib/module/autocomplete-scripts/zsh-autocomplete-script.mjs +0 -41
  429. package/lib/module/autocomplete-scripts/zsh-autocomplete-script.mjs.map +0 -1
  430. package/lib/module/help-message/format-arguments.mjs +0 -1
  431. package/lib/module/help-message/format-arguments.mjs.map +0 -1
  432. package/lib/module/help-message/format-cli.mjs +0 -1
  433. package/lib/module/help-message/format-cli.mjs.map +0 -1
  434. package/lib/module/help-message/format-options.mjs +0 -1
  435. package/lib/module/help-message/format-options.mjs.map +0 -1
  436. package/lib/module/help-message/format-subcommands.mjs +0 -1
  437. package/lib/module/help-message/format-subcommands.mjs.map +0 -1
  438. package/lib/module/help-message/styles.mjs +0 -1
  439. package/lib/module/help-message/styles.mjs.map +0 -1
  440. package/lib/module/index.mjs +0 -1
  441. package/lib/module/index.mjs.map +0 -1
  442. package/lib/module/markdown/generate-markdown.mjs +0 -1
  443. package/lib/module/markdown/generate-markdown.mjs.map +0 -1
  444. package/lib/module/metadata/get-arguments-metadata.mjs +0 -1
  445. package/lib/module/metadata/get-arguments-metadata.mjs.map +0 -1
  446. package/lib/module/metadata/get-cli-metadata.mjs +0 -1
  447. package/lib/module/metadata/get-cli-metadata.mjs.map +0 -1
  448. package/lib/module/metadata/get-options-metadata.mjs +0 -1
  449. package/lib/module/metadata/get-options-metadata.mjs.map +0 -1
  450. package/lib/module/metadata/get-subcommands-metadata.mjs +0 -1
  451. package/lib/module/metadata/get-subcommands-metadata.mjs.map +0 -1
  452. package/lib/module/parser/parse/parse.mjs +0 -1
  453. package/lib/module/parser/parse/parse.mjs.map +0 -1
  454. package/lib/module/parser/parse/parser-helpers.mjs +0 -1
  455. package/lib/module/parser/parse/parser-helpers.mjs.map +0 -1
  456. package/lib/module/parser/safe-parse.mjs +0 -1
  457. package/lib/module/parser/safe-parse.mjs.map +0 -1
  458. package/lib/module/parser/unsafe-parse.mjs +0 -1
  459. package/lib/module/parser/unsafe-parse.mjs.map +0 -1
  460. package/lib/module/parser/validate/validate-type.mjs +0 -1
  461. package/lib/module/parser/validate/validate-type.mjs.map +0 -1
  462. package/lib/module/parser/validate/validate.mjs +0 -1
  463. package/lib/module/parser/validate/validate.mjs.map +0 -1
  464. package/lib/module/utilities.mjs +0 -1
  465. package/lib/module/utilities.mjs.map +0 -1
  466. package/lib/module/zod-utilities.mjs +0 -1
  467. package/lib/module/zod-utilities.mjs.map +0 -1
  468. package/lib/typescript/help-message/format-cli.d.ts +0 -6
  469. package/lib/typescript/help-message/format-cli.d.ts.map +0 -1
  470. package/lib/typescript/metadata/get-arguments-metadata.d.ts +0 -4
  471. package/lib/typescript/metadata/get-arguments-metadata.d.ts.map +0 -1
  472. package/lib/typescript/metadata/get-cli-metadata.d.ts +0 -4
  473. package/lib/typescript/metadata/get-cli-metadata.d.ts.map +0 -1
  474. package/lib/typescript/metadata/get-options-metadata.d.ts +0 -4
  475. package/lib/typescript/metadata/get-options-metadata.d.ts.map +0 -1
  476. package/lib/typescript/metadata/get-subcommands-metadata.d.ts +0 -4
  477. package/lib/typescript/metadata/get-subcommands-metadata.d.ts.map +0 -1
  478. package/lib/typescript/metadata/metadata-types.d.ts +0 -80
  479. package/lib/typescript/metadata/metadata-types.d.ts.map +0 -1
  480. package/lib/typescript/parser/parse/parse-types.d.ts +0 -85
  481. package/lib/typescript/parser/parse/parse-types.d.ts.map +0 -1
  482. package/lib/typescript/parser/parse/parse.d.ts +0 -4
  483. package/lib/typescript/parser/parse/parse.d.ts.map +0 -1
  484. package/lib/typescript/parser/parse/parser-helpers.d.ts.map +0 -1
  485. package/lib/typescript/parser/safe-parse.d.ts +0 -4
  486. package/lib/typescript/parser/safe-parse.d.ts.map +0 -1
  487. package/lib/typescript/parser/unsafe-parse.d.ts +0 -4
  488. package/lib/typescript/parser/unsafe-parse.d.ts.map +0 -1
  489. package/lib/typescript/parser/validate/validate-type.d.ts +0 -23
  490. package/lib/typescript/parser/validate/validate-type.d.ts.map +0 -1
  491. package/lib/typescript/parser/validate/validate.d.ts +0 -12
  492. package/lib/typescript/parser/validate/validate.d.ts.map +0 -1
  493. package/lib/typescript/types.d.ts +0 -294
  494. package/lib/typescript/types.d.ts.map +0 -1
  495. package/lib/typescript/zod-utilities.d.ts +0 -28
  496. package/lib/typescript/zod-utilities.d.ts.map +0 -1
  497. package/src/help-message/format-cli.ts +0 -141
  498. package/src/metadata/get-arguments-metadata.ts +0 -25
  499. package/src/metadata/get-cli-metadata.ts +0 -23
  500. package/src/metadata/get-options-metadata.ts +0 -35
  501. package/src/metadata/get-subcommands-metadata.ts +0 -32
  502. package/src/metadata/metadata-types.ts +0 -114
  503. package/src/parser/parse/parse-types.ts +0 -89
  504. package/src/parser/parse/parse.ts +0 -235
  505. package/src/parser/safe-parse.ts +0 -103
  506. package/src/parser/unsafe-parse.ts +0 -98
  507. package/src/parser/validate/validate-type.ts +0 -20
  508. package/src/parser/validate/validate.ts +0 -71
  509. package/src/types.ts +0 -365
  510. package/src/zod-utilities.ts +0 -214
@@ -0,0 +1,5 @@
1
+ import type { Cli, Subcommand } from "../types/definitions-types.ts";
2
+ import type { PrintHelpOptions } from "../types/help-message-types.ts";
3
+ export declare function printCliHelp(cliDefinition: Cli, options?: PrintHelpOptions): void;
4
+ export declare function printSubcommandHelp(commandDefinition: Subcommand, options?: PrintHelpOptions, cliName?: string): void;
5
+ //# sourceMappingURL=print-help.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"print-help.d.ts","sourceRoot":"","sources":["../../../src/help-message/print-help.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAEvE,wBAAgB,YAAY,CAAC,aAAa,EAAE,GAAG,EAAE,OAAO,GAAE,gBAAqB,QAE9E;AAED,wBAAgB,mBAAmB,CAAC,iBAAiB,EAAE,UAAU,EAAE,OAAO,GAAE,gBAAqB,EAAE,OAAO,SAAK,QAE9G"}
@@ -0,0 +1,4 @@
1
+ import type { PrintHelpOptions } from "../types/help-message-types.ts";
2
+ import type { FormatOptions } from "./generate-for-cli.ts";
3
+ export declare function setPrintHelpOptionsDefaults(options: PrintHelpOptions): Required<FormatOptions>;
4
+ //# sourceMappingURL=set-defaults.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"set-defaults.d.ts","sourceRoot":"","sources":["../../../src/help-message/set-defaults.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,gBAAgB,GA2BnD,QAAQ,CAAC,aAAa,CAAC,CACxC"}
@@ -1,109 +1,33 @@
1
- import type { HelpMessageStyle } from "../types.js";
1
+ import type { HelpMessageStyleImpl } from "../types/help-message-types.ts";
2
+ export declare class HelpMessageStyle implements HelpMessageStyleImpl {
3
+ static noColor: (...text: unknown[]) => string;
4
+ title: (...text: unknown[]) => string;
5
+ description: (...text: unknown[]) => string;
6
+ default: (...text: unknown[]) => string;
7
+ optional: (...text: unknown[]) => string;
8
+ exampleTitle: (...text: unknown[]) => string;
9
+ example: (...text: unknown[]) => string;
10
+ command: (...text: unknown[]) => string;
11
+ option: (...text: unknown[]) => string;
12
+ argument: (...text: unknown[]) => string;
13
+ placeholder: (...text: unknown[]) => string;
14
+ punctuation: (...text: unknown[]) => string;
15
+ constructor(style: Partial<HelpMessageStyleImpl>, baseStyle?: HelpMessageStyleImpl);
16
+ }
2
17
  export declare const helpMessageStyles: Readonly<{
3
- default: {
4
- title: import("chalk").ChalkInstance;
5
- description: import("chalk").ChalkInstance;
6
- default: import("chalk").ChalkInstance;
7
- optional: import("chalk").ChalkInstance;
8
- exampleTitle: import("chalk").ChalkInstance;
9
- example: import("chalk").ChalkInstance;
10
- command: import("chalk").ChalkInstance;
11
- option: import("chalk").ChalkInstance;
12
- argument: import("chalk").ChalkInstance;
13
- placeholder: import("chalk").ChalkInstance;
14
- punctuation: import("chalk").ChalkInstance;
15
- };
16
- dracula: {
17
- title: import("chalk").ChalkInstance;
18
- description: import("chalk").ChalkInstance;
19
- default: import("chalk").ChalkInstance;
20
- optional: import("chalk").ChalkInstance;
21
- exampleTitle: import("chalk").ChalkInstance;
22
- example: import("chalk").ChalkInstance;
23
- command: import("chalk").ChalkInstance;
24
- option: import("chalk").ChalkInstance;
25
- argument: import("chalk").ChalkInstance;
26
- placeholder: import("chalk").ChalkInstance;
27
- punctuation: import("chalk").ChalkInstance;
28
- };
29
- solarizedDark: {
30
- title: import("chalk").ChalkInstance;
31
- description: import("chalk").ChalkInstance;
32
- default: import("chalk").ChalkInstance;
33
- optional: import("chalk").ChalkInstance;
34
- exampleTitle: import("chalk").ChalkInstance;
35
- example: import("chalk").ChalkInstance;
36
- command: import("chalk").ChalkInstance;
37
- option: import("chalk").ChalkInstance;
38
- argument: import("chalk").ChalkInstance;
39
- placeholder: import("chalk").ChalkInstance;
40
- punctuation: import("chalk").ChalkInstance;
41
- };
42
- nord: {
43
- title: import("chalk").ChalkInstance;
44
- description: import("chalk").ChalkInstance;
45
- default: import("chalk").ChalkInstance;
46
- optional: import("chalk").ChalkInstance;
47
- exampleTitle: import("chalk").ChalkInstance;
48
- example: import("chalk").ChalkInstance;
49
- command: import("chalk").ChalkInstance;
50
- option: import("chalk").ChalkInstance;
51
- argument: import("chalk").ChalkInstance;
52
- placeholder: import("chalk").ChalkInstance;
53
- punctuation: import("chalk").ChalkInstance;
54
- };
55
- html: {
56
- title: (...string: unknown[]) => string;
57
- description: (...string: unknown[]) => string;
58
- default: (...string: unknown[]) => string;
59
- optional: (...string: unknown[]) => string;
60
- exampleTitle: (...string: unknown[]) => string;
61
- example: (...string: unknown[]) => string;
62
- command: (...string: unknown[]) => string;
63
- option: (...string: unknown[]) => string;
64
- argument: (...string: unknown[]) => string;
65
- placeholder: (...string: unknown[]) => string;
66
- punctuation: (...string: unknown[]) => string;
67
- };
68
- gruvboxDark: {
69
- title: import("chalk").ChalkInstance;
70
- description: import("chalk").ChalkInstance;
71
- default: import("chalk").ChalkInstance;
72
- optional: import("chalk").ChalkInstance;
73
- exampleTitle: import("chalk").ChalkInstance;
74
- example: import("chalk").ChalkInstance;
75
- command: import("chalk").ChalkInstance;
76
- option: import("chalk").ChalkInstance;
77
- argument: import("chalk").ChalkInstance;
78
- placeholder: import("chalk").ChalkInstance;
79
- punctuation: import("chalk").ChalkInstance;
80
- };
81
- monokai: {
82
- title: import("chalk").ChalkInstance;
83
- description: import("chalk").ChalkInstance;
84
- default: import("chalk").ChalkInstance;
85
- optional: import("chalk").ChalkInstance;
86
- exampleTitle: import("chalk").ChalkInstance;
87
- example: import("chalk").ChalkInstance;
88
- command: import("chalk").ChalkInstance;
89
- option: import("chalk").ChalkInstance;
90
- argument: import("chalk").ChalkInstance;
91
- placeholder: import("chalk").ChalkInstance;
92
- punctuation: import("chalk").ChalkInstance;
93
- };
94
- oneDark: {
95
- title: import("chalk").ChalkInstance;
96
- description: import("chalk").ChalkInstance;
97
- default: import("chalk").ChalkInstance;
98
- optional: import("chalk").ChalkInstance;
99
- exampleTitle: import("chalk").ChalkInstance;
100
- example: import("chalk").ChalkInstance;
101
- command: import("chalk").ChalkInstance;
102
- option: import("chalk").ChalkInstance;
103
- argument: import("chalk").ChalkInstance;
104
- placeholder: import("chalk").ChalkInstance;
105
- punctuation: import("chalk").ChalkInstance;
106
- };
107
- readonly noColors: HelpMessageStyle;
18
+ default: HelpMessageStyle;
19
+ dracula: HelpMessageStyle;
20
+ solarizedDark: HelpMessageStyle;
21
+ nord: HelpMessageStyle;
22
+ /**
23
+ * - Wrap the output in a <pre> element to preserve whitespace.
24
+ * - If using `descriptionMarkdown`, set `markdownRenderer` to `html` instead of `terminal`.
25
+ */
26
+ html: HelpMessageStyle;
27
+ gruvboxDark: HelpMessageStyle;
28
+ monokai: HelpMessageStyle;
29
+ oneDark: HelpMessageStyle;
30
+ catppuccin: HelpMessageStyle;
31
+ noColors: HelpMessageStyle;
108
32
  }>;
109
33
  //# sourceMappingURL=styles.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../src/help-message/styles.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBA8GpB,gBAAgB;EAEmB,CAAC"}
1
+ {"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../src/help-message/styles.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE3E,qBAAa,gBAAiB,YAAW,oBAAoB;IAC3D,MAAM,CAAC,OAAO,GAAI,GAAG,MAAM,OAAO,EAAE,YAAoB;IAExD,KAAK,YAFsB,OAAO,EAAE,YAEH;IACjC,WAAW,YAHgB,OAAO,EAAE,YAGG;IACvC,OAAO,YAJoB,OAAO,EAAE,YAID;IACnC,QAAQ,YALmB,OAAO,EAAE,YAKA;IACpC,YAAY,YANe,OAAO,EAAE,YAMI;IACxC,OAAO,YAPoB,OAAO,EAAE,YAOD;IACnC,OAAO,YARoB,OAAO,EAAE,YAQD;IACnC,MAAM,YATqB,OAAO,EAAE,YASF;IAClC,QAAQ,YAVmB,OAAO,EAAE,YAUA;IACpC,WAAW,YAXgB,OAAO,EAAE,YAWG;IACvC,WAAW,YAZgB,OAAO,EAAE,YAYG;gBAE3B,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAAE,SAAS,CAAC,EAAE,oBAAoB;CAOnF;AAED,eAAO,MAAM,iBAAiB;;;;;IAyD5B;;;OAGG;;;;;;;EAwEH,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { ColorFunctionType } from "../types/help-message-types.ts";
2
+ export declare function terminalMarkdown(text: string, renderer?: "terminal" | "html", ansiTextColor?: ColorFunctionType): string;
3
+ //# sourceMappingURL=terminal-markdown.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"terminal-markdown.d.ts","sourceRoot":"","sources":["../../../src/help-message/terminal-markdown.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AA+HxE,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,QAAQ,GAAE,UAAU,GAAG,MAAmB,EAC1C,aAAa,GAAE,iBAAmD,GACjE,MAAM,CAYR"}
@@ -1,36 +1,24 @@
1
- import type { ActionsFunctions, Argument, CheckArgumentsOptional, CheckDuplicatedArguments, CheckDuplicatedOptions, Cli, Option, Prettify, Subcommand } from "./types.js";
2
- /**
3
- * - Insures that there are no duplicated options
4
- * - Insures that there are no duplicated arguments
5
- * - Insures that only the last argument is optional
6
- * - Insures no optional arguments are allowed when `allowPositional` is enabled
7
- */
8
- type CheckCliSubcommandInput<T extends Cli | Subcommand> = CheckDuplicatedOptions<T> extends infer Error extends string ? Error : CheckDuplicatedArguments<T> extends infer Error extends string ? Error : CheckArgumentsOptional<T> extends infer Error extends string ? Error : T;
9
- export declare function createCli<const T extends Cli>(input: CheckCliSubcommandInput<T>): Prettify<typeof input & ActionsFunctions<T>>;
10
- export declare function createSubcommand<const T extends Subcommand>(input: CheckCliSubcommandInput<T>): Prettify<typeof input & ActionsFunctions<T>>;
11
- /** - Insures that there are no duplicated options */
12
- type CheckOptionsInput<T extends Option[]> = CheckDuplicatedOptions<{
13
- options: T;
14
- }> extends infer Error extends string ? Error : T;
15
- export declare function createOptions<const T extends [Option, ...Option[]]>(options: CheckOptionsInput<T>): CheckOptionsInput<T>;
16
- /** - Insures that only the last argument is optional */
17
- type CheckArgumentsInput<T extends Argument[]> = CheckArgumentsOptional<{
18
- arguments: T;
19
- }> extends infer Error extends string ? Error : T;
20
- export declare function createArguments<const T extends [Argument, ...Argument[]]>(arguments_: CheckArgumentsInput<T>): CheckArgumentsInput<T>;
21
- export { formatCliHelpMessage as formatCliHelpMsg, formatSubcommandHelpMessage as formatSubcommandHelpMsg, printCliHelp, printSubcommandHelp, } from "./help-message/format-cli.js";
22
- export { helpMessageStyles } from "./help-message/styles.js";
23
- export { safeParse, safeParseAsync } from "./parser/safe-parse.js";
24
- export { unsafeParse as parse, unsafeParseAsync as parseAsync } from "./parser/unsafe-parse.js";
25
- export { isOptionalSchema, schemaDefaultValue, stringToArray, stringToSet } from "./zod-utilities.js";
26
- export { generateBashAutocompleteScript } from "./autocomplete-scripts/bash-autocomplete-script.js";
27
- export { generatePowerShellAutocompleteScript } from "./autocomplete-scripts/powershell-autocomplete-script.js";
28
- export { generateZshAutocompleteScript } from "./autocomplete-scripts/zsh-autocomplete-script.js";
29
- export { getArgumentsMetadata } from "./metadata/get-arguments-metadata.js";
30
- export { getCliMetadata } from "./metadata/get-cli-metadata.js";
31
- export { getOptionsMetadata } from "./metadata/get-options-metadata.js";
32
- export { getSubcommandsMetadata } from "./metadata/get-subcommands-metadata.js";
33
- export { generateMarkdown } from "./markdown/generate-markdown.js";
34
- export type * from "./metadata/metadata-types.js";
35
- export type * from "./types.js";
1
+ export { generateCliHelpMessage } from "./help-message/generate-for-cli.ts";
2
+ export { generateSubcommandHelpMessage } from "./help-message/generate-for-subcommand.ts";
3
+ export { printCliHelp, printSubcommandHelp } from "./help-message/print-help.ts";
4
+ export { HelpMessageStyle, helpMessageStyles } from "./help-message/styles.ts";
5
+ export { generateBashAutocompleteScript } from "./autocomplete-scripts/bash-autocomplete-script.ts";
6
+ export { generatePowerShellAutocompleteScript } from "./autocomplete-scripts/powershell-autocomplete-script.ts";
7
+ export { generateZshAutocompleteScript } from "./autocomplete-scripts/zsh-autocomplete-script.ts";
8
+ export { generateMarkdown } from "./markdown/generate-markdown.ts";
9
+ export { getArgumentsMetadata } from "./metadata/arguments-metadata.ts";
10
+ export { getCliMetadata } from "./metadata/cli-metadata.ts";
11
+ export { getOptionsMetadata } from "./metadata/options-metadata.ts";
12
+ export { getSubcommandsMetadata } from "./metadata/subcommands-metadata.ts";
13
+ export { defineArguments } from "./definitions/define-arguments.ts";
14
+ export { defineCLI } from "./definitions/define-cli.ts";
15
+ export { defineOptions } from "./definitions/define-options.ts";
16
+ export { defineSubcommand } from "./definitions/define-subcommand.ts";
17
+ export { coerce } from "./coerce/coerce-methods.ts";
18
+ export type * from "./types/context-types.ts";
19
+ export type * from "./types/definitions-types.ts";
20
+ export type * from "./types/help-message-types.ts";
21
+ export type * from "./types/io-types.ts";
22
+ export type * from "./types/metadata-types.ts";
23
+ export type * from "./types/types.ts";
36
24
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,QAAQ,EACR,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,GAAG,EACH,MAAM,EACN,QAAQ,EACR,UAAU,EACX,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,KAAK,uBAAuB,CAAC,CAAC,SAAS,GAAG,GAAG,UAAU,IACrD,sBAAsB,CAAC,CAAC,CAAC,SAAS,MAAM,KAAK,SAAS,MAAM,GACxD,KAAK,GACL,wBAAwB,CAAC,CAAC,CAAC,SAAS,MAAM,KAAK,SAAS,MAAM,GAC5D,KAAK,GACL,sBAAsB,CAAC,CAAC,CAAC,SAAS,MAAM,KAAK,SAAS,MAAM,GAC1D,KAAK,GACL,CAAC,CAAC;AAEZ,wBAAgB,SAAS,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAWV,QAAQ,CAAC,OAAO,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CACjH;AAED,wBAAgB,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAWxB,QAAQ,CAAC,OAAO,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CACjH;AAED,qDAAqD;AACrD,KAAK,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,IACvC,sBAAsB,CAAC;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC,SAAS,MAAM,KAAK,SAAS,MAAM,GAAG,KAAK,GAAG,CAAC,CAAC;AAExF,wBAAgB,aAAa,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,wBAEjG;AAED,wDAAwD;AACxD,KAAK,mBAAmB,CAAC,CAAC,SAAS,QAAQ,EAAE,IAC3C,sBAAsB,CAAC;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC,SAAS,MAAM,KAAK,SAAS,MAAM,GAAG,KAAK,GAAG,CAAC,CAAC;AAE1F,wBAAgB,eAAe,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC,CAAC,0BAE5G;AAED,OAAO,EACL,oBAAoB,IAAI,gBAAgB,EACxC,2BAA2B,IAAI,uBAAuB,EACtD,YAAY,EACZ,mBAAmB,GACpB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,EAAE,WAAW,IAAI,KAAK,EAAE,gBAAgB,IAAI,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEhG,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtG,OAAO,EAAE,8BAA8B,EAAE,MAAM,oDAAoD,CAAC;AACpG,OAAO,EAAE,oCAAoC,EAAE,MAAM,0DAA0D,CAAC;AAChH,OAAO,EAAE,6BAA6B,EAAE,MAAM,mDAAmD,CAAC;AAElG,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAEhF,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,YAAY,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE/E,OAAO,EAAE,8BAA8B,EAAE,MAAM,oDAAoD,CAAC;AACpG,OAAO,EAAE,oCAAoC,EAAE,MAAM,0DAA0D,CAAC;AAChH,OAAO,EAAE,6BAA6B,EAAE,MAAM,mDAAmD,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAEpD,mBAAmB,0BAA0B,CAAC;AAC9C,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,qBAAqB,CAAC;AACzC,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,kBAAkB,CAAC"}
@@ -1,3 +1,3 @@
1
- import type { Cli, Subcommand } from "../types.js";
2
- export declare function generateMarkdown(...parameters: [Cli, ...Subcommand[]]): string;
1
+ import type { Cli } from "../types/definitions-types.ts";
2
+ export declare function generateMarkdown(cliDefinition: Cli): string;
3
3
  //# sourceMappingURL=generate-markdown.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"generate-markdown.d.ts","sourceRoot":"","sources":["../../../src/markdown/generate-markdown.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEnD,wBAAgB,gBAAgB,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC,GAAG,MAAM,CAwC9E"}
1
+ {"version":3,"file":"generate-markdown.d.ts","sourceRoot":"","sources":["../../../src/markdown/generate-markdown.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAC;AAGzD,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,GAAG,GAAG,MAAM,CA6C3D"}
@@ -0,0 +1,4 @@
1
+ import type { Argument } from "../types/definitions-types.ts";
2
+ import type { ArgumentMetadata } from "../types/metadata-types.ts";
3
+ export declare function getArgumentsMetadata(argumentsDefinition: Record<string, Argument>): ArgumentMetadata[];
4
+ //# sourceMappingURL=arguments-metadata.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"arguments-metadata.d.ts","sourceRoot":"","sources":["../../../src/metadata/arguments-metadata.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,wBAAgB,oBAAoB,CAAC,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,gBAAgB,EAAE,CAsBtG"}
@@ -0,0 +1,4 @@
1
+ import type { Cli } from "../types/definitions-types.ts";
2
+ import type { CliMetadata } from "../types/metadata-types.ts";
3
+ export declare function getCliMetadata(cliDefinition: Cli): CliMetadata;
4
+ //# sourceMappingURL=cli-metadata.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli-metadata.d.ts","sourceRoot":"","sources":["../../../src/metadata/cli-metadata.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAE9D,wBAAgB,cAAc,CAAC,aAAa,EAAE,GAAG,GAAG,WAAW,CAkB9D"}
@@ -0,0 +1,4 @@
1
+ import type { Option } from "../types/definitions-types.ts";
2
+ import type { OptionMetadata } from "../types/metadata-types.ts";
3
+ export declare function getOptionsMetadata(optionsDefinition: Record<string, Option>): OptionMetadata[];
4
+ //# sourceMappingURL=options-metadata.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"options-metadata.d.ts","sourceRoot":"","sources":["../../../src/metadata/options-metadata.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE,wBAAgB,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,cAAc,EAAE,CA+B9F"}
@@ -0,0 +1,4 @@
1
+ import type { Subcommand } from "../types/definitions-types.ts";
2
+ import type { SubcommandMetadata } from "../types/metadata-types.ts";
3
+ export declare function getSubcommandsMetadata(commandDefinition: readonly Subcommand[]): SubcommandMetadata[];
4
+ //# sourceMappingURL=subcommands-metadata.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"subcommands-metadata.d.ts","sourceRoot":"","sources":["../../../src/metadata/subcommands-metadata.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE,wBAAgB,sBAAsB,CAAC,iBAAiB,EAAE,SAAS,UAAU,EAAE,GAAG,kBAAkB,EAAE,CA4BrG"}
@@ -0,0 +1,9 @@
1
+ import type { ContextWide } from "../../types/context-types.ts";
2
+ import type { Cli } from "../../types/definitions-types.ts";
3
+ /**
4
+ * Parse argv and create a cli context
5
+ *
6
+ * @throws {Error}
7
+ */
8
+ export declare function buildCliContext(argv: string[], cliDefinition: Cli): ContextWide;
9
+ //# sourceMappingURL=cli-context-builder.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli-context-builder.d.ts","sourceRoot":"","sources":["../../../../src/parse/context/cli-context-builder.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kCAAkC,CAAC;AAE5D;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,GAAG,eAoOjE"}
@@ -0,0 +1,6 @@
1
+ import type { ContextWide } from "../../types/context-types.ts";
2
+ import type { Cli, Subcommand } from "../../types/definitions-types.ts";
3
+ import type { InputTypeWide } from "../../types/io-types.ts";
4
+ /** @throws {Error} */
5
+ export declare function buildObjectContext(inputValues: InputTypeWide, commandDefinition: Subcommand | Cli): ContextWide;
6
+ //# sourceMappingURL=object-context-builder.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"object-context-builder.d.ts","sourceRoot":"","sources":["../../../../src/parse/context/object-context-builder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,KAAK,EAAY,GAAG,EAAU,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC1F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAE7D,sBAAsB;AACtB,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,UAAU,GAAG,GAAG,eAkBjG"}
@@ -1,27 +1,34 @@
1
- import type { Option, Subcommand } from "../../types.js";
1
+ import type { Cli, Option, Subcommand } from "../types/definitions-types.ts";
2
2
  /**
3
3
  * Retrieves a subcommand object from an array of subcommands by matching the provided subcommand name against the
4
4
  * subcommand's name or its aliases.
5
5
  *
6
- * @param subCmdName - The name or alias of the subcommand to search for.
6
+ * @param subcommandName - The name or alias of the subcommand to search for.
7
7
  * @param subcommandArr - An array of `Subcommand` objects to search within.
8
8
  * @returns The matching `Subcommand` object if found; otherwise, `undefined`.
9
9
  */
10
- export declare function findSubcommand(subCmdName: string | undefined, subcommandArray: Subcommand[]): Subcommand | undefined;
10
+ export declare function findSubcommandDefinition(subcommandName: string | undefined, cliDefinition: Cli): Subcommand | Cli | undefined;
11
11
  /**
12
12
  * Finds and returns an `Option` object from the provided list that matches the given argument string.
13
13
  *
14
14
  * The function supports matching by option name, aliases, and their negated forms (e.g., `--no-` prefix).
15
15
  *
16
- * @param optionArg - The argument string to match (e.g., `--foo`, `--no-bar`, `-f`).
16
+ * @param optionArgument - The argument string to match (e.g., `--foo`, `--no-bar`, `-f`).
17
17
  * @param options - An array of `Option` objects to search through.
18
18
  * @returns The matching `Option` object if found; otherwise, `undefined`.
19
19
  */
20
- export declare function findOption(optionArgument: string, options: [Option, ...Option[]]): Option | undefined;
20
+ export declare function findOption(optionArgument: string, options: Record<string, Option>): [string, Option] | undefined;
21
21
  /** - Decouple flags E.g. `-rf` -> `-r, -f` */
22
22
  export declare function decoupleFlags(arguments_: string[]): string[];
23
23
  /**
24
- * - Transforms an option argument name to a valid JavaScript variable name
24
+ * Transforms an option name to a set of variants: `camelCase`, `PascalCase`, `snake_case`, `SCREAMING_SNAKE_CASE`.
25
+ *
26
+ * **Example** for `--input-dir`
27
+ *
28
+ * - CamelCase: `inputDir`
29
+ * - PascalCase: `InputDir`
30
+ * - Snake_case: `input_dir`
31
+ * - SCREAMING_SNAKE_CASE: `INPUT_DIR`
25
32
  *
26
33
  * @param name - Should start with `'--'` or `'-'`
27
34
  */
@@ -31,10 +38,12 @@ export declare function isFlagArgument(name: string): boolean;
31
38
  /** - Check if an arg string is an options arg. E.g. `--input-dir` -> `true` , `-i` -> `true` */
32
39
  export declare function isOptionArgument(name: string | boolean): boolean;
33
40
  /**
34
- * - Transform option name to no name. E.g. `include` -> `noInclude`
35
- * - For short name like `-i` it will be ignored
41
+ * Transform option name to no name.
42
+ *
43
+ * - `verbose` -> `noVerbose`
44
+ * - `v` -> `noV`
36
45
  */
37
46
  export declare function negateOption(name: string): string;
38
47
  /** - Reverse of `transformArg`. E.g. `InputDir` -> `--input-dir` , `i` -> `-i` */
39
48
  export declare function transformOptionToArgument(name: string): string;
40
- //# sourceMappingURL=parser-helpers.d.ts.map
49
+ //# sourceMappingURL=parser-utilities.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parser-utilities.d.ts","sourceRoot":"","sources":["../../../src/parse/parser-utilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE7E;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,cAAc,EAAE,MAAM,GAAG,SAAS,EAClC,aAAa,EAAE,GAAG,GACjB,UAAU,GAAG,GAAG,GAAG,SAAS,CAkB9B;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CA+BhH;AAED,8CAA8C;AAC9C,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAqB5D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAyBvE;AAED,mEAAmE;AACnE,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEpD;AAOD,gGAAgG;AAChG,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAMhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,kFAAkF;AAClF,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAkB9D"}
@@ -0,0 +1,5 @@
1
+ import type { Cli } from "../types/definitions-types.ts";
2
+ import type { CliParseResultWide } from "../types/types.ts";
3
+ export declare function safeParse(stringOrArgv: string | string[], cliDefinition: Cli): CliParseResultWide;
4
+ export declare function safeParseAsync(stringOrArgv: string | string[], cliDefinition: Cli): Promise<CliParseResultWide>;
5
+ //# sourceMappingURL=safe-parse.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"safe-parse.d.ts","sourceRoot":"","sources":["../../../src/parse/safe-parse.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,wBAAgB,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,aAAa,EAAE,GAAG,GAAG,kBAAkB,CAcjG;AAED,wBAAsB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,aAAa,EAAE,GAAG,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAerH"}
@@ -0,0 +1,6 @@
1
+ import type { ContextWide } from "../../types/context-types.ts";
2
+ import type { Cli, Subcommand } from "../../types/definitions-types.ts";
3
+ import type { OutputTypeWide } from "../../types/io-types.ts";
4
+ /** @throws {Error} */
5
+ export declare function validate(context: ContextWide, commandDefinition: Subcommand | Cli): OutputTypeWide;
6
+ //# sourceMappingURL=validate-context.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validate-context.d.ts","sourceRoot":"","sources":["../../../../src/parse/validation/validate-context.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,sBAAsB;AACtB,wBAAgB,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,UAAU,GAAG,GAAG,kBAcjF"}
@@ -0,0 +1,12 @@
1
+ import type { ContextWide } from "../../../types/context-types.ts";
2
+ import type { Cli, Subcommand } from "../../../types/definitions-types.ts";
3
+ import type { OutputTypeWide } from "../../../types/io-types.ts";
4
+ interface ValidateArgument {
5
+ commandDefinition: Subcommand | Cli;
6
+ context: ContextWide;
7
+ output: OutputTypeWide;
8
+ }
9
+ /** @throws {Error} */
10
+ export declare function validateArguments({ commandDefinition, context, output }: ValidateArgument): void;
11
+ export {};
12
+ //# sourceMappingURL=arguments.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"arguments.d.ts","sourceRoot":"","sources":["../../../../../src/parse/validation/validators/arguments.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE,UAAU,gBAAgB;IACxB,iBAAiB,EAAE,UAAU,GAAG,GAAG,CAAC;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,sBAAsB;AACtB,wBAAgB,iBAAiB,CAAC,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,gBAAgB,QA0CzF"}
@@ -0,0 +1,16 @@
1
+ import type { ContextWide } from "../../../types/context-types.ts";
2
+ import type { Argument, Option } from "../../../types/definitions-types.ts";
3
+ interface ValidateConflictOptions {
4
+ /** The option or argument name to check its `requires` */
5
+ name: string;
6
+ /** The option or argument to check */
7
+ optionOrArgument: Option | Argument;
8
+ /** The parsed context */
9
+ context: ContextWide;
10
+ /** What we're checking */
11
+ type: "option" | "argument";
12
+ }
13
+ /** @throws {Error} */
14
+ export declare function validateConflictWith({ name, optionOrArgument, context, type }: ValidateConflictOptions): void;
15
+ export {};
16
+ //# sourceMappingURL=conflict.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"conflict.d.ts","sourceRoot":"","sources":["../../../../../src/parse/validation/validators/conflict.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE5E,UAAU,uBAAuB;IAC/B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IAEb,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IAEpC,yBAAyB;IACzB,OAAO,EAAE,WAAW,CAAC;IAErB,0BAA0B;IAC1B,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC7B;AAED,sBAAsB;AACtB,wBAAgB,oBAAoB,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,uBAAuB,QA+CtG"}
@@ -0,0 +1,16 @@
1
+ import type { ContextWide } from "../../../types/context-types.ts";
2
+ import type { Argument, Option } from "../../../types/definitions-types.ts";
3
+ interface ValidateExclusiveOptions {
4
+ /** The option or argument name to check its `requires` */
5
+ name: string;
6
+ /** The option or argument to check */
7
+ optionOrArgument: Option | Argument;
8
+ /** The parsed context */
9
+ context: ContextWide;
10
+ /** What we're checking */
11
+ type: "option" | "argument";
12
+ }
13
+ /** @throws {Error} */
14
+ export declare function validateExclusive({ name, optionOrArgument, context, type }: ValidateExclusiveOptions): void;
15
+ export {};
16
+ //# sourceMappingURL=exclusive.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"exclusive.d.ts","sourceRoot":"","sources":["../../../../../src/parse/validation/validators/exclusive.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE5E,UAAU,wBAAwB;IAChC,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IAEb,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IAEpC,yBAAyB;IACzB,OAAO,EAAE,WAAW,CAAC;IAErB,0BAA0B;IAC1B,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC7B;AAED,sBAAsB;AACtB,wBAAgB,iBAAiB,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,wBAAwB,QAiDpG"}
@@ -0,0 +1,5 @@
1
+ import type { ContextWide } from "../../../types/context-types.ts";
2
+ export declare function isArgumentExplicitlyPassed(name: string, context: ContextWide): boolean;
3
+ export declare function isOptionExplicitlyPassed(name: string, context: ContextWide): boolean;
4
+ export declare function isOptionOrArgumentExplicitlyPassed(name: string, context: ContextWide): boolean;
5
+ //# sourceMappingURL=explicitly-passed.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"explicitly-passed.d.ts","sourceRoot":"","sources":["../../../../../src/parse/validation/validators/explicitly-passed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAEnE,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,WAG5E;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,WAG1E;AAED,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,WAEpF"}
@@ -0,0 +1,12 @@
1
+ import type { ContextWide } from "../../../types/context-types.ts";
2
+ import type { Cli, Subcommand } from "../../../types/definitions-types.ts";
3
+ import type { OutputTypeWide } from "../../../types/io-types.ts";
4
+ interface ValidateOptions {
5
+ commandDefinition: Subcommand | Cli;
6
+ context: ContextWide;
7
+ output: OutputTypeWide;
8
+ }
9
+ /** @throws {Error} */
10
+ export declare function validateOptions({ commandDefinition, context, output }: ValidateOptions): void;
11
+ export {};
12
+ //# sourceMappingURL=options.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../../src/parse/validation/validators/options.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE,UAAU,eAAe;IACvB,iBAAiB,EAAE,UAAU,GAAG,GAAG,CAAC;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,sBAAsB;AACtB,wBAAgB,eAAe,CAAC,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,eAAe,QA0CtF"}
@@ -0,0 +1,18 @@
1
+ import type { ContextWide } from "../../../types/context-types.ts";
2
+ import type { Argument, Cli, Option, Subcommand } from "../../../types/definitions-types.ts";
3
+ interface ValidateRequiresOptions {
4
+ /** The option or argument name to check its `requires` */
5
+ name: string;
6
+ /** The subcommand or cli configuration */
7
+ commandDefinition: Subcommand | Cli;
8
+ /** The option or argument to check */
9
+ optionOrArgument: Option | Argument;
10
+ /** The parsed context */
11
+ context: ContextWide;
12
+ /** What we're checking */
13
+ type: "option" | "argument";
14
+ }
15
+ /** @throws {Error} */
16
+ export declare function validateRequires({ name, commandDefinition, optionOrArgument, context, type, }: ValidateRequiresOptions): void;
17
+ export {};
18
+ //# sourceMappingURL=requires.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"requires.d.ts","sourceRoot":"","sources":["../../../../../src/parse/validation/validators/requires.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAE7F,UAAU,uBAAuB;IAC/B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IAEb,0CAA0C;IAC1C,iBAAiB,EAAE,UAAU,GAAG,GAAG,CAAC;IAEpC,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IAEpC,yBAAyB;IACzB,OAAO,EAAE,WAAW,CAAC;IAErB,0BAA0B;IAC1B,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC7B;AAED,sBAAsB;AACtB,wBAAgB,gBAAgB,CAAC,EAC/B,IAAI,EACJ,iBAAiB,EACjB,gBAAgB,EAChB,OAAO,EACP,IAAI,GACL,EAAE,uBAAuB,QAgDzB"}