@shell-shock/core 0.2.1 → 0.3.0

package/dist/helpers/validations.cjs

@@ -0,0 +1,97 @@
+const require_plugin_utils_context_helpers = require('../plugin-utils/context-helpers.cjs');
+
+//#region src/helpers/validations.ts
+function validateCommandVariablePaths(command) {
+	const failures = [];
+	if (!command.isVirtual && command.path.segments.length > 0) {
+		const variablePathNames = /* @__PURE__ */ new Set();
+		for (const segment of command.path.segments.filter(require_plugin_utils_context_helpers.isVariableCommandPath) ?? []) {
+			if (variablePathNames.has(segment)) failures.push({
+				code: "DUPLICATE_VARIABLE_PATH_NAME",
+				details: `Duplicate variable path name "${require_plugin_utils_context_helpers.getVariableCommandPathName(segment)}" found in command.`
+			});
+			variablePathNames.add(require_plugin_utils_context_helpers.getVariableCommandPathName(segment));
+		}
+		if (command.path.segments.filter(require_plugin_utils_context_helpers.isVariableCommandPath).length !== Object.keys(command.path.variables ?? {}).length) failures.push({
+			code: "VARIABLE_PATH_MISMATCH",
+			details: `Mismatch between variable path segments and defined path variables in command (found ${command.path.segments.filter(require_plugin_utils_context_helpers.isVariableCommandPath).length} variables in the command folder path "${command.path.segments.join("/")}", but ${Object.keys(command.path.variables ?? {}).length} potential variable path(s) could be determined from the command's function signature).`
+		});
+		const missing = command.path.segments.filter(require_plugin_utils_context_helpers.isVariableCommandPath).filter((segment) => Object.prototype.hasOwnProperty.call(command.path.variables ?? {}, require_plugin_utils_context_helpers.getVariableCommandPathName(segment)) === false);
+		if (missing.length > 0) failures.push({
+			code: "MISSING_VARIABLE_PATH",
+			details: `${missing.length} variable path segment${missing.length > 1 ? "s" : ""} in the command folder path "${command.path.segments.join("/")}" do${missing.length > 1 ? "" : "es"} not have corresponding entr${missing.length > 1 ? "ies" : "y"} in the command's path variables: \n- ${missing.map((segment) => `"${require_plugin_utils_context_helpers.getVariableCommandPathName(segment)}"`).join("\n- ")}`
+		});
+		else {
+			for (const varName of Object.keys(command.path.variables ?? {})) if (!command.path.segments.filter(require_plugin_utils_context_helpers.isVariableCommandPath).find((segment) => require_plugin_utils_context_helpers.getVariableCommandPathName(segment) === varName)) failures.push({
+				code: "UNUSED_VARIABLE_PATH",
+				details: `The variable path name "${varName}" defined in the command's path variables is not used in the command folder path "${command.path.segments.join("/")}".`
+			});
+			command.path.segments.forEach((segment, index) => {
+				if (require_plugin_utils_context_helpers.isVariableCommandPath(segment) && command.path.variables[require_plugin_utils_context_helpers.getVariableCommandPathName(segment)]?.variadic === true && index + 1 < command.path.segments.length && command.path.segments[index + 1] && command.path.variables[require_plugin_utils_context_helpers.getVariableCommandPathName(command.path.segments[index + 1])]?.variadic === true) failures.push({
+					code: "MULTIPLE_VARIADIC_VARIABLE_PATHS",
+					details: `The variable path segment "${require_plugin_utils_context_helpers.getVariableCommandPathName(segment)}" in the command at path "${command.path.segments.join("/")}" is marked as variadic, and it is followed by another variadic variable path segment "${require_plugin_utils_context_helpers.getVariableCommandPathName(command.path.segments[index + 1])}". Only one variadic variable path segment is allowed per command, and it must be the final path segment.`
+				});
+			});
+		}
+	}
+	return failures;
+}
+function validateCommandOptions(command) {
+	const failures = [];
+	const optionNames = /* @__PURE__ */ new Set();
+	for (const option of Object.values(command.options ?? {})) {
+		if (optionNames.has(option.name)) failures.push({
+			code: "DUPLICATE_OPTION_NAME",
+			details: `Duplicate option name "${option.name}" found in command.`
+		});
+		optionNames.add(option.name);
+		for (const alias of option.alias) {
+			if (optionNames.has(alias)) failures.push({
+				code: "DUPLICATE_OPTION_ALIAS",
+				details: `Duplicate option name "${alias}" (an alias of "${option.name}") found in command.`
+			});
+			optionNames.add(alias);
+		}
+	}
+	return failures;
+}
+function validateCommandParams(command) {
+	const failures = [];
+	if (!command.isVirtual && command.params.length > 0) {
+		const paramNames = /* @__PURE__ */ new Set();
+		command.params.forEach((param, index) => {
+			if (paramNames.has(param.name)) failures.push({
+				code: "DUPLICATE_PARAM_NAME",
+				details: `Duplicate parameter name "${param.name}" found in command.`
+			});
+			paramNames.add(param.name);
+			if (param.optional) command.params.slice(index + 1).forEach((nextParam) => {
+				if (nextParam.optional && !nextParam.default) failures.push({
+					code: "OPTIONAL_PARAM_NOT_LAST",
+					details: `The parameter "${nextParam.name}" in the command at path "${command.path.segments.join("/")}" is required, but it follows an optional parameter "${param.name}". All required parameters must come before any optional parameters.`
+				});
+			});
+			if (param.variadic && index + 1 < command.params.length) {
+				if (command.params[index + 1]?.variadic) failures.push({
+					code: "MULTIPLE_VARIADIC_PARAMS",
+					details: `The parameter "${param.name}" in the command at path "${command.path.segments.join("/")}" is variadic, and it is followed by another variadic parameter "${command.params[index + 1]?.name}". Only one variadic parameter is allowed per command, and it must be the final parameter.`
+				});
+			}
+		});
+	}
+	return failures;
+}
+function validateCommand(command) {
+	const results = [];
+	let failures = validateCommandVariablePaths(command);
+	if (failures.length > 0) results.push(...failures);
+	failures = validateCommandParams(command);
+	if (failures.length > 0) results.push(...failures);
+	failures = validateCommandOptions(command);
+	if (failures.length > 0) results.push(...failures);
+	return results;
+}
+
+//#endregion
+exports.validateCommand = validateCommand;
+//# sourceMappingURL=validations.cjs.map

