args-tokens 0.9.0 → 0.10.0

package/README.md

@@ -9,11 +9,12 @@
 
 ## ✨ Features
 
-- ✅ High performance parser and resolver
+- ✅ High performance
 - ✅ `util.parseArgs` token compatibility
-- ✅ Type safe argument values
-- ✅ ES Modules distribution library
-- ✅ Support multi runtime: Browser, Node.js, Deno, Bun
+- ✅ ES Modules and modern JavaScript
+- ✅ Type safe
+- ✅ Zero dependencies
+- ✅ Universal runtime
 
 ## 🐱 Motivation
 

package/lib/parse.d.ts

@@ -21,6 +21,10 @@ export type ParsedArgs<T extends ArgOptions> = {
      * Positional arguments, same as `positionals` in {@link resolveArgs}
      */
     positionals: string[];
+    /**
+     * Validation errors, same as `errors` in {@link resolveArgs}
+     */
+    error: AggregateError | undefined;
 };
 /**
  * Parse command line arguments
@@ -35,7 +39,6 @@ export type ParsedArgs<T extends ArgOptions> = {
  * ```
  * @param args - command line arguments
  * @param options - parse options, about details see {@link ParseOptions}
- * @throws if command line arguments are invalid, this function will cause {@link AggregateError | validation errors}.
- * @returns parsed values
+ * @returns An object that contains the values of the arguments, positional arguments, and {@link AggregateError | validation errors}.
  */
 export declare function parse<O extends ArgOptions>(args: string[], options?: ParseOptions<O>): ParsedArgs<O>;

package/lib/parse.js

@@ -25,8 +25,7 @@ const DEFAULT_OPTIONS = {
  * ```
  * @param args - command line arguments
  * @param options - parse options, about details see {@link ParseOptions}
- * @throws if command line arguments are invalid, this function will cause {@link AggregateError | validation errors}.
- * @returns parsed values
+ * @returns An object that contains the values of the arguments, positional arguments, and {@link AggregateError | validation errors}.
  */
 export function parse(args, options = {}) {
     const { options: argOptions, allowCompatible = false } = options;

package/lib/resolver.d.ts

@@ -47,11 +47,11 @@ type FilterArgs<O extends ArgOptions, V extends Record<keyof O, unknown>, K exte
  * Resolve command line arguments
  * @param options - An options that contains {@link ArgOptionSchema | options schema}.
  * @param tokens - An array of {@link ArgToken | tokens}.
- * @throws if command line arguments are invalid, this function will cause {@link AggregateError | validation errors}.
- * @returns An object that contains the values of the arguments and positional arguments.
+ * @returns An object that contains the values of the arguments, positional arguments, and {@link AggregateError | validation errors}.
  */
 export declare function resolveArgs<T extends ArgOptions>(options: T, tokens: ArgToken[]): {
     values: ArgValues<T>;
     positionals: string[];
+    error: AggregateError | undefined;
 };
 export {};

package/lib/resolver.js

@@ -5,8 +5,7 @@ import { hasLongOptionPrefix, isShortOption } from './parser.js';
  * Resolve command line arguments
  * @param options - An options that contains {@link ArgOptionSchema | options schema}.
  * @param tokens - An array of {@link ArgToken | tokens}.
- * @throws if command line arguments are invalid, this function will cause {@link AggregateError | validation errors}.
- * @returns An object that contains the values of the arguments and positional arguments.
+ * @returns An object that contains the values of the arguments, positional arguments, and {@link AggregateError | validation errors}.
  */
 export function resolveArgs(options, tokens) {
     const values = {};
@@ -182,11 +181,8 @@ export function resolveArgs(options, tokens) {
             values[option] = schema.default;
         }
     }
-    if (errors.length > 0) {
-        // eslint-disable-next-line unicorn/error-message
-        throw new AggregateError(errors);
-    }
-    return { values, positionals };
+    // eslint-disable-next-line unicorn/error-message
+    return { values, positionals, error: errors.length > 0 ? new AggregateError(errors) : undefined };
 }
 function createRequireError(option, schema) {
     return new Error(`Option '--${option}' ${schema.short ? `or '-${schema.short}'` : ''} is required`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "args-tokens",
   "description": "parseArgs tokens compatibility and more high-performance parser",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"