@modern-js/utils 2.12.1-alpha.3 → 2.13.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (492) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/dist/{cjs/alias.js → alias.js} +15 -4
  3. package/dist/{cjs/analyzeProject.js → analyzeProject.js} +25 -5
  4. package/dist/{cjs/babel.js → babel.js} +16 -9
  5. package/dist/{cjs/compatRequire.js → compatRequire.js} +17 -4
  6. package/dist/compiled.d.ts +43 -0
  7. package/dist/{types/debug.d.ts → debug.d.ts} +1 -1
  8. package/dist/{cjs/emptyDir.js → emptyDir.js} +24 -4
  9. package/dist/{cjs/getEntryOptions.js → getEntryOptions.js} +15 -1
  10. package/dist/{cjs/getPackageManager.js → getPackageManager.js} +41 -19
  11. package/dist/{cjs/getPort.js → getPort.js} +24 -4
  12. package/dist/{cjs/getServerConfig.js → getServerConfig.js} +22 -2
  13. package/dist/{types/logger.d.ts → logger.d.ts} +1 -1
  14. package/dist/{cjs/logger.js → logger.js} +16 -5
  15. package/dist/{cjs/monorepo.js → monorepo.js} +15 -4
  16. package/dist/nodeEnv.js +81 -0
  17. package/dist/{cjs/path.js → path.js} +1 -1
  18. package/dist/{cjs/pathSerializer.js → pathSerializer.js} +1 -1
  19. package/dist/{cjs/react.js → react.js} +15 -4
  20. package/dist/{cjs/runtimeExports.js → runtimeExports.js} +1 -1
  21. package/dist/{cjs/universal → universal}/nestedRoutes.js +19 -2
  22. package/dist/{cjs/version.js → version.js} +40 -7
  23. package/dist/{cjs/watch.js → watch.js} +29 -9
  24. package/package.json +23 -55
  25. package/dist/cjs/nodeEnv.js +0 -55
  26. package/dist/compiled/address/index.js +0 -1
  27. package/dist/compiled/address/lib/address.d.ts +0 -28
  28. package/dist/compiled/address/package.json +0 -1
  29. package/dist/compiled/ajv/codegen.js +0 -1
  30. package/dist/compiled/ajv/index.js +0 -9
  31. package/dist/compiled/ajv/license +0 -22
  32. package/dist/compiled/ajv/package.json +0 -1
  33. package/dist/compiled/ajv/types/ajv.d.ts +0 -16
  34. package/dist/compiled/ajv/types/compile/codegen/code.d.ts +0 -40
  35. package/dist/compiled/ajv/types/compile/codegen/index.d.ts +0 -79
  36. package/dist/compiled/ajv/types/compile/codegen/scope.d.ts +0 -79
  37. package/dist/compiled/ajv/types/compile/errors.d.ts +0 -13
  38. package/dist/compiled/ajv/types/compile/index.d.ts +0 -80
  39. package/dist/compiled/ajv/types/compile/ref_error.d.ts +0 -6
  40. package/dist/compiled/ajv/types/compile/resolve.d.ts +0 -12
  41. package/dist/compiled/ajv/types/compile/rules.d.ts +0 -28
  42. package/dist/compiled/ajv/types/compile/util.d.ts +0 -40
  43. package/dist/compiled/ajv/types/compile/validate/index.d.ts +0 -42
  44. package/dist/compiled/ajv/types/compile/validate/subschema.d.ts +0 -47
  45. package/dist/compiled/ajv/types/core.d.ts +0 -173
  46. package/dist/compiled/ajv/types/runtime/validation_error.d.ts +0 -7
  47. package/dist/compiled/ajv/types/types/index.d.ts +0 -183
  48. package/dist/compiled/ajv/types/types/json-schema.d.ts +0 -124
  49. package/dist/compiled/ajv/types/types/jtd-schema.d.ts +0 -169
  50. package/dist/compiled/ajv/types/vocabularies/errors.d.ts +0 -1
  51. package/dist/compiled/ajv/uri-js.d.ts +0 -59
  52. package/dist/compiled/ajv-keywords/index.d.ts +0 -1
  53. package/dist/compiled/ajv-keywords/index.js +0 -1
  54. package/dist/compiled/ajv-keywords/license +0 -21
  55. package/dist/compiled/ajv-keywords/package.json +0 -1
  56. package/dist/compiled/better-ajv-errors/index.d.ts +0 -1
  57. package/dist/compiled/better-ajv-errors/index.js +0 -1
  58. package/dist/compiled/better-ajv-errors/license +0 -13
  59. package/dist/compiled/better-ajv-errors/package.json +0 -1
  60. package/dist/compiled/browserslist/index.d.ts +0 -178
  61. package/dist/compiled/browserslist/index.js +0 -1
  62. package/dist/compiled/browserslist/license +0 -20
  63. package/dist/compiled/browserslist/package.json +0 -1
  64. package/dist/compiled/chalk/index.d.ts +0 -415
  65. package/dist/compiled/chalk/index.js +0 -1
  66. package/dist/compiled/chalk/license +0 -9
  67. package/dist/compiled/chalk/package.json +0 -1
  68. package/dist/compiled/chokidar/anymatch/index.d.ts +0 -19
  69. package/dist/compiled/chokidar/fsevents.node +0 -0
  70. package/dist/compiled/chokidar/index.js +0 -40
  71. package/dist/compiled/chokidar/license +0 -21
  72. package/dist/compiled/chokidar/package.json +0 -1
  73. package/dist/compiled/chokidar/types/index.d.ts +0 -188
  74. package/dist/compiled/commander/index.js +0 -1
  75. package/dist/compiled/commander/license +0 -22
  76. package/dist/compiled/commander/package.json +0 -1
  77. package/dist/compiled/commander/typings/index.d.ts +0 -890
  78. package/dist/compiled/debug/index.d.ts +0 -54
  79. package/dist/compiled/debug/index.js +0 -1
  80. package/dist/compiled/debug/license +0 -20
  81. package/dist/compiled/debug/ms/index.d.ts +0 -25
  82. package/dist/compiled/debug/package.json +0 -1
  83. package/dist/compiled/dotenv/index.js +0 -1
  84. package/dist/compiled/dotenv/license +0 -23
  85. package/dist/compiled/dotenv/package.json +0 -1
  86. package/dist/compiled/dotenv/types/index.d.ts +0 -59
  87. package/dist/compiled/dotenv-expand/index.d.ts +0 -15
  88. package/dist/compiled/dotenv-expand/index.js +0 -1
  89. package/dist/compiled/dotenv-expand/license +0 -24
  90. package/dist/compiled/dotenv-expand/package.json +0 -1
  91. package/dist/compiled/execa/index.d.ts +0 -564
  92. package/dist/compiled/execa/index.js +0 -1
  93. package/dist/compiled/execa/license +0 -9
  94. package/dist/compiled/execa/package.json +0 -1
  95. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/adapters/fs.d.ts +0 -20
  96. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/index.d.ts +0 -12
  97. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/providers/async.d.ts +0 -7
  98. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/settings.d.ts +0 -20
  99. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/types/index.d.ts +0 -20
  100. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/adapters/fs.d.ts +0 -13
  101. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/index.d.ts +0 -12
  102. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/providers/async.d.ts +0 -4
  103. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/settings.d.ts +0 -16
  104. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/types/index.d.ts +0 -4
  105. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/index.d.ts +0 -14
  106. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/providers/async.d.ts +0 -12
  107. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/readers/async.d.ts +0 -30
  108. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/readers/reader.d.ts +0 -6
  109. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/settings.d.ts +0 -30
  110. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/types/index.d.ts +0 -8
  111. package/dist/compiled/fast-glob/index.js +0 -37
  112. package/dist/compiled/fast-glob/license +0 -21
  113. package/dist/compiled/fast-glob/out/index.d.ts +0 -27
  114. package/dist/compiled/fast-glob/out/managers/tasks.d.ts +0 -22
  115. package/dist/compiled/fast-glob/out/settings.d.ts +0 -164
  116. package/dist/compiled/fast-glob/out/types/index.d.ts +0 -31
  117. package/dist/compiled/fast-glob/package.json +0 -1
  118. package/dist/compiled/filesize/filesize.d.ts +0 -131
  119. package/dist/compiled/filesize/index.js +0 -9
  120. package/dist/compiled/filesize/license +0 -28
  121. package/dist/compiled/filesize/package.json +0 -1
  122. package/dist/compiled/fs-extra/index.d.ts +0 -563
  123. package/dist/compiled/fs-extra/index.js +0 -1
  124. package/dist/compiled/fs-extra/license +0 -15
  125. package/dist/compiled/fs-extra/package.json +0 -1
  126. package/dist/compiled/glob/index.d.ts +0 -91
  127. package/dist/compiled/glob/index.js +0 -1
  128. package/dist/compiled/glob/license +0 -21
  129. package/dist/compiled/glob/minimatch/index.d.ts +0 -204
  130. package/dist/compiled/glob/package.json +0 -1
  131. package/dist/compiled/globby/index.d.ts +0 -186
  132. package/dist/compiled/globby/index.js +0 -1
  133. package/dist/compiled/globby/license +0 -9
  134. package/dist/compiled/globby/package.json +0 -1
  135. package/dist/compiled/gzip-size/index.d.ts +0 -96
  136. package/dist/compiled/gzip-size/index.js +0 -1
  137. package/dist/compiled/gzip-size/license +0 -9
  138. package/dist/compiled/gzip-size/package.json +0 -1
  139. package/dist/compiled/import-lazy/index.d.ts +0 -26
  140. package/dist/compiled/import-lazy/index.js +0 -1
  141. package/dist/compiled/import-lazy/license +0 -9
  142. package/dist/compiled/import-lazy/package.json +0 -1
  143. package/dist/compiled/inquirer/index.d.ts +0 -997
  144. package/dist/compiled/inquirer/index.js +0 -9
  145. package/dist/compiled/inquirer/lib/objects/choice.d.ts +0 -65
  146. package/dist/compiled/inquirer/lib/objects/choices.d.ts +0 -206
  147. package/dist/compiled/inquirer/lib/objects/separator.d.ts +0 -37
  148. package/dist/compiled/inquirer/lib/ui/baseUI.d.ts +0 -37
  149. package/dist/compiled/inquirer/lib/ui/bottom-bar.d.ts +0 -65
  150. package/dist/compiled/inquirer/lib/ui/prompt.d.ts +0 -104
  151. package/dist/compiled/inquirer/license +0 -22
  152. package/dist/compiled/inquirer/package.json +0 -1
  153. package/dist/compiled/inquirer/through/index.d.ts +0 -25
  154. package/dist/compiled/js-yaml/index.d.ts +0 -154
  155. package/dist/compiled/js-yaml/index.js +0 -1
  156. package/dist/compiled/js-yaml/license +0 -21
  157. package/dist/compiled/js-yaml/package.json +0 -1
  158. package/dist/compiled/json5/index.js +0 -1
  159. package/dist/compiled/json5/lib/index.d.ts +0 -4
  160. package/dist/compiled/json5/lib/parse.d.ts +0 -15
  161. package/dist/compiled/json5/lib/stringify.d.ts +0 -89
  162. package/dist/compiled/json5/package.json +0 -1
  163. package/dist/compiled/lodash/common/array.d.ts +0 -2126
  164. package/dist/compiled/lodash/common/collection.d.ts +0 -1930
  165. package/dist/compiled/lodash/common/common.d.ts +0 -280
  166. package/dist/compiled/lodash/common/date.d.ts +0 -23
  167. package/dist/compiled/lodash/common/function.d.ts +0 -1446
  168. package/dist/compiled/lodash/common/lang.d.ts +0 -1693
  169. package/dist/compiled/lodash/common/math.d.ts +0 -405
  170. package/dist/compiled/lodash/common/number.d.ts +0 -131
  171. package/dist/compiled/lodash/common/object.d.ts +0 -2519
  172. package/dist/compiled/lodash/common/seq.d.ts +0 -210
  173. package/dist/compiled/lodash/common/string.d.ts +0 -788
  174. package/dist/compiled/lodash/common/util.d.ts +0 -1220
  175. package/dist/compiled/lodash/index.d.ts +0 -46
  176. package/dist/compiled/lodash/index.js +0 -5
  177. package/dist/compiled/lodash/license +0 -47
  178. package/dist/compiled/lodash/package.json +0 -1
  179. package/dist/compiled/mime-types/index.d.ts +0 -14
  180. package/dist/compiled/mime-types/index.js +0 -14
  181. package/dist/compiled/mime-types/license +0 -23
  182. package/dist/compiled/mime-types/package.json +0 -1
  183. package/dist/compiled/minimist/index.d.ts +0 -95
  184. package/dist/compiled/minimist/index.js +0 -1
  185. package/dist/compiled/minimist/license +0 -18
  186. package/dist/compiled/minimist/package.json +0 -1
  187. package/dist/compiled/nanoid/index.d.ts +0 -91
  188. package/dist/compiled/nanoid/index.js +0 -1
  189. package/dist/compiled/nanoid/license +0 -20
  190. package/dist/compiled/nanoid/package.json +0 -1
  191. package/dist/compiled/ora/cli-spinners/index.d.ts +0 -125
  192. package/dist/compiled/ora/index.d.ts +0 -277
  193. package/dist/compiled/ora/index.js +0 -3
  194. package/dist/compiled/ora/license +0 -9
  195. package/dist/compiled/ora/package.json +0 -1
  196. package/dist/compiled/pkg-up/index.d.ts +0 -48
  197. package/dist/compiled/pkg-up/index.js +0 -1
  198. package/dist/compiled/pkg-up/license +0 -9
  199. package/dist/compiled/pkg-up/package.json +0 -1
  200. package/dist/compiled/recursive-readdir/index.d.ts +0 -21
  201. package/dist/compiled/recursive-readdir/index.js +0 -1
  202. package/dist/compiled/recursive-readdir/license +0 -21
  203. package/dist/compiled/recursive-readdir/package.json +0 -1
  204. package/dist/compiled/schema-utils3/index.d.ts +0 -1
  205. package/dist/compiled/schema-utils3/index.js +0 -3
  206. package/dist/compiled/schema-utils3/license +0 -20
  207. package/dist/compiled/schema-utils3/package.json +0 -1
  208. package/dist/compiled/semver/classes/comparator.d.ts +0 -17
  209. package/dist/compiled/semver/classes/range.d.ts +0 -21
  210. package/dist/compiled/semver/classes/semver.d.ts +0 -62
  211. package/dist/compiled/semver/functions/clean.d.ts +0 -8
  212. package/dist/compiled/semver/functions/cmp.d.ts +0 -16
  213. package/dist/compiled/semver/functions/coerce.d.ts +0 -12
  214. package/dist/compiled/semver/functions/compare-build.d.ts +0 -16
  215. package/dist/compiled/semver/functions/compare-loose.d.ts +0 -5
  216. package/dist/compiled/semver/functions/compare.d.ts +0 -20
  217. package/dist/compiled/semver/functions/diff.d.ts +0 -13
  218. package/dist/compiled/semver/functions/eq.d.ts +0 -9
  219. package/dist/compiled/semver/functions/gt.d.ts +0 -9
  220. package/dist/compiled/semver/functions/gte.d.ts +0 -9
  221. package/dist/compiled/semver/functions/inc.d.ts +0 -15
  222. package/dist/compiled/semver/functions/lt.d.ts +0 -9
  223. package/dist/compiled/semver/functions/lte.d.ts +0 -8
  224. package/dist/compiled/semver/functions/major.d.ts +0 -9
  225. package/dist/compiled/semver/functions/minor.d.ts +0 -9
  226. package/dist/compiled/semver/functions/neq.d.ts +0 -9
  227. package/dist/compiled/semver/functions/parse.d.ts +0 -12
  228. package/dist/compiled/semver/functions/patch.d.ts +0 -9
  229. package/dist/compiled/semver/functions/prerelease.d.ts +0 -12
  230. package/dist/compiled/semver/functions/rcompare.d.ts +0 -15
  231. package/dist/compiled/semver/functions/rsort.d.ts +0 -9
  232. package/dist/compiled/semver/functions/satisfies.d.ts +0 -14
  233. package/dist/compiled/semver/functions/sort.d.ts +0 -9
  234. package/dist/compiled/semver/functions/valid.d.ts +0 -11
  235. package/dist/compiled/semver/index.d.ts +0 -133
  236. package/dist/compiled/semver/index.js +0 -1
  237. package/dist/compiled/semver/internals/identifiers.d.ts +0 -13
  238. package/dist/compiled/semver/license +0 -15
  239. package/dist/compiled/semver/package.json +0 -1
  240. package/dist/compiled/semver/ranges/gtr.d.ts +0 -14
  241. package/dist/compiled/semver/ranges/intersects.d.ts +0 -13
  242. package/dist/compiled/semver/ranges/ltr.d.ts +0 -14
  243. package/dist/compiled/semver/ranges/max-satisfying.d.ts +0 -14
  244. package/dist/compiled/semver/ranges/min-satisfying.d.ts +0 -14
  245. package/dist/compiled/semver/ranges/min-version.d.ts +0 -10
  246. package/dist/compiled/semver/ranges/outside.d.ts +0 -15
  247. package/dist/compiled/semver/ranges/simplify.d.ts +0 -14
  248. package/dist/compiled/semver/ranges/subset.d.ts +0 -13
  249. package/dist/compiled/semver/ranges/to-comparators.d.ts +0 -9
  250. package/dist/compiled/semver/ranges/valid.d.ts +0 -12
  251. package/dist/compiled/signale/index.d.ts +0 -162
  252. package/dist/compiled/signale/index.js +0 -1
  253. package/dist/compiled/signale/package.json +0 -1
  254. package/dist/compiled/slash/index.d.ts +0 -25
  255. package/dist/compiled/slash/index.js +0 -1
  256. package/dist/compiled/slash/license +0 -9
  257. package/dist/compiled/slash/package.json +0 -1
  258. package/dist/compiled/strip-ansi/index.d.ts +0 -17
  259. package/dist/compiled/strip-ansi/index.js +0 -1
  260. package/dist/compiled/strip-ansi/license +0 -9
  261. package/dist/compiled/strip-ansi/package.json +0 -1
  262. package/dist/compiled/tsconfig-paths/index.js +0 -1
  263. package/dist/compiled/tsconfig-paths/lib/config-loader.d.ts +0 -33
  264. package/dist/compiled/tsconfig-paths/lib/filesystem.d.ts +0 -34
  265. package/dist/compiled/tsconfig-paths/lib/index.d.ts +0 -5
  266. package/dist/compiled/tsconfig-paths/lib/mapping-entry.d.ts +0 -18
  267. package/dist/compiled/tsconfig-paths/lib/match-path-async.d.ts +0 -21
  268. package/dist/compiled/tsconfig-paths/lib/match-path-sync.d.ts +0 -32
  269. package/dist/compiled/tsconfig-paths/lib/register.d.ts +0 -12
  270. package/dist/compiled/tsconfig-paths/lib/try-path.d.ts +0 -15
  271. package/dist/compiled/tsconfig-paths/lib/tsconfig-loader.d.ts +0 -28
  272. package/dist/compiled/tsconfig-paths/license +0 -21
  273. package/dist/compiled/tsconfig-paths/package.json +0 -1
  274. package/dist/compiled/upath/index.js +0 -1
  275. package/dist/compiled/upath/license +0 -22
  276. package/dist/compiled/upath/package.json +0 -1
  277. package/dist/compiled/upath/upath.d.ts +0 -241
  278. package/dist/compiled/url-join/index.d.ts +0 -17
  279. package/dist/compiled/url-join/index.js +0 -1
  280. package/dist/compiled/url-join/license +0 -21
  281. package/dist/compiled/url-join/package.json +0 -1
  282. package/dist/compiled/webpack-chain/index.js +0 -1
  283. package/dist/compiled/webpack-chain/license +0 -373
  284. package/dist/compiled/webpack-chain/package.json +0 -1
  285. package/dist/compiled/webpack-chain/types/index.d.ts +0 -388
  286. package/dist/compiled/webpack-dev-middleware/index.js +0 -7
  287. package/dist/compiled/webpack-dev-middleware/license +0 -20
  288. package/dist/compiled/webpack-dev-middleware/package.json +0 -1
  289. package/dist/compiled/webpack-dev-middleware/types/index.d.ts +0 -262
  290. package/dist/esm/FileSizeReporter.js +0 -180
  291. package/dist/esm/alias.js +0 -83
  292. package/dist/esm/analyzeProject.js +0 -168
  293. package/dist/esm/applyOptionsChain.js +0 -26
  294. package/dist/esm/babel.js +0 -169
  295. package/dist/esm/chainId.js +0 -92
  296. package/dist/esm/clearConsole.js +0 -6
  297. package/dist/esm/commands.js +0 -17
  298. package/dist/esm/compatRequire.js +0 -68
  299. package/dist/esm/compiled.js +0 -34
  300. package/dist/esm/constants.js +0 -317
  301. package/dist/esm/debug.js +0 -5
  302. package/dist/esm/emptyDir.js +0 -158
  303. package/dist/esm/ensureAbsolutePath.js +0 -5
  304. package/dist/esm/ensureArray.js +0 -9
  305. package/dist/esm/findExists.js +0 -27
  306. package/dist/esm/generateMetaTags.js +0 -40
  307. package/dist/esm/getBrowserslist.js +0 -12
  308. package/dist/esm/getCoreJsVersion.js +0 -57
  309. package/dist/esm/getEntryOptions.js +0 -45
  310. package/dist/esm/getPackageManager.js +0 -187
  311. package/dist/esm/getPort.js +0 -215
  312. package/dist/esm/getServerConfig.js +0 -145
  313. package/dist/esm/getTargetDir.js +0 -6
  314. package/dist/esm/import.js +0 -8
  315. package/dist/esm/index.js +0 -44
  316. package/dist/esm/is/index.js +0 -85
  317. package/dist/esm/is/nodeEnv.js +0 -16
  318. package/dist/esm/is/platform.js +0 -7
  319. package/dist/esm/is/type.js +0 -25
  320. package/dist/esm/logger.js +0 -207
  321. package/dist/esm/monorepo.js +0 -109
  322. package/dist/esm/nodeEnv.js +0 -258
  323. package/dist/esm/path.js +0 -85
  324. package/dist/esm/pathSerializer.js +0 -85
  325. package/dist/esm/plugin.js +0 -45
  326. package/dist/esm/prettyInstructions.js +0 -96
  327. package/dist/esm/printBuildError.js +0 -24
  328. package/dist/esm/react.js +0 -43
  329. package/dist/esm/readTsConfig.js +0 -10
  330. package/dist/esm/removeSlash.js +0 -10
  331. package/dist/esm/resolve.js +0 -42
  332. package/dist/esm/routes.js +0 -19
  333. package/dist/esm/runtimeExports.js +0 -65
  334. package/dist/esm/ssr.js +0 -3
  335. package/dist/esm/storage.js +0 -36
  336. package/dist/esm/testUtils.js +0 -13
  337. package/dist/esm/types.js +0 -1
  338. package/dist/esm/universal/constants.js +0 -3
  339. package/dist/esm/universal/formatWebpack.js +0 -108
  340. package/dist/esm/universal/nestedRoutes.js +0 -174
  341. package/dist/esm/universal/remixRouter.js +0 -1
  342. package/dist/esm/universal/serialize.js +0 -7
  343. package/dist/esm/version.js +0 -193
  344. package/dist/esm/wait.js +0 -7
  345. package/dist/esm/watch.js +0 -230
  346. package/dist/esm-node/FileSizeReporter.js +0 -133
  347. package/dist/esm-node/alias.js +0 -61
  348. package/dist/esm-node/analyzeProject.js +0 -17
  349. package/dist/esm-node/applyOptionsChain.js +0 -35
  350. package/dist/esm-node/babel.js +0 -105
  351. package/dist/esm-node/chainId.js +0 -173
  352. package/dist/esm-node/clearConsole.js +0 -8
  353. package/dist/esm-node/commands.js +0 -22
  354. package/dist/esm-node/compatRequire.js +0 -42
  355. package/dist/esm-node/compiled.js +0 -77
  356. package/dist/esm-node/constants.js +0 -264
  357. package/dist/esm-node/debug.js +0 -5
  358. package/dist/esm-node/emptyDir.js +0 -9
  359. package/dist/esm-node/ensureAbsolutePath.js +0 -5
  360. package/dist/esm-node/ensureArray.js +0 -9
  361. package/dist/esm-node/findExists.js +0 -12
  362. package/dist/esm-node/generateMetaTags.js +0 -38
  363. package/dist/esm-node/getBrowserslist.js +0 -7
  364. package/dist/esm-node/getCoreJsVersion.js +0 -13
  365. package/dist/esm-node/getEntryOptions.js +0 -17
  366. package/dist/esm-node/getPackageManager.js +0 -32
  367. package/dist/esm-node/getPort.js +0 -59
  368. package/dist/esm-node/getServerConfig.js +0 -14
  369. package/dist/esm-node/getTargetDir.js +0 -8
  370. package/dist/esm-node/import.js +0 -9
  371. package/dist/esm-node/index.js +0 -44
  372. package/dist/esm-node/is/index.js +0 -71
  373. package/dist/esm-node/is/nodeEnv.js +0 -12
  374. package/dist/esm-node/is/platform.js +0 -6
  375. package/dist/esm-node/is/type.js +0 -34
  376. package/dist/esm-node/logger.js +0 -100
  377. package/dist/esm-node/monorepo.js +0 -87
  378. package/dist/esm-node/nodeEnv.js +0 -30
  379. package/dist/esm-node/path.js +0 -50
  380. package/dist/esm-node/pathSerializer.js +0 -46
  381. package/dist/esm-node/plugin.js +0 -23
  382. package/dist/esm-node/prettyInstructions.js +0 -77
  383. package/dist/esm-node/printBuildError.js +0 -34
  384. package/dist/esm-node/react.js +0 -20
  385. package/dist/esm-node/readTsConfig.js +0 -13
  386. package/dist/esm-node/removeSlash.js +0 -8
  387. package/dist/esm-node/resolve.js +0 -38
  388. package/dist/esm-node/routes.js +0 -24
  389. package/dist/esm-node/runtimeExports.js +0 -40
  390. package/dist/esm-node/ssr.js +0 -6
  391. package/dist/esm-node/storage.js +0 -42
  392. package/dist/esm-node/testUtils.js +0 -15
  393. package/dist/esm-node/types.js +0 -0
  394. package/dist/esm-node/universal/constants.js +0 -6
  395. package/dist/esm-node/universal/formatWebpack.js +0 -77
  396. package/dist/esm-node/universal/nestedRoutes.js +0 -93
  397. package/dist/esm-node/universal/remixRouter.js +0 -1
  398. package/dist/esm-node/universal/serialize.js +0 -7
  399. package/dist/esm-node/version.js +0 -25
  400. package/dist/esm-node/wait.js +0 -6
  401. package/dist/esm-node/watch.js +0 -36
  402. package/dist/types/compiled.d.ts +0 -43
  403. /package/dist/{types/FileSizeReporter.d.ts → FileSizeReporter.d.ts} +0 -0
  404. /package/dist/{cjs/FileSizeReporter.js → FileSizeReporter.js} +0 -0
  405. /package/dist/{types/alias.d.ts → alias.d.ts} +0 -0
  406. /package/dist/{types/analyzeProject.d.ts → analyzeProject.d.ts} +0 -0
  407. /package/dist/{types/applyOptionsChain.d.ts → applyOptionsChain.d.ts} +0 -0
  408. /package/dist/{cjs/applyOptionsChain.js → applyOptionsChain.js} +0 -0
  409. /package/dist/{types/babel.d.ts → babel.d.ts} +0 -0
  410. /package/dist/{types/chainId.d.ts → chainId.d.ts} +0 -0
  411. /package/dist/{cjs/chainId.js → chainId.js} +0 -0
  412. /package/dist/{types/clearConsole.d.ts → clearConsole.d.ts} +0 -0
  413. /package/dist/{cjs/clearConsole.js → clearConsole.js} +0 -0
  414. /package/dist/{types/commands.d.ts → commands.d.ts} +0 -0
  415. /package/dist/{cjs/commands.js → commands.js} +0 -0
  416. /package/dist/{types/compatRequire.d.ts → compatRequire.d.ts} +0 -0
  417. /package/dist/{cjs/compiled.js → compiled.js} +0 -0
  418. /package/dist/{types/constants.d.ts → constants.d.ts} +0 -0
  419. /package/dist/{cjs/constants.js → constants.js} +0 -0
  420. /package/dist/{cjs/debug.js → debug.js} +0 -0
  421. /package/dist/{types/emptyDir.d.ts → emptyDir.d.ts} +0 -0
  422. /package/dist/{types/ensureAbsolutePath.d.ts → ensureAbsolutePath.d.ts} +0 -0
  423. /package/dist/{cjs/ensureAbsolutePath.js → ensureAbsolutePath.js} +0 -0
  424. /package/dist/{types/ensureArray.d.ts → ensureArray.d.ts} +0 -0
  425. /package/dist/{cjs/ensureArray.js → ensureArray.js} +0 -0
  426. /package/dist/{types/findExists.d.ts → findExists.d.ts} +0 -0
  427. /package/dist/{cjs/findExists.js → findExists.js} +0 -0
  428. /package/dist/{types/generateMetaTags.d.ts → generateMetaTags.d.ts} +0 -0
  429. /package/dist/{cjs/generateMetaTags.js → generateMetaTags.js} +0 -0
  430. /package/dist/{types/getBrowserslist.d.ts → getBrowserslist.d.ts} +0 -0
  431. /package/dist/{cjs/getBrowserslist.js → getBrowserslist.js} +0 -0
  432. /package/dist/{types/getCoreJsVersion.d.ts → getCoreJsVersion.d.ts} +0 -0
  433. /package/dist/{cjs/getCoreJsVersion.js → getCoreJsVersion.js} +0 -0
  434. /package/dist/{types/getEntryOptions.d.ts → getEntryOptions.d.ts} +0 -0
  435. /package/dist/{types/getPackageManager.d.ts → getPackageManager.d.ts} +0 -0
  436. /package/dist/{types/getPort.d.ts → getPort.d.ts} +0 -0
  437. /package/dist/{types/getServerConfig.d.ts → getServerConfig.d.ts} +0 -0
  438. /package/dist/{types/getTargetDir.d.ts → getTargetDir.d.ts} +0 -0
  439. /package/dist/{cjs/getTargetDir.js → getTargetDir.js} +0 -0
  440. /package/dist/{types/import.d.ts → import.d.ts} +0 -0
  441. /package/dist/{cjs/import.js → import.js} +0 -0
  442. /package/dist/{types/index.d.ts → index.d.ts} +0 -0
  443. /package/dist/{cjs/index.js → index.js} +0 -0
  444. /package/dist/{types/is → is}/index.d.ts +0 -0
  445. /package/dist/{cjs/is → is}/index.js +0 -0
  446. /package/dist/{types/is → is}/nodeEnv.d.ts +0 -0
  447. /package/dist/{cjs/is → is}/nodeEnv.js +0 -0
  448. /package/dist/{types/is → is}/platform.d.ts +0 -0
  449. /package/dist/{cjs/is → is}/platform.js +0 -0
  450. /package/dist/{types/is → is}/type.d.ts +0 -0
  451. /package/dist/{cjs/is → is}/type.js +0 -0
  452. /package/dist/{types/monorepo.d.ts → monorepo.d.ts} +0 -0
  453. /package/dist/{types/nodeEnv.d.ts → nodeEnv.d.ts} +0 -0
  454. /package/dist/{types/path.d.ts → path.d.ts} +0 -0
  455. /package/dist/{types/pathSerializer.d.ts → pathSerializer.d.ts} +0 -0
  456. /package/dist/{types/plugin.d.ts → plugin.d.ts} +0 -0
  457. /package/dist/{cjs/plugin.js → plugin.js} +0 -0
  458. /package/dist/{types/prettyInstructions.d.ts → prettyInstructions.d.ts} +0 -0
  459. /package/dist/{cjs/prettyInstructions.js → prettyInstructions.js} +0 -0
  460. /package/dist/{types/printBuildError.d.ts → printBuildError.d.ts} +0 -0
  461. /package/dist/{cjs/printBuildError.js → printBuildError.js} +0 -0
  462. /package/dist/{types/react.d.ts → react.d.ts} +0 -0
  463. /package/dist/{types/readTsConfig.d.ts → readTsConfig.d.ts} +0 -0
  464. /package/dist/{cjs/readTsConfig.js → readTsConfig.js} +0 -0
  465. /package/dist/{types/removeSlash.d.ts → removeSlash.d.ts} +0 -0
  466. /package/dist/{cjs/removeSlash.js → removeSlash.js} +0 -0
  467. /package/dist/{types/resolve.d.ts → resolve.d.ts} +0 -0
  468. /package/dist/{cjs/resolve.js → resolve.js} +0 -0
  469. /package/dist/{types/routes.d.ts → routes.d.ts} +0 -0
  470. /package/dist/{cjs/routes.js → routes.js} +0 -0
  471. /package/dist/{types/runtimeExports.d.ts → runtimeExports.d.ts} +0 -0
  472. /package/dist/{types/ssr.d.ts → ssr.d.ts} +0 -0
  473. /package/dist/{cjs/ssr.js → ssr.js} +0 -0
  474. /package/dist/{types/storage.d.ts → storage.d.ts} +0 -0
  475. /package/dist/{cjs/storage.js → storage.js} +0 -0
  476. /package/dist/{types/testUtils.d.ts → testUtils.d.ts} +0 -0
  477. /package/dist/{cjs/testUtils.js → testUtils.js} +0 -0
  478. /package/dist/{types/types.d.ts → types.d.ts} +0 -0
  479. /package/dist/{cjs/types.js → types.js} +0 -0
  480. /package/dist/{types/universal → universal}/constants.d.ts +0 -0
  481. /package/dist/{cjs/universal → universal}/constants.js +0 -0
  482. /package/dist/{types/universal → universal}/formatWebpack.d.ts +0 -0
  483. /package/dist/{cjs/universal → universal}/formatWebpack.js +0 -0
  484. /package/dist/{types/universal → universal}/nestedRoutes.d.ts +0 -0
  485. /package/dist/{types/universal → universal}/remixRouter.d.ts +0 -0
  486. /package/dist/{cjs/universal → universal}/remixRouter.js +0 -0
  487. /package/dist/{types/universal → universal}/serialize.d.ts +0 -0
  488. /package/dist/{cjs/universal → universal}/serialize.js +0 -0
  489. /package/dist/{types/version.d.ts → version.d.ts} +0 -0
  490. /package/dist/{types/wait.d.ts → wait.d.ts} +0 -0
  491. /package/dist/{cjs/wait.js → wait.js} +0 -0
  492. /package/dist/{types/watch.d.ts → watch.d.ts} +0 -0