package/dist/helpers/validations.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validations.cjs","names":["getVariableCommandPathName","isVariableCommandPath","validateCommandVariablePaths","command","failures","isVirtual","path","segments","length","variablePathNames","Set","segment","filter","has","push","code","details","add","Object","keys","variables","join","missing","prototype","hasOwnProperty","call","map","varName","find","forEach","index","variadic","validateCommandOptions","optionNames","option","values","options","name","alias","validateCommandParams","params","paramNames","param","optional","slice","nextParam","default","validateCommand","results"],"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 {\n  getVariableCommandPathName,\n  isVariableCommandPath\n} from \"../plugin-utils/context-helpers\";\nimport type { CommandTree } from \"../types\";\n\nexport interface ValidationFailure {\n  code: string;\n  details: string;\n}\n\nexport function validateCommandVariablePaths(\n  command: CommandTree\n): ValidationFailure[] {\n  const failures: ValidationFailure[] = [];\n  if (!command.isVirtual && command.path.segments.length > 0) {\n    const variablePathNames = new Set<string>();\n    for (const segment of command.path.segments.filter(isVariableCommandPath) ??\n      []) {\n      if (variablePathNames.has(segment)) {\n        failures.push({\n          code: \"DUPLICATE_VARIABLE_PATH_NAME\",\n          details: `Duplicate variable path name \"${getVariableCommandPathName(segment)}\" found in command.`\n        });\n      }\n      variablePathNames.add(getVariableCommandPathName(segment));\n    }\n\n    if (\n      command.path.segments.filter(isVariableCommandPath).length !==\n      Object.keys(command.path.variables ?? {}).length\n    ) {\n      failures.push({\n        code: \"VARIABLE_PATH_MISMATCH\",\n        details: `Mismatch between variable path segments and defined path variables in command (found ${\n          command.path.segments.filter(isVariableCommandPath).length\n        } variables in the command folder path \"${command.path.segments.join(\"/\")}\", but ${\n          Object.keys(command.path.variables ?? {}).length\n        } potential variable path(s) could be determined from the command's function signature).`\n      });\n    }\n\n    const missing = command.path.segments\n      .filter(isVariableCommandPath)\n      .filter(\n        segment =>\n          Object.prototype.hasOwnProperty.call(\n            command.path.variables ?? {},\n            getVariableCommandPathName(segment)\n          ) === false\n      );\n    if (missing.length > 0) {\n      failures.push({\n        code: \"MISSING_VARIABLE_PATH\",\n        details: `${missing.length} variable path segment${missing.length > 1 ? \"s\" : \"\"} in the command folder path \"${command.path.segments.join(\n          \"/\"\n        )}\" do${missing.length > 1 ? \"\" : \"es\"} not have corresponding entr${\n          missing.length > 1 ? \"ies\" : \"y\"\n        } in the command's path variables: \\n- ${missing\n          .map(segment => `\"${getVariableCommandPathName(segment)}\"`)\n          .join(\"\\n- \")}`\n      });\n    } else {\n      for (const varName of Object.keys(command.path.variables ?? {})) {\n        if (\n          !command.path.segments\n            .filter(isVariableCommandPath)\n            .find(segment => getVariableCommandPathName(segment) === varName)\n        ) {\n          failures.push({\n            code: \"UNUSED_VARIABLE_PATH\",\n            details: `The variable path name \"${varName}\" defined in the command's path variables is not used in the command folder path \"${command.path.segments.join(\n              \"/\"\n            )}\".`\n          });\n        }\n      }\n\n      command.path.segments.forEach((segment, index) => {\n        if (\n          isVariableCommandPath(segment) &&\n          command.path.variables[getVariableCommandPathName(segment)]\n            ?.variadic === true &&\n          index + 1 < command.path.segments.length &&\n          command.path.segments[index + 1] &&\n          command.path.variables[\n            getVariableCommandPathName(command.path.segments[index + 1]!)\n          ]?.variadic === true\n        ) {\n          failures.push({\n            code: \"MULTIPLE_VARIADIC_VARIABLE_PATHS\",\n            details: `The variable path segment \"${getVariableCommandPathName(\n              segment\n            )}\" in the command at path \"${command.path.segments.join(\n              \"/\"\n            )}\" is marked as variadic, and it is followed by another variadic variable path segment \"${getVariableCommandPathName(\n              command.path.segments[index + 1]!\n            )}\". Only one variadic variable path segment is allowed per command, and it must be the final path segment.`\n          });\n        }\n      });\n    }\n  }\n\n  return failures;\n}\n\nexport function validateCommandOptions(\n  command: CommandTree\n): 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 validateCommandParams(\n  command: CommandTree\n): ValidationFailure[] {\n  const failures: ValidationFailure[] = [];\n  if (!command.isVirtual && command.params.length > 0) {\n    const paramNames = new Set<string>();\n    command.params.forEach((param, index) => {\n      if (paramNames.has(param.name)) {\n        failures.push({\n          code: \"DUPLICATE_PARAM_NAME\",\n          details: `Duplicate parameter name \"${param.name}\" found in command.`\n        });\n      }\n      paramNames.add(param.name);\n\n      if (param.optional) {\n        command.params.slice(index + 1).forEach(nextParam => {\n          if (nextParam.optional && !nextParam.default) {\n            failures.push({\n              code: \"OPTIONAL_PARAM_NOT_LAST\",\n              details: `The parameter \"${nextParam.name}\" in the command at path \"${command.path.segments.join(\n                \"/\"\n              )}\" is required, but it follows an optional parameter \"${\n                param.name\n              }\". All required parameters must come before any optional parameters.`\n            });\n          }\n        });\n      }\n\n      if (param.variadic && index + 1 < command.params.length) {\n        if (command.params[index + 1]?.variadic) {\n          failures.push({\n            code: \"MULTIPLE_VARIADIC_PARAMS\",\n            details: `The parameter \"${param.name}\" in the command at path \"${command.path.segments.join(\n              \"/\"\n            )}\" is variadic, and it is followed by another variadic parameter \"${\n              command.params[index + 1]?.name\n            }\". Only one variadic parameter is allowed per command, and it must be the final parameter.`\n          });\n        }\n      }\n    });\n  }\n\n  return failures;\n}\n\nexport function validateCommand(command: CommandTree): ValidationFailure[] {\n  const results: ValidationFailure[] = [];\n\n  let failures = validateCommandVariablePaths(command);\n  if (failures.length > 0) {\n    results.push(...failures);\n  }\n\n  failures = validateCommandParams(command);\n  if (failures.length > 0) {\n    results.push(...failures);\n  }\n\n  failures = validateCommandOptions(command);\n  if (failures.length > 0) {\n    results.push(...failures);\n  }\n\n  return results;\n}\n"],"mappings":";;;AA6BA,SAAgBE,6BACdC,SACqB;CACrB,MAAMC,WAAgC,EAAE;AACxC,KAAI,CAACD,QAAQE,aAAaF,QAAQG,KAAKC,SAASC,SAAS,GAAG;EAC1D,MAAMC,oCAAoB,IAAIC,KAAa;AAC3C,OAAK,MAAMC,WAAWR,QAAQG,KAAKC,SAASK,OAAOX,2DAAsB,IACvE,EAAE,EAAE;AACJ,OAAIQ,kBAAkBI,IAAIF,QAAQ,CAChCP,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,iCAAiChB,gEAA2BW,QAAQ,CAAA;IAC9E,CAAC;AAEJF,qBAAkBQ,IAAIjB,gEAA2BW,QAAQ,CAAC;;AAG5D,MACER,QAAQG,KAAKC,SAASK,OAAOX,2DAAsB,CAACO,WACpDU,OAAOC,KAAKhB,QAAQG,KAAKc,aAAa,EAAE,CAAC,CAACZ,OAE1CJ,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,wFACPb,QAAQG,KAAKC,SAASK,OAAOX,2DAAsB,CAACO,OAAM,yCAClBL,QAAQG,KAAKC,SAASc,KAAK,IAAI,CAAA,SACvEH,OAAOC,KAAKhB,QAAQG,KAAKc,aAAa,EAAE,CAAC,CAACZ,OAAM;GAEnD,CAAC;EAGJ,MAAMc,UAAUnB,QAAQG,KAAKC,SAC1BK,OAAOX,2DAAsB,CAC7BW,QACCD,YACEO,OAAOK,UAAUC,eAAeC,KAC9BtB,QAAQG,KAAKc,aAAa,EAAE,EAC5BpB,gEAA2BW,QAC7B,CAAC,KAAK,MACT;AACH,MAAIW,QAAQd,SAAS,EACnBJ,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,GAAGM,QAAQd,OAAM,wBAAyBc,QAAQd,SAAS,IAAI,MAAM,GAAE,+BAAgCL,QAAQG,KAAKC,SAASc,KACpI,IACD,CAAA,MAAOC,QAAQd,SAAS,IAAI,KAAK,KAAI,8BACpCc,QAAQd,SAAS,IAAI,QAAQ,IAAG,wCACOc,QACtCI,KAAIf,YAAW,IAAIX,gEAA2BW,QAAQ,CAAA,GAAI,CAC1DU,KAAK,OAAO;GAChB,CAAC;OACG;AACL,QAAK,MAAMM,WAAWT,OAAOC,KAAKhB,QAAQG,KAAKc,aAAa,EAAE,CAAC,CAC7D,KACE,CAACjB,QAAQG,KAAKC,SACXK,OAAOX,2DAAsB,CAC7B2B,MAAKjB,YAAWX,gEAA2BW,QAAQ,KAAKgB,QAAQ,CAEnEvB,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,2BAA2BW,QAAO,oFAAqFxB,QAAQG,KAAKC,SAASc,KACpJ,IACD,CAAA;IACF,CAAC;AAINlB,WAAQG,KAAKC,SAASsB,SAASlB,SAASmB,UAAU;AAChD,QACE7B,2DAAsBU,QAAQ,IAC9BR,QAAQG,KAAKc,UAAUpB,gEAA2BW,QAAQ,GACtDoB,aAAa,QACjBD,QAAQ,IAAI3B,QAAQG,KAAKC,SAASC,UAClCL,QAAQG,KAAKC,SAASuB,QAAQ,MAC9B3B,QAAQG,KAAKc,UACXpB,gEAA2BG,QAAQG,KAAKC,SAASuB,QAAQ,GAAI,GAC5DC,aAAa,KAEhB3B,UAASU,KAAK;KACZC,MAAM;KACNC,SAAS,8BAA8BhB,gEACrCW,QACD,CAAA,4BAA6BR,QAAQG,KAAKC,SAASc,KAClD,IACD,CAAA,yFAA0FrB,gEACzFG,QAAQG,KAAKC,SAASuB,QAAQ,GAC/B,CAAA;KACF,CAAC;KAEJ;;;AAIN,QAAO1B;;AAGT,SAAgB4B,uBACd7B,SACqB;CACrB,MAAMC,WAAgC,EAAE;CAExC,MAAM6B,8BAAc,IAAIvB,KAAa;AACrC,MAAK,MAAMwB,UAAUhB,OAAOiB,OAAOhC,QAAQiC,WAAW,EAAE,CAAC,EAAE;AACzD,MAAIH,YAAYpB,IAAIqB,OAAOG,KAAK,CAC9BjC,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,0BAA0BkB,OAAOG,KAAI;GAC/C,CAAC;AAEJJ,cAAYhB,IAAIiB,OAAOG,KAAK;AAE5B,OAAK,MAAMC,SAASJ,OAAOI,OAAO;AAChC,OAAIL,YAAYpB,IAAIyB,MAAM,CACxBlC,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,0BAA0BsB,MAAK,kBACtCJ,OAAOG,KAAI;IAEd,CAAC;AAEJJ,eAAYhB,IAAIqB,MAAM;;;AAI1B,QAAOlC;;AAGT,SAAgBmC,sBACdpC,SACqB;CACrB,MAAMC,WAAgC,EAAE;AACxC,KAAI,CAACD,QAAQE,aAAaF,QAAQqC,OAAOhC,SAAS,GAAG;EACnD,MAAMiC,6BAAa,IAAI/B,KAAa;AACpCP,UAAQqC,OAAOX,SAASa,OAAOZ,UAAU;AACvC,OAAIW,WAAW5B,IAAI6B,MAAML,KAAK,CAC5BjC,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,6BAA6B0B,MAAML,KAAI;IACjD,CAAC;AAEJI,cAAWxB,IAAIyB,MAAML,KAAK;AAE1B,OAAIK,MAAMC,SACRxC,SAAQqC,OAAOI,MAAMd,QAAQ,EAAE,CAACD,SAAQgB,cAAa;AACnD,QAAIA,UAAUF,YAAY,CAACE,UAAUC,QACnC1C,UAASU,KAAK;KACZC,MAAM;KACNC,SAAS,kBAAkB6B,UAAUR,KAAI,4BAA6BlC,QAAQG,KAAKC,SAASc,KAC1F,IACD,CAAA,uDACCqB,MAAML,KAAI;KAEb,CAAC;KAEJ;AAGJ,OAAIK,MAAMX,YAAYD,QAAQ,IAAI3B,QAAQqC,OAAOhC,QAC/C;QAAIL,QAAQqC,OAAOV,QAAQ,IAAIC,SAC7B3B,UAASU,KAAK;KACZC,MAAM;KACNC,SAAS,kBAAkB0B,MAAML,KAAI,4BAA6BlC,QAAQG,KAAKC,SAASc,KACtF,IACD,CAAA,mEACClB,QAAQqC,OAAOV,QAAQ,IAAIO,KAAI;KAElC,CAAC;;IAGN;;AAGJ,QAAOjC;;AAGT,SAAgB2C,gBAAgB5C,SAA2C;CACzE,MAAM6C,UAA+B,EAAE;CAEvC,IAAI5C,WAAWF,6BAA6BC,QAAQ;AACpD,KAAIC,SAASI,SAAS,EACpBwC,SAAQlC,KAAK,GAAGV,SAAS;AAG3BA,YAAWmC,sBAAsBpC,QAAQ;AACzC,KAAIC,SAASI,SAAS,EACpBwC,SAAQlC,KAAK,GAAGV,SAAS;AAG3BA,YAAW4B,uBAAuB7B,QAAQ;AAC1C,KAAIC,SAASI,SAAS,EACpBwC,SAAQlC,KAAK,GAAGV,SAAS;AAG3B,QAAO4C"}

