@shell-shock/core 0.17.8 → 0.17.11

package/dist/resolver/helpers.cjs

@@ -1 +1,182 @@
-require(`../_virtual/_rolldown/runtime.cjs`);const e=require(`../plugin-utils/context-helpers.cjs`),t=require(`../types/command.cjs`);let n=require(`@stryke/string-format/constant-case`),r=require(`@stryke/type-checks/is-set-string`),i=require(`defu`),a=require(`@stryke/string-format/title-case`),o=require(`@stryke/helpers/get-unique`),s=require(`@stryke/type-checks/is-string`);function c(e,t){return e.__type=t,e}function l(e,n,r=!1,i=!1,o,s){return`A${r&&!s?`n optional`:``} command-line ${n===t.CommandParameterKinds.boolean?`flag`:`option`} that allows the user to ${n===t.CommandParameterKinds.boolean?`set the`:i?`specify custom`:`specify a custom`} ${o?.trim()||(0,a.titleCase)(e)} ${n===t.CommandParameterKinds.boolean?`indicator`:`${n===t.CommandParameterKinds.number?`numeric`:`string`} value${i?`s`:``}`}.`}l.__type=[`name`,`CommandParameterKind`,`kind`,`optional`,`variadic`,`title`,`defaultValue`,`resolveCommandOptionDescription`,`Resolves the description for a command option based on its reflection.`,`P&2!"w"2#"2$"2%&2&8"2'8&/(?)`];function u(e,n,r=!1,i=!1,o,s){return`An${r&&!s?` optional`:``} argument that allows the user to ${n===t.CommandParameterKinds.boolean?`set the`:i?`specify custom`:`specify a custom`} ${o?.trim()||(0,a.titleCase)(e)} ${n===t.CommandParameterKinds.boolean?`indicator`:`${n===t.CommandParameterKinds.number?`numeric`:`string`} value${i?`s`:``}`}.`}u.__type=[`name`,`CommandParameterKind`,`kind`,`optional`,`variadic`,`title`,`defaultValue`,`resolveCommandArgumentDescription`,`Resolves the description for a command argument based on its reflection.`,`P&2!"w"2#"2$"2%&2&8"2'8&/(?)`];function d(e){return Object.fromEntries(Object.entries(e.output.options).map(c(([r,i])=>{let o=i.name||r,s=i.title||(0,a.titleCase)(o);return[r,{...i,name:o,title:s,description:i.description||l(o,i.kind,i.optional,i.kind!==t.CommandParameterKinds.boolean&&i.variadic,s,i.default),env:i.env||i.env===!1?i.env:e.input.context.config.autoAssignEnv?(0,n.constantCase)(o):!1}]},[`param0`,``,`P"2!"/"`])))}d.__type=[`ResolverContext`,`ctx`,`applyOptionsDefaults`,`P"w!2""/#`];function f(e){return e.output.args.map(c((r,i)=>{let o=r.name||`arg${i+1}`,s=r.title||(0,a.titleCase)(o);return{...r,name:o,title:s,description:r.description||u(o,r.kind,r.optional,r.kind!==t.CommandParameterKinds.boolean&&r.variadic,s,r.default),env:r.name?r.env||r.env===!1?r.env:e.input.context.config.autoAssignEnv?(0,n.constantCase)(o):!1:!1}},[`arg`,`i`,``,`P"2!"2""/#`]))}f.__type=[`ResolverContext`,`ctx`,`CommandArgument`,`applyArgsDefaults`,`P"w!2""w#F/$`];function p(t){t.output.description??=`The ${t.output.title.replace(/(?:c|C)ommands?$/,``).trim()} executable command-line interface.`,(0,r.isSetString)(t.input.context.config.reference?.commands)&&t.input.context.config.reference.commands.includes(`{command}`)&&(t.output.reference??=t.input.context.config.reference.commands?t.input.context.config.reference.commands.replace(`{command}`,t.input.command.segments.filter(c(t=>!e.isDynamicPathSegment(t),[`segment`,``,`P"2!"/"`])).join(`/`)):void 0)}p.__type=[`ResolverContext`,`ctx`,`applyDefaults`,`P"w!2""/#`];function m(t){t.output.title??=(0,a.titleCase)(t.input.command.name),t.output.description??=`A collection of available ${t.output.title.replace(/(?:c|C)ommands?$/,``).trim()||(0,a.titleCase)(t.input.command.name)} commands that are included in the ${e.getAppTitle(t.input.context,!0)} command-line application.`}m.__type=[`ResolverContext`,`ctx`,`resolveVirtualCommand`,`P"w!2""/#`];const h=(0,i.createDefu)(c((e,t,n)=>(0,s.isString)(e[t])&&(0,s.isString)(n)?((0,r.isSetString)(n)&&(e[t]=n),!0):Array.isArray(e[t])&&Array.isArray(n)?(n.length>0&&(e[t]=(0,o.getUniqueBy)(e[t].concat(n),c(e=>(0,s.isString)(e)?e:JSON.stringify(e),[`item`,``,`P"2!"/"`]))),!0):!1,[`obj`,`key`,`value`,``,`P"2!"2""2#"/$`]));exports.applyArgsDefaults=f,exports.applyDefaults=p,exports.applyOptionsDefaults=d,exports.mergeCommandParameter=h,exports.resolveVirtualCommand=m;
+const require_context_helpers = require('../plugin-utils/context-helpers.cjs');
+let _stryke_string_format_constant_case = require("@stryke/string-format/constant-case");
+let _stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
+let defu = require("defu");
+let _stryke_string_format_title_case = require("@stryke/string-format/title-case");
+let _stryke_helpers_get_unique = require("@stryke/helpers/get-unique");
+let _stryke_type_checks_is_string = require("@stryke/type-checks/is-string");
+
+//#region src/resolver/helpers.ts
+function __assignType(fn, args) {
+	fn.__type = args;
+	return fn;
+}
+/**
+* Resolves the description for a command option based on its reflection.
+*
+* @param name - The name of the command option.
+* @param type - The reflection kind of the command option.
+* @param required - Whether the command option is required.
+* @param variadic - Whether the command option is variadic (i.e., an array).
+* @param title - The title of the command option, if any.
+* @param defaultValue - The default value of the command option, if any.
+* @returns The resolved description for the command option.
+*/
+function resolveCommandOptionDescription(name, type, required = true, variadic = false, title, defaultValue) {
+	return `A${!required && !defaultValue ? "n optional" : ""} command-line ${type === "boolean" ? "flag" : "option"} that allows the user to ${type === "boolean" ? "set the" : variadic ? "specify custom" : "specify a custom"} ${title?.trim() || (0, _stryke_string_format_title_case.titleCase)(name)} ${type === "boolean" ? "indicator" : `${type === "number" ? "numeric" : "string"} value${variadic ? "s" : ""}`}.`;
+}
+resolveCommandOptionDescription.__type = [
+	"name",
+	"string",
+	"number",
+	"boolean",
+	"type",
+	"required",
+	"variadic",
+	"title",
+	"defaultValue",
+	"resolveCommandOptionDescription",
+	"Resolves the description for a command option based on its reflection.",
+	"P&2!P.\".#.$J2%\"2&\"2'&2(8\"2)8&/*?+"
+];
+/**
+* Resolves the description for a command argument based on its reflection.
+*
+* @param name - The name of the command argument.
+* @param type - The reflection kind of the command argument.
+* @param required - Whether the command argument is required.
+* @param variadic - Whether the command argument is variadic (i.e., an array).
+* @param title - The title of the command argument, if any.
+* @param defaultValue - The default value of the command argument, if any.
+* @returns The resolved description for the command argument.
+*/
+function resolveCommandArgumentDescription(name, type, required = true, variadic = false, title, defaultValue) {
+	return `An${!required && !defaultValue ? " optional" : ""} argument that allows the user to ${type === "boolean" ? "set the" : variadic ? "specify custom" : "specify a custom"} ${title?.trim() || (0, _stryke_string_format_title_case.titleCase)(name)} ${type === "boolean" ? "indicator" : `${type === "number" ? "numeric" : "string"} value${variadic ? "s" : ""}`}.`;
+}
+resolveCommandArgumentDescription.__type = [
+	"name",
+	"string",
+	"number",
+	"boolean",
+	"type",
+	"required",
+	"variadic",
+	"title",
+	"defaultValue",
+	"resolveCommandArgumentDescription",
+	"Resolves the description for a command argument based on its reflection.",
+	"P&2!P.\".#.$J2%\"2&\"2'&2(8\"2)8&/*?+"
+];
+function applyOptionsDefaults(ctx) {
+	return Object.fromEntries(Object.entries(ctx.output.options).map(__assignType(([key, option]) => {
+		const name = option.name || key;
+		const title = option.title || (0, _stryke_string_format_title_case.titleCase)(name);
+		return [key, {
+			...option,
+			name,
+			title,
+			description: option.description || resolveCommandOptionDescription(name, option.type, option.required, option.type !== "boolean" && option.variadic, title, option.default),
+			env: option.env || option.env === false ? option.env : ctx.input.context.config.autoAssignEnv ? (0, _stryke_string_format_constant_case.constantCase)(name) : false
+		}];
+	}, [
+		"param0",
+		"",
+		"P\"2!\"/\""
+	])));
+}
+applyOptionsDefaults.__type = [
+	"ResolverContext",
+	"ctx",
+	"applyOptionsDefaults",
+	"P\"w!2\"\"/#"
+];
+function applyArgsDefaults(ctx) {
+	return ctx.output.args.map(__assignType((arg, i) => {
+		const name = arg.name || `arg${i + 1}`;
+		const title = arg.title || (0, _stryke_string_format_title_case.titleCase)(name);
+		return {
+			...arg,
+			name,
+			title,
+			description: arg.description || resolveCommandArgumentDescription(name, arg.type, arg.required, arg.type !== "boolean" && arg.variadic, title, arg.default),
+			env: arg.name ? arg.env || arg.env === false ? arg.env : ctx.input.context.config.autoAssignEnv ? (0, _stryke_string_format_constant_case.constantCase)(name) : false : false
+		};
+	}, [
+		"arg",
+		"i",
+		"",
+		"P\"2!\"2\"\"/#"
+	]));
+}
+applyArgsDefaults.__type = [
+	"ResolverContext",
+	"ctx",
+	"CommandArgument",
+	"applyArgsDefaults",
+	"P\"w!2\"\"w#F/$"
+];
+function applyDefaults(ctx) {
+	ctx.output.description ??= `The ${ctx.output.title.replace(/(?:c|C)ommands?$/, "").trim()} executable command-line interface.`;
+	if ((0, _stryke_type_checks_is_set_string.isSetString)(ctx.input.context.config.reference?.commands) && ctx.input.context.config.reference.commands.includes("{command}")) ctx.output.docs ??= ctx.input.context.config.reference.commands ? ctx.input.context.config.reference.commands.replace("{command}", ctx.input.command.segments.filter(__assignType((segment) => !require_context_helpers.isDynamicPathSegment(segment), [
+		"segment",
+		"",
+		"P\"2!\"/\""
+	])).join("/")) : void 0;
+}
+applyDefaults.__type = [
+	"ResolverContext",
+	"ctx",
+	"applyDefaults",
+	"P\"w!2\"\"/#"
+];
+/**
+* Resolves a virtual command by applying default values to its title and description based on the command name and application title.
+*
+* @template TContext - The type of the context object.
+* @param ctx - The resolver context containing the input and output for the command resolution process.
+*/
+function resolveVirtualCommand(ctx) {
+	ctx.output.title ??= (0, _stryke_string_format_title_case.titleCase)(ctx.input.command.name);
+	ctx.output.description ??= `A collection of available ${ctx.output.title.replace(/(?:c|C)ommands?$/, "").trim() || (0, _stryke_string_format_title_case.titleCase)(ctx.input.command.name)} commands that are included in the ${require_context_helpers.getAppTitle(ctx.input.context, true)} command-line application.`;
+}
+resolveVirtualCommand.__type = [
+	"ResolverContext",
+	"ctx",
+	"resolveVirtualCommand",
+	"Resolves a virtual command by applying default values to its title and description based on the command name and application title.",
+	"P\"w!2\"\"/#?$"
+];
+/**
+* Merges two command parameters, giving precedence to string values in the second configuration.
+*
+* @param objA - The first command parameter object.
+* @param objB - The second command parameter object.
+* @returns The merged command parameter object.
+*/
+const mergeCommandParameter = (0, defu.createDefu)(__assignType((obj, key, value) => {
+	if ((0, _stryke_type_checks_is_string.isString)(obj[key]) && (0, _stryke_type_checks_is_string.isString)(value)) {
+		if ((0, _stryke_type_checks_is_set_string.isSetString)(value)) obj[key] = value;
+		return true;
+	} else if (Array.isArray(obj[key]) && Array.isArray(value)) {
+		if (value.length > 0) obj[key] = (0, _stryke_helpers_get_unique.getUniqueBy)(obj[key].concat(value), __assignType((item) => (0, _stryke_type_checks_is_string.isString)(item) ? item : JSON.stringify(item), [
+			"item",
+			"",
+			"P\"2!\"/\""
+		]));
+		return true;
+	}
+	return false;
+}, [
+	"obj",
+	"key",
+	"value",
+	"",
+	"P\"2!\"2\"\"2#\"/$"
+]));
+
+//#endregion
+exports.applyArgsDefaults = applyArgsDefaults;
+exports.applyDefaults = applyDefaults;
+exports.applyOptionsDefaults = applyOptionsDefaults;
+exports.resolveVirtualCommand = resolveVirtualCommand;
+//# sourceMappingURL=helpers.cjs.map

