@shell-shock/core 0.17.8 → 0.17.11

package/dist/helpers/validations.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"validations.mjs","names":[],"sources":["../../src/helpers/validations.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { CommandTree } from \"../types\";\nimport { CommandParameterKinds } from \"../types\";\n\nexport interface ValidationFailure {\n  code: string;\n  details: string;\n}\n\nexport function validateArguments(command: CommandTree): ValidationFailure[] {\n  const failures: ValidationFailure[] = [];\n\n  let sequential = false;\n  for (const argument of command.args ?? []) {\n    if (\n      (argument.kind === CommandParameterKinds.string ||\n        argument.kind === CommandParameterKinds.number) &&\n      argument.variadic\n    ) {\n      if (!sequential) {\n        sequential = true;\n      } else {\n        failures.push({\n          code: \"SEQUENTIAL_VARIADIC_ARGUMENTS\",\n          details: `Sequential variadic arguments are not allowed - since the argument preceding ${argument.name} is variadic, it must not also be variadic.`\n        });\n      }\n    } else {\n      sequential = false;\n    }\n  }\n\n  return failures;\n}\n\nexport function validateOptions(command: CommandTree): ValidationFailure[] {\n  const failures: ValidationFailure[] = [];\n\n  const optionNames = new Set<string>();\n  for (const option of Object.values(command.options ?? {})) {\n    if (optionNames.has(option.name)) {\n      failures.push({\n        code: \"DUPLICATE_OPTION_NAME\",\n        details: `Duplicate option name \"${option.name}\" found in command.`\n      });\n    }\n    optionNames.add(option.name);\n\n    for (const alias of option.alias) {\n      if (optionNames.has(alias)) {\n        failures.push({\n          code: \"DUPLICATE_OPTION_ALIAS\",\n          details: `Duplicate option name \"${alias}\" (an alias of \"${\n            option.name\n          }\") found in command.`\n        });\n      }\n      optionNames.add(alias);\n    }\n  }\n\n  return failures;\n}\n\nexport function validateCommand(command: CommandTree): ValidationFailure[] {\n  const results: ValidationFailure[] = [];\n\n  let failures = validateOptions(command);\n  if (failures.length > 0) {\n    results.push(...failures);\n  }\n\n  failures = validateArguments(command);\n  if (failures.length > 0) {\n    results.push(...failures);\n  }\n\n  return results;\n}\n"],"mappings":"6DAkBA,MAAM,EAAsB,CAAA,OAAS,UAAM,oBAAA,cAAA,eAG3C,IAAO,EAAU,EAAA,CACX,EAAQ,GACZ,IAAA,IAAS,KAAM,EAAA,MAAA,EAAA,EACjB,EAAA,OAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,SAAA,UAKM,KAAU,gCACT,QAAM,gFAAgC,EAAA,KAAA,6CACtC,CAAA,CALA,EAAS,GAQV,EAAS,GAGb,OAAM,EAER,EAAiB,OAAK,CAAA,cAAA,cAAA,EAAA,oBAAA,cAAA,CACtB,SAAgB,EAAC,EAAA,CACf,IAAM,EAAW,EAAC,CACZ,GAAE,IAAA,EAAA,CAAA,CAAA,IAAA,CAAA,CAAA,IAAA,KACR,IAAI,IAAA,KAAA,OAAA,OAAA,EAAA,SAAA,EAAA,CAAA,CAAA,CACA,EAAK,IAAA,EAAA,KAAA,EACL,EAAA,KAAa,CACf,KAAA,wBACF,QAAA,0BAAA,EAAA,KAAA,uBAGF,EAAA,IAAA,EAAA,KAAA,sBAEO,EAAS,IAAA,EAAgB,EACxB,EAAS,KAAC,+BAEV,QAAW,0BAAoB,EAAA,kBAAA,EAAA,KAAA,sBAChC,CAAA,CAED,EAAS,IAAK,EAAA,CAGlB,OAAM,EAER,EAAgB,OAAI,CAAM,cAAM,cAAA,EAAA,kBAAA,cAAA,eAE9B,IAAM,EAAO,EAAK,CACd,EAAI,EAAuB,EAAC,CAQhC,OAPI,EAAE,OAAc,GAClB,EAAM,KAAO,GAAA,EAAA,CAEf,EAAU,EAAO,EAAA,CACb,EAAQ,OAAS,GACnB,EAAM,KAAA,GAAA,EAAA,CAEJ,EAEN,EAAE,OAAA,CAAA,cAAA,cAAA,EAAA,kBAAA,cAAA"}
+{"version":3,"file":"validations.mjs","names":[],"sources":[],"mappings":""}

package/dist/index.cjs

