argue-cli 3.0.0 → 3.1.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.
package/README.md CHANGED
@@ -102,6 +102,23 @@ Reads the next argument and returns it. Throws an error if there are no argument
102
102
  const fileName = read() // 'sort-imports'
103
103
  ```
104
104
 
105
+ ### rest
106
+
107
+ ```ts
108
+ function rest(): string[]
109
+ ```
110
+
111
+ Reads all remaining arguments and returns them. Returns an empty array if there are none — unlike [`read`](#read), it never throws.
112
+
113
+ ```ts
114
+ // my-cli format a.js b.js c.js
115
+ expect('format')
116
+
117
+ const files = rest() // ['a.js', 'b.js', 'c.js']
118
+
119
+ end() // always passes after rest()
120
+ ```
121
+
105
122
  ### end
106
123
 
107
124
  ```ts
@@ -149,6 +166,22 @@ alias('install', 'i')
149
166
  alias('saveDev', 'save-dev', 'D')
150
167
  ```
151
168
 
169
+ ### autocase
170
+
171
+ ```ts
172
+ function autocase(argRef: ArgRef): ArgRef
173
+ ```
174
+
175
+ Describes an argument that matches both camelCase and kebab-case forms. The name can be given in either form — the twin form is added as an alias. Aliases longer than one character are autocased too. Use it anywhere an argument name is expected.
176
+
177
+ ```ts
178
+ autocase('firstRelease')
179
+ // --firstRelease and --first-release are both accepted
180
+
181
+ autocase(alias('save-dev', 'D'))
182
+ // --save-dev, --saveDev and -D
183
+ ```
184
+
152
185
  ### option
153
186
 
154
187
  ```ts