package/dist/resolver/helpers.cjs.map

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

package/dist/resolver/helpers.mjs

@@ -1,2 +1,179 @@
-import{getAppTitle as e,isDynamicPathSegment as t}from"../plugin-utils/context-helpers.mjs";import{CommandParameterKinds as n}from"../types/command.mjs";import{constantCase as r}from"@stryke/string-format/constant-case";import{isSetString as i}from"@stryke/type-checks/is-set-string";import{createDefu as a}from"defu";import{titleCase as o}from"@stryke/string-format/title-case";import{getUniqueBy as s}from"@stryke/helpers/get-unique";import{isString as c}from"@stryke/type-checks/is-string";function l(e,t){return e.__type=t,e}function u(e,t,r=!1,i=!1,a,s){return`A${r&&!s?`n optional`:``} command-line ${t===n.boolean?`flag`:`option`} that allows the user to ${t===n.boolean?`set the`:i?`specify custom`:`specify a custom`} ${a?.trim()||o(e)} ${t===n.boolean?`indicator`:`${t===n.number?`numeric`:`string`} value${i?`s`:``}`}.`}u.__type=[`name`,`CommandParameterKind`,`kind`,`optional`,`variadic`,`title`,`defaultValue`,`resolveCommandOptionDescription`,`Resolves the description for a command option based on its reflection.`,`P&2!"w"2#"2$"2%&2&8"2'8&/(?)`];function d(e,t,r=!1,i=!1,a,s){return`An${r&&!s?` optional`:``} argument that allows the user to ${t===n.boolean?`set the`:i?`specify custom`:`specify a custom`} ${a?.trim()||o(e)} ${t===n.boolean?`indicator`:`${t===n.number?`numeric`:`string`} value${i?`s`:``}`}.`}d.__type=[`name`,`CommandParameterKind`,`kind`,`optional`,`variadic`,`title`,`defaultValue`,`resolveCommandArgumentDescription`,`Resolves the description for a command argument based on its reflection.`,`P&2!"w"2#"2$"2%&2&8"2'8&/(?)`];function f(e){return Object.fromEntries(Object.entries(e.output.options).map(l(([t,i])=>{let a=i.name||t,s=i.title||o(a);return[t,{...i,name:a,title:s,description:i.description||u(a,i.kind,i.optional,i.kind!==n.boolean&&i.variadic,s,i.default),env:i.env||i.env===!1?i.env:e.input.context.config.autoAssignEnv?r(a):!1}]},[`param0`,``,`P"2!"/"`])))}f.__type=[`ResolverContext`,`ctx`,`applyOptionsDefaults`,`P"w!2""/#`];function p(e){return e.output.args.map(l((t,i)=>{let a=t.name||`arg${i+1}`,s=t.title||o(a);return{...t,name:a,title:s,description:t.description||d(a,t.kind,t.optional,t.kind!==n.boolean&&t.variadic,s,t.default),env:t.name?t.env||t.env===!1?t.env:e.input.context.config.autoAssignEnv?r(a):!1:!1}},[`arg`,`i`,``,`P"2!"2""/#`]))}p.__type=[`ResolverContext`,`ctx`,`CommandArgument`,`applyArgsDefaults`,`P"w!2""w#F/$`];function m(e){e.output.description??=`The ${e.output.title.replace(/(?:c|C)ommands?$/,``).trim()} executable command-line interface.`,i(e.input.context.config.reference?.commands)&&e.input.context.config.reference.commands.includes(`{command}`)&&(e.output.reference??=e.input.context.config.reference.commands?e.input.context.config.reference.commands.replace(`{command}`,e.input.command.segments.filter(l(e=>!t(e),[`segment`,``,`P"2!"/"`])).join(`/`)):void 0)}m.__type=[`ResolverContext`,`ctx`,`applyDefaults`,`P"w!2""/#`];function h(t){t.output.title??=o(t.input.command.name),t.output.description??=`A collection of available ${t.output.title.replace(/(?:c|C)ommands?$/,``).trim()||o(t.input.command.name)} commands that are included in the ${e(t.input.context,!0)} command-line application.`}h.__type=[`ResolverContext`,`ctx`,`resolveVirtualCommand`,`P"w!2""/#`];const g=a(l((e,t,n)=>c(e[t])&&c(n)?(i(n)&&(e[t]=n),!0):Array.isArray(e[t])&&Array.isArray(n)?(n.length>0&&(e[t]=s(e[t].concat(n),l(e=>c(e)?e:JSON.stringify(e),[`item`,``,`P"2!"/"`]))),!0):!1,[`obj`,`key`,`value`,``,`P"2!"2""2#"/$`]));export{p as applyArgsDefaults,m as applyDefaults,f as applyOptionsDefaults,g as mergeCommandParameter,h as resolveVirtualCommand};
+import { getAppTitle, isDynamicPathSegment } from "../plugin-utils/context-helpers.mjs";
+import { constantCase } from "@stryke/string-format/constant-case";
+import { isSetString } from "@stryke/type-checks/is-set-string";
+import { createDefu } from "defu";
+import { titleCase } from "@stryke/string-format/title-case";
+import { getUniqueBy } from "@stryke/helpers/get-unique";
+import { isString } from "@stryke/type-checks/is-string";
+
+//#region src/resolver/helpers.ts
+function __assignType(fn, args) {
+	fn.__type = args;
+	return fn;
+}
+/**
+* Resolves the description for a command option based on its reflection.
+*
+* @param name - The name of the command option.
+* @param type - The reflection kind of the command option.
+* @param required - Whether the command option is required.
+* @param variadic - Whether the command option is variadic (i.e., an array).
+* @param title - The title of the command option, if any.
+* @param defaultValue - The default value of the command option, if any.
+* @returns The resolved description for the command option.
+*/
+function resolveCommandOptionDescription(name, type, required = true, variadic = false, title, defaultValue) {
+	return `A${!required && !defaultValue ? "n optional" : ""} command-line ${type === "boolean" ? "flag" : "option"} that allows the user to ${type === "boolean" ? "set the" : variadic ? "specify custom" : "specify a custom"} ${title?.trim() || titleCase(name)} ${type === "boolean" ? "indicator" : `${type === "number" ? "numeric" : "string"} value${variadic ? "s" : ""}`}.`;
+}
+resolveCommandOptionDescription.__type = [
+	"name",
+	"string",
+	"number",
+	"boolean",
+	"type",
+	"required",
+	"variadic",
+	"title",
+	"defaultValue",
+	"resolveCommandOptionDescription",
+	"Resolves the description for a command option based on its reflection.",
+	"P&2!P.\".#.$J2%\"2&\"2'&2(8\"2)8&/*?+"
+];
+/**
+* Resolves the description for a command argument based on its reflection.
+*
+* @param name - The name of the command argument.
+* @param type - The reflection kind of the command argument.
+* @param required - Whether the command argument is required.
+* @param variadic - Whether the command argument is variadic (i.e., an array).
+* @param title - The title of the command argument, if any.
+* @param defaultValue - The default value of the command argument, if any.
+* @returns The resolved description for the command argument.
+*/
+function resolveCommandArgumentDescription(name, type, required = true, variadic = false, title, defaultValue) {
+	return `An${!required && !defaultValue ? " optional" : ""} argument that allows the user to ${type === "boolean" ? "set the" : variadic ? "specify custom" : "specify a custom"} ${title?.trim() || titleCase(name)} ${type === "boolean" ? "indicator" : `${type === "number" ? "numeric" : "string"} value${variadic ? "s" : ""}`}.`;
+}
+resolveCommandArgumentDescription.__type = [
+	"name",
+	"string",
+	"number",
+	"boolean",
+	"type",
+	"required",
+	"variadic",
+	"title",
+	"defaultValue",
+	"resolveCommandArgumentDescription",
+	"Resolves the description for a command argument based on its reflection.",
+	"P&2!P.\".#.$J2%\"2&\"2'&2(8\"2)8&/*?+"
+];
+function applyOptionsDefaults(ctx) {
+	return Object.fromEntries(Object.entries(ctx.output.options).map(__assignType(([key, option]) => {
+		const name = option.name || key;
+		const title = option.title || titleCase(name);
+		return [key, {
+			...option,
+			name,
+			title,
+			description: option.description || resolveCommandOptionDescription(name, option.type, option.required, option.type !== "boolean" && option.variadic, title, option.default),
+			env: option.env || option.env === false ? option.env : ctx.input.context.config.autoAssignEnv ? constantCase(name) : false
+		}];
+	}, [
+		"param0",
+		"",
+		"P\"2!\"/\""
+	])));
+}
+applyOptionsDefaults.__type = [
+	"ResolverContext",
+	"ctx",
+	"applyOptionsDefaults",
+	"P\"w!2\"\"/#"
+];
+function applyArgsDefaults(ctx) {
+	return ctx.output.args.map(__assignType((arg, i) => {
+		const name = arg.name || `arg${i + 1}`;
+		const title = arg.title || titleCase(name);
+		return {
+			...arg,
+			name,
+			title,
+			description: arg.description || resolveCommandArgumentDescription(name, arg.type, arg.required, arg.type !== "boolean" && arg.variadic, title, arg.default),
+			env: arg.name ? arg.env || arg.env === false ? arg.env : ctx.input.context.config.autoAssignEnv ? constantCase(name) : false : false
+		};
+	}, [
+		"arg",
+		"i",
+		"",
+		"P\"2!\"2\"\"/#"
+	]));
+}
+applyArgsDefaults.__type = [
+	"ResolverContext",
+	"ctx",
+	"CommandArgument",
+	"applyArgsDefaults",
+	"P\"w!2\"\"w#F/$"
+];
+function applyDefaults(ctx) {
+	ctx.output.description ??= `The ${ctx.output.title.replace(/(?:c|C)ommands?$/, "").trim()} executable command-line interface.`;
+	if (isSetString(ctx.input.context.config.reference?.commands) && ctx.input.context.config.reference.commands.includes("{command}")) ctx.output.docs ??= ctx.input.context.config.reference.commands ? ctx.input.context.config.reference.commands.replace("{command}", ctx.input.command.segments.filter(__assignType((segment) => !isDynamicPathSegment(segment), [
+		"segment",
+		"",
+		"P\"2!\"/\""
+	])).join("/")) : void 0;
+}
+applyDefaults.__type = [
+	"ResolverContext",
+	"ctx",
+	"applyDefaults",
+	"P\"w!2\"\"/#"
+];
+/**
+* Resolves a virtual command by applying default values to its title and description based on the command name and application title.
+*
+* @template TContext - The type of the context object.
+* @param ctx - The resolver context containing the input and output for the command resolution process.
+*/
+function resolveVirtualCommand(ctx) {
+	ctx.output.title ??= titleCase(ctx.input.command.name);
+	ctx.output.description ??= `A collection of available ${ctx.output.title.replace(/(?:c|C)ommands?$/, "").trim() || titleCase(ctx.input.command.name)} commands that are included in the ${getAppTitle(ctx.input.context, true)} command-line application.`;
+}
+resolveVirtualCommand.__type = [
+	"ResolverContext",
+	"ctx",
+	"resolveVirtualCommand",
+	"Resolves a virtual command by applying default values to its title and description based on the command name and application title.",
+	"P\"w!2\"\"/#?$"
+];
+/**
+* Merges two command parameters, giving precedence to string values in the second configuration.
+*
+* @param objA - The first command parameter object.
+* @param objB - The second command parameter object.
+* @returns The merged command parameter object.
+*/
+const mergeCommandParameter = createDefu(__assignType((obj, key, value) => {
+	if (isString(obj[key]) && isString(value)) {
+		if (isSetString(value)) obj[key] = value;
+		return true;
+	} else if (Array.isArray(obj[key]) && Array.isArray(value)) {
+		if (value.length > 0) obj[key] = getUniqueBy(obj[key].concat(value), __assignType((item) => isString(item) ? item : JSON.stringify(item), [
+			"item",
+			"",
+			"P\"2!\"/\""
+		]));
+		return true;
+	}
+	return false;
+}, [
+	"obj",
+	"key",
+	"value",
+	"",
+	"P\"2!\"2\"\"2#\"/$"
+]));
+
+//#endregion
+export { applyArgsDefaults, applyDefaults, applyOptionsDefaults, resolveVirtualCommand };
 //# sourceMappingURL=helpers.mjs.map

