@shell-shock/core 0.6.0 → 0.8.0

package/dist/types/command.d.mts

@@ -1,94 +1,267 @@
-import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import { ReflectionFunction, ReflectionKind, ReflectionParameter, ReflectionProperty, SerializedTypes } from "@powerlines/deepkit/vendor/type";
 import { AnyFunction } from "@stryke/types/base";
 import { ResolvedEntryTypeDefinition } from "powerlines/types/resolved";
 
 //#region src/types/command.d.ts
-interface BaseCommandOption {
+interface BaseCommandParameter {
+  /**
+   * The option name.
+   */
   name: string;
+  /**
+   * The option kind.
+   */
   kind: ReflectionKind;
+  /**
+   * The display title.
+   */
   title: string;
+  /**
+   * The option description.
+   */
   description: string;
+  /**
+   * Alternative option names.
+   */
   alias: string[];
+  /**
+   * The environment variable name or false to disable.
+   */
   env: string | false;
+  /**
+   * Whether the option is optional.
+   */
   optional: boolean;
 }
-interface StringCommandOption extends BaseCommandOption {
+interface StringCommandParameter extends BaseCommandParameter {
+  /**
+   * The option kind.
+   */
   kind: ReflectionKind.string;
+  /**
+   * The default value.
+   */
   default?: string;
+  /**
+   * Whether the option accepts multiple values.
+   */
   variadic: boolean;
 }
-interface NumberCommandOption extends BaseCommandOption {
+interface NumberCommandParameter extends BaseCommandParameter {
+  /**
+   * The option kind.
+   */
   kind: ReflectionKind.number;
+  /**
+   * The default value.
+   */
   default?: number;
+  /**
+   * Whether the option accepts multiple values.
+   */
   variadic: boolean;
 }
-interface BooleanCommandOption extends BaseCommandOption {
+interface BooleanCommandParameter extends BaseCommandParameter {
+  /**
+   * The option kind.
+   */
   kind: ReflectionKind.boolean;
+  /**
+   * The default value.
+   */
   default?: boolean;
+  /**
+   * The option this negates.
+   */
   isNegativeOf?: string;
+  /**
+   * Whether to skip adding a negative option.
+   */
+  skipAddingNegative?: boolean;
+}
+interface StringCommandOption extends StringCommandParameter {
+  /**
+   * The property reflection.
+   */
+  reflection?: ReflectionProperty;
+}
+interface NumberCommandOption extends NumberCommandParameter {
+  /**
+   * The property reflection.
+   */
+  reflection?: ReflectionProperty;
+}
+interface BooleanCommandOption extends BooleanCommandParameter {
+  /**
+   * The property reflection.
+   */
+  reflection?: ReflectionProperty;
+  /**
+   * The option this negates.
+   */
+  isNegativeOf?: string;
+  /**
+   * Whether to skip adding a negative option.
+   */
   skipAddingNegative?: boolean;
 }
 type CommandOption = StringCommandOption | NumberCommandOption | BooleanCommandOption;
-interface CommandPath {
-  value: string | null;
-  segments: string[];
+interface StringCommandArgument extends StringCommandParameter {
+  /**
+   * The parameter reflection.
+   */
+  reflection: ReflectionParameter;
+}
+interface NumberCommandArgument extends NumberCommandParameter {
+  /**
+   * The parameter reflection.
+   */
+  reflection: ReflectionParameter;
+}
+interface BooleanCommandArgument extends BooleanCommandParameter {
+  /**
+   * The parameter reflection.
+   */
+  reflection: ReflectionParameter;
 }
+type CommandArgument = StringCommandArgument | NumberCommandArgument | BooleanCommandArgument;
 interface CommandBase {
+  /**
+   * The command id.
+   */
   id: string | null;
+  /**
+   * The command name.
+   */
   name: string;
+  /**
+   * The full command path value.
+   */
+  path: string | null;
+  /**
+   * The path segments.
+   */
+  segments: string[];
+  /**
+   * The display title.
+   */
   title?: string;
+  /**
+   * The command description.
+   */
   description?: string;
+  /**
+   * Alternative command names.
+   */
   alias?: string[];
-  path: CommandPath;
+  /**
+   * The command icon.
+   */
+  icon?: string;
+  /**
+   * Whether the command is virtual.
+   */
   isVirtual: boolean;
 }
 interface CommandInput extends CommandBase {
+  /**
+   * The command id.
+   */
   id: string;
+  /**
+   * The resolved entry definition.
+   */
   entry: ResolvedEntryTypeDefinition;
 }
-type CommandDynamicSegment = {
-  name: string;
-  title: string;
-  description: string;
-  optional: boolean;
-} & ({
-  default?: string;
-  catchAll: false;
-  variadic: false;
-} | {
-  default?: string;
-  catchAll: true;
-  variadic: false;
-} | {
-  default?: string[];
-  catchAll: true;
-  variadic: true;
-});
-interface CommandTreePath extends CommandPath {
-  dynamics: Record<string, CommandDynamicSegment>;
-}
 type CommandTree = CommandInput & {
+  /**
+   * The display title.
+   */
   title: string;
+  /**
+   * The command description.
+   */
   description: string;
+  /**
+   * Alternative command names.
+   */
   alias: string[];
-  path: CommandTreePath;
+  /**
+   * The command options.
+   */
   options: Record<string, CommandOption>;
+  /**
+   * The positional arguments provided to the command.
+   */
+  arguments: CommandArgument[];
+  /**
+   * The parent command.
+   */
   parent: null | CommandTree;
+  /**
+   * Child commands.
+   */
   children: Record<string, CommandTree>;
+  /**
+   * The command handler reflection.
+   */
+  reflection: ReflectionFunction | null;
 };
-type SerializedCommandTree = Omit<CommandTree, "parent" | "children"> & {
+type SerializedCommandOption = Omit<CommandOption, "reflection">;
+type SerializedCommandArgument = Omit<CommandArgument, "reflection">;
+type SerializedCommandTree = Omit<CommandTree, "options" | "arguments" | "parent" | "children" | "reflection"> & {
+  /**
+   * The command options.
+   */
+  options: Record<string, SerializedCommandOption>;
+  /**
+   * The positional arguments provided to the command.
+   */
+  arguments: SerializedCommandArgument[];
+  /**
+   * The parent command id.
+   */
   parent: null | string;
+  /**
+   * Serialized child commands.
+   */
   children: Record<string, SerializedCommandTree>;
+  /**
+   * The command handler reflection.
+   */
+  reflection?: SerializedTypes;
 };
 interface Metadata {
+  /**
+   * The display name of the command.
+   *
+   * @remarks
+   * This value will be used in various displays of the user interface and documentation. If not provided, a formatted value of the command name will be used.
+   */
   title?: string;
+  /**
+   * A brief description of what the command does.
+   *
+   * @remarks
+   * This value will be used in various displays of the user interface and documentation. If not provided, a default message may be shown.
+   */
   description?: string;
+  /**
+   * One or more alternative names for the command.
+   */
   alias?: string | string[];
+  /**
+   * An optional icon to visually represent the command in user interfaces.
+   *
+   * @remarks
+   * This can be a string containing an emoji, a Unicode character, or any other symbol that helps to visually identify the command. If not provided, no icon will be displayed.
+   */
+  icon?: string;
 }
 interface CommandModule {
   metadata?: Metadata;
   default?: AnyFunction;
 }
 //#endregion
-export { BaseCommandOption, BooleanCommandOption, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandPath, CommandTree, CommandTreePath, Metadata, NumberCommandOption, SerializedCommandTree, StringCommandOption };
+export { BaseCommandParameter, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandArgument, CommandBase, CommandInput, CommandModule, CommandOption, CommandTree, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, SerializedCommandArgument, SerializedCommandOption, SerializedCommandTree, StringCommandArgument, StringCommandOption, StringCommandParameter };
 //# sourceMappingURL=command.d.mts.map

package/dist/types/command.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"command.d.mts","names":[],"sources":["../../src/types/command.ts"],"sourcesContent":[],"mappings":";;;;;UAsBiB,iBAAA;;EAAA,IAAA,EAET,cAF0B;EAUjB,KAAA,EAAA,MAAA;EAMA,WAAA,EAAA,MAAA;EAMA,KAAA,EAAA,MAAA,EAAA;EAOL,GAAA,EAAA,MAAA,GAAA,KAAa;EACrB,QAAA,EAAA,OAAA;;AAEA,UAtBa,mBAAA,SAA4B,iBAsBzC,CAAA;EAAoB,IAAA,EArBhB,cAAA,CAAe,MAqBC;EAEP,OAAA,CAAA,EAAA,MAAW;EAKX,QAAA,EAAA,OAAW;AAU5B;AAKY,UAtCK,mBAAA,SAA4B,iBAsCZ,CAAA;EAuBhB,IAAA,EA5DT,cAAA,CAAe,MA4DU;EACN,OAAA,CAAA,EAAA,MAAA;EAAf,QAAA,EAAA,OAAA;;AADwC,UAvDnC,oBAAA,SAA6B,iBAuDM,CAAA;EAIxC,IAAA,EA1DJ,cAAA,CAAe,OA0DA;EAAG,OAAA,CAAA,EAAA,OAAA;EAIlB,YAAA,CAAA,EAAA,MAAA;EACkB,kBAAA,CAAA,EAAA,OAAA;;AACT,KA1DL,aAAA,GACR,mBAyDa,GAxDb,mBAwDa,GAvDb,oBAuDa;AACU,UAtDV,WAAA,CAsDU;EAAf,KAAA,EAAA,MAAA,GAAA,IAAA;EAAM,QAAA,EAAA,MAAA,EAAA;AAGlB;AAAyC,UApDxB,WAAA,CAoDwB;EAAL,EAAA,EAAA,MAAA,GAAA,IAAA;EAET,IAAA,EAAA,MAAA;EAAf,KAAA,CAAA,EAAA,MAAA;EAAM,WAAA,CAAA,EAAA,MAAA;EAGD,KAAA,CAAA,EAAA,MAAQ,EAAA;EAMR,IAAA,EAzDT,WAyDsB;;;UArDb,YAAA,SAAqB;;SAE7B;;KAGG,qBAAA;;;;;;;;;;;;;;;;;;UAuBK,eAAA,SAAwB;YAC7B,eAAe;;KAGf,WAAA,GAAc;;;;QAIlB;WACG,eAAe;iBACT;YACL,eAAe;;KAGf,qBAAA,GAAwB,KAAK;;YAE7B,eAAe;;UAGV,QAAA;;;;;UAMA,aAAA;aACJ;YACD"}
+{"version":3,"file":"command.d.mts","names":[],"sources":["../../src/types/command.ts"],"sourcesContent":[],"mappings":";;;;;UA4BiB,oBAAA;;AAAjB;AA+BA;EAeiB,IAAA,EAAA,MAAA;EAeA;AAmBjB;AAOA;EAOiB,IAAA,EAtFT,cAsFS;EAeL;;;EAGR,KAAA,EAAA,MAAA;EAAoB;AAExB;AAOA;EAOiB,WAAA,EAAA,MAAA;EAOL;;;EAGR,KAAA,EAAA,MAAA,EAAA;EAAsB;AAE1B;AAuCA;EAWY,GAAA,EAAA,MAAA,GAAW,KAAA;EAAG;;;EAoBb,QAAA,EAAA,OAAA;;AAQc,UA3LV,sBAAA,SAA+B,oBA2LrB,CAAA;EAAf;;;EAOA,IAAA,EA9LJ,cAAA,CAAe,MA8LY;EAEvB;AAEZ;;EAAoC,OAAA,CAAA,EAAA,MAAA;EAOV;;;EAYC,QAAA,EAAA,OAAA;;AAIZ,UA9ME,sBAAA,SAA+B,oBA8MjC,CAAA;EAAe;AAG9B;AA+BA;QA5OQ,cAAA,CAAe;;;;;;;;;;UAWN,uBAAA,SAAgC;;;;QAIzC,cAAA,CAAe;;;;;;;;;;;;;;UAeN,mBAAA,SAA4B;;;;eAI9B;;UAGE,mBAAA,SAA4B;;;;eAI9B;;UAGE,oBAAA,SAA6B;;;;eAI/B;;;;;;;;;;KAWH,aAAA,GACR,sBACA,sBACA;UAEa,qBAAA,SAA8B;;;;cAIjC;;UAGG,qBAAA,SAA8B;;;;cAIjC;;UAGG,sBAAA,SAA+B;;;;cAIlC;;KAGF,eAAA,GACR,wBACA,wBACA;UAEa,WAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAuCA,YAAA,SAAqB;;;;;;;;SAQ7B;;KAGG,WAAA,GAAc;;;;;;;;;;;;;;;;WAgBf,eAAe;;;;aAIb;;;;iBAII;;;;YAIL,eAAe;;;;cAIb;;KAGF,uBAAA,GAA0B,KAAK;KAE/B,yBAAA,GAA4B,KAAK;KAEjC,qBAAA,GAAwB,KAClC;;;;WAMS,eAAe;;;;aAIb;;;;;;;;YAQD,eAAe;;;;eAIZ;;UAGE,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;UA+BA,aAAA;aACJ;YACD"}

package/dist/types/index.d.cts

@@ -1,5 +1,6 @@
-import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandPath, CommandTree, CommandTreePath, Metadata, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./command.cjs";
+import { BaseCommandParameter, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandArgument, CommandBase, CommandInput, CommandModule, CommandOption, CommandTree, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, SerializedCommandArgument, SerializedCommandOption, SerializedCommandTree, StringCommandArgument, StringCommandOption, StringCommandParameter } from "./command.cjs";
 import { Context, UnresolvedContext } from "./context.cjs";
 import { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig } from "./config.cjs";
 import { BaseCommandOptions } from "./options.cjs";
-export { BaseCommandOption, BaseCommandOptions, BaseConfig, BooleanCommandOption, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandPath, CommandTree, CommandTreePath, Context, Metadata, NumberCommandOption, Options, OutputConfig, ResolvedConfig, SerializedCommandTree, StringCommandOption, UnresolvedContext, UserConfig };
+import { CommandContext } from "./runtime.cjs";
+export { BaseCommandOptions, BaseCommandParameter, BaseConfig, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandArgument, CommandBase, CommandContext, CommandInput, CommandModule, CommandOption, CommandTree, Context, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, Options, OutputConfig, ResolvedConfig, SerializedCommandArgument, SerializedCommandOption, SerializedCommandTree, StringCommandArgument, StringCommandOption, StringCommandParameter, UnresolvedContext, UserConfig };

package/dist/types/index.d.mts

@@ -1,5 +1,6 @@
-import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandPath, CommandTree, CommandTreePath, Metadata, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./command.mjs";
+import { BaseCommandParameter, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandArgument, CommandBase, CommandInput, CommandModule, CommandOption, CommandTree, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, SerializedCommandArgument, SerializedCommandOption, SerializedCommandTree, StringCommandArgument, StringCommandOption, StringCommandParameter } from "./command.mjs";
 import { Context, UnresolvedContext } from "./context.mjs";
 import { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig } from "./config.mjs";
 import { BaseCommandOptions } from "./options.mjs";
-export { BaseCommandOption, BaseCommandOptions, BaseConfig, BooleanCommandOption, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandPath, CommandTree, CommandTreePath, Context, Metadata, NumberCommandOption, Options, OutputConfig, ResolvedConfig, SerializedCommandTree, StringCommandOption, UnresolvedContext, UserConfig };
+import { CommandContext } from "./runtime.mjs";
+export { BaseCommandOptions, BaseCommandParameter, BaseConfig, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandArgument, CommandBase, CommandContext, CommandInput, CommandModule, CommandOption, CommandTree, Context, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, Options, OutputConfig, ResolvedConfig, SerializedCommandArgument, SerializedCommandOption, SerializedCommandTree, StringCommandArgument, StringCommandOption, StringCommandParameter, UnresolvedContext, UserConfig };

package/dist/types/runtime.d.cts

@@ -1,24 +1,14 @@
 //#region src/types/runtime.d.ts
-interface RuntimePath {
+interface CommandContext {
   /**
-   * The full path as a string value.
+   * The current command path within the runtime context.
    */
-  value: string;
+  path: string;
   /**
    * The individual segments that make up the path.
    */
-  segments: (string | string[])[];
-}
-interface RuntimeContext<TOptions extends Record<string, string | number | boolean | string[] | number[]> = Record<string, string | number | boolean | string[] | number[]>, TPath extends RuntimePath = RuntimePath> {
-  /**
-   * The parsed command-line options.
-   */
-  options: TOptions;
-  /**
-   * The current command path within the runtime context.
-   */
-  path: TPath;
+  segments: string[];
 }
 //#endregion
-export { RuntimeContext, RuntimePath };
+export { CommandContext };
 //# sourceMappingURL=runtime.d.cts.map

package/dist/types/runtime.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.cts","names":[],"sources":["../../src/types/runtime.ts"],"sourcesContent":[],"mappings":";UAkBiB,WAAA;EAAA;AAYjB;;EAIM,KAAA,EAAA,MAAA;EACU;;;EAUR,QAAA,EAAA,CAAA,MAAA,GAAA,MAAA,EAAA,CAAA,EAAA;;UAfS,gCACE,kEAGb,+EACU,cAAc;;;;WAKnB;;;;QAKH"}
+{"version":3,"file":"runtime.d.cts","names":[],"sources":["../../src/types/runtime.ts"],"sourcesContent":[],"mappings":";UAkBiB,cAAA;EAAA"}

package/dist/types/runtime.d.mts

@@ -1,24 +1,14 @@
 //#region src/types/runtime.d.ts
-interface RuntimePath {
+interface CommandContext {
   /**
-   * The full path as a string value.
+   * The current command path within the runtime context.
    */
-  value: string;
+  path: string;
   /**
    * The individual segments that make up the path.
    */
-  segments: (string | string[])[];
-}
-interface RuntimeContext<TOptions extends Record<string, string | number | boolean | string[] | number[]> = Record<string, string | number | boolean | string[] | number[]>, TPath extends RuntimePath = RuntimePath> {
-  /**
-   * The parsed command-line options.
-   */
-  options: TOptions;
-  /**
-   * The current command path within the runtime context.
-   */
-  path: TPath;
+  segments: string[];
 }
 //#endregion
-export { RuntimeContext, RuntimePath };
+export { CommandContext };
 //# sourceMappingURL=runtime.d.mts.map

package/dist/types/runtime.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.mts","names":[],"sources":["../../src/types/runtime.ts"],"sourcesContent":[],"mappings":";UAkBiB,WAAA;EAAA;AAYjB;;EAIM,KAAA,EAAA,MAAA;EACU;;;EAUR,QAAA,EAAA,CAAA,MAAA,GAAA,MAAA,EAAA,CAAA,EAAA;;UAfS,gCACE,kEAGb,+EACU,cAAc;;;;WAKnB;;;;QAKH"}
+{"version":3,"file":"runtime.d.mts","names":[],"sources":["../../src/types/runtime.ts"],"sourcesContent":[],"mappings":";UAkBiB,cAAA;EAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shell-shock/core",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "type": "module",
   "description": "A package containing the core Shell Shock functionality used to build and manage a command-line application.",
   "repository": {
@@ -88,6 +88,20 @@
         "default": "./dist/components/docs.mjs"
       }
     },
+    "./components/helpers": {
+      "require": {
+        "types": "./dist/components/helpers.d.cts",
+        "default": "./dist/components/helpers.cjs"
+      },
+      "import": {
+        "types": "./dist/components/helpers.d.mts",
+        "default": "./dist/components/helpers.mjs"
+      },
+      "default": {
+        "types": "./dist/components/helpers.d.mts",
+        "default": "./dist/components/helpers.mjs"
+      }
+    },
     "./components/options-parser-logic": {
       "require": {
         "types": "./dist/components/options-parser-logic.d.cts",
@@ -350,13 +364,13 @@
     "@alloy-js/core": "^0.22.0",
     "@alloy-js/markdown": "^0.22.0",
     "@alloy-js/typescript": "^0.22.0",
-    "@powerlines/deepkit": "^0.6.50",
-    "@powerlines/plugin-alloy": "^0.20.14",
-    "@powerlines/plugin-automd": "^0.1.270",
-    "@powerlines/plugin-deepkit": "^0.11.149",
-    "@powerlines/plugin-nodejs": "^0.1.175",
-    "@powerlines/plugin-plugin": "^0.12.221",
-    "@powerlines/plugin-tsdown": "^0.1.223",
+    "@powerlines/deepkit": "^0.6.51",
+    "@powerlines/plugin-alloy": "^0.20.15",
+    "@powerlines/plugin-automd": "^0.1.271",
+    "@powerlines/plugin-deepkit": "^0.11.150",
+    "@powerlines/plugin-nodejs": "^0.1.176",
+    "@powerlines/plugin-plugin": "^0.12.222",
+    "@powerlines/plugin-tsdown": "^0.1.224",
     "@stryke/cli": "0.13.12",
     "@stryke/convert": "^0.6.38",
     "@stryke/fs": "^0.33.40",
@@ -368,10 +382,10 @@
     "@stryke/types": "^0.10.37",
     "automd": "0.4.2",
     "defu": "6.1.4",
-    "powerlines": "^0.38.37",
+    "powerlines": "^0.38.38",
     "rolldown": "1.0.0-beta.52"
   },
-  "devDependencies": { "@types/node": "^22.19.9", "typescript": "^5.9.3" },
+  "devDependencies": { "@types/node": "^22.19.10", "typescript": "^5.9.3" },
   "publishConfig": { "access": "public" },
-  "gitHead": "56bc5ad6b21f20ec50ff934e8227f8b21751fc66"
+  "gitHead": "a3710248496a9b6251c18d6ee4af3587a0dc1fa5"
 }