package/dist/helpers/validations.mjs

@@ -0,0 +1,97 @@
+import { getVariableCommandPathName, isVariableCommandPath } from "../plugin-utils/context-helpers.mjs";
+
+//#region src/helpers/validations.ts
+function validateCommandVariablePaths(command) {
+	const failures = [];
+	if (!command.isVirtual && command.path.segments.length > 0) {
+		const variablePathNames = /* @__PURE__ */ new Set();
+		for (const segment of command.path.segments.filter(isVariableCommandPath) ?? []) {
+			if (variablePathNames.has(segment)) failures.push({
+				code: "DUPLICATE_VARIABLE_PATH_NAME",
+				details: `Duplicate variable path name "${getVariableCommandPathName(segment)}" found in command.`
+			});
+			variablePathNames.add(getVariableCommandPathName(segment));
+		}
+		if (command.path.segments.filter(isVariableCommandPath).length !== Object.keys(command.path.variables ?? {}).length) failures.push({
+			code: "VARIABLE_PATH_MISMATCH",
+			details: `Mismatch between variable path segments and defined path variables in command (found ${command.path.segments.filter(isVariableCommandPath).length} variables in the command folder path "${command.path.segments.join("/")}", but ${Object.keys(command.path.variables ?? {}).length} potential variable path(s) could be determined from the command's function signature).`
+		});
+		const missing = command.path.segments.filter(isVariableCommandPath).filter((segment) => Object.prototype.hasOwnProperty.call(command.path.variables ?? {}, getVariableCommandPathName(segment)) === false);
+		if (missing.length > 0) failures.push({
+			code: "MISSING_VARIABLE_PATH",
+			details: `${missing.length} variable path segment${missing.length > 1 ? "s" : ""} in the command folder path "${command.path.segments.join("/")}" do${missing.length > 1 ? "" : "es"} not have corresponding entr${missing.length > 1 ? "ies" : "y"} in the command's path variables: \n- ${missing.map((segment) => `"${getVariableCommandPathName(segment)}"`).join("\n- ")}`
+		});
+		else {
+			for (const varName of Object.keys(command.path.variables ?? {})) if (!command.path.segments.filter(isVariableCommandPath).find((segment) => getVariableCommandPathName(segment) === varName)) failures.push({
+				code: "UNUSED_VARIABLE_PATH",
+				details: `The variable path name "${varName}" defined in the command's path variables is not used in the command folder path "${command.path.segments.join("/")}".`
+			});
+			command.path.segments.forEach((segment, index) => {
+				if (isVariableCommandPath(segment) && command.path.variables[getVariableCommandPathName(segment)]?.variadic === true && index + 1 < command.path.segments.length && command.path.segments[index + 1] && command.path.variables[getVariableCommandPathName(command.path.segments[index + 1])]?.variadic === true) failures.push({
+					code: "MULTIPLE_VARIADIC_VARIABLE_PATHS",
+					details: `The variable path segment "${getVariableCommandPathName(segment)}" in the command at path "${command.path.segments.join("/")}" is marked as variadic, and it is followed by another variadic variable path segment "${getVariableCommandPathName(command.path.segments[index + 1])}". Only one variadic variable path segment is allowed per command, and it must be the final path segment.`
+				});
+			});
+		}
+	}
+	return failures;
+}
+function validateCommandOptions(command) {
+	const failures = [];
+	const optionNames = /* @__PURE__ */ new Set();
+	for (const option of Object.values(command.options ?? {})) {
+		if (optionNames.has(option.name)) failures.push({
+			code: "DUPLICATE_OPTION_NAME",
+			details: `Duplicate option name "${option.name}" found in command.`
+		});
+		optionNames.add(option.name);
+		for (const alias of option.alias) {
+			if (optionNames.has(alias)) failures.push({
+				code: "DUPLICATE_OPTION_ALIAS",
+				details: `Duplicate option name "${alias}" (an alias of "${option.name}") found in command.`
+			});
+			optionNames.add(alias);
+		}
+	}
+	return failures;
+}
+function validateCommandParams(command) {
+	const failures = [];
+	if (!command.isVirtual && command.params.length > 0) {
+		const paramNames = /* @__PURE__ */ new Set();
+		command.params.forEach((param, index) => {
+			if (paramNames.has(param.name)) failures.push({
+				code: "DUPLICATE_PARAM_NAME",
+				details: `Duplicate parameter name "${param.name}" found in command.`
+			});
+			paramNames.add(param.name);
+			if (param.optional) command.params.slice(index + 1).forEach((nextParam) => {
+				if (nextParam.optional && !nextParam.default) failures.push({
+					code: "OPTIONAL_PARAM_NOT_LAST",
+					details: `The parameter "${nextParam.name}" in the command at path "${command.path.segments.join("/")}" is required, but it follows an optional parameter "${param.name}". All required parameters must come before any optional parameters.`
+				});
+			});
+			if (param.variadic && index + 1 < command.params.length) {
+				if (command.params[index + 1]?.variadic) failures.push({
+					code: "MULTIPLE_VARIADIC_PARAMS",
+					details: `The parameter "${param.name}" in the command at path "${command.path.segments.join("/")}" is variadic, and it is followed by another variadic parameter "${command.params[index + 1]?.name}". Only one variadic parameter is allowed per command, and it must be the final parameter.`
+				});
+			}
+		});
+	}
+	return failures;
+}
+function validateCommand(command) {
+	const results = [];
+	let failures = validateCommandVariablePaths(command);
+	if (failures.length > 0) results.push(...failures);
+	failures = validateCommandParams(command);
+	if (failures.length > 0) results.push(...failures);
+	failures = validateCommandOptions(command);
+	if (failures.length > 0) results.push(...failures);
+	return results;
+}
+
+//#endregion
+export { validateCommand };
+//# sourceMappingURL=validations.mjs.map