@@ -1 +1,123 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./types/command.cjs`),t=require(`./types/config.cjs`),n=require(`./types/context.cjs`),r=require(`./types/options.cjs`),i=require(`./api.cjs`);exports.CommandParameterKinds=e.CommandParameterKinds,exports.ShellShockAPI=i.ShellShockAPI,exports.__ΩAsCommandParameterConfig=e.__ΩAsCommandParameterConfig,exports.__ΩBaseBooleanCommandParameter=e.__ΩBaseBooleanCommandParameter,exports.__ΩBaseCommandOptions=r.__ΩBaseCommandOptions,exports.__ΩBaseCommandParameter=e.__ΩBaseCommandParameter,exports.__ΩBaseNumberCommandParameter=e.__ΩBaseNumberCommandParameter,exports.__ΩBaseSingleCommandParameter=e.__ΩBaseSingleCommandParameter,exports.__ΩBaseStringCommandParameter=e.__ΩBaseStringCommandParameter,exports.__ΩBaseVariadicCommandParameter=e.__ΩBaseVariadicCommandParameter,exports.__ΩBooleanCommandOption=e.__ΩBooleanCommandOption,exports.__ΩBooleanCommandParameter=e.__ΩBooleanCommandParameter,exports.__ΩBooleanCommandParameterConfig=e.__ΩBooleanCommandParameterConfig,exports.__ΩCommandArgument=e.__ΩCommandArgument,exports.__ΩCommandArgumentConfig=e.__ΩCommandArgumentConfig,exports.__ΩCommandBase=e.__ΩCommandBase,exports.__ΩCommandConfig=e.__ΩCommandConfig,exports.__ΩCommandMetadata=e.__ΩCommandMetadata,exports.__ΩCommandModule=e.__ΩCommandModule,exports.__ΩCommandOption=e.__ΩCommandOption,exports.__ΩCommandOptionConfig=e.__ΩCommandOptionConfig,exports.__ΩCommandParameter=e.__ΩCommandParameter,exports.__ΩCommandParameterConfig=e.__ΩCommandParameterConfig,exports.__ΩCommandParameterKind=e.__ΩCommandParameterKind,exports.__ΩCommandParameterType=e.__ΩCommandParameterType,exports.__ΩCommandTree=e.__ΩCommandTree,exports.__ΩContext=n.__ΩContext,exports.__ΩNumberCommandParameter=e.__ΩNumberCommandParameter,exports.__ΩNumberCommandParameterConfig=e.__ΩNumberCommandParameterConfig,exports.__ΩOptions=t.__ΩOptions,exports.__ΩOutputConfig=t.__ΩOutputConfig,exports.__ΩReferenceOptions=t.__ΩReferenceOptions,exports.__ΩResolvedConfig=t.__ΩResolvedConfig,exports.__ΩSerializedCommandTree=e.__ΩSerializedCommandTree,exports.__ΩSingleBooleanCommandParameter=e.__ΩSingleBooleanCommandParameter,exports.__ΩSingleNumberCommandParameter=e.__ΩSingleNumberCommandParameter,exports.__ΩSingleStringCommandParameter=e.__ΩSingleStringCommandParameter,exports.__ΩStringCommandParameter=e.__ΩStringCommandParameter,exports.__ΩStringCommandParameterConfig=e.__ΩStringCommandParameterConfig,exports.__ΩUnresolvedContext=n.__ΩUnresolvedContext,exports.__ΩUserConfig=t.__ΩUserConfig,exports.__ΩVariadicBooleanCommandParameter=e.__ΩVariadicBooleanCommandParameter,exports.__ΩVariadicNumberCommandParameter=e.__ΩVariadicNumberCommandParameter,exports.__ΩVariadicStringCommandParameter=e.__ΩVariadicStringCommandParameter,exports.createShellShock=i.createShellShock;
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_config = require('./config.cjs');
+
+//#region src/index.ts
+const __ΩPartial = [
+	"T",
+	"Partial",
+	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
+];
+const __ΩRecord = [
+	"K",
+	"T",
+	"Record",
+	"l'e#\"Rb!b\"Pde\"!N#!w#y"
+];
+/**
+* A utility function to define a Shell Shock command's metadata.
+*
+* @remarks
+* This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+*
+* @example
+* ```ts
+* import { defineMetadata } from '@shell-shock/core';
+*
+* export const metadata = defineMetadata({
+*  name: 'my-command',
+*  title: 'My Custom Command',
+*  icon: '🗲',
+*  description: 'This is my custom command',
+*  alias: ['mc', 'my-cmd'],
+*  tags: ['custom', 'example']
+* });
+* ```
+*
+* @param metadata - A partial user configuration object.
+* @returns A complete user configuration object.
+*/
+function defineMetadata(metadata) {
+	return metadata;
+}
+defineMetadata.__type = [
+	() => __ΩPartial,
+	"CommandMetadata",
+	"metadata",
+	"defineMetadata",
+	"A utility function to define a Shell Shock command's metadata.",
+	"P\"w\"o!\"2#\"w\"/$?%"
+];
+/**
+* A utility function to define a Shell Shock command's options.
+*
+* @remarks
+* This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+*
+* @example
+* ```ts
+* import { defineOptions } from '@shell-shock/core';
+*
+* export const options = defineOptions({
+*  verbose: {
+*    name: 'verbose',
+*    description: 'Enable verbose output',
+*    type: 'boolean'
+*  }
+* });
+* ```
+*
+* @param options - A record of command option configurations.
+* @returns A complete record of command option configurations.
+*/
+function defineOptions(options) {
+	return options;
+}
+defineOptions.__type = [
+	() => __ΩRecord,
+	"CommandOptionConfig",
+	"options",
+	() => __ΩRecord,
+	"defineOptions",
+	"A utility function to define a Shell Shock command's options.",
+	"P&\"w\"o!#2#&\"w\"o$#/%?&"
+];
+/**
+* A utility function to define a Shell Shock command's arguments.
+*
+* @remarks
+* This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+*
+* @example
+* ```ts
+* import { defineArguments } from '@shell-shock/core';
+*
+* export const args = defineArguments([
+*  {
+*    name: 'input',
+*    type: 'string',
+*    description: 'The input file',
+*    required: true
+*  }
+* ]);
+* ```
+*
+* @param args - An array of command argument configurations.
+* @returns A complete array of command argument configurations.
+*/
+function defineArguments(args) {
+	return args;
+}
+defineArguments.__type = [
+	"CommandArgumentConfig",
+	"args",
+	"defineArguments",
+	"A utility function to define a Shell Shock command's arguments.",
+	"P\"w!F2\"\"w!F/#?$"
+];
+
+//#endregion
+exports.defineArguments = defineArguments;
+exports.defineConfig = require_config.defineConfig;
+exports.defineMetadata = defineMetadata;
+exports.defineOptions = defineOptions;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":[],"mappings":""}

package/dist/index.d.cts

@@ -1,6 +1,81 @@
-import { ShellShockAPI, createShellShock } from "./api.cjs";
-import { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterKind, CommandParameterKinds, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter } from "./types/command.cjs";
-import { Context, UnresolvedContext } from "./types/context.cjs";
-import { Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig } from "./types/config.cjs";
+import { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter } from "./types/command.cjs";
+import { Context, ExecutionContext, UnresolvedContext } from "./types/context.cjs";
+import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.cjs";
 import { BaseCommandOptions } from "./types/options.cjs";
-export { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandOptions, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterKind, CommandParameterKinds, CommandParameterType, CommandTree, Context, NumberCommandParameter, NumberCommandParameterConfig, Options, OutputConfig, ReferenceOptions, ResolvedConfig, SerializedCommandTree, ShellShockAPI, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, UnresolvedContext, UserConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter, createShellShock };
+import { defineConfig } from "./config.cjs";
+
+//#region src/index.d.ts
+/**
+ * A utility function to define a Shell Shock command's metadata.
+ *
+ * @remarks
+ * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+ *
+ * @example
+ * ```ts
+ * import { defineMetadata } from '@shell-shock/core';
+ *
+ * export const metadata = defineMetadata({
+ *  name: 'my-command',
+ *  title: 'My Custom Command',
+ *  icon: '🗲',
+ *  description: 'This is my custom command',
+ *  alias: ['mc', 'my-cmd'],
+ *  tags: ['custom', 'example']
+ * });
+ * ```
+ *
+ * @param metadata - A partial user configuration object.
+ * @returns A complete user configuration object.
+ */
+declare function defineMetadata(metadata: Partial<CommandMetadata>): CommandMetadata;
+/**
+ * A utility function to define a Shell Shock command's options.
+ *
+ * @remarks
+ * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+ *
+ * @example
+ * ```ts
+ * import { defineOptions } from '@shell-shock/core';
+ *
+ * export const options = defineOptions({
+ *  verbose: {
+ *    name: 'verbose',
+ *    description: 'Enable verbose output',
+ *    type: 'boolean'
+ *  }
+ * });
+ * ```
+ *
+ * @param options - A record of command option configurations.
+ * @returns A complete record of command option configurations.
+ */
+declare function defineOptions(options: Record<string, CommandOptionConfig>): Record<string, CommandOptionConfig>;
+/**
+ * A utility function to define a Shell Shock command's arguments.
+ *
+ * @remarks
+ * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+ *
+ * @example
+ * ```ts
+ * import { defineArguments } from '@shell-shock/core';
+ *
+ * export const args = defineArguments([
+ *  {
+ *    name: 'input',
+ *    type: 'string',
+ *    description: 'The input file',
+ *    required: true
+ *  }
+ * ]);
+ * ```
+ *
+ * @param args - An array of command argument configurations.
+ * @returns A complete array of command argument configurations.
+ */
+declare function defineArguments(args: CommandArgumentConfig[]): CommandArgumentConfig[];
+//#endregion
+export { type AsCommandParameterConfig, type BaseBooleanCommandParameter, type BaseCommandOptions, type BaseCommandParameter, type BaseNumberCommandParameter, type BaseSingleCommandParameter, type BaseStringCommandParameter, type BaseVariadicCommandParameter, type BooleanCommandOption, type BooleanCommandParameter, type BooleanCommandParameterConfig, type CommandArgument, type CommandArgumentConfig, type CommandBase, type CommandConfig, type CommandMetadata, type CommandModule, type CommandOption, type CommandOptionConfig, type CommandParameter, type CommandParameterConfig, type CommandParameterType, type CommandTree, type Context, type EngineOptions, type ExecutionContext, type NumberCommandParameter, type NumberCommandParameterConfig, type Options, type OutputConfig, type ReferenceOptions, type ResolvedConfig, type SerializedCommandTree, type SingleBooleanCommandParameter, type SingleNumberCommandParameter, type SingleStringCommandParameter, type StringCommandParameter, type StringCommandParameterConfig, type UnresolvedContext, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, type VariadicBooleanCommandParameter, type VariadicNumberCommandParameter, type VariadicStringCommandParameter, defineArguments, defineConfig, defineMetadata, defineOptions };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;;;;AAkDA;;;;;;;;;;;;;AAEkB;AA0BlB;;;;iBA5BgB,cAAA,CACd,QAAA,EAAU,OAAA,CAAQ,eAAA,IACjB,eAAA;;;;;;;;;;;AA4BkC;AA2BrC;;;;;;;;AAEwB;;;iBA/BR,aAAA,CACd,OAAA,EAAS,MAAA,SAAe,mBAAA,IACvB,MAAA,SAAe,mBAAA;;;;;;;;;;;;;;;;;;;;;;;;iBA2BF,eAAA,CACd,IAAA,EAAM,qBAAA,KACL,qBAAqB"}

package/dist/index.d.mts

@@ -1,6 +1,81 @@
-import { ShellShockAPI, createShellShock } from "./api.mjs";
-import { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterKind, CommandParameterKinds, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter } from "./types/command.mjs";
-import { Context, UnresolvedContext } from "./types/context.mjs";
-import { Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig } from "./types/config.mjs";
+import { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter } from "./types/command.mjs";
+import { Context, ExecutionContext, UnresolvedContext } from "./types/context.mjs";
+import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.mjs";
 import { BaseCommandOptions } from "./types/options.mjs";
-export { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandOptions, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterKind, CommandParameterKinds, CommandParameterType, CommandTree, Context, NumberCommandParameter, NumberCommandParameterConfig, Options, OutputConfig, ReferenceOptions, ResolvedConfig, SerializedCommandTree, ShellShockAPI, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, UnresolvedContext, UserConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter, createShellShock };
+import { defineConfig } from "./config.mjs";
+
+//#region src/index.d.ts
+/**
+ * A utility function to define a Shell Shock command's metadata.
+ *
+ * @remarks
+ * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+ *
+ * @example
+ * ```ts
+ * import { defineMetadata } from '@shell-shock/core';
+ *
+ * export const metadata = defineMetadata({
+ *  name: 'my-command',
+ *  title: 'My Custom Command',
+ *  icon: '🗲',
+ *  description: 'This is my custom command',
+ *  alias: ['mc', 'my-cmd'],
+ *  tags: ['custom', 'example']
+ * });
+ * ```
+ *
+ * @param metadata - A partial user configuration object.
+ * @returns A complete user configuration object.
+ */
+declare function defineMetadata(metadata: Partial<CommandMetadata>): CommandMetadata;
+/**
+ * A utility function to define a Shell Shock command's options.
+ *
+ * @remarks
+ * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+ *
+ * @example
+ * ```ts
+ * import { defineOptions } from '@shell-shock/core';
+ *
+ * export const options = defineOptions({
+ *  verbose: {
+ *    name: 'verbose',
+ *    description: 'Enable verbose output',
+ *    type: 'boolean'
+ *  }
+ * });
+ * ```
+ *
+ * @param options - A record of command option configurations.
+ * @returns A complete record of command option configurations.
+ */
+declare function defineOptions(options: Record<string, CommandOptionConfig>): Record<string, CommandOptionConfig>;
+/**
+ * A utility function to define a Shell Shock command's arguments.
+ *
+ * @remarks
+ * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+ *
+ * @example
+ * ```ts
+ * import { defineArguments } from '@shell-shock/core';
+ *
+ * export const args = defineArguments([
+ *  {
+ *    name: 'input',
+ *    type: 'string',
+ *    description: 'The input file',
+ *    required: true
+ *  }
+ * ]);
+ * ```
+ *
+ * @param args - An array of command argument configurations.
+ * @returns A complete array of command argument configurations.
+ */
+declare function defineArguments(args: CommandArgumentConfig[]): CommandArgumentConfig[];
+//#endregion
+export { type AsCommandParameterConfig, type BaseBooleanCommandParameter, type BaseCommandOptions, type BaseCommandParameter, type BaseNumberCommandParameter, type BaseSingleCommandParameter, type BaseStringCommandParameter, type BaseVariadicCommandParameter, type BooleanCommandOption, type BooleanCommandParameter, type BooleanCommandParameterConfig, type CommandArgument, type CommandArgumentConfig, type CommandBase, type CommandConfig, type CommandMetadata, type CommandModule, type CommandOption, type CommandOptionConfig, type CommandParameter, type CommandParameterConfig, type CommandParameterType, type CommandTree, type Context, type EngineOptions, type ExecutionContext, type NumberCommandParameter, type NumberCommandParameterConfig, type Options, type OutputConfig, type ReferenceOptions, type ResolvedConfig, type SerializedCommandTree, type SingleBooleanCommandParameter, type SingleNumberCommandParameter, type SingleStringCommandParameter, type StringCommandParameter, type StringCommandParameterConfig, type UnresolvedContext, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, type VariadicBooleanCommandParameter, type VariadicNumberCommandParameter, type VariadicStringCommandParameter, defineArguments, defineConfig, defineMetadata, defineOptions };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":""}

package/dist/index.mjs

@@ -1 +1,119 @@
-import{CommandParameterKinds as e,__ΩAsCommandParameterConfig as t,__ΩBaseBooleanCommandParameter as n,__ΩBaseCommandParameter as r,__ΩBaseNumberCommandParameter as i,__ΩBaseSingleCommandParameter as a,__ΩBaseStringCommandParameter as o,__ΩBaseVariadicCommandParameter as s,__ΩBooleanCommandOption as c,__ΩBooleanCommandParameter as l,__ΩBooleanCommandParameterConfig as u,__ΩCommandArgument as d,__ΩCommandArgumentConfig as f,__ΩCommandBase as p,__ΩCommandConfig as m,__ΩCommandMetadata as h,__ΩCommandModule as g,__ΩCommandOption as _,__ΩCommandOptionConfig as v,__ΩCommandParameter as y,__ΩCommandParameterConfig as b,__ΩCommandParameterKind as x,__ΩCommandParameterType as S,__ΩCommandTree as C,__ΩNumberCommandParameter as w,__ΩNumberCommandParameterConfig as T,__ΩSerializedCommandTree as E,__ΩSingleBooleanCommandParameter as D,__ΩSingleNumberCommandParameter as O,__ΩSingleStringCommandParameter as k,__ΩStringCommandParameter as A,__ΩStringCommandParameterConfig as j,__ΩVariadicBooleanCommandParameter as M,__ΩVariadicNumberCommandParameter as N,__ΩVariadicStringCommandParameter as P}from"./types/command.mjs";import{__ΩOptions as F,__ΩOutputConfig as I,__ΩReferenceOptions as L,__ΩResolvedConfig as R,__ΩUserConfig as z}from"./types/config.mjs";import{__ΩContext as B,__ΩUnresolvedContext as V}from"./types/context.mjs";import{__ΩBaseCommandOptions as H}from"./types/options.mjs";import{ShellShockAPI as U,createShellShock as W}from"./api.mjs";export{e as CommandParameterKinds,U as ShellShockAPI,t as __ΩAsCommandParameterConfig,n as __ΩBaseBooleanCommandParameter,H as __ΩBaseCommandOptions,r as __ΩBaseCommandParameter,i as __ΩBaseNumberCommandParameter,a as __ΩBaseSingleCommandParameter,o as __ΩBaseStringCommandParameter,s as __ΩBaseVariadicCommandParameter,c as __ΩBooleanCommandOption,l as __ΩBooleanCommandParameter,u as __ΩBooleanCommandParameterConfig,d as __ΩCommandArgument,f as __ΩCommandArgumentConfig,p as __ΩCommandBase,m as __ΩCommandConfig,h as __ΩCommandMetadata,g as __ΩCommandModule,_ as __ΩCommandOption,v as __ΩCommandOptionConfig,y as __ΩCommandParameter,b as __ΩCommandParameterConfig,x as __ΩCommandParameterKind,S as __ΩCommandParameterType,C as __ΩCommandTree,B as __ΩContext,w as __ΩNumberCommandParameter,T as __ΩNumberCommandParameterConfig,F as __ΩOptions,I as __ΩOutputConfig,L as __ΩReferenceOptions,R as __ΩResolvedConfig,E as __ΩSerializedCommandTree,D as __ΩSingleBooleanCommandParameter,O as __ΩSingleNumberCommandParameter,k as __ΩSingleStringCommandParameter,A as __ΩStringCommandParameter,j as __ΩStringCommandParameterConfig,V as __ΩUnresolvedContext,z as __ΩUserConfig,M as __ΩVariadicBooleanCommandParameter,N as __ΩVariadicNumberCommandParameter,P as __ΩVariadicStringCommandParameter,W as createShellShock};
+import { defineConfig } from "./config.mjs";
+
+//#region src/index.ts
+const __ΩPartial = [
+	"T",
+	"Partial",
+	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
+];
+const __ΩRecord = [
+	"K",
+	"T",
+	"Record",
+	"l'e#\"Rb!b\"Pde\"!N#!w#y"
+];
+/**
+* A utility function to define a Shell Shock command's metadata.
+*
+* @remarks
+* This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+*
+* @example
+* ```ts
+* import { defineMetadata } from '@shell-shock/core';
+*
+* export const metadata = defineMetadata({
+*  name: 'my-command',
+*  title: 'My Custom Command',
+*  icon: '🗲',
+*  description: 'This is my custom command',
+*  alias: ['mc', 'my-cmd'],
+*  tags: ['custom', 'example']
+* });
+* ```
+*
+* @param metadata - A partial user configuration object.
+* @returns A complete user configuration object.
+*/
+function defineMetadata(metadata) {
+	return metadata;
+}
+defineMetadata.__type = [
+	() => __ΩPartial,
+	"CommandMetadata",
+	"metadata",
+	"defineMetadata",
+	"A utility function to define a Shell Shock command's metadata.",
+	"P\"w\"o!\"2#\"w\"/$?%"
+];
+/**
+* A utility function to define a Shell Shock command's options.
+*
+* @remarks
+* This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+*
+* @example
+* ```ts
+* import { defineOptions } from '@shell-shock/core';
+*
+* export const options = defineOptions({
+*  verbose: {
+*    name: 'verbose',
+*    description: 'Enable verbose output',
+*    type: 'boolean'
+*  }
+* });
+* ```
+*
+* @param options - A record of command option configurations.
+* @returns A complete record of command option configurations.
+*/
+function defineOptions(options) {
+	return options;
+}
+defineOptions.__type = [
+	() => __ΩRecord,
+	"CommandOptionConfig",
+	"options",
+	() => __ΩRecord,
+	"defineOptions",
+	"A utility function to define a Shell Shock command's options.",
+	"P&\"w\"o!#2#&\"w\"o$#/%?&"
+];
+/**
+* A utility function to define a Shell Shock command's arguments.
+*
+* @remarks
+* This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+*
+* @example
+* ```ts
+* import { defineArguments } from '@shell-shock/core';
+*
+* export const args = defineArguments([
+*  {
+*    name: 'input',
+*    type: 'string',
+*    description: 'The input file',
+*    required: true
+*  }
+* ]);
+* ```
+*
+* @param args - An array of command argument configurations.
+* @returns A complete array of command argument configurations.
+*/
+function defineArguments(args) {
+	return args;
+}
+defineArguments.__type = [
+	"CommandArgumentConfig",
+	"args",
+	"defineArguments",
+	"A utility function to define a Shell Shock command's arguments.",
+	"P\"w!F2\"\"w!F/#?$"
+];
+
+//#endregion
+export { defineArguments, defineConfig, defineMetadata, defineOptions };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":[],"mappings":""}

package/dist/package.cjs

@@ -0,0 +1,12 @@
+
+//#region package.json
+var version = "0.17.10";
+
+//#endregion
+Object.defineProperty(exports, 'version', {
+  enumerable: true,
+  get: function () {
+    return version;
+  }
+});
+//# sourceMappingURL=package.cjs.map

package/dist/package.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.cjs","names":[],"sources":[],"mappings":""}

package/dist/package.mjs

@@ -0,0 +1,6 @@
+//#region package.json
+var version = "0.17.10";
+
+//#endregion
+export { version };
+//# sourceMappingURL=package.mjs.map

package/dist/package.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.mjs","names":[],"sources":[],"mappings":""}

package/dist/plugin-utils/compute-bin.cjs

@@ -1 +1,48 @@
-require(`../_virtual/_rolldown/runtime.cjs`);const e=require(`./context-helpers.cjs`);let t=require(`@stryke/path/join-paths`),n=require(`@alloy-js/core`);function r(e,t){return e.__type=t,e}function i(i){return(0,n.computed)(()=>({id:``,name:e.getAppName(i),title:e.getAppTitle(i),description:e.getAppDescription(i),isVirtual:!0,path:null,segments:[],alias:[],tags:[],source:`file`,options:Object.fromEntries(i.globalOptions.map(r(e=>[e.name,e],[`option`,``,`P"2!"/"`]))),args:[],entry:{file:(0,t.joinPaths)(i.entryPath,`bin.ts`)},parent:null,children:i.commands})).value}i.__type=[`Context`,`context`,`CommandTree`,`computeBin`,`Compute the command tree for the CLI application, starting from the root bin command. This will be used to determine which commands are available in the CLI application and their respective details.`,`P"w!2""w#/$?%`],exports.computeBin=i;
+const require_context_helpers = require('./context-helpers.cjs');
+let _stryke_path_join_paths = require("@stryke/path/join-paths");
+
+//#region src/plugin-utils/compute-bin.ts
+function __assignType(fn, args) {
+	fn.__type = args;
+	return fn;
+}
+/**
+* Computes the command tree for the root binary command based on the provided context.
+*
+* @param context - The plugin context containing the necessary information to compute the command tree.
+* @returns The computed command tree for the root binary command.
+*/
+function computeBin(context) {
+	return {
+		id: "",
+		name: require_context_helpers.getAppName(context),
+		title: require_context_helpers.getAppTitle(context),
+		description: require_context_helpers.getAppDescription(context),
+		virtual: true,
+		path: null,
+		segments: [],
+		alias: [],
+		tags: [],
+		options: Object.fromEntries(context.globalOptions.map(__assignType((option) => [option.name, option], [
+			"option",
+			"",
+			"P\"2!\"/\""
+		]))),
+		args: [],
+		entry: { file: (0, _stryke_path_join_paths.joinPaths)(context.entryPath, "bin.ts") },
+		parent: null,
+		children: context.commands
+	};
+}
+computeBin.__type = [
+	"Context",
+	"context",
+	"CommandTree",
+	"computeBin",
+	"Computes the command tree for the root binary command based on the provided context.",
+	"P\"w!2\"\"w#/$?%"
+];
+
+//#endregion
+exports.computeBin = computeBin;
+//# sourceMappingURL=compute-bin.cjs.map

