jackspeak - npm Package Compare versions

Comparing version 4.0.3 to 4.1.0

dist/commonjs/index.d.ts

@@ -198,2 +198,6 @@ import { inspect, InspectOptions, ParseArgsConfig } from 'node:util';
     constructor(options?: JackOptions);
+    get definitions(): C;
+    get shorts(): Record<string, string>;
+    get jackOptions(): JackOptions;
+    get usageFields(): UsageField[];
     /**
@@ -200,0 +204,0 @@ * Set the default value (which will still be overridden by env or cli)

dist/commonjs/index.js

@@ -246,2 +246,14 @@ "use strict";
     }
+    get definitions() {
+        return this.#configSet;
+    }
+    get shorts() {
+        return this.#shorts;
+    }
+    get jackOptions() {
+        return this.#options;
+    }
+    get usageFields() {
+        return this.#fields;
+    }
     /**
@@ -428,3 +440,3 @@ * Set the default value (which will still be overridden by env or cli)
             const cause = validOptions && !isValidOption(value, validOptions) ?
-                { name: field, found: value, validOptions: validOptions }
+                { name: field, found: value, validOptions }
                 : valid && !valid(value) ? { name: field, found: value }
@@ -431,0 +443,0 @@ : undefined;

dist/esm/index.d.ts

@@ -198,2 +198,6 @@ import { inspect, InspectOptions, ParseArgsConfig } from 'node:util';
     constructor(options?: JackOptions);
+    get definitions(): C;
+    get shorts(): Record<string, string>;
+    get jackOptions(): JackOptions;
+    get usageFields(): UsageField[];
     /**
@@ -200,0 +204,0 @@ * Set the default value (which will still be overridden by env or cli)

dist/esm/index.js

@@ -237,2 +237,14 @@ import { inspect, parseArgs, } from 'node:util';
     }
+    get definitions() {
+        return this.#configSet;
+    }
+    get shorts() {
+        return this.#shorts;
+    }
+    get jackOptions() {
+        return this.#options;
+    }
+    get usageFields() {
+        return this.#fields;
+    }
     /**
@@ -419,3 +431,3 @@ * Set the default value (which will still be overridden by env or cli)
             const cause = validOptions && !isValidOption(value, validOptions) ?
-                { name: field, found: value, validOptions: validOptions }
+                { name: field, found: value, validOptions }
                 : valid && !valid(value) ? { name: field, found: value }
@@ -422,0 +434,0 @@ : undefined;

package.json

 {
   "name": "jackspeak",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "A very strict and proper argument parser.",
@@ -5,0 +5,0 @@ "tshy": {

README.md

@@ -212,2 +212,34 @@ # jackspeak
 
+## Informative Getters
+
+Once you've defined several fields with the various methods
+described above, you can get at the definitions and such with
+these methods.
+
+This are primarily just informative, but can be useful in some
+advanced scenarios, such as providing "Did you mean?" type
+suggestions when someone misspells an option name.
+
+### `Jack.definitions`
+
+The set of config field definitions in no particular order. This
+is a data object suitable to passing to `util.parseArgs`, but
+with the addition of `short` and `description` fields, where
+appropriate.
+
+### `Jack.jackOptions`
+
+The options passed into the initial `jack()` function (or `new
+Jack()` constructor).
+
+### `Jack.shorts`
+
+The `{ <short>: <long> }` name record for all short options
+defined.
+
+### `Jack.usageFields`
+
+The array of fields that are used to generate `Jack.usage()` and
+`Jack.usageMarkdown()` content.
+
 ## Actions
@@ -214,0 +246,0 @@

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

284682

0.94%

Lines of code

2481

1.31%

Number of lines in readme file

390

8.94%

No dependency changes