@boneskull/bargs 3.2.0 → 3.3.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 (70) hide show
  1. package/README.md +79 -30
  2. package/dist/bargs.cjs +102 -12
  3. package/dist/bargs.cjs.map +1 -1
  4. package/dist/bargs.d.cts +51 -5
  5. package/dist/bargs.d.cts.map +1 -1
  6. package/dist/bargs.d.ts +51 -5
  7. package/dist/bargs.d.ts.map +1 -1
  8. package/dist/bargs.js +99 -11
  9. package/dist/bargs.js.map +1 -1
  10. package/dist/help.cjs +31 -2
  11. package/dist/help.cjs.map +1 -1
  12. package/dist/help.d.cts +4 -0
  13. package/dist/help.d.cts.map +1 -1
  14. package/dist/help.d.ts +4 -0
  15. package/dist/help.d.ts.map +1 -1
  16. package/dist/help.js +31 -2
  17. package/dist/help.js.map +1 -1
  18. package/dist/index.cjs +3 -3
  19. package/dist/index.cjs.map +1 -1
  20. package/dist/index.d.cts +3 -4
  21. package/dist/index.d.cts.map +1 -1
  22. package/dist/index.d.ts +3 -4
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/index.js +2 -3
  25. package/dist/index.js.map +1 -1
  26. package/dist/opt.cjs +38 -0
  27. package/dist/opt.cjs.map +1 -1
  28. package/dist/opt.d.cts +26 -0
  29. package/dist/opt.d.cts.map +1 -1
  30. package/dist/opt.d.ts +26 -0
  31. package/dist/opt.d.ts.map +1 -1
  32. package/dist/opt.js +38 -0
  33. package/dist/opt.js.map +1 -1
  34. package/dist/osc.cjs +12 -0
  35. package/dist/osc.cjs.map +1 -1
  36. package/dist/osc.d.cts +6 -0
  37. package/dist/osc.d.cts.map +1 -1
  38. package/dist/osc.d.ts +6 -0
  39. package/dist/osc.d.ts.map +1 -1
  40. package/dist/osc.js +12 -0
  41. package/dist/osc.js.map +1 -1
  42. package/dist/parser.cjs +48 -1
  43. package/dist/parser.cjs.map +1 -1
  44. package/dist/parser.d.cts +2 -0
  45. package/dist/parser.d.cts.map +1 -1
  46. package/dist/parser.d.ts +2 -0
  47. package/dist/parser.d.ts.map +1 -1
  48. package/dist/parser.js +48 -1
  49. package/dist/parser.js.map +1 -1
  50. package/dist/theme.cjs +8 -0
  51. package/dist/theme.cjs.map +1 -1
  52. package/dist/theme.d.cts +6 -0
  53. package/dist/theme.d.cts.map +1 -1
  54. package/dist/theme.d.ts +6 -0
  55. package/dist/theme.d.ts.map +1 -1
  56. package/dist/theme.js +8 -0
  57. package/dist/theme.js.map +1 -1
  58. package/dist/types.d.cts +27 -1
  59. package/dist/types.d.cts.map +1 -1
  60. package/dist/types.d.ts +27 -1
  61. package/dist/types.d.ts.map +1 -1
  62. package/dist/version.cjs +16 -0
  63. package/dist/version.cjs.map +1 -1
  64. package/dist/version.d.cts +4 -0
  65. package/dist/version.d.cts.map +1 -1
  66. package/dist/version.d.ts +4 -0
  67. package/dist/version.d.ts.map +1 -1
  68. package/dist/version.js +16 -0
  69. package/dist/version.js.map +1 -1
  70. package/package.json +3 -1
package/dist/version.js CHANGED
@@ -13,12 +13,16 @@ import { dirname, join } from 'node:path';
13
13
  /**
14
14
  * Normalize a repository URL to clean HTTPS format. Strips leading `git+` and
15
15
  * trailing `.git`.
16
+ *
17
+ * @function
16
18
  */
17
19
  const normalizeRepoUrl = (url) => {
18
20
  return url.replace(/^git\+/, '').replace(/\.git$/, '');
19
21
  };
20
22
  /**
21
23
  * Validate that a URL is HTTPS. Returns the URL if valid, undefined otherwise.
24
+ *
25
+ * @function
22
26
  */