package/dist/plugin-utils/compute-bin.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"compute-bin.cjs","names":[],"sources":[],"mappings":""}

package/dist/plugin-utils/compute-bin.d.cts

@@ -2,10 +2,10 @@ import { CommandTree } from "../types/command.cjs";
 import { Context } from "../types/context.cjs";
 //#region src/plugin-utils/compute-bin.d.ts
 /**
- * Compute the command tree for the CLI application, starting from the root bin command. This will be used to determine which commands are available in the CLI application and their respective details.
+ * Computes the command tree for the root binary command based on the provided context.
  *
  * @param context - The plugin context containing the necessary information to compute the command tree.
- * @returns The computed command tree for the CLI application, starting from the root bin command. This will include all commands discovered in the project and their respective details, organized in a hierarchical structure based on their segments and paths.
+ * @returns The computed command tree for the root binary command.
  */
 declare function computeBin(context: Context): CommandTree;
 //#endregion

package/dist/plugin-utils/compute-bin.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"compute-bin.d.cts","names":[],"sources":["../../src/plugin-utils/compute-bin.ts"],"mappings":";;;;;;;AA6BA;;iBAAgB,UAAA,CAAW,OAAA,EAAS,OAAA,GAAU,WAAA"}
+{"version":3,"file":"compute-bin.d.cts","names":[],"sources":["../../src/plugin-utils/compute-bin.ts"],"mappings":";;;;;;;AA4BA;;iBAAgB,UAAA,CAAW,OAAA,EAAS,OAAA,GAAU,WAAW"}