package/dist/helpers/validations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validations.mjs","names":["getVariableCommandPathName","isVariableCommandPath","validateCommandVariablePaths","command","failures","isVirtual","path","segments","length","variablePathNames","Set","segment","filter","has","push","code","details","add","Object","keys","variables","join","missing","prototype","hasOwnProperty","call","map","varName","find","forEach","index","variadic","validateCommandOptions","optionNames","option","values","options","name","alias","validateCommandParams","params","paramNames","param","optional","slice","nextParam","default","validateCommand","results"],"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 {\n  getVariableCommandPathName,\n  isVariableCommandPath\n} from \"../plugin-utils/context-helpers\";\nimport type { CommandTree } from \"../types\";\n\nexport interface ValidationFailure {\n  code: string;\n  details: string;\n}\n\nexport function validateCommandVariablePaths(\n  command: CommandTree\n): ValidationFailure[] {\n  const failures: ValidationFailure[] = [];\n  if (!command.isVirtual && command.path.segments.length > 0) {\n    const variablePathNames = new Set<string>();\n    for (const segment of command.path.segments.filter(isVariableCommandPath) ??\n      []) {\n      if (variablePathNames.has(segment)) {\n        failures.push({\n          code: \"DUPLICATE_VARIABLE_PATH_NAME\",\n          details: `Duplicate variable path name \"${getVariableCommandPathName(segment)}\" found in command.`\n        });\n      }\n      variablePathNames.add(getVariableCommandPathName(segment));\n    }\n\n    if (\n      command.path.segments.filter(isVariableCommandPath).length !==\n      Object.keys(command.path.variables ?? {}).length\n    ) {\n      failures.push({\n        code: \"VARIABLE_PATH_MISMATCH\",\n        details: `Mismatch between variable path segments and defined path variables in command (found ${\n          command.path.segments.filter(isVariableCommandPath).length\n        } variables in the command folder path \"${command.path.segments.join(\"/\")}\", but ${\n          Object.keys(command.path.variables ?? {}).length\n        } potential variable path(s) could be determined from the command's function signature).`\n      });\n    }\n\n    const missing = command.path.segments\n      .filter(isVariableCommandPath)\n      .filter(\n        segment =>\n          Object.prototype.hasOwnProperty.call(\n            command.path.variables ?? {},\n            getVariableCommandPathName(segment)\n          ) === false\n      );\n    if (missing.length > 0) {\n      failures.push({\n        code: \"MISSING_VARIABLE_PATH\",\n        details: `${missing.length} variable path segment${missing.length > 1 ? \"s\" : \"\"} in the command folder path \"${command.path.segments.join(\n          \"/\"\n        )}\" do${missing.length > 1 ? \"\" : \"es\"} not have corresponding entr${\n          missing.length > 1 ? \"ies\" : \"y\"\n        } in the command's path variables: \\n- ${missing\n          .map(segment => `\"${getVariableCommandPathName(segment)}\"`)\n          .join(\"\\n- \")}`\n      });\n    } else {\n      for (const varName of Object.keys(command.path.variables ?? {})) {\n        if (\n          !command.path.segments\n            .filter(isVariableCommandPath)\n            .find(segment => getVariableCommandPathName(segment) === varName)\n        ) {\n          failures.push({\n            code: \"UNUSED_VARIABLE_PATH\",\n            details: `The variable path name \"${varName}\" defined in the command's path variables is not used in the command folder path \"${command.path.segments.join(\n              \"/\"\n            )}\".`\n          });\n        }\n      }\n\n      command.path.segments.forEach((segment, index) => {\n        if (\n          isVariableCommandPath(segment) &&\n          command.path.variables[getVariableCommandPathName(segment)]\n            ?.variadic === true &&\n          index + 1 < command.path.segments.length &&\n          command.path.segments[index + 1] &&\n          command.path.variables[\n            getVariableCommandPathName(command.path.segments[index + 1]!)\n          ]?.variadic === true\n        ) {\n          failures.push({\n            code: \"MULTIPLE_VARIADIC_VARIABLE_PATHS\",\n            details: `The variable path segment \"${getVariableCommandPathName(\n              segment\n            )}\" in the command at path \"${command.path.segments.join(\n              \"/\"\n            )}\" is marked as variadic, and it is followed by another variadic variable path segment \"${getVariableCommandPathName(\n              command.path.segments[index + 1]!\n            )}\". Only one variadic variable path segment is allowed per command, and it must be the final path segment.`\n          });\n        }\n      });\n    }\n  }\n\n  return failures;\n}\n\nexport function validateCommandOptions(\n  command: CommandTree\n): 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 validateCommandParams(\n  command: CommandTree\n): ValidationFailure[] {\n  const failures: ValidationFailure[] = [];\n  if (!command.isVirtual && command.params.length > 0) {\n    const paramNames = new Set<string>();\n    command.params.forEach((param, index) => {\n      if (paramNames.has(param.name)) {\n        failures.push({\n          code: \"DUPLICATE_PARAM_NAME\",\n          details: `Duplicate parameter name \"${param.name}\" found in command.`\n        });\n      }\n      paramNames.add(param.name);\n\n      if (param.optional) {\n        command.params.slice(index + 1).forEach(nextParam => {\n          if (nextParam.optional && !nextParam.default) {\n            failures.push({\n              code: \"OPTIONAL_PARAM_NOT_LAST\",\n              details: `The parameter \"${nextParam.name}\" in the command at path \"${command.path.segments.join(\n                \"/\"\n              )}\" is required, but it follows an optional parameter \"${\n                param.name\n              }\". All required parameters must come before any optional parameters.`\n            });\n          }\n        });\n      }\n\n      if (param.variadic && index + 1 < command.params.length) {\n        if (command.params[index + 1]?.variadic) {\n          failures.push({\n            code: \"MULTIPLE_VARIADIC_PARAMS\",\n            details: `The parameter \"${param.name}\" in the command at path \"${command.path.segments.join(\n              \"/\"\n            )}\" is variadic, and it is followed by another variadic parameter \"${\n              command.params[index + 1]?.name\n            }\". Only one variadic parameter is allowed per command, and it must be the final parameter.`\n          });\n        }\n      }\n    });\n  }\n\n  return failures;\n}\n\nexport function validateCommand(command: CommandTree): ValidationFailure[] {\n  const results: ValidationFailure[] = [];\n\n  let failures = validateCommandVariablePaths(command);\n  if (failures.length > 0) {\n    results.push(...failures);\n  }\n\n  failures = validateCommandParams(command);\n  if (failures.length > 0) {\n    results.push(...failures);\n  }\n\n  failures = validateCommandOptions(command);\n  if (failures.length > 0) {\n    results.push(...failures);\n  }\n\n  return results;\n}\n"],"mappings":";;;AA6BA,SAAgBE,6BACdC,SACqB;CACrB,MAAMC,WAAgC,EAAE;AACxC,KAAI,CAACD,QAAQE,aAAaF,QAAQG,KAAKC,SAASC,SAAS,GAAG;EAC1D,MAAMC,oCAAoB,IAAIC,KAAa;AAC3C,OAAK,MAAMC,WAAWR,QAAQG,KAAKC,SAASK,OAAOX,sBAAsB,IACvE,EAAE,EAAE;AACJ,OAAIQ,kBAAkBI,IAAIF,QAAQ,CAChCP,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,iCAAiChB,2BAA2BW,QAAQ,CAAA;IAC9E,CAAC;AAEJF,qBAAkBQ,IAAIjB,2BAA2BW,QAAQ,CAAC;;AAG5D,MACER,QAAQG,KAAKC,SAASK,OAAOX,sBAAsB,CAACO,WACpDU,OAAOC,KAAKhB,QAAQG,KAAKc,aAAa,EAAE,CAAC,CAACZ,OAE1CJ,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,wFACPb,QAAQG,KAAKC,SAASK,OAAOX,sBAAsB,CAACO,OAAM,yCAClBL,QAAQG,KAAKC,SAASc,KAAK,IAAI,CAAA,SACvEH,OAAOC,KAAKhB,QAAQG,KAAKc,aAAa,EAAE,CAAC,CAACZ,OAAM;GAEnD,CAAC;EAGJ,MAAMc,UAAUnB,QAAQG,KAAKC,SAC1BK,OAAOX,sBAAsB,CAC7BW,QACCD,YACEO,OAAOK,UAAUC,eAAeC,KAC9BtB,QAAQG,KAAKc,aAAa,EAAE,EAC5BpB,2BAA2BW,QAC7B,CAAC,KAAK,MACT;AACH,MAAIW,QAAQd,SAAS,EACnBJ,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,GAAGM,QAAQd,OAAM,wBAAyBc,QAAQd,SAAS,IAAI,MAAM,GAAE,+BAAgCL,QAAQG,KAAKC,SAASc,KACpI,IACD,CAAA,MAAOC,QAAQd,SAAS,IAAI,KAAK,KAAI,8BACpCc,QAAQd,SAAS,IAAI,QAAQ,IAAG,wCACOc,QACtCI,KAAIf,YAAW,IAAIX,2BAA2BW,QAAQ,CAAA,GAAI,CAC1DU,KAAK,OAAO;GAChB,CAAC;OACG;AACL,QAAK,MAAMM,WAAWT,OAAOC,KAAKhB,QAAQG,KAAKc,aAAa,EAAE,CAAC,CAC7D,KACE,CAACjB,QAAQG,KAAKC,SACXK,OAAOX,sBAAsB,CAC7B2B,MAAKjB,YAAWX,2BAA2BW,QAAQ,KAAKgB,QAAQ,CAEnEvB,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,2BAA2BW,QAAO,oFAAqFxB,QAAQG,KAAKC,SAASc,KACpJ,IACD,CAAA;IACF,CAAC;AAINlB,WAAQG,KAAKC,SAASsB,SAASlB,SAASmB,UAAU;AAChD,QACE7B,sBAAsBU,QAAQ,IAC9BR,QAAQG,KAAKc,UAAUpB,2BAA2BW,QAAQ,GACtDoB,aAAa,QACjBD,QAAQ,IAAI3B,QAAQG,KAAKC,SAASC,UAClCL,QAAQG,KAAKC,SAASuB,QAAQ,MAC9B3B,QAAQG,KAAKc,UACXpB,2BAA2BG,QAAQG,KAAKC,SAASuB,QAAQ,GAAI,GAC5DC,aAAa,KAEhB3B,UAASU,KAAK;KACZC,MAAM;KACNC,SAAS,8BAA8BhB,2BACrCW,QACD,CAAA,4BAA6BR,QAAQG,KAAKC,SAASc,KAClD,IACD,CAAA,yFAA0FrB,2BACzFG,QAAQG,KAAKC,SAASuB,QAAQ,GAC/B,CAAA;KACF,CAAC;KAEJ;;;AAIN,QAAO1B;;AAGT,SAAgB4B,uBACd7B,SACqB;CACrB,MAAMC,WAAgC,EAAE;CAExC,MAAM6B,8BAAc,IAAIvB,KAAa;AACrC,MAAK,MAAMwB,UAAUhB,OAAOiB,OAAOhC,QAAQiC,WAAW,EAAE,CAAC,EAAE;AACzD,MAAIH,YAAYpB,IAAIqB,OAAOG,KAAK,CAC9BjC,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,0BAA0BkB,OAAOG,KAAI;GAC/C,CAAC;AAEJJ,cAAYhB,IAAIiB,OAAOG,KAAK;AAE5B,OAAK,MAAMC,SAASJ,OAAOI,OAAO;AAChC,OAAIL,YAAYpB,IAAIyB,MAAM,CACxBlC,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,0BAA0BsB,MAAK,kBACtCJ,OAAOG,KAAI;IAEd,CAAC;AAEJJ,eAAYhB,IAAIqB,MAAM;;;AAI1B,QAAOlC;;AAGT,SAAgBmC,sBACdpC,SACqB;CACrB,MAAMC,WAAgC,EAAE;AACxC,KAAI,CAACD,QAAQE,aAAaF,QAAQqC,OAAOhC,SAAS,GAAG;EACnD,MAAMiC,6BAAa,IAAI/B,KAAa;AACpCP,UAAQqC,OAAOX,SAASa,OAAOZ,UAAU;AACvC,OAAIW,WAAW5B,IAAI6B,MAAML,KAAK,CAC5BjC,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,6BAA6B0B,MAAML,KAAI;IACjD,CAAC;AAEJI,cAAWxB,IAAIyB,MAAML,KAAK;AAE1B,OAAIK,MAAMC,SACRxC,SAAQqC,OAAOI,MAAMd,QAAQ,EAAE,CAACD,SAAQgB,cAAa;AACnD,QAAIA,UAAUF,YAAY,CAACE,UAAUC,QACnC1C,UAASU,KAAK;KACZC,MAAM;KACNC,SAAS,kBAAkB6B,UAAUR,KAAI,4BAA6BlC,QAAQG,KAAKC,SAASc,KAC1F,IACD,CAAA,uDACCqB,MAAML,KAAI;KAEb,CAAC;KAEJ;AAGJ,OAAIK,MAAMX,YAAYD,QAAQ,IAAI3B,QAAQqC,OAAOhC,QAC/C;QAAIL,QAAQqC,OAAOV,QAAQ,IAAIC,SAC7B3B,UAASU,KAAK;KACZC,MAAM;KACNC,SAAS,kBAAkB0B,MAAML,KAAI,4BAA6BlC,QAAQG,KAAKC,SAASc,KACtF,IACD,CAAA,mEACClB,QAAQqC,OAAOV,QAAQ,IAAIO,KAAI;KAElC,CAAC;;IAGN;;AAGJ,QAAOjC;;AAGT,SAAgB2C,gBAAgB5C,SAA2C;CACzE,MAAM6C,UAA+B,EAAE;CAEvC,IAAI5C,WAAWF,6BAA6BC,QAAQ;AACpD,KAAIC,SAASI,SAAS,EACpBwC,SAAQlC,KAAK,GAAGV,SAAS;AAG3BA,YAAWmC,sBAAsBpC,QAAQ;AACzC,KAAIC,SAASI,SAAS,EACpBwC,SAAQlC,KAAK,GAAGV,SAAS;AAG3BA,YAAW4B,uBAAuB7B,QAAQ;AAC1C,KAAIC,SAASI,SAAS,EACpBwC,SAAQlC,KAAK,GAAGV,SAAS;AAG3B,QAAO4C"}