23
27
  const validateHttpsUrl = (url) => {
24
28
  if (!url) {
@@ -29,6 +33,8 @@ const validateHttpsUrl = (url) => {
29
33
  /**
30
34
  * Extract repository URL from package.json repository field. Handles both
31
35
  * string and object forms.
36
+ *
37
+ * @function
32
38
  */
33
39
  const extractRepoUrl = (repository) => {
34
40
  if (!repository) {
@@ -43,6 +49,8 @@ const extractRepoUrl = (repository) => {
43
49
  };
44
50
  /**
45
51
  * Find package.json by walking up from startDir (async).
52
+ *
53
+ * @function
46
54
  */
47
55
  const findPackageJson = async (startDir) => {
48
56
  let dir = startDir;
@@ -62,6 +70,8 @@ const findPackageJson = async (startDir) => {
62
70
  };
63
71
  /**
64
72
  * Find package.json by walking up from startDir (sync).
73
+ *
74
+ * @function
65
75
  */
66
76
  const findPackageJsonSync = (startDir) => {
67
77
  let dir = startDir;
@@ -81,6 +91,8 @@ const findPackageJsonSync = (startDir) => {
81
91
  };
82
92
  /**
83
93
  * Read version from package.json (async).
94
+ *
95
+ * @function
84
96
  */
85
97
  const readVersionFromPackageJson = async (pkgPath) => {
86
98
  try {
@@ -94,6 +106,8 @@ const readVersionFromPackageJson = async (pkgPath) => {
94
106
  };
95
107
  /**
96
108
  * Detect version: use provided version or read from nearest package.json.
109
+ *
110
+ * @function
97
111
  */
98
112
  export const detectVersion = async (providedVersion, startDir = process.cwd()) => {
99
113
  if (providedVersion) {
@@ -108,6 +122,8 @@ export const detectVersion = async (providedVersion, startDir = process.cwd()) =
108
122
  /**
109
123
  * Read package info (homepage, repository) from package.json synchronously.
110
124
  * Returns only HTTPS URLs; other URL schemes are omitted.
125
+ *
126
+ * @function
111
127
  */
112
128
  export const readPackageInfoSync = (startDir = process.cwd()) => {
113
129
  const pkgPath = findPackageJsonSync(startDir);
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AA4B1C;;;GAGG;AACH,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAU,EAAE;IAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,gBAAgB,GAAG,CAAC,GAAuB,EAAsB,EAAE;IACvE,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;AACtD,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,cAAc,GAAG,CACrB,UAAgD,EAC5B,EAAE;IACtB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;IAC5E,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC5C,OAAO,gBAAgB,CAAC,UAAU,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,eAAe,GAAG,KAAK,EAC3B,QAAgB,EACa,EAAE;IAC/B,IAAI,GAAG,GAAG,QAAQ,CAAC;IACnB,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,OAAO,GAAG,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC1C,IAAI,CAAC;YACH,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACjC,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,GAAG,CAAC;YACd,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAsB,EAAE;IACnE,IAAI,GAAG,GAAG,QAAQ,CAAC;IACnB,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,OAAO,GAAG,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC1C,IAAI,CAAC;YACH,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,GAAG,CAAC;YACd,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,0BAA0B,GAAG,KAAK,EACtC,OAAe,EACc,EAAE;IAC/B,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAmB,CAAC;QAClD,OAAO,GAAG,CAAC,OAAO,CAAC;IACrB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,eAAmC,EACnC,WAAmB,OAAO,CAAC,GAAG,EAAE,EACH,EAAE;IAC/B,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,WAAmB,OAAO,CAAC,GAAG,EAAE,EACnB,EAAE;IACf,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAmB,CAAC;QAElD,OAAO;YACL,QAAQ,EAAE,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,UAAU,EAAE,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC;SAC3C,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC,CAAC"}
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AA4B1C;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAU,EAAE;IAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,CAAC,GAAuB,EAAsB,EAAE;IACvE,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;AACtD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,cAAc,GAAG,CACrB,UAAgD,EAC5B,EAAE;IACtB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;IAC5E,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC5C,OAAO,gBAAgB,CAAC,UAAU,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,eAAe,GAAG,KAAK,EAC3B,QAAgB,EACa,EAAE;IAC/B,IAAI,GAAG,GAAG,QAAQ,CAAC;IACnB,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,OAAO,GAAG,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC1C,IAAI,CAAC;YACH,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACjC,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,GAAG,CAAC;YACd,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAsB,EAAE;IACnE,IAAI,GAAG,GAAG,QAAQ,CAAC;IACnB,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,OAAO,GAAG,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC1C,IAAI,CAAC;YACH,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,GAAG,CAAC;YACd,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,0BAA0B,GAAG,KAAK,EACtC,OAAe,EACc,EAAE;IAC/B,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAmB,CAAC;QAClD,OAAO,GAAG,CAAC,OAAO,CAAC;IACrB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,eAAmC,EACnC,WAAmB,OAAO,CAAC,GAAG,EAAE,EACH,EAAE;IAC/B,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,WAAmB,OAAO,CAAC,GAAG,EAAE,EACnB,EAAE;IACf,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAmB,CAAC;QAElD,OAAO;YACL,QAAQ,EAAE,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,UAAU,EAAE,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC;SAC3C,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@boneskull/bargs",
3
- "version": "3.2.0",
3
+ "version": "3.3.0",
4
4
  "type": "module",
5
5
  "description": "A TypeScript-first CLI argument parser wrapping util.parseArgs() with full type inference",
6
6
  "repository": {
@@ -69,6 +69,8 @@
69
69
  "@stylistic/eslint-plugin": "5.6.1",
70
70
  "@types/node": "24.10.4",
71
71
  "@types/wallabyjs": "0.0.15",
72
+ "@typescript-eslint/typescript-estree": "8.52.0",
73
+ "@typescript-eslint/utils": "8.52.0",
72
74
  "bupkis": "0.14.0",
73
75
  "cspell": "9.4.0",
74
76
  "eslint": "9.39.2",