@thi.ng/args 2.1.3 → 2.1.6

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-11-21T17:09:28Z
+- **Last updated**: 2022-04-07T14:17:30Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [2.1.6](https://github.com/thi-ng/umbrella/tree/@thi.ng/args@2.1.6) (2022-04-07)
+
+#### ♻️ Refactoring
+
+- replace deprecated .substr() w/ .substring() ([0710509](https://github.com/thi-ng/umbrella/commit/0710509))
+
 ## [2.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/args@2.1.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -233,4 +233,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2018 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2018 - 2022 Karsten Schmidt // Apache Software License 2.0

package/args.d.ts

@@ -4,7 +4,7 @@ import type { ArgSpec, KVDict, KVMultiDict, Tuple } from "./api.js";
  * Returns a full {@link ArgSpec} for a boolean flag. The mere presence of this
  * arg will enable the flag.
  *
- * @param spec
+ * @param spec -
  */
 export declare const flag: <S extends Partial<ArgSpec<boolean>>>(spec: S) => S & {
     flag: true;
@@ -14,7 +14,7 @@ export declare const flag: <S extends Partial<ArgSpec<boolean>>>(spec: S) => S &
 /**
  * Returns a full {@link ArgSpec} for a string value arg.
  *
- * @param spec
+ * @param spec -
  */
 export declare const string: <S extends Partial<ArgSpec<string>>>(spec: S) => S & {
     coerce: Fn<string, string>;
@@ -26,7 +26,7 @@ export declare const string: <S extends Partial<ArgSpec<string>>>(spec: S) => S
  * multi string value arg. This argument can be provided mutiple times with
  * values collected into an array.
  *
- * @param spec
+ * @param spec -
  */
 export declare const strings: <S extends Partial<ArgSpec<string[]> & {
     delim: string;
@@ -40,7 +40,7 @@ export declare const strings: <S extends Partial<ArgSpec<string[]> & {
  * Returns a full {@link ArgSpec} for a floating point value arg. The value
  * will be autoatically coerced into a number using {@link coerceFloat}.
  *
- * @param spec
+ * @param spec -
  */
 export declare const float: <S extends Partial<ArgSpec<number>>>(spec: S) => S & {
     coerce: Fn<string, number>;
@@ -51,7 +51,7 @@ export declare const float: <S extends Partial<ArgSpec<number>>>(spec: S) => S &
  * Returns a full {@link ArgSpec} for a single hex integer value arg. The value
  * will be autoatically coerced into a number using {@link coerceHexInt}.
  *
- * @param spec
+ * @param spec -
  */
 export declare const hex: <S extends Partial<ArgSpec<number>>>(spec: S) => S & {
     coerce: Fn<string, number>;
@@ -62,7 +62,7 @@ export declare const hex: <S extends Partial<ArgSpec<number>>>(spec: S) => S & {
  * Returns a full {@link ArgSpec} for a single integer value arg. The value
  * will be autoatically coerced into a number using {@link coerceInt}.
  *
- * @param spec
+ * @param spec -
  */
 export declare const int: <S extends Partial<ArgSpec<number>>>(spec: S) => S & {
     coerce: Fn<string, number>;
@@ -74,7 +74,7 @@ export declare const int: <S extends Partial<ArgSpec<number>>>(spec: S) => S & {
  * multi floating point value arg. This argument can be provided mutiple times
  * with values being coerced into numbers and collected into an array.
  *
- * @param spec
+ * @param spec -
  */
 export declare const floats: <S extends Partial<ArgSpec<number[]> & {
     delim: string;
@@ -89,7 +89,7 @@ export declare const floats: <S extends Partial<ArgSpec<number[]> & {
  * hex integer value arg. This argument can be provided mutiple times with
  * values being coerced into numbers and collected into an array.
  *
- * @param spec
+ * @param spec -
  */
 export declare const hexes: <S extends Partial<ArgSpec<number[]> & {
     delim: string;
@@ -104,7 +104,7 @@ export declare const hexes: <S extends Partial<ArgSpec<number[]> & {
  * integer value arg. This argument can be provided mutiple times with values
  * being coerced into numbers and collected into an array.
  *
- * @param spec
+ * @param spec -
  */
 export declare const ints: <S extends Partial<ArgSpec<number[]> & {
     delim: string;
@@ -118,7 +118,7 @@ export declare const ints: <S extends Partial<ArgSpec<number[]> & {
  * Returns full {@link ArgSpec} for a JSON value arg. The raw CLI value string
  * will be automcatically coerced using {@link coerceJson}.
  *
- * @param spec
+ * @param spec -
  */
 export declare const json: <T, S extends Partial<ArgSpec<T>>>(spec: S) => S & {
     coerce: Fn<string, T>;
@@ -129,8 +129,8 @@ export declare const json: <T, S extends Partial<ArgSpec<T>>>(spec: S) => S & {
  * Returns full {@link ArgSpec} for an enum-like string value arg. The raw CLI
  * value string will be automcatically validated using {@link coerceOneOf}.
  *
- * @param opts
- * @param spec
+ * @param opts -
+ * @param spec -
  */
 export declare const oneOf: <K extends string, S extends Partial<ArgSpec<K>>>(opts: readonly K[], spec: S) => S & {
     coerce: Fn<string, K>;
@@ -144,8 +144,8 @@ export declare const oneOf: <K extends string, S extends Partial<ArgSpec<K>>>(op
  * enum-like string value args. The raw CLI value strings will be automcatically
  * validated using {@link coerceOneOf} and collected into an array.
  *
- * @param opts
- * @param spec
+ * @param opts -
+ * @param spec -
  */
 export declare const oneOfMulti: <K extends string, S extends Partial<ArgSpec<K[]> & {
     delim: string;
@@ -166,8 +166,8 @@ export declare const oneOfMulti: <K extends string, S extends Partial<ArgSpec<K[
  * are allowed and will receive a `"true"` as their value. However, if `strict`
  * is true, only full KV pairs are allowed.
  *
- * @param spec
- * @param delim
+ * @param spec -
+ * @param delim -
  */
 export declare const kvPairs: <S extends Partial<ArgSpec<KVDict>>>(spec: S, delim?: string, strict?: boolean | undefined) => S & {
     coerce: Fn<string[], KVDict>;
@@ -180,9 +180,9 @@ export declare const kvPairs: <S extends Partial<ArgSpec<KVDict>>>(spec: S, deli
  * which supports multiple values per given key (each key's values are collected
  * into arrays).
  *
- * @param spec
- * @param delim
- * @param strict
+ * @param spec -
+ * @param delim -
+ * @param strict -
  */
 export declare const kvPairsMulti: <S extends Partial<ArgSpec<KVMultiDict>>>(spec: S, delim?: string, strict?: boolean | undefined) => S & {
     coerce: Fn<string[], KVMultiDict>;
@@ -211,10 +211,10 @@ export declare const kvPairsMulti: <S extends Partial<ArgSpec<KVMultiDict>>>(spe
  * // }
  * ```
  *
- * @param coerce
- * @param size
- * @param spec
- * @param delim
+ * @param coerce -
+ * @param size -
+ * @param spec -
+ * @param delim -
  */
 export declare const tuple: <T, S extends Partial<ArgSpec<Tuple<T>>>>(coerce: Fn<string, T>, size: number, spec: S, delim?: string) => S & {
     coerce: Fn<string, Tuple<T>>;
@@ -224,9 +224,9 @@ export declare const tuple: <T, S extends Partial<ArgSpec<Tuple<T>>>>(coerce: Fn
 /**
  * Syntax sugar for `tuple(coerceInt, size, {...}, delim)`.
  *
- * @param size
- * @param spec
- * @param delim
+ * @param size -
+ * @param spec -
+ * @param delim -
  */
 export declare const size: <S extends Partial<ArgSpec<Tuple<number>>>>(size: number, spec: S, delim?: string) => S & {
     coerce: Fn<string, Tuple<number>>;
@@ -236,9 +236,9 @@ export declare const size: <S extends Partial<ArgSpec<Tuple<number>>>>(size: num
 /**
  * Syntax sugar for `tuple(coerceFloat, size, {...}, delim)`.
  *
- * @param size
- * @param spec
- * @param delim
+ * @param size -
+ * @param spec -
+ * @param delim -
  */
 export declare const vec: <S extends Partial<ArgSpec<Tuple<number>>>>(size: number, spec: S, delim?: string) => S & {
     coerce: Fn<string, Tuple<number>>;

package/args.js

@@ -18,7 +18,7 @@ const $hint = (hint, delim) => hint + (delim ? `[${delim}..]` : "");
  * Returns a full {@link ArgSpec} for a boolean flag. The mere presence of this
  * arg will enable the flag.
  *
- * @param spec
+ * @param spec -
  */
 export const flag = (spec) => ({
     flag: true,
@@ -29,7 +29,7 @@ export const flag = (spec) => ({
 /**
  * Returns a full {@link ArgSpec} for a string value arg.
  *
- * @param spec
+ * @param spec -
  */
 export const string = $single((x) => x, "STR");
 /**
@@ -37,28 +37,28 @@ export const string = $single((x) => x, "STR");
  * multi string value arg. This argument can be provided mutiple times with
  * values collected into an array.
  *
- * @param spec
+ * @param spec -
  */
 export const strings = $multi((x) => x, "STR");
 /**
  * Returns a full {@link ArgSpec} for a floating point value arg. The value
  * will be autoatically coerced into a number using {@link coerceFloat}.
  *
- * @param spec
+ * @param spec -
  */
 export const float = $single(coerceFloat, "NUM");
 /**
  * Returns a full {@link ArgSpec} for a single hex integer value arg. The value
  * will be autoatically coerced into a number using {@link coerceHexInt}.
  *
- * @param spec
+ * @param spec -
  */
 export const hex = $single(coerceHexInt, "HEX");
 /**
  * Returns a full {@link ArgSpec} for a single integer value arg. The value
  * will be autoatically coerced into a number using {@link coerceInt}.
  *
- * @param spec
+ * @param spec -
  */
 export const int = $single(coerceInt, "INT");
 /**
@@ -66,7 +66,7 @@ export const int = $single(coerceInt, "INT");
  * multi floating point value arg. This argument can be provided mutiple times
  * with values being coerced into numbers and collected into an array.
  *
- * @param spec
+ * @param spec -
  */
 export const floats = $multi(coerceFloats, "NUM");
 /**
@@ -74,7 +74,7 @@ export const floats = $multi(coerceFloats, "NUM");
  * hex integer value arg. This argument can be provided mutiple times with
  * values being coerced into numbers and collected into an array.
  *
- * @param spec
+ * @param spec -
  */
 export const hexes = $multi(coerceHexInts, "HEX");
 /**
@@ -82,14 +82,14 @@ export const hexes = $multi(coerceHexInts, "HEX");
  * integer value arg. This argument can be provided mutiple times with values
  * being coerced into numbers and collected into an array.
  *
- * @param spec
+ * @param spec -
  */
 export const ints = $multi(coerceInts, "INT");
 /**
  * Returns full {@link ArgSpec} for a JSON value arg. The raw CLI value string
  * will be automcatically coerced using {@link coerceJson}.
  *
- * @param spec
+ * @param spec -
  */
 export const json = (spec) => ({
     coerce: coerceJson,
@@ -102,8 +102,8 @@ const $desc = (opts, prefix) => `${prefix ? prefix + ": " : ""}${opts.map((x) =>
  * Returns full {@link ArgSpec} for an enum-like string value arg. The raw CLI
  * value string will be automcatically validated using {@link coerceOneOf}.
  *
- * @param opts
- * @param spec
+ * @param opts -
+ * @param spec -
  */
 export const oneOf = (opts, spec) => ({
     coerce: coerceOneOf(opts),
@@ -117,8 +117,8 @@ export const oneOf = (opts, spec) => ({
  * enum-like string value args. The raw CLI value strings will be automcatically
  * validated using {@link coerceOneOf} and collected into an array.
  *
- * @param opts
- * @param spec
+ * @param opts -
+ * @param spec -
  */
 export const oneOfMulti = (opts, spec) => ({
     coerce: (xs) => xs.map(coerceOneOf(opts)),
@@ -137,8 +137,8 @@ export const oneOfMulti = (opts, spec) => ({
  * are allowed and will receive a `"true"` as their value. However, if `strict`
  * is true, only full KV pairs are allowed.
  *
- * @param spec
- * @param delim
+ * @param spec -
+ * @param delim -
  */
 export const kvPairs = (spec, delim = "=", strict) => ({
     coerce: coerceKV(delim, strict),
@@ -152,9 +152,9 @@ export const kvPairs = (spec, delim = "=", strict) => ({
  * which supports multiple values per given key (each key's values are collected
  * into arrays).
  *
- * @param spec
- * @param delim
- * @param strict
+ * @param spec -
+ * @param delim -
+ * @param strict -
  */
 export const kvPairsMulti = (spec, delim = "=", strict) => ({
     coerce: coerceKV(delim, strict, true),
@@ -184,10 +184,10 @@ export const kvPairsMulti = (spec, delim = "=", strict) => ({
  * // }
  * ```
  *
- * @param coerce
- * @param size
- * @param spec
- * @param delim
+ * @param coerce -
+ * @param size -
+ * @param spec -
+ * @param delim -
  */
 export const tuple = (coerce, size, spec, delim = ",") => ({
     coerce: coerceTuple(coerce, size, delim),
@@ -198,16 +198,16 @@ export const tuple = (coerce, size, spec, delim = ",") => ({
 /**
  * Syntax sugar for `tuple(coerceInt, size, {...}, delim)`.
  *
- * @param size
- * @param spec
- * @param delim
+ * @param size -
+ * @param spec -
+ * @param delim -
  */
 export const size = (size, spec, delim = "x") => tuple(coerceInt, size, spec, delim);
 /**
  * Syntax sugar for `tuple(coerceFloat, size, {...}, delim)`.
  *
- * @param size
- * @param spec
- * @param delim
+ * @param size -
+ * @param spec -
+ * @param delim -
  */
 export const vec = (size, spec, delim = ",") => tuple(coerceFloat, size, spec, delim);

package/coerce.js

@@ -20,8 +20,8 @@ export function coerceKV(delim = "=", strict = false, multi = false) {
             idx < 1 &&
             illegalArgs(`got '${x}', but expected a 'key${delim}value' pair`);
         if (idx > 0) {
-            const id = x.substr(0, idx);
-            const val = x.substr(idx + 1);
+            const id = x.substring(0, idx);
+            const val = x.substring(idx + 1);
             if (multi) {
                 acc[id] ? acc[id].push(val) : (acc[id] = [val]);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/args",
-  "version": "2.1.3",
+  "version": "2.1.6",
   "description": "Declarative, functional & typechecked CLI argument/options parser, value coercions etc.",
   "type": "module",
   "module": "./index.js",
@@ -34,18 +34,18 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.2",
-    "@thi.ng/checks": "^3.1.2",
-    "@thi.ng/errors": "^2.1.2",
-    "@thi.ng/strings": "^3.3.0"
+    "@thi.ng/api": "^8.3.5",
+    "@thi.ng/checks": "^3.1.5",
+    "@thi.ng/errors": "^2.1.5",
+    "@thi.ng/strings": "^3.3.3"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.19",
-    "@thi.ng/testament": "^0.2.2",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.5",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.9",
-    "typescript": "^4.5.2"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "argument",
@@ -75,26 +75,26 @@
   ],
   "exports": {
     ".": {
-      "import": "./index.js"
+      "default": "./index.js"
     },
     "./api": {
-      "import": "./api.js"
+      "default": "./api.js"
     },
     "./args": {
-      "import": "./args.js"
+      "default": "./args.js"
     },
     "./coerce": {
-      "import": "./coerce.js"
+      "default": "./coerce.js"
     },
     "./parse": {
-      "import": "./parse.js"
+      "default": "./parse.js"
     },
     "./usage": {
-      "import": "./usage.js"
+      "default": "./usage.js"
     }
   },
   "thi.ng": {
     "year": 2018
   },
-  "gitHead": "32cf1a96854f9bb97aca65ffa05ca862ea377059\n"
+  "gitHead": "5ee1feb590dd935593b1dd4e7f38a3ed3ba64765\n"
 }

package/parse.js

@@ -57,10 +57,10 @@ const parseKey = (specs, aliases, acc, a) => {
             // terminator arg, stop parsing
             if (a === "--")
                 return { state: 1 };
-            id = camel(a.substr(2));
+            id = camel(a.substring(2));
         }
         else {
-            id = aliases[a.substr(1)];
+            id = aliases[a.substring(1)];
             !id && illegalArgs(`unknown option: ${a}`);
         }
         const spec = specs[id];