package/dist/index.cjs

@@ -1,24 +1,16 @@
 Object.defineProperty(exports, '__esModule', { value: true });
-const require_powerlines = require('./powerlines.cjs');
+const require_plugin = require('./plugin.cjs');
 const require_api = require('./api.cjs');
 const require_config = require('./config.cjs');
 
 //#region src/index.ts
-/**
-* Creates a new {@link ShellShockAPI} instance.
-*
-* @param options - The user configuration options.
-* @returns A promise that resolves to a {@link ShellShockAPI} instance.
-*/
-async function createShellShock(options = {}) {
-	options.root ??= process.cwd();
-	return require_api.ShellShockAPI.from(options);
-}
 var src_default = require_api.ShellShockAPI;
 
 //#endregion
 exports.ShellShockAPI = require_api.ShellShockAPI;
-exports.createShellShock = createShellShock;
+exports.createShellShock = require_api.createShellShock;
 exports.default = src_default;
 exports.defineConfig = require_config.defineConfig;
-exports.shellShock = require_powerlines.shellShock;
+exports.plugin = require_plugin.plugin;
+exports.shellShock = require_plugin.plugin;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["ShellShockAPI","createShellShock","plugin","shellShock"],"sources":["../src/index.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 { ShellShockAPI, createShellShock } from \"./api\";\n\nexport * from \"./config\";\n\nexport { plugin, shellShock } from \"./plugin\";\nexport * from \"./types\";\n\n// eslint-disable-next-line perfectionist/sort-named-exports\nexport { ShellShockAPI, createShellShock };\nexport default ShellShockAPI;\n"],"mappings":";;;;;;AA2BA,kBAAeA"}

