feat: parse string defaults

- also fixes storing of default command-argument values

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

README.md

@@ -2874,14 +2874,13 @@ Data used to create parse candidates (TypeScript interface).
 #### Properties
 
 - `choices?` ([`List<string>`](#list), optional)
-  — list of option choices
+  — the list of allowed choices
 - `default?` ([`DefaultInfo`](#defaultinfo), optional)
-  — default value configuration
-  > 👉 **note**: the option-argument `parser` will not be called.
+  — the default value configuration
+  > 👉 **note**: the argument `parser` is called **if the default value is a string**.
 - `parser?` ([`ParseArg<any, string> | ParseArg<any, string[]>`](#parseargt), optional)
-  — handler used to parse arguments. the handler receives two parameters, the raw, unparsed argument (or
-  *arguments* for variadic candidates), and the default value for the argument.
-  it should return the new value for the argument
+  — the handler used to parse arguments. the handler receives two parameters, the raw, unparsed argument, and the
+  previous value for the argument. it should return the new value for the argument
 
 ### `ParseableMetadata`
 

__fixtures__/commands/clamp.mts

@@ -32,10 +32,7 @@ export default {
       parser: bool()
     },
     {
-      default: {
-        description: 'Number.MAX_SAFE_INTEGER',
-        value: Number.MAX_SAFE_INTEGER
-      },
+      default: { value: 'MAX_SAFE_INTEGER' },
       description: 'upper bound (inclusive)',
       flags: '-M --max <n>',
       parser: number

__fixtures__/commands/distinct.mts

@@ -15,6 +15,7 @@ import type { SubcommandInfo as CommandInfo } from '@flex-development/kronk'
  */
 export default {
   arguments: {
+    default: { value: new Set() },
     description: 'the list of numbers',
     parser: unique,
     syntax: sfmt.optional({ id: 'numbers', variadic: true })

src/enums/keid.mts

@@ -26,6 +26,7 @@ const enum keid {
   missing_argument = 'kronk/missing-argument',
   missing_mandatory_option = 'kronk/missing-mandatory-option',
   no_flags = 'kronk/no-flags',
+  required_argument_after_optional = 'kronk/required-argument-after-optional',
   unknown_implied_option = 'kronk/unknown-implied-option',
   unknown_option = 'kronk/unknown-option'
 }

src/interfaces/__tests__/kronk-error.map.spec-d.mts

@@ -7,10 +7,10 @@ import type TestSubject from '#interfaces/kronk-error.map'
 import type { CommandError, KronkError } from '@flex-development/kronk'
 
 describe('unit-d:interfaces/KronkErrorMap', () => {
-  it('should match ["argument-after-variadic": CommandError]', () => {
+  it('should match ["argument-after-variadic": KronkError]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('argument-after-variadic')
-      .toEqualTypeOf<CommandError>()
+      .toEqualTypeOf<KronkError>()
   })
 
   it('should match ["conflicting-option": CommandError]', () => {
@@ -79,6 +79,12 @@ describe('unit-d:interfaces/KronkErrorMap', () => {
       .toEqualTypeOf<KronkError>()
   })
 
+  it('should match ["required-argument-after-optional": KronkError]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('required-argument-after-optional')
+      .toEqualTypeOf<KronkError>()
+  })
+
   it('should match ["unknown-implied-option": KronkError]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('unknown-implied-option')

src/interfaces/kronk-error.map.mts

@@ -21,7 +21,7 @@ import type { CommandError, KronkError } from '@flex-development/kronk'
  *  }
  */
 interface KronkErrorMap {
-  'argument-after-variadic': CommandError
+  'argument-after-variadic': KronkError
   'conflicting-option': CommandError
   'duplicate-option': CommandError
   'duplicate-subcommand': CommandError
@@ -33,6 +33,7 @@ interface KronkErrorMap {
   'missing-argument': CommandError
   'missing-mandatory-option': CommandError
   'no-flags': KronkError
+  'required-argument-after-optional': KronkError
   'unknown-implied-option': KronkError
   'unknown-option': CommandError
   error: KronkError

src/interfaces/parseable.info.mts

@@ -19,16 +19,17 @@ import type {
  */
 interface ParseableInfo extends HelpableInfo {
   /**
-   * List of allowed choices.
+   * The list of allowed choices.
    *
    * @see {@linkcode List}
    */
   choices?: List<string> | null | undefined
 
   /**
-   * Default value configuration.
+   * The default value configuration.
    *
-   * > 👉 **Note**: The argument {@linkcode parser} will not be called.
+   * > 👉 **Note**: The argument {@linkcode parser} is called
+   * > **if the default value is a string**.
    *
    * @see {@linkcode DefaultInfo}
    */

src/lib/__snapshots__/command.functional.snap

@@ -193,7 +193,10 @@ exports[`functional:lib/Command > errors > should error on excess command or opt
   "command": {
     "command": "copy",
     "ancestors": [],
-    "args": [],
+    "args": [
+      undefined,
+      ".",
+    ],
     "argv": [
       "./index.mjs",
       "./dist",
@@ -756,7 +759,10 @@ exports[`functional:lib/Command > errors > should error on missing command or op
   "command": {
     "command": "copy",
     "ancestors": [],
-    "args": [],
+    "args": [
+      undefined,
+      ".",
+    ],
     "argv": [],
     "optionValueSources": {},
     "opts": {},
@@ -779,7 +785,10 @@ exports[`functional:lib/Command > errors > should error on missing command or op
   "command": {
     "command": "copy",
     "ancestors": [],
-    "args": [],
+    "args": [
+      undefined,
+      ".",
+    ],
     "argv": [],
     "optionValueSources": {},
     "opts": {},
@@ -1174,7 +1183,10 @@ exports[`functional:lib/Command > errors > should error on unknown option (0) 1`
   "command": {
     "command": "copy",
     "ancestors": [],
-    "args": [],
+    "args": [
+      undefined,
+      ".",
+    ],
     "argv": [
       "./index.mts",
       "--debug",
@@ -1546,6 +1558,7 @@ exports[`functional:lib/Command > parsing > should run command (5) 1`] = `
   "ancestors": [],
   "args": [
     "./dist/index.mjs",
+    ".",
   ],
   "argv": [
     "./dist/index.mjs",
@@ -1590,6 +1603,7 @@ exports[`functional:lib/Command > parsing > should run command (7) 1`] = `
   "ancestors": [],
   "args": [
     "./src/main.mjs",
+    ".",
   ],
   "argv": [
     "./src/main.mjs",
@@ -1632,7 +1646,9 @@ exports[`functional:lib/Command > parsing > should run command (9) 1`] = `
 {
   "command": "distinct",
   "ancestors": [],
-  "args": [],
+  "args": [
+    Set {},
+  ],
   "argv": [],
   "optionValueSources": {},
   "opts": {},
@@ -1649,7 +1665,9 @@ exports[`functional:lib/Command > parsing > should run command (10) 1`] = `
 {
   "command": "distinct",
   "ancestors": [],
-  "args": [],
+  "args": [
+    Set {},
+  ],
   "argv": [],
   "optionValueSources": {},
   "opts": {},

src/lib/__snapshots__/command.snap

@@ -4,7 +4,7 @@ exports[`unit:lib/Command > #addArgument > should throw if argument is added aft
 {
   "code": 1,
   "id": "kronk/argument-after-variadic",
-  "message": "Cannot have argument after variadic argument (<numbers...>)",
+  "message": "Cannot have argument after variadic argument",
   "additional": [],
   "cause": {
     "argument": "<...>",
@@ -13,6 +13,19 @@ exports[`unit:lib/Command > #addArgument > should throw if argument is added aft
 }
 `;
 
+exports[`unit:lib/Command > #addArgument > should throw if required argument is added after optional 1`] = `
+{
+  "code": 1,
+  "id": "kronk/required-argument-after-optional",
+  "message": "Cannot have required argument after optional argument",
+  "additional": [],
+  "cause": {
+    "argument": "<>",
+    "last": "[artifact]",
+  },
+}
+`;
+
 exports[`unit:lib/Command > #addCommand > should throw on duplicate subcommand alias 1`] = `
 {
   "code": 1,