@@ -1,890 +0,0 @@
1
- // Type definitions for commander
2
- // Original definitions by: Alan Agius <https://github.com/alan-agius4>, Marcelo Dezem <https://github.com/mdezem>, vvakame <https://github.com/vvakame>, Jules Randolph <https://github.com/sveinburne>
3
-
4
- // Using method rather than property for method-signature-style, to document method overloads separately. Allow either.
5
- /* eslint-disable @typescript-eslint/method-signature-style */
6
- /* eslint-disable @typescript-eslint/no-explicit-any */
7
-
8
- export class CommanderError extends Error {
9
- code: string;
10
- exitCode: number;
11
- message: string;
12
- nestedError?: string;
13
-
14
- /**
15
- * Constructs the CommanderError class
16
- * @param exitCode - suggested exit code which could be used with process.exit
17
- * @param code - an id string representing the error
18
- * @param message - human-readable description of the error
19
- * @constructor
20
- */
21
- constructor(exitCode: number, code: string, message: string);
22
- }
23
-
24
- export class InvalidArgumentError extends CommanderError {
25
- /**
26
- * Constructs the InvalidArgumentError class
27
- * @param message - explanation of why argument is invalid
28
- * @constructor
29
- */
30
- constructor(message: string);
31
- }
32
- export { InvalidArgumentError as InvalidOptionArgumentError }; // deprecated old name
33
-
34
- export interface ErrorOptions { // optional parameter for error()
35
- /** an id string representing the error */
36
- code?: string;
37
- /** suggested exit code which could be used with process.exit */
38
- exitCode?: number;
39
- }
40
-
41
- export class Argument {
42
- description: string;
43
- required: boolean;
44
- variadic: boolean;
45
-
46
- /**
47
- * Initialize a new command argument with the given name and description.
48
- * The default is that the argument is required, and you can explicitly
49
- * indicate this with <> around the name. Put [] around the name for an optional argument.
50
- */
51
- constructor(arg: string, description?: string);
52
-
53
- /**
54
- * Return argument name.
55
- */
56
- name(): string;
57
-
58
- /**
59
- * Set the default value, and optionally supply the description to be displayed in the help.
60
- */
61
- default(value: unknown, description?: string): this;
62
-
63
- /**
64
- * Set the custom handler for processing CLI command arguments into argument values.
65
- */
66
- argParser<T>(fn: (value: string, previous: T) => T): this;
67
-
68
- /**
69
- * Only allow argument value to be one of choices.
70
- */
71
- choices(values: readonly string[]): this;
72
-
73
- /**
74
- * Make argument required.
75
- */
76
- argRequired(): this;
77
-
78
- /**
79
- * Make argument optional.
80
- */
81
- argOptional(): this;
82
- }
83
-
84
- export class Option {
85
- flags: string;
86
- description: string;
87
-
88
- required: boolean; // A value must be supplied when the option is specified.
89
- optional: boolean; // A value is optional when the option is specified.
90
- variadic: boolean;
91
- mandatory: boolean; // The option must have a value after parsing, which usually means it must be specified on command line.
92
- optionFlags: string;
93
- short?: string;
94
- long?: string;
95
- negate: boolean;
96
- defaultValue?: any;
97
- defaultValueDescription?: string;
98
- parseArg?: <T>(value: string, previous: T) => T;
99
- hidden: boolean;
100
- argChoices?: string[];
101
-
102
- constructor(flags: string, description?: string);
103
-
104
- /**
105
- * Set the default value, and optionally supply the description to be displayed in the help.
106
- */
107
- default(value: unknown, description?: string): this;
108
-
109
- /**
110
- * Preset to use when option used without option-argument, especially optional but also boolean and negated.
111
- * The custom processing (parseArg) is called.
112
- *
113
- * @example
114
- * ```ts
115
- * new Option('--color').default('GREYSCALE').preset('RGB');
116
- * new Option('--donate [amount]').preset('20').argParser(parseFloat);
117
- * ```
118
- */
119
- preset(arg: unknown): this;
120
-
121
- /**
122
- * Add option name(s) that conflict with this option.
123
- * An error will be displayed if conflicting options are found during parsing.
124
- *
125
- * @example
126
- * ```ts
127
- * new Option('--rgb').conflicts('cmyk');
128
- * new Option('--js').conflicts(['ts', 'jsx']);
129
- * ```
130
- */
131
- conflicts(names: string | string[]): this;
132
-
133
- /**
134
- * Specify implied option values for when this option is set and the implied options are not.
135
- *
136
- * The custom processing (parseArg) is not called on the implied values.
137
- *
138
- * @example
139
- * program
140
- * .addOption(new Option('--log', 'write logging information to file'))
141
- * .addOption(new Option('--trace', 'log extra details').implies({ log: 'trace.txt' }));
142
- */
143
- implies(optionValues: OptionValues): this;
144
-
145
- /**
146
- * Set environment variable to check for option value.
147
- *
148
- * An environment variables is only used if when processed the current option value is
149
- * undefined, or the source of the current value is 'default' or 'config' or 'env'.
150
- */
151
- env(name: string): this;
152
-
153
- /**
154
- * Calculate the full description, including defaultValue etc.
155
- */
156
- fullDescription(): string;
157
-
158
- /**
159
- * Set the custom handler for processing CLI option arguments into option values.
160
- */
161
- argParser<T>(fn: (value: string, previous: T) => T): this;
162
-
163
- /**
164
- * Whether the option is mandatory and must have a value after parsing.
165
- */
166
- makeOptionMandatory(mandatory?: boolean): this;
167
-
168
- /**
169
- * Hide option in help.
170
- */
171
- hideHelp(hide?: boolean): this;
172
-
173
- /**
174
- * Only allow option value to be one of choices.
175
- */
176
- choices(values: readonly string[]): this;
177
-
178
- /**
179
- * Return option name.
180
- */
181
- name(): string;
182
-
183
- /**
184
- * Return option name, in a camelcase format that can be used
185
- * as a object attribute key.
186
- */
187
- attributeName(): string;
188
-
189
- /**
190
- * Return whether a boolean option.
191
- *
192
- * Options are one of boolean, negated, required argument, or optional argument.
193
- */
194
- isBoolean(): boolean;
195
- }
196
-
197
- export class Help {
198
- /** output helpWidth, long lines are wrapped to fit */
199
- helpWidth?: number;
200
- sortSubcommands: boolean;
201
- sortOptions: boolean;
202
- showGlobalOptions: boolean;
203
-
204
- constructor();
205
-
206
- /** Get the command term to show in the list of subcommands. */
207
- subcommandTerm(cmd: Command): string;
208
- /** Get the command summary to show in the list of subcommands. */
209
- subcommandDescription(cmd: Command): string;
210
- /** Get the option term to show in the list of options. */
211
- optionTerm(option: Option): string;
212
- /** Get the option description to show in the list of options. */
213
- optionDescription(option: Option): string;
214
- /** Get the argument term to show in the list of arguments. */
215
- argumentTerm(argument: Argument): string;
216
- /** Get the argument description to show in the list of arguments. */
217
- argumentDescription(argument: Argument): string;
218
-
219
- /** Get the command usage to be displayed at the top of the built-in help. */
220
- commandUsage(cmd: Command): string;
221
- /** Get the description for the command. */
222
- commandDescription(cmd: Command): string;
223
-
224
- /** Get an array of the visible subcommands. Includes a placeholder for the implicit help command, if there is one. */
225
- visibleCommands(cmd: Command): Command[];
226
- /** Get an array of the visible options. Includes a placeholder for the implicit help option, if there is one. */
227
- visibleOptions(cmd: Command): Option[];
228
- /** Get an array of the visible global options. (Not including help.) */
229
- visibleGlobalOptions(cmd: Command): Option[];
230
- /** Get an array of the arguments which have descriptions. */
231
- visibleArguments(cmd: Command): Argument[];
232
-
233
- /** Get the longest command term length. */
234
- longestSubcommandTermLength(cmd: Command, helper: Help): number;
235
- /** Get the longest option term length. */
236
- longestOptionTermLength(cmd: Command, helper: Help): number;
237
- /** Get the longest global option term length. */
238
- longestGlobalOptionTermLength(cmd: Command, helper: Help): number;
239
- /** Get the longest argument term length. */
240
- longestArgumentTermLength(cmd: Command, helper: Help): number;
241
- /** Calculate the pad width from the maximum term length. */
242
- padWidth(cmd: Command, helper: Help): number;
243
-
244
- /**
245
- * Wrap the given string to width characters per line, with lines after the first indented.
246
- * Do not wrap if insufficient room for wrapping (minColumnWidth), or string is manually formatted.
247
- */
248
- wrap(str: string, width: number, indent: number, minColumnWidth?: number): string;
249
-
250
- /** Generate the built-in help text. */
251
- formatHelp(cmd: Command, helper: Help): string;
252
- }
253
- export type HelpConfiguration = Partial<Help>;
254
-
255
- export interface ParseOptions {
256
- from: 'node' | 'electron' | 'user';
257
- }
258
- export interface HelpContext { // optional parameter for .help() and .outputHelp()
259
- error: boolean;
260
- }
261
- export interface AddHelpTextContext { // passed to text function used with .addHelpText()
262
- error: boolean;
263
- command: Command;
264
- }
265
- export interface OutputConfiguration {
266
- writeOut?(str: string): void;
267
- writeErr?(str: string): void;
268
- getOutHelpWidth?(): number;
269
- getErrHelpWidth?(): number;
270
- outputError?(str: string, write: (str: string) => void): void;
271
-
272
- }
273
-
274
- export type AddHelpTextPosition = 'beforeAll' | 'before' | 'after' | 'afterAll';
275
- export type HookEvent = 'preSubcommand' | 'preAction' | 'postAction';
276
- export type OptionValueSource = 'default' | 'config' | 'env' | 'cli' | 'implied';
277
-
278
- export type OptionValues = Record<string, any>;
279
-
280
- export class Command {
281
- args: string[];
282
- processedArgs: any[];
283
- readonly commands: readonly Command[];
284
- readonly options: readonly Option[];
285
- parent: Command | null;
286
-
287
- constructor(name?: string);
288
-
289
- /**
290
- * Set the program version to `str`.
291
- *
292
- * This method auto-registers the "-V, --version" flag
293
- * which will print the version number when passed.
294
- *
295
- * You can optionally supply the flags and description to override the defaults.
296
- */
297
- version(str: string, flags?: string, description?: string): this;
298
-
299
- /**
300
- * Define a command, implemented using an action handler.
301
- *
302
- * @remarks
303
- * The command description is supplied using `.description`, not as a parameter to `.command`.
304
- *
305
- * @example
306
- * ```ts
307
- * program
308
- * .command('clone <source> [destination]')
309
- * .description('clone a repository into a newly created directory')
310
- * .action((source, destination) => {
311
- * console.log('clone command called');
312
- * });
313
- * ```
314
- *
315
- * @param nameAndArgs - command name and arguments, args are `<required>` or `[optional]` and last may also be `variadic...`
316
- * @param opts - configuration options
317
- * @returns new command
318
- */
319
- command(nameAndArgs: string, opts?: CommandOptions): ReturnType<this['createCommand']>;
320
- /**
321
- * Define a command, implemented in a separate executable file.
322
- *
323
- * @remarks
324
- * The command description is supplied as the second parameter to `.command`.
325
- *
326
- * @example
327
- * ```ts
328
- * program
329
- * .command('start <service>', 'start named service')
330
- * .command('stop [service]', 'stop named service, or all if no name supplied');
331
- * ```
332
- *
333
- * @param nameAndArgs - command name and arguments, args are `<required>` or `[optional]` and last may also be `variadic...`
334
- * @param description - description of executable command
335
- * @param opts - configuration options
336
- * @returns `this` command for chaining
337
- */
338
- command(nameAndArgs: string, description: string, opts?: ExecutableCommandOptions): this;
339
-
340
- /**
341
- * Factory routine to create a new unattached command.
342
- *
343
- * See .command() for creating an attached subcommand, which uses this routine to
344
- * create the command. You can override createCommand to customise subcommands.
345
- */
346
- createCommand(name?: string): Command;
347
-
348
- /**
349
- * Add a prepared subcommand.
350
- *
351
- * See .command() for creating an attached subcommand which inherits settings from its parent.
352
- *
353
- * @returns `this` command for chaining
354
- */
355
- addCommand(cmd: Command, opts?: CommandOptions): this;
356
-
357
- /**
358
- * Factory routine to create a new unattached argument.
359
- *
360
- * See .argument() for creating an attached argument, which uses this routine to
361
- * create the argument. You can override createArgument to return a custom argument.
362
- */
363
- createArgument(name: string, description?: string): Argument;
364
-
365
- /**
366
- * Define argument syntax for command.
367
- *
368
- * The default is that the argument is required, and you can explicitly
369
- * indicate this with <> around the name. Put [] around the name for an optional argument.
370
- *
371
- * @example
372
- * ```
373
- * program.argument('<input-file>');
374
- * program.argument('[output-file]');
375
- * ```
376
- *
377
- * @returns `this` command for chaining
378
- */
379
- argument<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): this;
380
- argument(name: string, description?: string, defaultValue?: unknown): this;
381
-
382
- /**
383
- * Define argument syntax for command, adding a prepared argument.
384
- *
385
- * @returns `this` command for chaining
386
- */
387
- addArgument(arg: Argument): this;
388
-
389
- /**
390
- * Define argument syntax for command, adding multiple at once (without descriptions).
391
- *
392
- * See also .argument().
393
- *
394
- * @example
395
- * ```
396
- * program.arguments('<cmd> [env]');
397
- * ```
398
- *
399
- * @returns `this` command for chaining
400
- */
401
- arguments(names: string): this;
402
-
403
- /**
404
- * Override default decision whether to add implicit help command.
405
- *
406
- * @example
407
- * ```
408
- * addHelpCommand() // force on
409
- * addHelpCommand(false); // force off
410
- * addHelpCommand('help [cmd]', 'display help for [cmd]'); // force on with custom details
411
- * ```
412
- *
413
- * @returns `this` command for chaining
414
- */
415
- addHelpCommand(enableOrNameAndArgs?: string | boolean, description?: string): this;
416
-
417
- /**
418
- * Add hook for life cycle event.
419
- */
420
- hook(event: HookEvent, listener: (thisCommand: Command, actionCommand: Command) => void | Promise<void>): this;
421
-
422
- /**
423
- * Register callback to use as replacement for calling process.exit.
424
- */
425
- exitOverride(callback?: (err: CommanderError) => never | void): this;
426
-
427
- /**
428
- * Display error message and exit (or call exitOverride).
429
- */
430
- error(message: string, errorOptions?: ErrorOptions): never;
431
-
432
- /**
433
- * You can customise the help with a subclass of Help by overriding createHelp,
434
- * or by overriding Help properties using configureHelp().
435
- */
436
- createHelp(): Help;
437
-
438
- /**
439
- * You can customise the help by overriding Help properties using configureHelp(),
440
- * or with a subclass of Help by overriding createHelp().
441
- */
442
- configureHelp(configuration: HelpConfiguration): this;
443
- /** Get configuration */
444
- configureHelp(): HelpConfiguration;
445
-
446
- /**
447
- * The default output goes to stdout and stderr. You can customise this for special
448
- * applications. You can also customise the display of errors by overriding outputError.
449
- *
450
- * The configuration properties are all functions:
451
- * ```
452
- * // functions to change where being written, stdout and stderr
453
- * writeOut(str)
454
- * writeErr(str)
455
- * // matching functions to specify width for wrapping help
456
- * getOutHelpWidth()
457
- * getErrHelpWidth()
458
- * // functions based on what is being written out
459
- * outputError(str, write) // used for displaying errors, and not used for displaying help
460
- * ```
461
- */
462
- configureOutput(configuration: OutputConfiguration): this;
463
- /** Get configuration */
464
- configureOutput(): OutputConfiguration;
465
-
466
- /**
467
- * Copy settings that are useful to have in common across root command and subcommands.
468
- *
469
- * (Used internally when adding a command using `.command()` so subcommands inherit parent settings.)
470
- */
471
- copyInheritedSettings(sourceCommand: Command): this;
472
-
473
- /**
474
- * Display the help or a custom message after an error occurs.
475
- */
476
- showHelpAfterError(displayHelp?: boolean | string): this;
477
-
478
- /**
479
- * Display suggestion of similar commands for unknown commands, or options for unknown options.
480
- */
481
- showSuggestionAfterError(displaySuggestion?: boolean): this;
482
-
483
- /**
484
- * Register callback `fn` for the command.
485
- *
486
- * @example
487
- * ```
488
- * program
489
- * .command('serve')
490
- * .description('start service')
491
- * .action(function() {
492
- * // do work here
493
- * });
494
- * ```
495
- *
496
- * @returns `this` command for chaining
497
- */
498
- action(fn: (...args: any[]) => void | Promise<void>): this;
499
-
500
- /**
501
- * Define option with `flags`, `description` and optional
502
- * coercion `fn`.
503
- *
504
- * The `flags` string contains the short and/or long flags,
505
- * separated by comma, a pipe or space. The following are all valid
506
- * all will output this way when `--help` is used.
507
- *
508
- * "-p, --pepper"
509
- * "-p|--pepper"
510
- * "-p --pepper"
511
- *
512
- * @example
513
- * ```
514
- * // simple boolean defaulting to false
515
- * program.option('-p, --pepper', 'add pepper');
516
- *
517
- * --pepper
518
- * program.pepper
519
- * // => Boolean
520
- *
521
- * // simple boolean defaulting to true
522
- * program.option('-C, --no-cheese', 'remove cheese');
523
- *
524
- * program.cheese
525
- * // => true
526
- *
527
- * --no-cheese
528
- * program.cheese
529
- * // => false
530
- *
531
- * // required argument
532
- * program.option('-C, --chdir <path>', 'change the working directory');
533
- *
534
- * --chdir /tmp
535
- * program.chdir
536
- * // => "/tmp"
537
- *
538
- * // optional argument
539
- * program.option('-c, --cheese [type]', 'add cheese [marble]');
540
- * ```
541
- *
542
- * @returns `this` command for chaining
543
- */
544
- option(flags: string, description?: string, defaultValue?: string | boolean | string[]): this;
545
- option<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): this;
546
- /** @deprecated since v7, instead use choices or a custom function */
547
- option(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean | string[]): this;
548
-
549
- /**
550
- * Define a required option, which must have a value after parsing. This usually means
551
- * the option must be specified on the command line. (Otherwise the same as .option().)
552
- *
553
- * The `flags` string contains the short and/or long flags, separated by comma, a pipe or space.
554
- */
555
- requiredOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): this;
556
- requiredOption<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): this;
557
- /** @deprecated since v7, instead use choices or a custom function */
558
- requiredOption(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean | string[]): this;
559
-
560
- /**
561
- * Factory routine to create a new unattached option.
562
- *
563
- * See .option() for creating an attached option, which uses this routine to
564
- * create the option. You can override createOption to return a custom option.
565
- */
566
-
567
- createOption(flags: string, description?: string): Option;
568
-
569
- /**
570
- * Add a prepared Option.
571
- *
572
- * See .option() and .requiredOption() for creating and attaching an option in a single call.
573
- */
574
- addOption(option: Option): this;
575
-
576
- /**
577
- * Whether to store option values as properties on command object,
578
- * or store separately (specify false). In both cases the option values can be accessed using .opts().
579
- *
580
- * @returns `this` command for chaining
581
- */
582
- storeOptionsAsProperties<T extends OptionValues>(): this & T;
583
- storeOptionsAsProperties<T extends OptionValues>(storeAsProperties: true): this & T;
584
- storeOptionsAsProperties(storeAsProperties?: boolean): this;
585
-
586
- /**
587
- * Retrieve option value.
588
- */
589
- getOptionValue(key: string): any;
590
-
591
- /**
592
- * Store option value.
593
- */
594
- setOptionValue(key: string, value: unknown): this;
595
-
596
- /**
597
- * Store option value and where the value came from.
598
- */
599
- setOptionValueWithSource(key: string, value: unknown, source: OptionValueSource): this;
600
-
601
- /**
602
- * Get source of option value.
603
- */
604
- getOptionValueSource(key: string): OptionValueSource | undefined;
605
-
606
- /**
607
- * Get source of option value. See also .optsWithGlobals().
608
- */
609
- getOptionValueSourceWithGlobals(key: string): OptionValueSource | undefined;
610
-
611
- /**
612
- * Alter parsing of short flags with optional values.
613
- *
614
- * @example
615
- * ```
616
- * // for `.option('-f,--flag [value]'):
617
- * .combineFlagAndOptionalValue(true) // `-f80` is treated like `--flag=80`, this is the default behaviour
618
- * .combineFlagAndOptionalValue(false) // `-fb` is treated like `-f -b`
619
- * ```
620
- *
621
- * @returns `this` command for chaining
622
- */
623
- combineFlagAndOptionalValue(combine?: boolean): this;
624
-
625
- /**
626
- * Allow unknown options on the command line.
627
- *
628
- * @returns `this` command for chaining
629
- */
630
- allowUnknownOption(allowUnknown?: boolean): this;
631
-
632
- /**
633
- * Allow excess command-arguments on the command line. Pass false to make excess arguments an error.
634
- *
635
- * @returns `this` command for chaining
636
- */
637
- allowExcessArguments(allowExcess?: boolean): this;
638
-
639
- /**
640
- * Enable positional options. Positional means global options are specified before subcommands which lets
641
- * subcommands reuse the same option names, and also enables subcommands to turn on passThroughOptions.
642
- *
643
- * The default behaviour is non-positional and global options may appear anywhere on the command line.
644
- *
645
- * @returns `this` command for chaining
646
- */
647
- enablePositionalOptions(positional?: boolean): this;
648
-
649
- /**
650
- * Pass through options that come after command-arguments rather than treat them as command-options,
651
- * so actual command-options come before command-arguments. Turning this on for a subcommand requires
652
- * positional options to have been enabled on the program (parent commands).
653
- *
654
- * The default behaviour is non-positional and options may appear before or after command-arguments.
655
- *
656
- * @returns `this` command for chaining
657
- */
658
- passThroughOptions(passThrough?: boolean): this;
659
-
660
- /**
661
- * Parse `argv`, setting options and invoking commands when defined.
662
- *
663
- * The default expectation is that the arguments are from node and have the application as argv[0]
664
- * and the script being run in argv[1], with user parameters after that.
665
- *
666
- * @example
667
- * ```
668
- * program.parse(process.argv);
669
- * program.parse(); // implicitly use process.argv and auto-detect node vs electron conventions
670
- * program.parse(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
671
- * ```
672
- *
673
- * @returns `this` command for chaining
674
- */
675
- parse(argv?: readonly string[], options?: ParseOptions): this;
676
-
677
- /**
678
- * Parse `argv`, setting options and invoking commands when defined.
679
- *
680
- * Use parseAsync instead of parse if any of your action handlers are async. Returns a Promise.
681
- *
682
- * The default expectation is that the arguments are from node and have the application as argv[0]
683
- * and the script being run in argv[1], with user parameters after that.
684
- *
685
- * @example
686
- * ```
687
- * program.parseAsync(process.argv);
688
- * program.parseAsync(); // implicitly use process.argv and auto-detect node vs electron conventions
689
- * program.parseAsync(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
690
- * ```
691
- *
692
- * @returns Promise
693
- */
694
- parseAsync(argv?: readonly string[], options?: ParseOptions): Promise<this>;
695
-
696
- /**
697
- * Parse options from `argv` removing known options,
698
- * and return argv split into operands and unknown arguments.
699
- *
700
- * argv => operands, unknown
701
- * --known kkk op => [op], []
702
- * op --known kkk => [op], []
703
- * sub --unknown uuu op => [sub], [--unknown uuu op]
704
- * sub -- --unknown uuu op => [sub --unknown uuu op], []
705
- */
706
- parseOptions(argv: string[]): ParseOptionsResult;
707
-
708
- /**
709
- * Return an object containing local option values as key-value pairs
710
- */
711
- opts<T extends OptionValues>(): T;
712
-
713
- /**
714
- * Return an object containing merged local and global option values as key-value pairs.
715
- */
716
- optsWithGlobals<T extends OptionValues>(): T;
717
-
718
- /**
719
- * Set the description.
720
- *
721
- * @returns `this` command for chaining
722
- */
723
-
724
- description(str: string): this;
725
- /** @deprecated since v8, instead use .argument to add command argument with description */
726
- description(str: string, argsDescription: Record<string, string>): this;
727
- /**
728
- * Get the description.
729
- */
730
- description(): string;
731
-
732
- /**
733
- * Set the summary. Used when listed as subcommand of parent.
734
- *
735
- * @returns `this` command for chaining
736
- */
737
-
738
- summary(str: string): this;
739
- /**
740
- * Get the summary.
741
- */
742
- summary(): string;
743
-
744
- /**
745
- * Set an alias for the command.
746
- *
747
- * You may call more than once to add multiple aliases. Only the first alias is shown in the auto-generated help.
748
- *
749
- * @returns `this` command for chaining
750
- */
751
- alias(alias: string): this;
752
- /**
753
- * Get alias for the command.
754
- */
755
- alias(): string;
756
-
757
- /**
758
- * Set aliases for the command.
759
- *
760
- * Only the first alias is shown in the auto-generated help.
761
- *
762
- * @returns `this` command for chaining
763
- */
764
- aliases(aliases: readonly string[]): this;
765
- /**
766
- * Get aliases for the command.
767
- */
768
- aliases(): string[];
769
-
770
- /**
771
- * Set the command usage.
772
- *
773
- * @returns `this` command for chaining
774
- */
775
- usage(str: string): this;
776
- /**
777
- * Get the command usage.
778
- */
779
- usage(): string;
780
-
781
- /**
782
- * Set the name of the command.
783
- *
784
- * @returns `this` command for chaining
785
- */
786
- name(str: string): this;
787
- /**
788
- * Get the name of the command.
789
- */
790
- name(): string;
791
-
792
- /**
793
- * Set the name of the command from script filename, such as process.argv[1],
794
- * or require.main.filename, or __filename.
795
- *
796
- * (Used internally and public although not documented in README.)
797
- *
798
- * @example
799
- * ```ts
800
- * program.nameFromFilename(require.main.filename);
801
- * ```
802
- *
803
- * @returns `this` command for chaining
804
- */
805
- nameFromFilename(filename: string): this;
806
-
807
- /**
808
- * Set the directory for searching for executable subcommands of this command.
809
- *
810
- * @example
811
- * ```ts
812
- * program.executableDir(__dirname);
813
- * // or
814
- * program.executableDir('subcommands');
815
- * ```
816
- *
817
- * @returns `this` command for chaining
818
- */
819
- executableDir(path: string): this;
820
- /**
821
- * Get the executable search directory.
822
- */
823
- executableDir(): string;
824
-
825
- /**
826
- * Output help information for this command.
827
- *
828
- * Outputs built-in help, and custom text added using `.addHelpText()`.
829
- *
830
- */
831
- outputHelp(context?: HelpContext): void;
832
- /** @deprecated since v7 */
833
- outputHelp(cb?: (str: string) => string): void;
834
-
835
- /**
836
- * Return command help documentation.
837
- */
838
- helpInformation(context?: HelpContext): string;
839
-
840
- /**
841
- * You can pass in flags and a description to override the help
842
- * flags and help description for your command. Pass in false
843
- * to disable the built-in help option.
844
- */
845
- helpOption(flags?: string | boolean, description?: string): this;
846
-
847
- /**
848
- * Output help information and exit.
849
- *
850
- * Outputs built-in help, and custom text added using `.addHelpText()`.
851
- */
852
- help(context?: HelpContext): never;
853
- /** @deprecated since v7 */
854
- help(cb?: (str: string) => string): never;
855
-
856
- /**
857
- * Add additional text to be displayed with the built-in help.
858
- *
859
- * Position is 'before' or 'after' to affect just this command,
860
- * and 'beforeAll' or 'afterAll' to affect this command and all its subcommands.
861
- */
862
- addHelpText(position: AddHelpTextPosition, text: string): this;
863
- addHelpText(position: AddHelpTextPosition, text: (context: AddHelpTextContext) => string): this;
864
-
865
- /**
866
- * Add a listener (callback) for when events occur. (Implemented using EventEmitter.)
867
- */
868
- on(event: string | symbol, listener: (...args: any[]) => void): this;
869
- }
870
-
871
- export interface CommandOptions {
872
- hidden?: boolean;
873
- isDefault?: boolean;
874
- /** @deprecated since v7, replaced by hidden */
875
- noHelp?: boolean;
876
- }
877
- export interface ExecutableCommandOptions extends CommandOptions {
878
- executableFile?: string;
879
- }
880
-
881
- export interface ParseOptionsResult {
882
- operands: string[];
883
- unknown: string[];
884
- }
885
-
886
- export function createCommand(name?: string): Command;
887
- export function createOption(flags: string, description?: string): Option;
888
- export function createArgument(name: string, description?: string): Argument;
889
-
890
- export const program: Command;