package/dist/index.d.cts

@@ -1,20 +1,9 @@
-import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandTree, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./types/command.cjs";
-import { Context } from "./types/context.cjs";
-import { Options, ResolvedConfig, UserConfig } from "./types/config.cjs";
-import { ShellShockAPI } from "./api.cjs";
+import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandPath, CommandTree, CommandTreePath, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./types/command.cjs";
+import { Context, UnresolvedContext } from "./types/context.cjs";
+import { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig } from "./types/config.cjs";
+import { ShellShockAPI, createShellShock } from "./api.cjs";
 import { defineConfig } from "./config.cjs";
-import shellShock from "./powerlines.cjs";
+import plugin from "./plugin.cjs";
 import { BaseCommandOptions } from "./types/options.cjs";
 import "./types/index.cjs";
-
-//#region src/index.d.ts
-
-/**
- * Creates a new {@link ShellShockAPI} instance.
- *
- * @param options - The user configuration options.
- * @returns A promise that resolves to a {@link ShellShockAPI} instance.
- */
-declare function createShellShock(options?: Partial<UserConfig>): Promise<ShellShockAPI>;
-//#endregion
-export { BaseCommandOption, BaseCommandOptions, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandTree, Context, NumberCommandOption, Options, ResolvedConfig, SerializedCommandTree, ShellShockAPI, ShellShockAPI as default, StringCommandOption, UserConfig, createShellShock, defineConfig, shellShock };
+export { BaseCommandOption, BaseCommandOptions, BaseConfig, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandPath, CommandTree, CommandTreePath, Context, NumberCommandOption, Options, OutputConfig, ResolvedConfig, SerializedCommandTree, ShellShockAPI, ShellShockAPI as default, StringCommandOption, UnresolvedContext, UserConfig, createShellShock, defineConfig, plugin, plugin as shellShock };

package/dist/index.d.mts

@@ -1,20 +1,9 @@
-import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandTree, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./types/command.mjs";
-import { Context } from "./types/context.mjs";
-import { Options, ResolvedConfig, UserConfig } from "./types/config.mjs";
-import { ShellShockAPI } from "./api.mjs";
+import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandPath, CommandTree, CommandTreePath, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./types/command.mjs";
+import { Context, UnresolvedContext } from "./types/context.mjs";
+import { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig } from "./types/config.mjs";
+import { ShellShockAPI, createShellShock } from "./api.mjs";
 import { defineConfig } from "./config.mjs";
-import shellShock from "./powerlines.mjs";
+import plugin from "./plugin.mjs";
 import { BaseCommandOptions } from "./types/options.mjs";
 import "./types/index.mjs";
-
-//#region src/index.d.ts
-
-/**
- * Creates a new {@link ShellShockAPI} instance.
- *
- * @param options - The user configuration options.
- * @returns A promise that resolves to a {@link ShellShockAPI} instance.
- */
-declare function createShellShock(options?: Partial<UserConfig>): Promise<ShellShockAPI>;
-//#endregion
-export { BaseCommandOption, BaseCommandOptions, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandTree, Context, NumberCommandOption, Options, ResolvedConfig, SerializedCommandTree, ShellShockAPI, ShellShockAPI as default, StringCommandOption, UserConfig, createShellShock, defineConfig, shellShock };
+export { BaseCommandOption, BaseCommandOptions, BaseConfig, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandPath, CommandTree, CommandTreePath, Context, NumberCommandOption, Options, OutputConfig, ResolvedConfig, SerializedCommandTree, ShellShockAPI, ShellShockAPI as default, StringCommandOption, UnresolvedContext, UserConfig, createShellShock, defineConfig, plugin, plugin as shellShock };

package/dist/index.mjs

@@ -1,19 +1,10 @@
-import { shellShock } from "./powerlines.mjs";
-import { ShellShockAPI } from "./api.mjs";
+import { plugin } from "./plugin.mjs";
+import { ShellShockAPI, createShellShock } from "./api.mjs";
 import { defineConfig } from "./config.mjs";
 
 //#region src/index.ts
-/**
-* Creates a new {@link ShellShockAPI} instance.
-*
-* @param options - The user configuration options.
-* @returns A promise that resolves to a {@link ShellShockAPI} instance.
-*/
-async function createShellShock(options = {}) {
-	options.root ??= process.cwd();
-	return ShellShockAPI.from(options);
-}
 var src_default = ShellShockAPI;
 
 //#endregion