package/dist/plugin-utils/compute-bin.d.mts

@@ -2,10 +2,10 @@ import { CommandTree } from "../types/command.mjs";
 import { Context } from "../types/context.mjs";
 //#region src/plugin-utils/compute-bin.d.ts
 /**
- * Compute the command tree for the CLI application, starting from the root bin command. This will be used to determine which commands are available in the CLI application and their respective details.
+ * Computes the command tree for the root binary command based on the provided context.
  *
  * @param context - The plugin context containing the necessary information to compute the command tree.
- * @returns The computed command tree for the CLI application, starting from the root bin command. This will include all commands discovered in the project and their respective details, organized in a hierarchical structure based on their segments and paths.
+ * @returns The computed command tree for the root binary command.
  */
 declare function computeBin(context: Context): CommandTree;
 //#endregion

package/dist/plugin-utils/compute-bin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"compute-bin.d.mts","names":[],"sources":["../../src/plugin-utils/compute-bin.ts"],"mappings":";;;;;;;AA6BA;;iBAAgB,UAAA,CAAW,OAAA,EAAS,OAAA,GAAU,WAAA"}
+{"version":3,"file":"compute-bin.d.mts","names":[],"sources":["../../src/plugin-utils/compute-bin.ts"],"mappings":""}

package/dist/plugin-utils/compute-bin.mjs