@@ -162,13 +195,29 @@ Describes an option with a value of the given type, to be read by [`readOptions`
162
195
  - `Boolean` — a flag without a value, `true` when present: `--verbose`
163
196
  - `Array` — splits the next argument by commas; repeated options are merged: `--plugins eslint,swc --plugins tsc` → `['eslint', 'swc', 'tsc']`
164
197
 
198
+ ### flag
199
+
200
+ ```ts
201
+ function flag(argRef: ArgRef): OptionReader
202
+ ```
203
+
204
+ Describes a boolean flag with `--no-*` negation support, to be read by [`readOptions`](#readoptions): `--verbose` sets `true`, `--no-verbose` sets `false`. Use `option(argRef, Boolean)` when negation is not wanted.
205
+
206
+ ```ts
207
+ const options = readOptions(
208
+ flag(autocase('firstRelease'))
209
+ )
210
+ // --first-release → { firstRelease: true }
211
+ // --no-first-release, --no-firstRelease → { firstRelease: false }
212
+ ```
213
+
165
214
  ### readOptions
166
215
 
167
216
  ```ts
168
217
  function readOptions(...optionReaders: OptionReader[]): OptionResult
169
218
  ```
170
219
 
171
- Scans the arguments and reads all described options. Both `--option` and `-o` prefixes are accepted. Arguments that don't match any described option are left untouched, so you can continue reading them afterwards.
220
+ Scans the arguments and reads all described options. Both `--option` and `-o` prefixes are accepted, and a value can be passed either as the next argument or inline: `--workspace packages/app` and `--workspace=packages/app` are equivalent. Arguments that don't match any described option are left untouched, so you can continue reading them afterwards.
172
221
 
173
222
  The result is a strongly typed object, where every property is optional — an option simply may not be passed:
174
223
 
package/dist/args.d.ts CHANGED
@@ -7,6 +7,13 @@ import type { AliasArgRef, ArgRef, PrimitiveConstructor, OptionsReaderState, Opt
7
7
  * @returns Description of argument with aliases..
8
8
  */
9
9
  export declare function alias<T extends string>(name: T, alias: string, ...restAliases: string[]): AliasArgRef<T>;
10
+ /**
11
+ * Describe argument that matches both camelCase and kebab-case forms.
12
+ * Name and every alias longer than one character get the twin form as an alias.
13
+ * @param argRef - Argument name in either form.
14
+ * @returns Description of argument with the twin forms as aliases.
15
+ */
16
+ export declare function autocase<T extends string>(argRef: ArgRef<T>): ArgRef<T>;
10
17
  /**
11
18
  * Describe option with value.
12
19
  * @param argRef - Option name.
@@ -14,4 +21,10 @@ export declare function alias<T extends string>(name: T, alias: string, ...restA
14
21
  * @returns Option reader.
15
22
  */
16
23
  export declare function option<T extends string, K extends PrimitiveConstructor>(argRef: ArgRef<T>, type: K): (option: string, read: OptionsReaderRead, options: OptionsReaderState) => OptionResult<T, K> | null;
24
+ /**
25
+ * Describe boolean flag with `--no-*` negation support.
26
+ * @param argRef - Flag name.
27
+ * @returns Option reader.
28
+ */
29
+ export declare function flag<T extends string>(argRef: ArgRef<T>): (option: string) => OptionResult<T, BooleanConstructor> | null;
17
30
  //# sourceMappingURL=args.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../src/args.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,MAAM,EACN,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACb,MAAM,YAAY,CAAA;AAGnB;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAKxG;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,oBAAoB,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,YA8B/E,MAAM,QAAQ,iBAAiB,WAAW,kBAAkB,+BA6B/E"}
1
+ {"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../src/args.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,MAAM,EACN,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACb,MAAM,YAAY,CAAA;AAGnB;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAKxG;AAUD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAuBvE;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,oBAAoB,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,YA8B/E,MAAM,QAAQ,iBAAiB,WAAW,kBAAkB,+BA6B/E;AAID;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,YACtC,MAAM,gDAiBvB"}
package/dist/core.d.ts CHANGED
@@ -5,6 +5,11 @@ import type { ArgRef } from './types.js';
5
5
  * @returns Next argument.
6
6
  */
7
7
  export declare function read(): string;
8
+ /**
9
+ * Read all remaining arguments.
10
+ * @returns Remaining arguments, empty array if none.
11
+ */
12
+ export declare function rest(): string[];
8
13
  /**
9
14
  * Expectation of the end.
10
15
  * Throws an error if there are more arguments left.
@@ -1 +1 @@
1
- {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIxC;;;;GAIG;AACH,wBAAgB,IAAI,WAQnB;AAED;;;GAGG;AACH,wBAAgB,GAAG,SAIlB;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KASpE"}
1
+ {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIxC;;;;GAIG;AACH,wBAAgB,IAAI,WAQnB;AAED;;;GAGG;AACH,wBAAgB,IAAI,aAEnB;AAED;;;GAGG;AACH,wBAAgB,GAAG,SAIlB;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KASpE"}
package/dist/index.js CHANGED
@@ -60,6 +60,13 @@ function read() {
60
60
  return value;
61
61
  }
62
62
  /**
63
+ * Read all remaining arguments.
64
+ * @returns Remaining arguments, empty array if none.
65
+ */
66
+ function rest() {
67
+ return argv.splice(0, argv.length);
68
+ }
69
+ /**
63
70
  * Expectation of the end.
64
71
  * Throws an error if there are more arguments left.
65
72
  */
@@ -92,6 +99,33 @@ function alias(name, alias, ...restAliases) {
92
99
  aliases: [alias, ...restAliases]
93
100
  };
94
101
  }
102
+ function caseTwin(name) {
103
+ return name.length > 1 ? name.includes("-") ? name.replace(/-+(.)/g, (_, char) => char.toUpperCase()) : name.replace(/[A-Z]/g, (char) => `-${char.toLowerCase()}`) : name;
104
+ }
105
+ /**
106
+ * Describe argument that matches both camelCase and kebab-case forms.
107
+ * Name and every alias longer than one character get the twin form as an alias.
108
+ * @param argRef - Argument name in either form.
109
+ * @returns Description of argument with the twin forms as aliases.
110
+ */
111
+ function autocase(argRef) {
112
+ let name;
113
+ let aliases;
114
+ if (typeof argRef === "string") {
115
+ name = argRef;
116
+ aliases = /* @__PURE__ */ new Set();
117
+ } else {
118
+ name = argRef.name;
119
+ aliases = new Set(argRef.aliases.concat(argRef.aliases.map(caseTwin)));
120
+ }
121
+ aliases.add(caseTwin(name));
122
+ aliases.delete(name);
123
+ if (!aliases.size) return argRef;
124
+ return {
125
+ name,
126
+ aliases: [...aliases]
127
+ };
128
+ }
95
129
  /**
96
130
  * Describe option with value.
97
131
  * @param argRef - Option name.
@@ -124,6 +158,24 @@ function option(argRef, type) {
124
158
  return null;
125
159
  };
126
160
  }
161
+ const NEGATION_PREFIX = "no-";
162
+ /**
163
+ * Describe boolean flag with `--no-*` negation support.
164
+ * @param argRef - Flag name.
165
+ * @returns Option reader.
166
+ */
167
+ function flag(argRef) {
168
+ return (option) => {
169
+ let value = true;
170
+ let argName = matchArgName(argRef, option);
171
+ if (!argName && option.startsWith(NEGATION_PREFIX)) {
172
+ value = false;
173
+ argName = matchArgName(argRef, option.slice(3));
174
+ }
175
+ if (argName) return { [argName]: value };
176
+ return null;
177
+ };
178
+ }
127
179
  //#endregion
128
180
  //#region src/options.ts
129
181
  function isOption(arg) {
@@ -132,6 +184,10 @@ function isOption(arg) {
132
184
  function removePrefix(arg) {
133
185
  return arg.replace(/^--?/, "");
134
186
  }
187
+ function splitOption(arg) {
188
+ const eqIndex = arg.indexOf("=");
189
+ return eqIndex === -1 ? [arg] : [arg.slice(0, eqIndex), arg.slice(eqIndex + 1)];
190
+ }
135
191
  function createOptionReader(optionReaders) {
136
192
  return optionReaders.reduceRight((readNextOption, readOption) => {
137
193
  if (!readNextOption) return readOption;
@@ -151,13 +207,20 @@ function readOptions(...optionReaders) {
151
207
  let i = 0;
152
208
  let arg = argv[i];
153
209
  let optionResult;
210
+ let optionEqValue;
154
211
  const next = () => {
155
212
  arg = argv[++i];
156
213
  };
157
214
  const remove = () => {
215
+ if (optionEqValue !== void 0) throw new Error(`Unexpected value for "${arg}"`);
158
216
  argv.splice(i--, 1);
159
217
  };
160
218
  const read = () => {
219
+ if (optionEqValue !== void 0) {
220
+ const value = optionEqValue;
221
+ optionEqValue = void 0;
222
+ return value;
223
+ }
161
224
  next();
162
225
  remove();
163
226
  if (!arg) throw new Error("Unexpected end of arguments");
@@ -165,6 +228,7 @@ function readOptions(...optionReaders) {
165
228
  };
166
229
  while (arg) {
167
230
  if (isOption(arg)) {
231
+ [arg, optionEqValue] = splitOption(arg);
168
232
  optionResult = readOption(removePrefix(arg), read, options);
169
233
  if (optionResult) {
170
234
  remove();
@@ -176,6 +240,6 @@ function readOptions(...optionReaders) {
176
240
  return options;
177
241
  }
178
242
  //#endregion
179
- export { alias, argv, end, expect, option, read, readOptions, resetArgs, setArgs };
243
+ export { alias, argv, autocase, end, expect, flag, option, read, readOptions, resetArgs, rest, setArgs };
180
244
 
181
245
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../src/argv.ts","../src/utils.ts","../src/core.ts","../src/args.ts","../src/options.ts"],"sourcesContent":["\nconst ARGV_START_INDEX = 2\n\n/**\n * Internal state of arguments.\n */\nexport const argv = process.argv.slice(ARGV_START_INDEX)\n\n/**\n * Reset arguments state.\n */\nexport function resetArgs() {\n argv.splice(0, argv.length)\n argv.push(...process.argv.slice(ARGV_START_INDEX))\n}\n\n/**\n * Set arguments state.\n * @param args\n */\nexport function setArgs(...args: string[]) {\n argv.splice(0, argv.length)\n argv.push(...args)\n}\n","\nimport type { ArgRef } from './types.js'\n\ntype FlatMerge<T> = T extends infer U ? { [K in keyof U]: U[K] } : never\n\nexport type Merge<T extends readonly [...unknown[]]> = T extends [infer L, ...infer R]\n ? FlatMerge<NonNullable<L> & Merge<R>>\n : unknown\n\nexport type UnionMerge<T extends readonly [...unknown[]]> = T extends [infer L, ...infer R]\n ? L | Merge<R>\n // oxlint-disable-next-line typescript/no-explicit-any\n : any\n\n// oxlint-disable-next-line typescript/no-explicit-any\ntype AnyFunction = (...args: any[]) => any\n\nexport type ReturnTypes<T extends readonly [...AnyFunction[]]> = T extends [infer L, ...infer R]\n ? L extends AnyFunction\n ? R extends AnyFunction[]\n ? [ReturnType<L>, ...ReturnTypes<R>]\n : []\n : []\n : []\n\n/**\n * Match reference with argument.\n * @param argRef\n * @param arg\n * @returns Full name or null.\n */\nexport function matchArgName<T extends string>(argRef: ArgRef<T>, arg: string) {\n if (typeof argRef === 'string') {\n return argRef === arg\n ? argRef\n : null\n }\n\n if (argRef.name === arg) {\n return argRef.name\n }\n\n return argRef.aliases.includes(arg)\n ? argRef.name\n : null\n}\n\n/**\n * Find full argument name in references.\n * @param argRefs\n * @param arg\n * @returns Found argument's full name or null.\n */\nexport function findArgName<T extends string>(argRefs: [...ArgRef<T>[]], arg: string) {\n let argRef: ArgRef<T>\n let argName: T | null\n\n for (argRef of argRefs) {\n argName = matchArgName(argRef, arg)\n\n if (argName) {\n return argName\n }\n }\n\n return null\n}\n","import type { ArgRef } from './types.js'\nimport { argv } from './argv.js'\nimport { findArgName } from './utils.js'\n\n/**\n * Read next argument.\n * Throws error if no next argument.\n * @returns Next argument.\n */\nexport function read() {\n const value = argv.shift()\n\n if (!value) {\n throw new Error('Unexpected end of arguments')\n }\n\n return value\n}\n\n/**\n * Expectation of the end.\n * Throws an error if there are more arguments left.\n */\nexport function end() {\n if (argv.length) {\n throw new Error(`Unexpected argument \"${argv[0]}\"`)\n }\n}\n\n/**\n * Expect one of the given arguments.\n * @param argRefs\n * @returns Expected full argument name.\n */\nexport function expect<T extends string>(...argRefs: [...ArgRef<T>[]]) {\n const arg = read()\n const argName = findArgName(argRefs, arg)\n\n if (!argName) {\n throw new Error(`Unexpected argument \"${arg}\"`)\n }\n\n return argName\n}\n","import type {\n AliasArgRef,\n ArgRef,\n PrimitiveConstructor,\n OptionsReaderState,\n OptionsReaderRead,\n OptionResult\n} from './types.js'\nimport { matchArgName } from './utils.js'\n\n/**\n * Describe argument with aliases.\n * @param name - Main name.\n * @param alias - Alias name.\n * @param restAliases - Rest aliases.\n * @returns Description of argument with aliases..\n */\nexport function alias<T extends string>(name: T, alias: string, ...restAliases: string[]): AliasArgRef<T> {\n return {\n name,\n aliases: [alias, ...restAliases]\n }\n}\n\n/**\n * Describe option with value.\n * @param argRef - Option name.\n * @param type - Value type.\n * @returns Option reader.\n */\nexport function option<T extends string, K extends PrimitiveConstructor>(argRef: ArgRef<T>, type: K) {\n if (type === String) {\n return (option: string, read: OptionsReaderRead) => {\n const argName = matchArgName(argRef, option)\n\n if (argName) {\n return {\n [argName]: read()\n } as OptionResult<T, K>\n }\n\n return null\n }\n }\n\n if (type === Number) {\n return (option: string, read: OptionsReaderRead) => {\n const argName = matchArgName(argRef, option)\n\n if (argName) {\n return {\n [argName]: parseFloat(read())\n } as OptionResult<T, K>\n }\n\n return null\n }\n }\n\n if (type === Array) {\n return (option: string, read: OptionsReaderRead, options: OptionsReaderState) => {\n const argName = matchArgName(argRef, option)\n\n if (argName) {\n const prevValues = options[argName]\n const values = read().split(',')\n\n return {\n [argName]: Array.isArray(prevValues)\n ? prevValues.concat(values)\n : values\n } as OptionResult<T, K>\n }\n\n return null\n }\n }\n\n return (option: string) => {\n const argName = matchArgName(argRef, option)\n\n if (argName) {\n return {\n [argName]: true\n } as OptionResult<T, K>\n }\n\n return null\n }\n}\n","import type {\n OptionReader,\n OptionResult\n} from './types.js'\nimport type {\n Merge,\n ReturnTypes,\n UnionMerge\n} from './utils.js'\nimport { argv } from './argv.js'\n\nfunction isOption(arg: string) {\n return /^--?[^-].*/.test(arg)\n}\n\nfunction removePrefix(arg: string) {\n return arg.replace(/^--?/, '')\n}\n\nfunction createOptionReader<T extends OptionReader[]>(optionReaders: [...T]) {\n const optionReader = optionReaders.reduceRight<OptionReader | null>(\n (readNextOption, readOption) => {\n if (!readNextOption) {\n return readOption\n }\n\n return (option, read, options) => readOption(option, read, options) ?? readNextOption(option, read, options)\n },\n null\n )\n\n return optionReader as OptionReader<UnionMerge<ReturnTypes<T>>> | null\n}\n\n/**\n * Read options from arguments.\n * @param optionReaders\n * @returns Options with values.\n */\nexport function readOptions<T extends OptionReader[]>(...optionReaders: [...T]): Partial<Merge<ReturnTypes<T>>> {\n if (!argv.length) {\n return {}\n }\n\n const readOption = createOptionReader(optionReaders)\n\n if (!readOption) {\n return {}\n }\n\n const options = {}\n let i = 0\n let arg = argv[i]\n let optionResult: OptionResult | null\n const next = () => {\n arg = argv[++i]\n }\n const remove = () => {\n argv.splice(i--, 1)\n }\n const read = () => {\n next()\n remove()\n\n if (!arg) {\n throw new Error('Unexpected end of arguments')\n }\n\n return arg\n }\n\n // oxlint-disable-next-line eslint/no-unmodified-loop-condition\n while (arg) {\n if (isOption(arg)) {\n optionResult = readOption(removePrefix(arg), read, options)\n\n if (optionResult) {\n remove()\n Object.assign(options, optionResult)\n }\n }\n\n next()\n }\n\n return options\n}\n"],"mappings":";AACA,MAAM,mBAAmB;;;;AAKzB,MAAa,OAAO,QAAQ,KAAK,MAAM,gBAAgB;;;;AAKvD,SAAgB,YAAY;CAC1B,KAAK,OAAO,GAAG,KAAK,MAAM;CAC1B,KAAK,KAAK,GAAG,QAAQ,KAAK,MAAM,gBAAgB,CAAC;AACnD;;;;;AAMA,SAAgB,QAAQ,GAAG,MAAgB;CACzC,KAAK,OAAO,GAAG,KAAK,MAAM;CAC1B,KAAK,KAAK,GAAG,IAAI;AACnB;;;;;;;;;ACQA,SAAgB,aAA+B,QAAmB,KAAa;CAC7E,IAAI,OAAO,WAAW,UACpB,OAAO,WAAW,MACd,SACA;CAGN,IAAI,OAAO,SAAS,KAClB,OAAO,OAAO;CAGhB,OAAO,OAAO,QAAQ,SAAS,GAAG,IAC9B,OAAO,OACP;AACN;;;;;;;AAQA,SAAgB,YAA8B,SAA2B,KAAa;CACpF,IAAI;CACJ,IAAI;CAEJ,KAAK,UAAU,SAAS;EACtB,UAAU,aAAa,QAAQ,GAAG;EAElC,IAAI,SACF,OAAO;CAEX;CAEA,OAAO;AACT;;;;;;;;ACzDA,SAAgB,OAAO;CACrB,MAAM,QAAQ,KAAK,MAAM;CAEzB,IAAI,CAAC,OACH,MAAM,IAAI,MAAM,6BAA6B;CAG/C,OAAO;AACT;;;;;AAMA,SAAgB,MAAM;CACpB,IAAI,KAAK,QACP,MAAM,IAAI,MAAM,wBAAwB,KAAK,GAAG,EAAE;AAEtD;;;;;;AAOA,SAAgB,OAAyB,GAAG,SAA2B;CACrE,MAAM,MAAM,KAAK;CACjB,MAAM,UAAU,YAAY,SAAS,GAAG;CAExC,IAAI,CAAC,SACH,MAAM,IAAI,MAAM,wBAAwB,IAAI,EAAE;CAGhD,OAAO;AACT;;;;;;;;;;AC1BA,SAAgB,MAAwB,MAAS,OAAe,GAAG,aAAuC;CACxG,OAAO;EACL;EACA,SAAS,CAAC,OAAO,GAAG,WAAW;CACjC;AACF;;;;;;;AAQA,SAAgB,OAAyD,QAAmB,MAAS;CACnG,IAAI,SAAS,QACX,QAAQ,QAAgB,SAA4B;EAClD,MAAM,UAAU,aAAa,QAAQ,MAAM;EAE3C,IAAI,SACF,OAAO,GACJ,UAAU,KAAK,EAClB;EAGF,OAAO;CACT;CAGF,IAAI,SAAS,QACX,QAAQ,QAAgB,SAA4B;EAClD,MAAM,UAAU,aAAa,QAAQ,MAAM;EAE3C,IAAI,SACF,OAAO,GACJ,UAAU,WAAW,KAAK,CAAC,EAC9B;EAGF,OAAO;CACT;CAGF,IAAI,SAAS,OACX,QAAQ,QAAgB,MAAyB,YAAgC;EAC/E,MAAM,UAAU,aAAa,QAAQ,MAAM;EAE3C,IAAI,SAAS;GACX,MAAM,aAAa,QAAQ;GAC3B,MAAM,SAAS,KAAK,CAAC,CAAC,MAAM,GAAG;GAE/B,OAAO,GACJ,UAAU,MAAM,QAAQ,UAAU,IAC/B,WAAW,OAAO,MAAM,IACxB,OACN;EACF;EAEA,OAAO;CACT;CAGF,QAAQ,WAAmB;EACzB,MAAM,UAAU,aAAa,QAAQ,MAAM;EAE3C,IAAI,SACF,OAAO,GACJ,UAAU,KACb;EAGF,OAAO;CACT;AACF;;;AC9EA,SAAS,SAAS,KAAa;CAC7B,OAAO,aAAa,KAAK,GAAG;AAC9B;AAEA,SAAS,aAAa,KAAa;CACjC,OAAO,IAAI,QAAQ,QAAQ,EAAE;AAC/B;AAEA,SAAS,mBAA6C,eAAuB;CAY3E,OAXqB,cAAc,aAChC,gBAAgB,eAAe;EAC9B,IAAI,CAAC,gBACH,OAAO;EAGT,QAAQ,QAAQ,MAAM,YAAY,WAAW,QAAQ,MAAM,OAAO,KAAK,eAAe,QAAQ,MAAM,OAAO;CAC7G,GACA,IAGK;AACT;;;;;;AAOA,SAAgB,YAAsC,GAAG,eAAuD;CAC9G,IAAI,CAAC,KAAK,QACR,OAAO,CAAC;CAGV,MAAM,aAAa,mBAAmB,aAAa;CAEnD,IAAI,CAAC,YACH,OAAO,CAAC;CAGV,MAAM,UAAU,CAAC;CACjB,IAAI,IAAI;CACR,IAAI,MAAM,KAAK;CACf,IAAI;CACJ,MAAM,aAAa;EACjB,MAAM,KAAK,EAAE;CACf;CACA,MAAM,eAAe;EACnB,KAAK,OAAO,KAAK,CAAC;CACpB;CACA,MAAM,aAAa;EACjB,KAAK;EACL,OAAO;EAEP,IAAI,CAAC,KACH,MAAM,IAAI,MAAM,6BAA6B;EAG/C,OAAO;CACT;CAGA,OAAO,KAAK;EACV,IAAI,SAAS,GAAG,GAAG;GACjB,eAAe,WAAW,aAAa,GAAG,GAAG,MAAM,OAAO;GAE1D,IAAI,cAAc;IAChB,OAAO;IACP,OAAO,OAAO,SAAS,YAAY;GACrC;EACF;EAEA,KAAK;CACP;CAEA,OAAO;AACT"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../src/argv.ts","../src/utils.ts","../src/core.ts","../src/args.ts","../src/options.ts"],"sourcesContent":["\nconst ARGV_START_INDEX = 2\n\n/**\n * Internal state of arguments.\n */\nexport const argv = process.argv.slice(ARGV_START_INDEX)\n\n/**\n * Reset arguments state.\n */\nexport function resetArgs() {\n argv.splice(0, argv.length)\n argv.push(...process.argv.slice(ARGV_START_INDEX))\n}\n\n/**\n * Set arguments state.\n * @param args\n */\nexport function setArgs(...args: string[]) {\n argv.splice(0, argv.length)\n argv.push(...args)\n}\n","\nimport type { ArgRef } from './types.js'\n\ntype FlatMerge<T> = T extends infer U ? { [K in keyof U]: U[K] } : never\n\nexport type Merge<T extends readonly [...unknown[]]> = T extends [infer L, ...infer R]\n ? FlatMerge<NonNullable<L> & Merge<R>>\n : unknown\n\nexport type UnionMerge<T extends readonly [...unknown[]]> = T extends [infer L, ...infer R]\n ? L | Merge<R>\n // oxlint-disable-next-line typescript/no-explicit-any\n : any\n\n// oxlint-disable-next-line typescript/no-explicit-any\ntype AnyFunction = (...args: any[]) => any\n\nexport type ReturnTypes<T extends readonly [...AnyFunction[]]> = T extends [infer L, ...infer R]\n ? L extends AnyFunction\n ? R extends AnyFunction[]\n ? [ReturnType<L>, ...ReturnTypes<R>]\n : []\n : []\n : []\n\n/**\n * Match reference with argument.\n * @param argRef\n * @param arg\n * @returns Full name or null.\n */\nexport function matchArgName<T extends string>(argRef: ArgRef<T>, arg: string) {\n if (typeof argRef === 'string') {\n return argRef === arg\n ? argRef\n : null\n }\n\n if (argRef.name === arg) {\n return argRef.name\n }\n\n return argRef.aliases.includes(arg)\n ? argRef.name\n : null\n}\n\n/**\n * Find full argument name in references.\n * @param argRefs\n * @param arg\n * @returns Found argument's full name or null.\n */\nexport function findArgName<T extends string>(argRefs: [...ArgRef<T>[]], arg: string) {\n let argRef: ArgRef<T>\n let argName: T | null\n\n for (argRef of argRefs) {\n argName = matchArgName(argRef, arg)\n\n if (argName) {\n return argName\n }\n }\n\n return null\n}\n","import type { ArgRef } from './types.js'\nimport { argv } from './argv.js'\nimport { findArgName } from './utils.js'\n\n/**\n * Read next argument.\n * Throws error if no next argument.\n * @returns Next argument.\n */\nexport function read() {\n const value = argv.shift()\n\n if (!value) {\n throw new Error('Unexpected end of arguments')\n }\n\n return value\n}\n\n/**\n * Read all remaining arguments.\n * @returns Remaining arguments, empty array if none.\n */\nexport function rest() {\n return argv.splice(0, argv.length)\n}\n\n/**\n * Expectation of the end.\n * Throws an error if there are more arguments left.\n */\nexport function end() {\n if (argv.length) {\n throw new Error(`Unexpected argument \"${argv[0]}\"`)\n }\n}\n\n/**\n * Expect one of the given arguments.\n * @param argRefs\n * @returns Expected full argument name.\n */\nexport function expect<T extends string>(...argRefs: [...ArgRef<T>[]]) {\n const arg = read()\n const argName = findArgName(argRefs, arg)\n\n if (!argName) {\n throw new Error(`Unexpected argument \"${arg}\"`)\n }\n\n return argName\n}\n","import type {\n AliasArgRef,\n ArgRef,\n PrimitiveConstructor,\n OptionsReaderState,\n OptionsReaderRead,\n OptionResult\n} from './types.js'\nimport { matchArgName } from './utils.js'\n\n/**\n * Describe argument with aliases.\n * @param name - Main name.\n * @param alias - Alias name.\n * @param restAliases - Rest aliases.\n * @returns Description of argument with aliases..\n */\nexport function alias<T extends string>(name: T, alias: string, ...restAliases: string[]): AliasArgRef<T> {\n return {\n name,\n aliases: [alias, ...restAliases]\n }\n}\n\nfunction caseTwin(name: string) {\n return name.length > 1\n ? name.includes('-')\n ? name.replace(/-+(.)/g, (_, char: string) => char.toUpperCase())\n : name.replace(/[A-Z]/g, char => `-${char.toLowerCase()}`)\n : name\n}\n\n/**\n * Describe argument that matches both camelCase and kebab-case forms.\n * Name and every alias longer than one character get the twin form as an alias.\n * @param argRef - Argument name in either form.\n * @returns Description of argument with the twin forms as aliases.\n */\nexport function autocase<T extends string>(argRef: ArgRef<T>): ArgRef<T> {\n let name\n let aliases\n\n if (typeof argRef === 'string') {\n name = argRef\n aliases = new Set<string>()\n } else {\n name = argRef.name\n aliases = new Set(argRef.aliases.concat(argRef.aliases.map(caseTwin)))\n }\n\n aliases.add(caseTwin(name))\n aliases.delete(name)\n\n if (!aliases.size) {\n return argRef\n }\n\n return {\n name,\n aliases: [...aliases]\n }\n}\n\n/**\n * Describe option with value.\n * @param argRef - Option name.\n * @param type - Value type.\n * @returns Option reader.\n */\nexport function option<T extends string, K extends PrimitiveConstructor>(argRef: ArgRef<T>, type: K) {\n if (type === String) {\n return (option: string, read: OptionsReaderRead) => {\n const argName = matchArgName(argRef, option)\n\n if (argName) {\n return {\n [argName]: read()\n } as OptionResult<T, K>\n }\n\n return null\n }\n }\n\n if (type === Number) {\n return (option: string, read: OptionsReaderRead) => {\n const argName = matchArgName(argRef, option)\n\n if (argName) {\n return {\n [argName]: parseFloat(read())\n } as OptionResult<T, K>\n }\n\n return null\n }\n }\n\n if (type === Array) {\n return (option: string, read: OptionsReaderRead, options: OptionsReaderState) => {\n const argName = matchArgName(argRef, option)\n\n if (argName) {\n const prevValues = options[argName]\n const values = read().split(',')\n\n return {\n [argName]: Array.isArray(prevValues)\n ? prevValues.concat(values)\n : values\n } as OptionResult<T, K>\n }\n\n return null\n }\n }\n\n return (option: string) => {\n const argName = matchArgName(argRef, option)\n\n if (argName) {\n return {\n [argName]: true\n } as OptionResult<T, K>\n }\n\n return null\n }\n}\n\nconst NEGATION_PREFIX = 'no-'\n\n/**\n * Describe boolean flag with `--no-*` negation support.\n * @param argRef - Flag name.\n * @returns Option reader.\n */\nexport function flag<T extends string>(argRef: ArgRef<T>) {\n return (option: string) => {\n let value = true\n let argName = matchArgName(argRef, option)\n\n if (!argName && option.startsWith(NEGATION_PREFIX)) {\n value = false\n argName = matchArgName(argRef, option.slice(NEGATION_PREFIX.length))\n }\n\n if (argName) {\n return {\n [argName]: value\n } as OptionResult<T, BooleanConstructor>\n }\n\n return null\n }\n}\n","import type {\n OptionReader,\n OptionResult\n} from './types.js'\nimport type {\n Merge,\n ReturnTypes,\n UnionMerge\n} from './utils.js'\nimport { argv } from './argv.js'\n\nfunction isOption(arg: string) {\n return /^--?[^-].*/.test(arg)\n}\n\nfunction removePrefix(arg: string) {\n return arg.replace(/^--?/, '')\n}\n\nfunction splitOption(arg: string): [name: string, value?: string] {\n const eqIndex = arg.indexOf('=')\n\n return eqIndex === -1\n ? [arg]\n : [arg.slice(0, eqIndex), arg.slice(eqIndex + 1)]\n}\n\nfunction createOptionReader<T extends OptionReader[]>(optionReaders: [...T]) {\n const optionReader = optionReaders.reduceRight<OptionReader | null>(\n (readNextOption, readOption) => {\n if (!readNextOption) {\n return readOption\n }\n\n return (option, read, options) => readOption(option, read, options) ?? readNextOption(option, read, options)\n },\n null\n )\n\n return optionReader as OptionReader<UnionMerge<ReturnTypes<T>>> | null\n}\n\n/**\n * Read options from arguments.\n * @param optionReaders\n * @returns Options with values.\n */\nexport function readOptions<T extends OptionReader[]>(...optionReaders: [...T]): Partial<Merge<ReturnTypes<T>>> {\n if (!argv.length) {\n return {}\n }\n\n const readOption = createOptionReader(optionReaders)\n\n if (!readOption) {\n return {}\n }\n\n const options = {}\n let i = 0\n let arg = argv[i]\n let optionResult: OptionResult | null\n let optionEqValue: string | undefined\n const next = () => {\n arg = argv[++i]\n }\n const remove = () => {\n if (optionEqValue !== undefined) {\n throw new Error(`Unexpected value for \"${arg}\"`)\n }\n\n argv.splice(i--, 1)\n }\n const read = () => {\n if (optionEqValue !== undefined) {\n const value = optionEqValue\n\n optionEqValue = undefined\n\n return value\n }\n\n next()\n remove()\n\n if (!arg) {\n throw new Error('Unexpected end of arguments')\n }\n\n return arg\n }\n\n // oxlint-disable-next-line eslint/no-unmodified-loop-condition\n while (arg) {\n if (isOption(arg)) {\n [arg, optionEqValue] = splitOption(arg)\n optionResult = readOption(removePrefix(arg), read, options)\n\n if (optionResult) {\n remove()\n Object.assign(options, optionResult)\n }\n }\n\n next()\n }\n\n return options\n}\n"],"mappings":";AACA,MAAM,mBAAmB;;;;AAKzB,MAAa,OAAO,QAAQ,KAAK,MAAM,gBAAgB;;;;AAKvD,SAAgB,YAAY;CAC1B,KAAK,OAAO,GAAG,KAAK,MAAM;CAC1B,KAAK,KAAK,GAAG,QAAQ,KAAK,MAAM,gBAAgB,CAAC;AACnD;;;;;AAMA,SAAgB,QAAQ,GAAG,MAAgB;CACzC,KAAK,OAAO,GAAG,KAAK,MAAM;CAC1B,KAAK,KAAK,GAAG,IAAI;AACnB;;;;;;;;;ACQA,SAAgB,aAA+B,QAAmB,KAAa;CAC7E,IAAI,OAAO,WAAW,UACpB,OAAO,WAAW,MACd,SACA;CAGN,IAAI,OAAO,SAAS,KAClB,OAAO,OAAO;CAGhB,OAAO,OAAO,QAAQ,SAAS,GAAG,IAC9B,OAAO,OACP;AACN;;;;;;;AAQA,SAAgB,YAA8B,SAA2B,KAAa;CACpF,IAAI;CACJ,IAAI;CAEJ,KAAK,UAAU,SAAS;EACtB,UAAU,aAAa,QAAQ,GAAG;EAElC,IAAI,SACF,OAAO;CAEX;CAEA,OAAO;AACT;;;;;;;;ACzDA,SAAgB,OAAO;CACrB,MAAM,QAAQ,KAAK,MAAM;CAEzB,IAAI,CAAC,OACH,MAAM,IAAI,MAAM,6BAA6B;CAG/C,OAAO;AACT;;;;;AAMA,SAAgB,OAAO;CACrB,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM;AACnC;;;;;AAMA,SAAgB,MAAM;CACpB,IAAI,KAAK,QACP,MAAM,IAAI,MAAM,wBAAwB,KAAK,GAAG,EAAE;AAEtD;;;;;;AAOA,SAAgB,OAAyB,GAAG,SAA2B;CACrE,MAAM,MAAM,KAAK;CACjB,MAAM,UAAU,YAAY,SAAS,GAAG;CAExC,IAAI,CAAC,SACH,MAAM,IAAI,MAAM,wBAAwB,IAAI,EAAE;CAGhD,OAAO;AACT;;;;;;;;;;AClCA,SAAgB,MAAwB,MAAS,OAAe,GAAG,aAAuC;CACxG,OAAO;EACL;EACA,SAAS,CAAC,OAAO,GAAG,WAAW;CACjC;AACF;AAEA,SAAS,SAAS,MAAc;CAC9B,OAAO,KAAK,SAAS,IACjB,KAAK,SAAS,GAAG,IACf,KAAK,QAAQ,WAAW,GAAG,SAAiB,KAAK,YAAY,CAAC,IAC9D,KAAK,QAAQ,WAAU,SAAQ,IAAI,KAAK,YAAY,GAAG,IACzD;AACN;;;;;;;AAQA,SAAgB,SAA2B,QAA8B;CACvE,IAAI;CACJ,IAAI;CAEJ,IAAI,OAAO,WAAW,UAAU;EAC9B,OAAO;EACP,0BAAU,IAAI,IAAY;CAC5B,OAAO;EACL,OAAO,OAAO;EACd,UAAU,IAAI,IAAI,OAAO,QAAQ,OAAO,OAAO,QAAQ,IAAI,QAAQ,CAAC,CAAC;CACvE;CAEA,QAAQ,IAAI,SAAS,IAAI,CAAC;CAC1B,QAAQ,OAAO,IAAI;CAEnB,IAAI,CAAC,QAAQ,MACX,OAAO;CAGT,OAAO;EACL;EACA,SAAS,CAAC,GAAG,OAAO;CACtB;AACF;;;;;;;AAQA,SAAgB,OAAyD,QAAmB,MAAS;CACnG,IAAI,SAAS,QACX,QAAQ,QAAgB,SAA4B;EAClD,MAAM,UAAU,aAAa,QAAQ,MAAM;EAE3C,IAAI,SACF,OAAO,GACJ,UAAU,KAAK,EAClB;EAGF,OAAO;CACT;CAGF,IAAI,SAAS,QACX,QAAQ,QAAgB,SAA4B;EAClD,MAAM,UAAU,aAAa,QAAQ,MAAM;EAE3C,IAAI,SACF,OAAO,GACJ,UAAU,WAAW,KAAK,CAAC,EAC9B;EAGF,OAAO;CACT;CAGF,IAAI,SAAS,OACX,QAAQ,QAAgB,MAAyB,YAAgC;EAC/E,MAAM,UAAU,aAAa,QAAQ,MAAM;EAE3C,IAAI,SAAS;GACX,MAAM,aAAa,QAAQ;GAC3B,MAAM,SAAS,KAAK,CAAC,CAAC,MAAM,GAAG;GAE/B,OAAO,GACJ,UAAU,MAAM,QAAQ,UAAU,IAC/B,WAAW,OAAO,MAAM,IACxB,OACN;EACF;EAEA,OAAO;CACT;CAGF,QAAQ,WAAmB;EACzB,MAAM,UAAU,aAAa,QAAQ,MAAM;EAE3C,IAAI,SACF,OAAO,GACJ,UAAU,KACb;EAGF,OAAO;CACT;AACF;AAEA,MAAM,kBAAkB;;;;;;AAOxB,SAAgB,KAAuB,QAAmB;CACxD,QAAQ,WAAmB;EACzB,IAAI,QAAQ;EACZ,IAAI,UAAU,aAAa,QAAQ,MAAM;EAEzC,IAAI,CAAC,WAAW,OAAO,WAAW,eAAe,GAAG;GAClD,QAAQ;GACR,UAAU,aAAa,QAAQ,OAAO,MAAM,CAAsB,CAAC;EACrE;EAEA,IAAI,SACF,OAAO,GACJ,UAAU,MACb;EAGF,OAAO;CACT;AACF;;;AChJA,SAAS,SAAS,KAAa;CAC7B,OAAO,aAAa,KAAK,GAAG;AAC9B;AAEA,SAAS,aAAa,KAAa;CACjC,OAAO,IAAI,QAAQ,QAAQ,EAAE;AAC/B;AAEA,SAAS,YAAY,KAA6C;CAChE,MAAM,UAAU,IAAI,QAAQ,GAAG;CAE/B,OAAO,YAAY,KACf,CAAC,GAAG,IACJ,CAAC,IAAI,MAAM,GAAG,OAAO,GAAG,IAAI,MAAM,UAAU,CAAC,CAAC;AACpD;AAEA,SAAS,mBAA6C,eAAuB;CAY3E,OAXqB,cAAc,aAChC,gBAAgB,eAAe;EAC9B,IAAI,CAAC,gBACH,OAAO;EAGT,QAAQ,QAAQ,MAAM,YAAY,WAAW,QAAQ,MAAM,OAAO,KAAK,eAAe,QAAQ,MAAM,OAAO;CAC7G,GACA,IAGK;AACT;;;;;;AAOA,SAAgB,YAAsC,GAAG,eAAuD;CAC9G,IAAI,CAAC,KAAK,QACR,OAAO,CAAC;CAGV,MAAM,aAAa,mBAAmB,aAAa;CAEnD,IAAI,CAAC,YACH,OAAO,CAAC;CAGV,MAAM,UAAU,CAAC;CACjB,IAAI,IAAI;CACR,IAAI,MAAM,KAAK;CACf,IAAI;CACJ,IAAI;CACJ,MAAM,aAAa;EACjB,MAAM,KAAK,EAAE;CACf;CACA,MAAM,eAAe;EACnB,IAAI,kBAAkB,KAAA,GACpB,MAAM,IAAI,MAAM,yBAAyB,IAAI,EAAE;EAGjD,KAAK,OAAO,KAAK,CAAC;CACpB;CACA,MAAM,aAAa;EACjB,IAAI,kBAAkB,KAAA,GAAW;GAC/B,MAAM,QAAQ;GAEd,gBAAgB,KAAA;GAEhB,OAAO;EACT;EAEA,KAAK;EACL,OAAO;EAEP,IAAI,CAAC,KACH,MAAM,IAAI,MAAM,6BAA6B;EAG/C,OAAO;CACT;CAGA,OAAO,KAAK;EACV,IAAI,SAAS,GAAG,GAAG;GACjB,CAAC,KAAK,iBAAiB,YAAY,GAAG;GACtC,eAAe,WAAW,aAAa,GAAG,GAAG,MAAM,OAAO;GAE1D,IAAI,cAAc;IAChB,OAAO;IACP,OAAO,OAAO,SAAS,YAAY;GACrC;EACF;EAEA,KAAK;CACP;CAEA,OAAO;AACT"}
@@ -1 +1 @@
1
- {"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAEb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EAEZ,MAAM,YAAY,CAAA;AA0BnB;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,EAAE,GAAG,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CA+C9G"}
1
+ {"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAEb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EAEZ,MAAM,YAAY,CAAA;AAkCnB;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,EAAE,GAAG,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CA6D9G"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "argue-cli",
3
3
  "type": "module",
4
- "version": "3.0.0",
4
+ "version": "3.1.0",
5
5
  "description": "A thin and strongly typed CLI arguments parser for Node.js.",
6
6
  "author": "dangreen",
7
7
  "license": "MIT",
@@ -21,7 +21,7 @@
21
21
  "terminal"
22
22
  ],
23
23
  "engines": {
24
- "node": ">=24"
24
+ "node": ">=22"
25
25
  },
26
26
  "types": "./dist/index.d.ts",
27
27
  "exports": {