-export { ShellShockAPI, createShellShock, src_default as default, defineConfig, shellShock };
+export { ShellShockAPI, createShellShock, src_default as default, defineConfig, plugin, plugin as shellShock };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["ShellShockAPI","createShellShock","plugin","shellShock"],"sources":["../src/index.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 { ShellShockAPI, createShellShock } from \"./api\";\n\nexport * from \"./config\";\n\nexport { plugin, shellShock } from \"./plugin\";\nexport * from \"./types\";\n\n// eslint-disable-next-line perfectionist/sort-named-exports\nexport { ShellShockAPI, createShellShock };\nexport default ShellShockAPI;\n"],"mappings":";;;;;AA2BA,kBAAeA"}

package/dist/plugin-utils/context-helpers.cjs

@@ -0,0 +1,86 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+let __stryke_string_format_kebab_case = require("@stryke/string-format/kebab-case");
+let __stryke_type_checks_is_set_object = require("@stryke/type-checks/is-set-object");
+let __stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
+let __stryke_string_format_title_case = require("@stryke/string-format/title-case");
+
+//#region src/plugin-utils/context-helpers.ts
+/**
+* Sorts command argument aliases, placing single-character aliases first, followed by multi-character aliases, and then sorting them alphabetically.
+*
+* @param aliases - An array of argument aliases to sort.
+* @returns A new array of sorted aliases.
+*/
+function sortArgAliases(aliases) {
+	if (aliases.length === 0) return [];
+	const result = aliases.filter((alias) => alias.length === 1);
+	result.push(...aliases.filter((alias) => alias.length > 1));
+	return result.sort((a, b) => a.localeCompare(b));
+}
+/**
+* Retrieves the application name from the context and configuration.
+*
+* @param context - The build context containing workspace and package information.
+* @returns The application name in kebab-case format.
+* @throws An error if no valid application name is found.
+*/
+function getAppName(context) {
+	const result = context.config.name || ((0, __stryke_type_checks_is_set_string.isSetString)(context.config.bin) || Array.isArray(context.config.bin) && context.config.bin.length > 0 && (0, __stryke_type_checks_is_set_string.isSetString)(context.config.bin[0]) ? (0, __stryke_type_checks_is_set_string.isSetString)(context.config.bin) ? context.config.bin : context.config.bin[0] : context.packageJson?.name);
+	if (!(0, __stryke_type_checks_is_set_string.isSetString)(result)) throw new Error("No application name found. Please provide a 'bin' option in the configuration or ensure the package.json has a valid 'name' field.");
+	return (0, __stryke_string_format_kebab_case.kebabCase)(result);
+}
+/**
+* Retrieves the application title from the context and configuration.
+*
+* @param context - The build context containing workspace and package information.
+* @returns The application title in title-case format.
+*/
+function getAppTitle(context) {
+	return (0, __stryke_string_format_title_case.titleCase)(context.config.name || getAppName(context));
+}
+/**
+* Retrieves the application description from the context and configuration.
+*
+* @param context - The build context containing workspace and package information.
+* @returns The application description.
+*/
+function getAppDescription(context) {
+	return context.config.description || context.packageJson?.description || `The ${getAppTitle(context)} command-line interface application.`;
+}
+/**
+* Retrieves the primary binary name for the application.
+*
+* @param context - The build context containing workspace and package information.
+* @returns The primary binary name as a string.
+*/
+function getAppBin(context) {
+	return (0, __stryke_type_checks_is_set_object.isSetObject)(context.config.bin) ? Object.keys(context.config.bin)[0] : (0, __stryke_string_format_kebab_case.kebabCase)(getAppName(context));
+}
+/**
+* Determines if a given command path segment is variable (enclosed in square brackets).
+*
+* @param path - The command path segment to check.
+* @returns True if the path is variable, false otherwise.
+*/
+function isVariableCommandPath(path) {
+	return path.startsWith("[") && path.endsWith("]");
+}
+/**
+* Extracts the variable name from a command path segment by removing enclosing square brackets.
+*
+* @param path - The command path segment.
+* @returns The variable name without square brackets.
+*/
+function getVariableCommandPathName(path) {
+	return path.replaceAll(/^\[+/g, "").replaceAll(/\]+$/g, "");
+}
+
+//#endregion
+exports.getAppBin = getAppBin;
+exports.getAppDescription = getAppDescription;
+exports.getAppName = getAppName;
+exports.getAppTitle = getAppTitle;
+exports.getVariableCommandPathName = getVariableCommandPathName;
+exports.isVariableCommandPath = isVariableCommandPath;
+exports.sortArgAliases = sortArgAliases;
+//# sourceMappingURL=context-helpers.cjs.map

package/dist/plugin-utils/context-helpers.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-helpers.cjs","names":["kebabCase","titleCase","isSetObject","isSetString","sortArgAliases","aliases","length","result","filter","alias","push","sort","a","b","localeCompare","getAppName","context","config","name","bin","Array","isArray","packageJson","Error","getAppTitle","getAppDescription","description","getAppBin","Object","keys","isVariableCommandPath","path","startsWith","endsWith","getVariableCommandPathName","replaceAll"],"sources":["../../src/plugin-utils/context-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 { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport type { Context, UnresolvedContext } from \"../types\";\n\n/**\n * Sorts command argument aliases, placing single-character aliases first, followed by multi-character aliases, and then sorting them alphabetically.\n *\n * @param aliases - An array of argument aliases to sort.\n * @returns A new array of sorted aliases.\n */\nexport function sortArgAliases(aliases: string[]): string[] {\n  if (aliases.length === 0) {\n    return [];\n  }\n\n  const result = aliases.filter(alias => alias.length === 1);\n  result.push(...aliases.filter(alias => alias.length > 1));\n\n  return result.sort((a, b) => a.localeCompare(b));\n}\n\n/**\n * Retrieves the application name from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application name in kebab-case format.\n * @throws An error if no valid application name is found.\n */\nexport function getAppName(context: UnresolvedContext | Context): string {\n  const result =\n    context.config.name ||\n    (isSetString(context.config.bin) ||\n    (Array.isArray(context.config.bin) &&\n      context.config.bin.length > 0 &&\n      isSetString(context.config.bin[0]))\n      ? isSetString(context.config.bin)\n        ? context.config.bin\n        : context.config.bin[0]\n      : context.packageJson?.name);\n  if (!isSetString(result)) {\n    throw new Error(\n      \"No application name found. Please provide a 'bin' option in the configuration or ensure the package.json has a valid 'name' field.\"\n    );\n  }\n\n  return kebabCase(result);\n}\n\n/**\n * Retrieves the application title from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application title in title-case format.\n */\nexport function getAppTitle(context: UnresolvedContext | Context): string {\n  return titleCase(context.config.name || getAppName(context));\n}\n\n/**\n * Retrieves the application description from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application description.\n */\nexport function getAppDescription(\n  context: UnresolvedContext | Context\n): string {\n  return (\n    context.config.description ||\n    context.packageJson?.description ||\n    `The ${getAppTitle(context)} command-line interface application.`\n  );\n}\n\n/**\n * Retrieves the primary binary name for the application.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The primary binary name as a string.\n */\nexport function getAppBin(context: Context): string {\n  return isSetObject(context.config.bin)\n    ? Object.keys(context.config.bin)[0]!\n    : kebabCase(getAppName(context));\n}\n\n/**\n * Determines if a given command path segment is variable (enclosed in square brackets).\n *\n * @param path - The command path segment to check.\n * @returns True if the path is variable, false otherwise.\n */\nexport function isVariableCommandPath(path: string): boolean {\n  return path.startsWith(\"[\") && path.endsWith(\"]\");\n}\n\n/**\n * Extracts the variable name from a command path segment by removing enclosing square brackets.\n *\n * @param path - The command path segment.\n * @returns The variable name without square brackets.\n */\nexport function getVariableCommandPathName(path: string): string {\n  return path.replaceAll(/^\\[+/g, \"\").replaceAll(/\\]+$/g, \"\");\n}\n"],"mappings":";;;;;;;;;;;;;AA8BA,SAAgBI,eAAeC,SAA6B;AAC1D,KAAIA,QAAQC,WAAW,EACrB,QAAO,EAAE;CAGX,MAAMC,SAASF,QAAQG,QAAOC,UAASA,MAAMH,WAAW,EAAE;AAC1DC,QAAOG,KAAK,GAAGL,QAAQG,QAAOC,UAASA,MAAMH,SAAS,EAAE,CAAC;AAEzD,QAAOC,OAAOI,MAAMC,GAAGC,MAAMD,EAAEE,cAAcD,EAAE,CAAC;;;;;;;;;AAUlD,SAAgBE,WAAWC,SAA8C;CACvE,MAAMT,SACJS,QAAQC,OAAOC,6DACFF,QAAQC,OAAOE,IAAI,IAC/BC,MAAMC,QAAQL,QAAQC,OAAOE,IAAI,IAChCH,QAAQC,OAAOE,IAAIb,SAAS,yDAChBU,QAAQC,OAAOE,IAAI,GAAI,uDACrBH,QAAQC,OAAOE,IAAI,GAC7BH,QAAQC,OAAOE,MACfH,QAAQC,OAAOE,IAAI,KACrBH,QAAQM,aAAaJ;AAC3B,KAAI,qDAAaX,OAAO,CACtB,OAAM,IAAIgB,MACR,qIACD;AAGH,yDAAiBhB,OAAO;;;;;;;;AAS1B,SAAgBiB,YAAYR,SAA8C;AACxE,yDAAiBA,QAAQC,OAAOC,QAAQH,WAAWC,QAAQ,CAAC;;;;;;;;AAS9D,SAAgBS,kBACdT,SACQ;AACR,QACEA,QAAQC,OAAOS,eACfV,QAAQM,aAAaI,eACrB,OAAOF,YAAYR,QAAQ,CAAA;;;;;;;;AAU/B,SAAgBW,UAAUX,SAA0B;AAClD,4DAAmBA,QAAQC,OAAOE,IAAI,GAClCS,OAAOC,KAAKb,QAAQC,OAAOE,IAAI,CAAC,sDACtBJ,WAAWC,QAAQ,CAAC;;;;;;;;AASpC,SAAgBc,sBAAsBC,MAAuB;AAC3D,QAAOA,KAAKC,WAAW,IAAI,IAAID,KAAKE,SAAS,IAAI;;;;;;;;AASnD,SAAgBC,2BAA2BH,MAAsB;AAC/D,QAAOA,KAAKI,WAAW,SAAS,GAAG,CAACA,WAAW,SAAS,GAAG"}