@@ -1,2 +1,48 @@
-import{getAppDescription as e,getAppName as t,getAppTitle as n}from"./context-helpers.mjs";import{joinPaths as r}from"@stryke/path/join-paths";import{computed as i}from"@alloy-js/core";function a(e,t){return e.__type=t,e}function o(o){return i(()=>({id:``,name:t(o),title:n(o),description:e(o),isVirtual:!0,path:null,segments:[],alias:[],tags:[],source:`file`,options:Object.fromEntries(o.globalOptions.map(a(e=>[e.name,e],[`option`,``,`P"2!"/"`]))),args:[],entry:{file:r(o.entryPath,`bin.ts`)},parent:null,children:o.commands})).value}o.__type=[`Context`,`context`,`CommandTree`,`computeBin`,`Compute the command tree for the CLI application, starting from the root bin command. This will be used to determine which commands are available in the CLI application and their respective details.`,`P"w!2""w#/$?%`];export{o as computeBin};
+import { getAppDescription, getAppName, getAppTitle } from "./context-helpers.mjs";
+import { joinPaths } from "@stryke/path/join-paths";
+
+//#region src/plugin-utils/compute-bin.ts
+function __assignType(fn, args) {
+	fn.__type = args;
+	return fn;
+}
+/**
+* Computes the command tree for the root binary command based on the provided context.
+*
+* @param context - The plugin context containing the necessary information to compute the command tree.
+* @returns The computed command tree for the root binary command.
+*/
+function computeBin(context) {
+	return {
+		id: "",
+		name: getAppName(context),
+		title: getAppTitle(context),
+		description: getAppDescription(context),
+		virtual: true,
+		path: null,
+		segments: [],
+		alias: [],
+		tags: [],
+		options: Object.fromEntries(context.globalOptions.map(__assignType((option) => [option.name, option], [
+			"option",
+			"",
+			"P\"2!\"/\""
+		]))),
+		args: [],
+		entry: { file: joinPaths(context.entryPath, "bin.ts") },
+		parent: null,
+		children: context.commands
+	};
+}
+computeBin.__type = [
+	"Context",
+	"context",
+	"CommandTree",
+	"computeBin",
+	"Computes the command tree for the root binary command based on the provided context.",
+	"P\"w!2\"\"w#/$?%"
+];
+
+//#endregion
+export { computeBin };
 //# sourceMappingURL=compute-bin.mjs.map

