args-tokens 0.13.2 → 0.13.4

package/lib/index.d.ts

@@ -4,34 +4,34 @@ import { ArgOptions, ArgValues } from './resolver.js';
 export { ArgOptionSchema, OptionResolveError, resolveArgs } from './resolver.js';
 
 /**
-* Parse options for {@link parse} function
+* Parse options for {@link parse} function.
 */
 interface ParseOptions<O extends ArgOptions> extends ParserOptions {
 	/**
-	* Command line options, about details see {@link ArgOptions}
+	* Command line options, about details see {@link ArgOptions}.
 	*/
 	options?: O;
 }
 /**
-* Parsed command line arguments
+* Parsed command line arguments.
 */
 type ParsedArgs<T extends ArgOptions> = {
 	/**
-	* Parsed values, same as `values` in {@link resolveArgs}
+	* Parsed values, same as `values` in {@link resolveArgs}.
 	*/
 	values: ArgValues<T>
 	/**
-	* Positional arguments, same as `positionals` in {@link resolveArgs}
+	* Positional arguments, same as `positionals` in {@link resolveArgs}.
 	*/
 	positionals: string[]
 	/**
-	* Validation errors, same as `errors` in {@link resolveArgs}
+	* Validation errors, same as `errors` in {@link resolveArgs}.
 	*/
 	error: AggregateError | undefined
 };
 /**
-* Parse command line arguments
-* @description This function is a convenient API, that is used {@link parseArgs} and {@link resolveArgs} in internal.
+* Parse command line arguments.
+* This function is a convenient API, that is used {@link parseArgs} and {@link resolveArgs} in internal.
 * @example
 * ```js
 * import { parse } from 'args-tokens'

package/lib/index.js

@@ -1,5 +1,5 @@
-import { parseArgs } from "./parser-DYj8MxIm.js";
-import { OptionResolveError, resolveArgs } from "./resolver-DcIzyGlA.js";
+import { parseArgs } from "./parser-DxH6Mf-o.js";
+import { OptionResolveError, resolveArgs } from "./resolver-Di82Qgwx.js";
 
 //#region src/parse.ts
 const DEFAULT_OPTIONS = {

package/lib/{parser-DYj8MxIm.js → parser-DxH6Mf-o.js}

@@ -124,9 +124,9 @@ function isShortOption(arg) {
 	return arg.length === 2 && arg.codePointAt(0) === HYPHEN_CODE && arg.codePointAt(1) !== HYPHEN_CODE;
 }
 /**
-* Check if `arg` is a short option group (e.g. `-abc`)
+* Check if `arg` is a short option group (e.g. `-abc`).
 * @param arg the argument to check
-* @returns whether `arg` is a short option group
+* @returns whether `arg` is a short option group.
 */
 function isShortOptionGroup(arg) {
 	if (arg.length <= 2) return false;
@@ -135,17 +135,17 @@ function isShortOptionGroup(arg) {
 	return true;
 }
 /**
-* Check if `arg` is a long option (e.g. `--foo`)
+* Check if `arg` is a long option (e.g. `--foo`).
 * @param arg the argument to check
-* @returns whether `arg` is a long option
+* @returns whether `arg` is a long option.
 */
 function isLongOption(arg) {
 	return hasLongOptionPrefix(arg) && !arg.includes(EQUAL_CHAR, 3);
 }
 /**
-* Check if `arg` is a long option with value (e.g. `--foo=bar`)
+* Check if `arg` is a long option with value (e.g. `--foo=bar`).
 * @param arg the argument to check
-* @returns whether `arg` is a long option
+* @returns whether `arg` is a long option.
 */
 function isLongOptionAndValue(arg) {
 	return hasLongOptionPrefix(arg) && arg.includes(EQUAL_CHAR, 3);
@@ -154,9 +154,9 @@ function hasLongOptionPrefix(arg) {
 	return arg.length > 2 && ~arg.indexOf(LONG_OPTION_PREFIX);
 }
 /**
-* Check if a `value` is an option value
+* Check if a `value` is an option value.
 * @param value a value to check
-* @returns whether a `value` is an option value
+* @returns whether a `value` is an option value.
 */
 function hasOptionValue(value) {
 	return !(value == null) && value.codePointAt(0) !== HYPHEN_CODE;

package/lib/parser.d.ts

@@ -1,28 +1,32 @@
 /**
-* Argument token Kind
+* Entry point of argument parser.
+* @module
+*/
+/**
+* Argument token Kind.
 * - `option`: option token, support short option (e.g. `-x`) and long option (e.g. `--foo`)
 * - `option-terminator`: option terminator (`--`) token, see guideline 10 in https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html
 * - `positional`: positional token
 */
 type ArgTokenKind = "option" | "option-terminator" | "positional";
 /**
-* Argument token
+* Argument token.
 */
 interface ArgToken {
 	/**
-	* Argument token kind
+	* Argument token kind.
 	*/
 	kind: ArgTokenKind;
 	/**
-	* Argument token index, e.g `--foo bar` => `--foo` index is 0, `bar` index is 1
+	* Argument token index, e.g `--foo bar` => `--foo` index is 0, `bar` index is 1.
 	*/
 	index: number;
 	/**
-	* Option name, e.g. `--foo` => `foo`, `-x` => `x`
+	* Option name, e.g. `--foo` => `foo`, `-x` => `x`.
 	*/
 	name?: string;
 	/**
-	* Raw option name, e.g. `--foo` => `--foo`, `-x` => `-x`
+	* Raw option name, e.g. `--foo` => `--foo`, `-x` => `-x`.
 	*/
 	rawName?: string;
 	/**
@@ -36,17 +40,17 @@ interface ArgToken {
 	inlineValue?: boolean;
 }
 /**
-* Parser Options
+* Parser Options.
 */
 interface ParserOptions {
 	/**
-	* [Node.js parseArgs](https://nodejs.org/api/util.html#parseargs-tokens) tokens compatible mode
+	* [Node.js parseArgs](https://nodejs.org/api/util.html#parseargs-tokens) tokens compatible mode.
 	* @default false
 	*/
 	allowCompatible?: boolean;
 }
 /**
-* Parse command line arguments
+* Parse command line arguments.
 * @example
 * ```js
 * import { parseArgs } from 'args-tokens' // for Node.js and Bun
@@ -59,19 +63,19 @@ interface ParserOptions {
 * ```
 * @param args command line arguments
 * @param options parse options
-* @returns argument tokens
+* @returns Argument tokens.
 */
 declare function parseArgs(args: string[], options?: ParserOptions): ArgToken[];
 /**
-* Check if `arg` is a short option (e.g. `-f`)
+* Check if `arg` is a short option (e.g. `-f`).
 * @param arg the argument to check
-* @returns whether `arg` is a short option
+* @returns whether `arg` is a short option.
 */
 declare function isShortOption(arg: string): boolean;
 /**
-* Check if `arg` is a long option prefix (e.g. `--`)
+* Check if `arg` is a long option prefix (e.g. `--`).
 * @param arg the argument to check
-* @returns whether `arg` is a long option prefix
+* @returns whether `arg` is a long option prefix.
 */
 declare function hasLongOptionPrefix(arg: string): boolean;
 

package/lib/parser.js

@@ -1,3 +1,3 @@
-import { hasLongOptionPrefix, isShortOption, parseArgs } from "./parser-DYj8MxIm.js";
+import { hasLongOptionPrefix, isShortOption, parseArgs } from "./parser-DxH6Mf-o.js";
 
 export { hasLongOptionPrefix, isShortOption, parseArgs };

package/lib/{resolver-DcIzyGlA.js → resolver-Di82Qgwx.js}

@@ -1,4 +1,4 @@
-import { hasLongOptionPrefix, isShortOption } from "./parser-DYj8MxIm.js";
+import { hasLongOptionPrefix, isShortOption } from "./parser-DxH6Mf-o.js";
 
 //#region src/resolver.ts
 function resolveArgs(options, tokens) {

package/lib/resolver.d.ts

@@ -2,8 +2,7 @@ import { ArgToken } from './parser.js';
 
 /**
 * An option schema for an argument.
-*
-* @description This schema is similar to the schema of the `node:utils`.
+* This schema is similar to the schema of the `node:utils`.
 * difference is that:
 * - `multiple` property is not supported
 * - `required` property and `description` property are added
@@ -54,7 +53,7 @@ type FilterArgs<
 	K extends keyof ArgOptionSchema
 > = { [Option in keyof O as O[Option][K] extends {} ? Option : never] : V[Option] };
 /**
-* Resolve command line arguments
+* Resolve command line arguments.
 * @param options - An options that contains {@link ArgOptionSchema | options schema}.
 * @param tokens - An array of {@link ArgToken | tokens}.
 * @returns An object that contains the values of the arguments, positional arguments, and {@link AggregateError | validation errors}.
@@ -64,6 +63,10 @@ declare function resolveArgs<T extends ArgOptions>(options: T, tokens: ArgToken[
 	positionals: string[]
 	error: AggregateError | undefined
 };
+/**
+* An error that occurs when resolving options.
+* This error is thrown when the option is not valid.
+*/
 declare class OptionResolveError extends Error {
 	name: string;
 	schema: ArgOptionSchema;

package/lib/resolver.js

@@ -1,4 +1,4 @@
-import "./parser-DYj8MxIm.js";
-import { OptionResolveError, resolveArgs } from "./resolver-DcIzyGlA.js";
+import "./parser-DxH6Mf-o.js";
+import { OptionResolveError, resolveArgs } from "./resolver-Di82Qgwx.js";
 
 export { OptionResolveError, resolveArgs };

package/package.json

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