package/dist/plugin-utils/context-helpers.d.cts

@@ -0,0 +1,58 @@
+import { Context, UnresolvedContext } from "../types/context.cjs";
+import "../types/index.cjs";
+
+//#region src/plugin-utils/context-helpers.d.ts
+
+/**
+ * Sorts command argument aliases, placing single-character aliases first, followed by multi-character aliases, and then sorting them alphabetically.
+ *
+ * @param aliases - An array of argument aliases to sort.
+ * @returns A new array of sorted aliases.
+ */
+declare function sortArgAliases(aliases: string[]): string[];
+/**
+ * Retrieves the application name from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application name in kebab-case format.
+ * @throws An error if no valid application name is found.
+ */
+declare function getAppName(context: UnresolvedContext | Context): string;
+/**
+ * Retrieves the application title from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application title in title-case format.
+ */
+declare function getAppTitle(context: UnresolvedContext | Context): string;
+/**
+ * Retrieves the application description from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application description.
+ */
+declare function getAppDescription(context: UnresolvedContext | Context): string;
+/**
+ * Retrieves the primary binary name for the application.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The primary binary name as a string.
+ */
+declare function getAppBin(context: Context): string;
+/**
+ * Determines if a given command path segment is variable (enclosed in square brackets).
+ *
+ * @param path - The command path segment to check.
+ * @returns True if the path is variable, false otherwise.
+ */
+declare function isVariableCommandPath(path: string): boolean;
+/**
+ * Extracts the variable name from a command path segment by removing enclosing square brackets.
+ *
+ * @param path - The command path segment.
+ * @returns The variable name without square brackets.
+ */
+declare function getVariableCommandPathName(path: string): string;
+//#endregion
+export { getAppBin, getAppDescription, getAppName, getAppTitle, getVariableCommandPathName, isVariableCommandPath, sortArgAliases };
+//# sourceMappingURL=context-helpers.d.cts.map

package/dist/plugin-utils/context-helpers.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-helpers.d.cts","names":[],"sources":["../../src/plugin-utils/context-helpers.ts"],"sourcesContent":[],"mappings":";;;;;;;;AA8BA;AAkBA;AA0BA;AAUgB,iBAtDA,cAAA,CAuDL,OAAA,EAAA,MAAA,EAAoB,CAAA,EAAA,MAAO,EAAA;AAetC;AAYA;AAUA;;;;;iBA1EgB,UAAA,UAAoB,oBAAoB;;;;;;;iBA0BxC,WAAA,UAAqB,oBAAoB;;;;;;;iBAUzC,iBAAA,UACL,oBAAoB;;;;;;;iBAef,SAAA,UAAmB;;;;;;;iBAYnB,qBAAA;;;;;;;iBAUA,0BAAA"}

package/dist/plugin-utils/context-helpers.d.mts

@@ -0,0 +1,58 @@
+import { Context, UnresolvedContext } from "../types/context.mjs";
+import "../types/index.mjs";
+
+//#region src/plugin-utils/context-helpers.d.ts
+
+/**
+ * Sorts command argument aliases, placing single-character aliases first, followed by multi-character aliases, and then sorting them alphabetically.
+ *
+ * @param aliases - An array of argument aliases to sort.
+ * @returns A new array of sorted aliases.
+ */
+declare function sortArgAliases(aliases: string[]): string[];
+/**
+ * Retrieves the application name from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application name in kebab-case format.
+ * @throws An error if no valid application name is found.
+ */
+declare function getAppName(context: UnresolvedContext | Context): string;
+/**
+ * Retrieves the application title from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application title in title-case format.
+ */
+declare function getAppTitle(context: UnresolvedContext | Context): string;
+/**
+ * Retrieves the application description from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application description.
+ */
+declare function getAppDescription(context: UnresolvedContext | Context): string;
+/**
+ * Retrieves the primary binary name for the application.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The primary binary name as a string.
+ */
+declare function getAppBin(context: Context): string;
+/**
+ * Determines if a given command path segment is variable (enclosed in square brackets).
+ *
+ * @param path - The command path segment to check.
+ * @returns True if the path is variable, false otherwise.
+ */
+declare function isVariableCommandPath(path: string): boolean;
+/**
+ * Extracts the variable name from a command path segment by removing enclosing square brackets.
+ *
+ * @param path - The command path segment.
+ * @returns The variable name without square brackets.
+ */
+declare function getVariableCommandPathName(path: string): string;
+//#endregion
+export { getAppBin, getAppDescription, getAppName, getAppTitle, getVariableCommandPathName, isVariableCommandPath, sortArgAliases };
+//# sourceMappingURL=context-helpers.d.mts.map

package/dist/plugin-utils/context-helpers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-helpers.d.mts","names":[],"sources":["../../src/plugin-utils/context-helpers.ts"],"sourcesContent":[],"mappings":";;;;;;;;AA8BA;AAkBA;AA0BA;AAUgB,iBAtDA,cAAA,CAuDL,OAAA,EAAA,MAAA,EAAoB,CAAA,EAAA,MAAO,EAAA;AAetC;AAYA;AAUA;;;;;iBA1EgB,UAAA,UAAoB,oBAAoB;;;;;;;iBA0BxC,WAAA,UAAqB,oBAAoB;;;;;;;iBAUzC,iBAAA,UACL,oBAAoB;;;;;;;iBAef,SAAA,UAAmB;;;;;;;iBAYnB,qBAAA;;;;;;;iBAUA,0BAAA"}