package/dist/plugin-utils/compute-bin.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"compute-bin.mjs","names":[],"sources":["../../src/plugin-utils/compute-bin.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { computed } from \"@alloy-js/core\";\nimport { joinPaths } from \"@stryke/path/join-paths\";\nimport type { CommandTree, Context } from \"../types\";\nimport { getAppDescription, getAppName, getAppTitle } from \"./context-helpers\";\n\n/**\n * Compute the command tree for the CLI application, starting from the root bin command. This will be used to determine which commands are available in the CLI application and their respective details.\n *\n * @param context - The plugin context containing the necessary information to compute the command tree.\n * @returns The computed command tree for the CLI application, starting from the root bin command. This will include all commands discovered in the project and their respective details, organized in a hierarchical structure based on their segments and paths.\n */\nexport function computeBin(context: Context): CommandTree {\n  const bin = computed(() => ({\n    id: \"\",\n    name: getAppName(context),\n    title: getAppTitle(context),\n    description: getAppDescription(context),\n    isVirtual: true,\n    path: null,\n    segments: [],\n    alias: [],\n    tags: [],\n    source: \"file\",\n    options: Object.fromEntries(\n      context.globalOptions.map(option => [option.name, option])\n    ),\n    args: [],\n    entry: {\n      file: joinPaths(context.entryPath, \"bin.ts\")\n    },\n    parent: null,\n    children: context.commands\n  }));\n\n  return bin.value;\n}\n"],"mappings":"yLAAA,SAAS,EAAa,EAAI,EAAM,CAE9B,kBAAO,EA4BT,SAAc,EAAa,EAAG,CAoB5B,OAnBQ,OAAA,CACN,GAAI,GACJ,KAAM,EAAC,EAAY,CACnB,MAAA,EAAa,EAAA,CACb,YAAW,EAAI,EAAA,CACf,UAAU,GACV,KAAA,KACA,SAAS,EAAA,CACT,MAAO,EAAC,CACR,KAAM,EAAE,CACR,OAAQ,OACR,QAAS,OAAC,YAAkB,EAAQ,cAAc,IAAE,EAAO,GAAA,CAAA,EAAA,KAAA,EAAA,CAAA,CAAA,SAAA,GAAA,UAAA,CAAA,CAAA,CAAA,CAC3D,KAAC,EAAA,CACD,MAAO,CACP,KAAO,EAAA,EAAA,UAAA,SAAA,CACN,CACD,OAAC,KACD,SAAQ,EAAI,SACb,EACE,CAAA,MAEL,EAAS,OAAS,CAAA,UAAA,UAAA,cAAA,aAAA,yMAAA,gBAAA"}
+{"version":3,"file":"compute-bin.mjs","names":[],"sources":[],"mappings":""}