package/dist/resolver/helpers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.mjs","names":[],"sources":["../../src/resolver/helpers.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 { getUniqueBy } from \"@stryke/helpers/get-unique\";\nimport { constantCase } from \"@stryke/string-format/constant-case\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { isString } from \"@stryke/type-checks/is-string\";\nimport { createDefu } from \"defu\";\nimport {\n  getAppTitle,\n  isDynamicPathSegment\n} from \"../plugin-utils/context-helpers\";\nimport type { CommandArgument, CommandParameterKind } from \"../types/command\";\nimport { CommandParameterKinds } from \"../types/command\";\nimport type { Context } from \"../types/context\";\nimport type { ResolverContext } from \"./types\";\n\n/**\n * Resolves the description for a command option based on its reflection.\n *\n * @param name - The name of the command option.\n * @param kind - The reflection kind of the command option.\n * @param optional - Whether the command option is optional.\n * @param variadic - Whether the command option is variadic (i.e., an array).\n * @param title - The title of the command option, if any.\n * @param defaultValue - The default value of the command option, if any.\n * @returns The resolved description for the command option.\n */\nexport function resolveCommandOptionDescription(\n  name: string,\n  kind: CommandParameterKind,\n  optional = false,\n  variadic = false,\n  title?: string,\n  defaultValue?: any\n): string {\n  return `A${optional && !defaultValue ? \"n optional\" : \"\"} command-line ${\n    kind === CommandParameterKinds.boolean ? \"flag\" : \"option\"\n  } that allows the user to ${\n    kind === CommandParameterKinds.boolean\n      ? \"set the\"\n      : variadic\n        ? \"specify custom\"\n        : \"specify a custom\"\n  } ${title?.trim() || titleCase(name)} ${\n    kind === CommandParameterKinds.boolean\n      ? \"indicator\"\n      : `${kind === CommandParameterKinds.number ? \"numeric\" : \"string\"} value${\n          variadic ? \"s\" : \"\"\n        }`\n  }.`;\n}\n\n/**\n * Resolves the description for a command argument based on its reflection.\n *\n * @param name - The name of the command argument.\n * @param kind - The reflection kind of the command argument.\n * @param optional - Whether the command argument is optional.\n * @param variadic - Whether the command argument is variadic (i.e., an array).\n * @param title - The title of the command argument, if any.\n * @param defaultValue - The default value of the command argument, if any.\n * @returns The resolved description for the command argument.\n */\nexport function resolveCommandArgumentDescription(\n  name: string,\n  kind: CommandParameterKind,\n  optional = false,\n  variadic = false,\n  title?: string,\n  defaultValue?: any\n): string {\n  return `An${\n    optional && !defaultValue ? \" optional\" : \"\"\n  } argument that allows the user to ${\n    kind === CommandParameterKinds.boolean\n      ? \"set the\"\n      : variadic\n        ? \"specify custom\"\n        : \"specify a custom\"\n  } ${title?.trim() || titleCase(name)} ${\n    kind === CommandParameterKinds.boolean\n      ? \"indicator\"\n      : `${kind === CommandParameterKinds.number ? \"numeric\" : \"string\"} value${\n          variadic ? \"s\" : \"\"\n        }`\n  }.`;\n}\n\nexport function applyOptionsDefaults(ctx: ResolverContext) {\n  return Object.fromEntries(\n    Object.entries(ctx.output.options).map(([key, option]) => {\n      const name = option.name || key;\n      const title = option.title || titleCase(name);\n\n      return [\n        key,\n        {\n          ...option,\n          name,\n          title,\n          description:\n            option.description ||\n            resolveCommandOptionDescription(\n              name,\n              option.kind,\n              option.optional,\n              option.kind !== CommandParameterKinds.boolean && option.variadic,\n              title,\n              option.default\n            ),\n          env:\n            option.env || option.env === false\n              ? option.env\n              : ctx.input.context.config.autoAssignEnv\n                ? constantCase(name)\n                : false\n        }\n      ];\n    })\n  );\n}\n\nexport function applyArgsDefaults(ctx: ResolverContext): CommandArgument[] {\n  return ctx.output.args.map((arg, i) => {\n    const name = arg.name || `arg${i + 1}`;\n    const title = arg.title || titleCase(name);\n\n    return {\n      ...arg,\n      name,\n      title,\n      description:\n        arg.description ||\n        resolveCommandArgumentDescription(\n          name,\n          arg.kind,\n          arg.optional,\n          arg.kind !== CommandParameterKinds.boolean && arg.variadic,\n          title,\n          arg.default\n        ),\n      env: arg.name\n        ? arg.env || arg.env === false\n          ? arg.env\n          : ctx.input.context.config.autoAssignEnv\n            ? constantCase(name)\n            : false\n        : false\n    };\n  });\n}\n\nexport function applyDefaults(ctx: ResolverContext) {\n  ctx.output.description ??= `The ${ctx.output.title.replace(/(?:c|C)ommands?$/, \"\").trim()} executable command-line interface.`;\n  if (\n    isSetString(ctx.input.context.config.reference?.commands) &&\n    ctx.input.context.config.reference.commands.includes(\"{command}\")\n  ) {\n    ctx.output.reference ??= ctx.input.context.config.reference.commands\n      ? ctx.input.context.config.reference.commands.replace(\n          \"{command}\",\n          ctx.input.command.segments\n            .filter(segment => !isDynamicPathSegment(segment))\n            .join(\"/\")\n        )\n      : undefined;\n  }\n}\n\nexport function resolveVirtualCommand<TContext extends Context = Context>(\n  ctx: ResolverContext<TContext>\n) {\n  ctx.output.title ??= titleCase(ctx.input.command.name);\n  ctx.output.description ??= `A collection of available ${\n    ctx.output.title.replace(/(?:c|C)ommands?$/, \"\").trim() ||\n    titleCase(ctx.input.command.name)\n  } commands that are included in the ${getAppTitle(\n    ctx.input.context,\n    true\n  )} command-line application.`;\n}\n\n/**\n * Merges two command parameters, giving precedence to string values in the second configuration.\n *\n * @param objA - The first command parameter object.\n * @param objB - The second command parameter object.\n * @returns The merged command parameter object.\n */\nexport const mergeCommandParameter = createDefu((obj, key, value) => {\n  if (isString(obj[key]) && isString(value)) {\n    if (isSetString(value)) {\n      obj[key] = value;\n    }\n\n    return true;\n  } else if (Array.isArray(obj[key]) && Array.isArray(value)) {\n    if (value.length > 0) {\n      obj[key] = getUniqueBy((obj[key] as unknown[]).concat(value), item =>\n        isString(item) ? item : JSON.stringify(item)\n      ) as (typeof obj)[typeof key];\n    }\n\n    return true;\n  }\n\n  return false;\n});\n"],"mappings":"6eAAA,SAAS,EAAa,EAAI,EAAM,CAE9B,kBAAO,EAsCT,SAAgB,EAA2B,EAAW,EAAG,EAAA,GAAA,EAAA,GAAA,EAAA,EAAA,CACvD,MAAO,IAAC,GAAe,CAAA,EAAY,aAAa,GAAQ,gBAAc,IAAA,EAAA,QAAA,OAAA,SAAA,2BAAA,IAAA,EAAA,QAAA,UAAA,EAAA,iBAAA,mBAAA,GAAA,GAAA,MAAA,EAAA,EAAA,EAAA,CAAA,GAAA,IAAA,EAAA,QAAA,YAAA,GAAA,IAAA,EAAA,OAAA,UAAA,SAAA,QAAA,EAAA,IAAA,KAAA,GAExE,EAAE,OAAA,CAAA,OAAA,uBAAA,OAAA,WAAA,WAAA,QAAA,eAAA,kCAAA,yEAAA,+BAAA,CAYF,SAAa,EAAsB,EAAA,EAAA,EAAA,GAAA,EAAA,GAAA,EAAA,EAAA,CACjC,MAAO,KAAI,GAAG,CAAA,EAAA,YAAA,GAAA,oCAAA,IAAA,EAAA,QAAA,UAAA,EAAA,iBAAA,mBAAA,GAAA,GAAA,MAAA,EAAA,EAAA,EAAA,CAAA,GAAA,IAAA,EAAA,QAAA,YAAA,GAAA,IAAA,EAAA,OAAA,UAAA,SAAA,QAAA,EAAA,IAAA,KAAA,GAEhB,EAAyB,OAAA,CAAA,OAAA,uBAAA,OAAA,WAAA,WAAA,QAAA,eAAA,oCAAA,2EAAA,+BAAA,CACzB,SAAW,EAAgB,EAAA,CACzB,OAAI,OAAO,YAAU,OAAU,QAAQ,EAAA,OAAA,QAAA,CAAA,IAAA,GAAA,CAAA,EAAA,KAAA,CACrC,IAAM,EAAG,EAAA,MAAA,EACJ,EAAS,EAAA,OAAA,EAAA,EAAA,CACd,MAAO,CAAA,EAAM,CACX,GAAG,EACH,OACD,QACL,YAAA,EAAA,aAAA,EAAA,EAAA,EAAA,KAAA,EAAA,SAAA,EAAA,OAAA,EAAA,SAAA,EAAA,SAAA,EAAA,EAAA,QAAA,0EAEE,CAAA,EACC,CAAA,SAAa,GAAA,UAAY,CAAG,CAAC,CAAC,CAEjC,EAAqB,OAAQ,CAAA,kBAAoB,MAAA,uBAAA,YAAA,CACjD,SAAgB,EAAgB,EAAO,CACrC,OAAO,EAAC,OAAU,KAAC,IAAQ,GAAY,EAAA,IAAY,CACjD,IAAM,EAAA,EAAW,MAAQ,MAAI,EAAA,IACvB,EAAQ,EAAI,OAAS,EAAI,EAAQ,CACvC,MAAM,CACN,GAAA,EACF,OACI,QACA,YAAQ,EAAA,aAAA,EAAA,EAAA,EAAA,KAAA,EAAA,SAAA,EAAA,OAAA,EAAA,SAAA,EAAA,SAAA,EAAA,EAAA,QAAA,CACR,IAAE,EAAA,KAAA,EAAA,KAAoB,EAAA,MAAA,GAAA,EAAA,IAAA,EAAA,MAAA,QAAA,OAAA,cAAA,EAAA,EAAA,CAAA,GAAA,GAC1B,EACA,CAAA,MAAW,IAAK,GAAA,aAAA,CAAA,CAAA,CAElB,EAAiB,OAAA,CAAA,kBAAA,MAAA,kBAAA,oBAAA,eAAA,CACjB,SAAU,EAAA,EAAA,CACR,EAAA,OAAW,cAAA,OAAA,EAAA,OAAA,MAAA,QAAA,mBAAA,GAAA,CAAA,MAAA,CAAA,qCACT,EAAa,EAAA,MAAA,QAAiB,OAAS,WAAI,SAAA,EAAA,EAAA,MAAA,QAAA,OAAA,UAAA,SAAA,SAAA,YAAA,GAC3C,EAAA,OAAS,YAAgB,EAAI,MAAK,QAAA,OAAA,UAAA,SAAA,EAAA,MAAA,QAAA,OAAA,UAAA,SAAA,QAAA,YAAA,EAAA,MAAA,QAAA,SAAA,OAAA,EAAA,GAAA,CAAA,EAAA,EAAA,CAAA,CAAA,UAAA,GAAA,UAAA,CAAA,CAAA,CAAA,KAAA,IAAA,CAAA,CAAA,IAAA,IAGtC,EAAQ,OAAA,CAAA,kBAAA,MAAA,gBAAA,YAAA,CACR,SAAW,EAAc,EAAA,CACvB,EAAI,OAAK,QAAU,EAAM,EAAA,MAAA,QAAA,KAAA,CACzB,EAAI,OAAO,cAAU,6BAAkB,EAAA,OAAA,MAAA,QAAA,mBAAA,GAAA,CAAA,MAAA,EAAA,EAAA,EAAA,MAAA,QAAA,KAAA,CAAA,qCAAA,EAAA,EAAA,MAAA,QAAA,GAAA,CAAA,4BAEzC,EAAkB,OAAA,CAAA,kBAAA,MAAA,wBAAA,YAAA,CAQlB,MAAS,EAAkB,EAAA,GAAA,EAAA,EAAA,IACvB,EAAO,EAAQ,GAAI,EAAA,EAAc,EAAM,EACrC,EAAa,EAAO,GACpB,EAAA,GAAW,GAEX,IACK,MAAA,QAAA,EAAA,GAAA,EAAA,MAAA,QAAA,EAAA,EACH,EAAA,OAAA,IACF,EAAI,GAAG,EAAM,EAAA,GAAA,OAAA,EAAA,CAAA,EAAA,GAAA,EAAA,EAAA,CAAA,EAAA,KAAA,UAAA,EAAA,CAAA,CAAA,OAAA,GAAA,UAAA,CAAA,CAAA,EAET,IAED,GACN,CAAC,MAAO,MAAC,QAAA,GAAA,gBAA+B,CAAA,CAAA"}
+{"version":3,"file":"helpers.mjs","names":[],"sources":[],"mappings":""}