@shell-shock/core 0.17.1 → 0.17.3

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

@@ -1 +1 @@
-{"version":3,"file":"command.d.cts","names":[],"sources":["../../src/types/command.ts"],"mappings":";;;;;;;;KAyBY,oBAAA;AAAA,cAMC,qBAAA;EAAA;;;;KAMD,oBAAA,WACF,qBAAA,eAAoC,qBAAA;AAAA,UAE7B,oBAAA;EALP;;;EASR,IAAA;;;;EAKA,IAAA,EAAM,oBAAA;EAZI;;;EAiBV,KAAA;EAhBiE;AAEnE;;EAmBE,WAAA;EAV0B;;;EAe1B,KAAA;EAVA;;;EAeA,GAAA;EAKA;;;EAAA,QAAA;EAQe;;;EAHf,QAAA;AAAA;AAAA,UAGe,sBAAA,SAA+B,oBAAA;EAS9C;;;EALA,IAAA;EAwBO;AAGT;;EAtBE,OAAA;EAsBkE;;;EAjBlE,MAAA;EA+BA;;;EAjBA,OAAA;AAAA;AAAA,UAGe,sBAAA,SAA+B,oBAAA;EAiBqB;;;EAbnE,IAAA;EAsBO;;AAGT;EApBE,OAAA;;;;EAKA,OAAA;AAAA;AAAA,UAGe,uBAAA,SAAgC,oBAAA;EAa7C;;;EATF,IAAA;EAWyB;AAE3B;;EARE,OAAA;AAAA;AAAA,KAGU,gBAAA,GACR,sBAAA,GACA,sBAAA,GACA,uBAAA;AAAA,KAEQ,wBAAA,WAAmC,oBAAA,IAAwB,IAAA,CACrE,CAAA,sBAGA,OAAA,CAAQ,IAAA,CAAK,CAAA;EACX,KAAA;AAAA;AAAA,KAGQ,4BAAA,GACV,wBAAA,CAAyB,sBAAA;AAAA,KACf,4BAAA,GACV,wBAAA,CAAyB,sBAAA;AAAA,KACf,6BAAA,GACV,wBAAA,CAAyB,uBAAA;AAAA,KAEf,sBAAA,GACR,4BAAA,GACA,4BAAA,GACA,6BAAA;AAAA,UAEa,oBAAA,SAA6B,uBAAA;EApByB;;;EAwBrE,YAAA;EApBa;;;EAyBb,kBAAA;AAAA;AAAA,KAGU,aAAA,GACR,sBAAA,GACA,sBAAA,GACA,oBAAA;AAAA,KACQ,mBAAA,GAAsB,wBAAA,CAAyB,aAAA;AAAA,KAE/C,eAAA,GACR,sBAAA,GACA,sBAAA,GACA,uBAAA;AAAA,KACQ,qBAAA,GAAwB,wBAAA,CAAyB,eAAA;AAAA,UAE5C,WAAA;EAlCuB;;;EAsCtC,EAAA;EApCU;;;EAyCV,IAAA;EAxCgD;AAElD;;EA2CE,IAAA;EA1CE;;;EA+CF,QAAA;EA7C+B;;;EAkD/B,KAAA;EAlD+B;;AAEjC;EAqDE,WAAA;;;;EAKA,KAAA;EAjDA;;;EAsDA,IAAA;EAnDuB;;;EAwDvB,SAAA;EArDE;;;;;;EA6DF,SAAA;AAAA;AAAA,UAGe,aAAA,SAAsB,WAAA;EA/DR;;;EAmE7B,EAAA;EAjEU;;;EAsEV,KAAA,EAAO,2BAAA;EApEL;;;;;;EA4EF,IAAA;AAAA;AAAA,KAGU,WAAA,GAAc,aAAA;EA7Ed;;;EAiFV,KAAA;EAjF0E;AAE5E;;EAoFE,WAAA;EApF0B;;;EAyF1B,KAAA;EAtEA;;;;;;EA8EA,IAAA;EA7CS;;AAGX;EA+CE,OAAA,EAAS,MAAA,SAAe,aAAA;;;;EAKxB,IAAA,EAAM,eAAA;EA3CN;;;EAgDA,MAAA,SAAe,WAAA;EAxCX;AAGN;;EA0CE,QAAA,EAAU,MAAA,SAAe,WAAA;AAAA;AAAA,KAGf,qBAAA,GAAwB,IAAA,CAAK,WAAA;EAlB9B;;;EAsBT,MAAA;EAPU;;;EAWV,QAAA,EAAU,MAAA,SAAe,qBAAA;AAAA;AAAA,UAGV,eAAA;EA1Cf;;;;;;EAiDA,KAAA;EA1BA;;;;;;EAkCA,WAAA;EA1BU;;;EA+BV,KAAA;EA/BkC;;;;;;EAuClC,IAAA;EAnCA;;;;;;EA2CA,IAAA;EApC8B;;;;;;EA4C9B,SAAA;AAAA;AAAA,UAGe,aAAA;EACf,QAAA,GAAW,eAAA;EACX,OAAA,GACI,MAAA,SAAe,mBAAA,IACf,iBAAA,GACA,oBAAA,CAAqB,MAAA,SAAe,oBAAA,KACpC,EAAA,CAAG,YAAA;EACP,IAAA,GACI,qBAAA,KACA,oBAAA,GACA,oBAAA,CAAqB,oBAAA,MACrB,EAAA,CAAG,WAAA;EACP,OAAA,GAAU,WAAA;AAAA"}
+{"version":3,"file":"command.d.cts","names":[],"sources":["../../src/types/command.ts"],"mappings":";;;;;;;;KAyBY,oBAAA;AAAA,cAMC,qBAAA;EAAA;;;;KAMD,oBAAA,WACF,qBAAA,eAAoC,qBAAA;AAAA,UAE7B,oBAAA;EALP;;;EASR,IAAA;;;;EAKA,IAAA,EAAM,oBAAA;EAZI;;;EAiBV,KAAA;EAhBiE;AAEnE;;EAmBE,WAAA;EAV0B;;;EAe1B,KAAA;EAVA;;;EAeA,GAAA;EAKA;;;EAAA,QAAA;EAQe;;;EAHf,QAAA;AAAA;AAAA,UAGe,sBAAA,SAA+B,oBAAA;EAS9C;;;EALA,IAAA;EAwBO;AAGT;;EAtBE,OAAA;EAsBkE;;;EAjBlE,MAAA;EA+BA;;;EAjBA,OAAA;AAAA;AAAA,UAGe,sBAAA,SAA+B,oBAAA;EAiBqB;;;EAbnE,IAAA;EAsBO;;AAGT;EApBE,OAAA;;;;EAKA,OAAA;AAAA;AAAA,UAGe,uBAAA,SAAgC,oBAAA;EAa7C;;;EATF,IAAA;EAWyB;AAE3B;;EARE,OAAA;AAAA;AAAA,KAGU,gBAAA,GACR,sBAAA,GACA,sBAAA,GACA,uBAAA;AAAA,KAEQ,wBAAA,WAAmC,oBAAA,IAAwB,IAAA,CACrE,CAAA,sBAGA,OAAA,CAAQ,IAAA,CAAK,CAAA;EACX,KAAA;AAAA;AAAA,KAGQ,4BAAA,GACV,wBAAA,CAAyB,sBAAA;AAAA,KACf,4BAAA,GACV,wBAAA,CAAyB,sBAAA;AAAA,KACf,6BAAA,GACV,wBAAA,CAAyB,uBAAA;AAAA,KAEf,sBAAA,GACR,4BAAA,GACA,4BAAA,GACA,6BAAA;AAAA,UAEa,oBAAA,SAA6B,uBAAA;EApByB;;;EAwBrE,YAAA;EApBa;;;EAyBb,kBAAA;AAAA;AAAA,KAGU,aAAA,GACR,sBAAA,GACA,sBAAA,GACA,oBAAA;AAAA,KACQ,mBAAA,GAAsB,wBAAA,CAAyB,aAAA;AAAA,KAE/C,eAAA,GACR,sBAAA,GACA,sBAAA,GACA,uBAAA;AAAA,KACQ,qBAAA,GAAwB,wBAAA,CAAyB,eAAA;AAAA,UAE5C,WAAA;EAlCuB;;;EAsCtC,EAAA;EApCU;;;EAyCV,IAAA;EAxCgD;AAElD;;EA2CE,IAAA;EA1CE;;;EA+CF,QAAA;EA7C+B;;;EAkD/B,KAAA;EAlD+B;;AAEjC;EAqDE,WAAA;;;;EAKA,KAAA;EAjDA;;;EAsDA,IAAA;EAnDuB;;;EAwDvB,SAAA;EArDE;;;;;;EA6DF,SAAA;AAAA;AAAA,UAGe,aAAA,SAAsB,WAAA;EA/DR;;;EAmE7B,EAAA;EAjEU;;;EAsEV,KAAA,EAAO,2BAAA;EApEL;;;;;;EA4EF,IAAA;EA3EyB;;AAC3B;EA+EE,MAAA;AAAA;AAAA,KAGU,WAAA,GAAc,aAAA;EAlFkD;AAE5E;;EAoFE,KAAA;EApF0B;;;EAyF1B,WAAA;EAtEA;;;EA2EA,KAAA;EAvDA;;;;;AAgBF;EA+CE,IAAA;;;;EAKA,MAAA;EA3CA;;;EAgDA,OAAA,EAAS,MAAA,SAAe,aAAA;EAnClB;;AAGR;EAqCE,IAAA,EAAM,eAAA;;;;EAKN,MAAA,SAAe,WAAA;EALT;;;EAUN,QAAA,EAAU,MAAA,SAAe,WAAA;AAAA;AAAA,KAGf,qBAAA,GAAwB,IAAA,CAAK,WAAA;EAlDf;;;EAsDxB,MAAA;EAhCA;;;EAoCA,QAAA,EAAU,MAAA,SAAe,qBAAA;AAAA;AAAA,UAGV,eAAA;EAxBT;;;;;;EA+BN,KAAA;EArBoC;AAGtC;;;;;EA0BE,WAAA;EAlBU;;;EAuBV,KAAA;EA/BuC;;;;;;EAuCvC,IAAA;EA5Be;;;;;;EAoCf,IAAA;EARA;;;;;AAmBF;EAHE,SAAA;AAAA;AAAA,UAGe,aAAA;EACf,QAAA,GAAW,eAAA;EACX,OAAA,GACI,MAAA,SAAe,mBAAA,IACf,iBAAA,GACA,oBAAA,CAAqB,MAAA,SAAe,oBAAA,KACpC,EAAA,CAAG,YAAA;EACP,IAAA,GACI,qBAAA,KACA,oBAAA,GACA,oBAAA,CAAqB,oBAAA,MACrB,EAAA,CAAG,WAAA;EACP,OAAA,GAAU,WAAA;AAAA"}

package/dist/types/command.d.mts

@@ -172,6 +172,10 @@ interface CommandConfig extends CommandBase {
    * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.
    */
   tags?: string[];
+  /**
+   * A string representing the source of the command, which can be "file", a specific plugin name, or any other string value that describes the source that added the command.
+   */
+  source?: "file" | string;
 }
 type CommandTree = CommandConfig & {
   /**
@@ -187,12 +191,16 @@ type CommandTree = CommandConfig & {
    */
   alias: string[];
   /**
-   * Optional tags for the command.
+   * A set of tags for the command.
    *
    * @remarks
    * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.
    */
   tags: string[];
+  /**
+   * A string representing the source of the command, which can be "file", a specific plugin name, or any other string value that describes the source that added the command.
+   */
+  source: "file" | string;
   /**
    * The command options.
    */

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

@@ -1 +1 @@
-{"version":3,"file":"command.d.mts","names":[],"sources":["../../src/types/command.ts"],"mappings":";;;;;;;;KAyBY,oBAAA;AAAA,cAMC,qBAAA;EAAA;;;;KAMD,oBAAA,WACF,qBAAA,eAAoC,qBAAA;AAAA,UAE7B,oBAAA;EALP;;;EASR,IAAA;;;;EAKA,IAAA,EAAM,oBAAA;EAZI;;;EAiBV,KAAA;EAhBiE;AAEnE;;EAmBE,WAAA;EAV0B;;;EAe1B,KAAA;EAVA;;;EAeA,GAAA;EAKA;;;EAAA,QAAA;EAQe;;;EAHf,QAAA;AAAA;AAAA,UAGe,sBAAA,SAA+B,oBAAA;EAS9C;;;EALA,IAAA;EAwBO;AAGT;;EAtBE,OAAA;EAsBkE;;;EAjBlE,MAAA;EA+BA;;;EAjBA,OAAA;AAAA;AAAA,UAGe,sBAAA,SAA+B,oBAAA;EAiBqB;;;EAbnE,IAAA;EAsBO;;AAGT;EApBE,OAAA;;;;EAKA,OAAA;AAAA;AAAA,UAGe,uBAAA,SAAgC,oBAAA;EAa7C;;;EATF,IAAA;EAWyB;AAE3B;;EARE,OAAA;AAAA;AAAA,KAGU,gBAAA,GACR,sBAAA,GACA,sBAAA,GACA,uBAAA;AAAA,KAEQ,wBAAA,WAAmC,oBAAA,IAAwB,IAAA,CACrE,CAAA,sBAGA,OAAA,CAAQ,IAAA,CAAK,CAAA;EACX,KAAA;AAAA;AAAA,KAGQ,4BAAA,GACV,wBAAA,CAAyB,sBAAA;AAAA,KACf,4BAAA,GACV,wBAAA,CAAyB,sBAAA;AAAA,KACf,6BAAA,GACV,wBAAA,CAAyB,uBAAA;AAAA,KAEf,sBAAA,GACR,4BAAA,GACA,4BAAA,GACA,6BAAA;AAAA,UAEa,oBAAA,SAA6B,uBAAA;EApByB;;;EAwBrE,YAAA;EApBa;;;EAyBb,kBAAA;AAAA;AAAA,KAGU,aAAA,GACR,sBAAA,GACA,sBAAA,GACA,oBAAA;AAAA,KACQ,mBAAA,GAAsB,wBAAA,CAAyB,aAAA;AAAA,KAE/C,eAAA,GACR,sBAAA,GACA,sBAAA,GACA,uBAAA;AAAA,KACQ,qBAAA,GAAwB,wBAAA,CAAyB,eAAA;AAAA,UAE5C,WAAA;EAlCuB;;;EAsCtC,EAAA;EApCU;;;EAyCV,IAAA;EAxCgD;AAElD;;EA2CE,IAAA;EA1CE;;;EA+CF,QAAA;EA7C+B;;;EAkD/B,KAAA;EAlD+B;;AAEjC;EAqDE,WAAA;;;;EAKA,KAAA;EAjDA;;;EAsDA,IAAA;EAnDuB;;;EAwDvB,SAAA;EArDE;;;;;;EA6DF,SAAA;AAAA;AAAA,UAGe,aAAA,SAAsB,WAAA;EA/DR;;;EAmE7B,EAAA;EAjEU;;;EAsEV,KAAA,EAAO,2BAAA;EApEL;;;;;;EA4EF,IAAA;AAAA;AAAA,KAGU,WAAA,GAAc,aAAA;EA7Ed;;;EAiFV,KAAA;EAjF0E;AAE5E;;EAoFE,WAAA;EApF0B;;;EAyF1B,KAAA;EAtEA;;;;;;EA8EA,IAAA;EA7CS;;AAGX;EA+CE,OAAA,EAAS,MAAA,SAAe,aAAA;;;;EAKxB,IAAA,EAAM,eAAA;EA3CN;;;EAgDA,MAAA,SAAe,WAAA;EAxCX;AAGN;;EA0CE,QAAA,EAAU,MAAA,SAAe,WAAA;AAAA;AAAA,KAGf,qBAAA,GAAwB,IAAA,CAAK,WAAA;EAlB9B;;;EAsBT,MAAA;EAPU;;;EAWV,QAAA,EAAU,MAAA,SAAe,qBAAA;AAAA;AAAA,UAGV,eAAA;EA1Cf;;;;;;EAiDA,KAAA;EA1BA;;;;;;EAkCA,WAAA;EA1BU;;;EA+BV,KAAA;EA/BkC;;;;;;EAuClC,IAAA;EAnCA;;;;;;EA2CA,IAAA;EApC8B;;;;;;EA4C9B,SAAA;AAAA;AAAA,UAGe,aAAA;EACf,QAAA,GAAW,eAAA;EACX,OAAA,GACI,MAAA,SAAe,mBAAA,IACf,iBAAA,GACA,oBAAA,CAAqB,MAAA,SAAe,oBAAA,KACpC,EAAA,CAAG,YAAA;EACP,IAAA,GACI,qBAAA,KACA,oBAAA,GACA,oBAAA,CAAqB,oBAAA,MACrB,EAAA,CAAG,WAAA;EACP,OAAA,GAAU,WAAA;AAAA"}
+{"version":3,"file":"command.d.mts","names":[],"sources":["../../src/types/command.ts"],"mappings":";;;;;;;;KAyBY,oBAAA;AAAA,cAMC,qBAAA;EAAA;;;;KAMD,oBAAA,WACF,qBAAA,eAAoC,qBAAA;AAAA,UAE7B,oBAAA;EALP;;;EASR,IAAA;;;;EAKA,IAAA,EAAM,oBAAA;EAZI;;;EAiBV,KAAA;EAhBiE;AAEnE;;EAmBE,WAAA;EAV0B;;;EAe1B,KAAA;EAVA;;;EAeA,GAAA;EAKA;;;EAAA,QAAA;EAQe;;;EAHf,QAAA;AAAA;AAAA,UAGe,sBAAA,SAA+B,oBAAA;EAS9C;;;EALA,IAAA;EAwBO;AAGT;;EAtBE,OAAA;EAsBkE;;;EAjBlE,MAAA;EA+BA;;;EAjBA,OAAA;AAAA;AAAA,UAGe,sBAAA,SAA+B,oBAAA;EAiBqB;;;EAbnE,IAAA;EAsBO;;AAGT;EApBE,OAAA;;;;EAKA,OAAA;AAAA;AAAA,UAGe,uBAAA,SAAgC,oBAAA;EAa7C;;;EATF,IAAA;EAWyB;AAE3B;;EARE,OAAA;AAAA;AAAA,KAGU,gBAAA,GACR,sBAAA,GACA,sBAAA,GACA,uBAAA;AAAA,KAEQ,wBAAA,WAAmC,oBAAA,IAAwB,IAAA,CACrE,CAAA,sBAGA,OAAA,CAAQ,IAAA,CAAK,CAAA;EACX,KAAA;AAAA;AAAA,KAGQ,4BAAA,GACV,wBAAA,CAAyB,sBAAA;AAAA,KACf,4BAAA,GACV,wBAAA,CAAyB,sBAAA;AAAA,KACf,6BAAA,GACV,wBAAA,CAAyB,uBAAA;AAAA,KAEf,sBAAA,GACR,4BAAA,GACA,4BAAA,GACA,6BAAA;AAAA,UAEa,oBAAA,SAA6B,uBAAA;EApByB;;;EAwBrE,YAAA;EApBa;;;EAyBb,kBAAA;AAAA;AAAA,KAGU,aAAA,GACR,sBAAA,GACA,sBAAA,GACA,oBAAA;AAAA,KACQ,mBAAA,GAAsB,wBAAA,CAAyB,aAAA;AAAA,KAE/C,eAAA,GACR,sBAAA,GACA,sBAAA,GACA,uBAAA;AAAA,KACQ,qBAAA,GAAwB,wBAAA,CAAyB,eAAA;AAAA,UAE5C,WAAA;EAlCuB;;;EAsCtC,EAAA;EApCU;;;EAyCV,IAAA;EAxCgD;AAElD;;EA2CE,IAAA;EA1CE;;;EA+CF,QAAA;EA7C+B;;;EAkD/B,KAAA;EAlD+B;;AAEjC;EAqDE,WAAA;;;;EAKA,KAAA;EAjDA;;;EAsDA,IAAA;EAnDuB;;;EAwDvB,SAAA;EArDE;;;;;;EA6DF,SAAA;AAAA;AAAA,UAGe,aAAA,SAAsB,WAAA;EA/DR;;;EAmE7B,EAAA;EAjEU;;;EAsEV,KAAA,EAAO,2BAAA;EApEL;;;;;;EA4EF,IAAA;EA3EyB;;AAC3B;EA+EE,MAAA;AAAA;AAAA,KAGU,WAAA,GAAc,aAAA;EAlFkD;AAE5E;;EAoFE,KAAA;EApF0B;;;EAyF1B,WAAA;EAtEA;;;EA2EA,KAAA;EAvDA;;;;;AAgBF;EA+CE,IAAA;;;;EAKA,MAAA;EA3CA;;;EAgDA,OAAA,EAAS,MAAA,SAAe,aAAA;EAnClB;;AAGR;EAqCE,IAAA,EAAM,eAAA;;;;EAKN,MAAA,SAAe,WAAA;EALT;;;EAUN,QAAA,EAAU,MAAA,SAAe,WAAA;AAAA;AAAA,KAGf,qBAAA,GAAwB,IAAA,CAAK,WAAA;EAlDf;;;EAsDxB,MAAA;EAhCA;;;EAoCA,QAAA,EAAU,MAAA,SAAe,qBAAA;AAAA;AAAA,UAGV,eAAA;EAxBT;;;;;;EA+BN,KAAA;EArBoC;AAGtC;;;;;EA0BE,WAAA;EAlBU;;;EAuBV,KAAA;EA/BuC;;;;;;EAuCvC,IAAA;EA5Be;;;;;;EAoCf,IAAA;EARA;;;;;AAmBF;EAHE,SAAA;AAAA;AAAA,UAGe,aAAA;EACf,QAAA,GAAW,eAAA;EACX,OAAA,GACI,MAAA,SAAe,mBAAA,IACf,iBAAA,GACA,oBAAA,CAAqB,MAAA,SAAe,oBAAA,KACpC,EAAA,CAAG,YAAA;EACP,IAAA,GACI,qBAAA,KACA,oBAAA,GACA,oBAAA,CAAqB,oBAAA,MACrB,EAAA,CAAG,WAAA;EACP,OAAA,GAAU,WAAA;AAAA"}

package/dist/types/command.mjs

@@ -44,23 +44,33 @@ const __ΩCommandParameterKind = [
 ];
 const __ΩBaseCommandParameter = [
 	"name",
+	"The option name.",
 	() => __ΩCommandParameterKind,
 	"kind",
+	"The option kind.",
 	"title",
+	"The display title.",
 	"description",
+	"The option description.",
 	"alias",
+	"Alternative option names.",
 	false,
 	"env",
+	"The environment variable name or false to disable.",
 	"optional",
+	"Whether the option is optional.",
 	"variadic",
+	"Whether the option accepts multiple values.",
 	"BaseCommandParameter",
-	"P&4!n\"4#&4$&4%&F4&P&.'J4()4))4*Mw+y"
+	"P&4!?\"n#4$?%&4&?'&4(?)&F4*?+P&.,J4-?.)4/?0)41?2Mw3y"
 ];
 const __ΩStringCommandParameter = [
 	() => __ΩBaseCommandParameter,
 	"string",
 	"kind",
+	"The option kind.",
 	"default",
+	"The default value.",
 	"email",
 	"uri",
 	"uuid",
@@ -71,26 +81,33 @@ const __ΩStringCommandParameter = [
 	"date-time",
 	"duration",
 	"format",
+	"A standard string format to validate the option value against.",
 	"choices",
+	"The allowed choices for the option value.",
 	"StringCommandParameter",
-	"Pn!.\"4#&4$8P.%.&.'.(.).*.+.,.-J4.8&F4/8Mw0y"
+	"Pn!.\"4#?$&4%8?&P.'.(.).*.+.,.-.../J408?1&F428?3Mw4y"
 ];
 const __ΩNumberCommandParameter = [
 	() => __ΩBaseCommandParameter,
 	"number",
 	"kind",
+	"The option kind.",
 	"default",
+	"The default value.",
 	"choices",
+	"The allowed choices for the option value.",
 	"NumberCommandParameter",
-	"Pn!.\"4#'4$8'F4%8Mw&y"
+	"Pn!.\"4#?$'4%8?&'F4'8?(Mw)y"
 ];
 const __ΩBooleanCommandParameter = [
 	() => __ΩBaseCommandParameter,
 	"boolean",
 	"kind",
+	"The option kind.",
 	"default",
+	"The default value.",
 	"BooleanCommandParameter",
-	"Pn!.\"4#)4$8Mw%y"
+	"Pn!.\"4#?$)4%8?&Mw'y"
 ];
 const __ΩCommandParameter = [
 	() => __ΩStringCommandParameter,
@@ -140,9 +157,11 @@ const __ΩCommandParameterConfig = [
 const __ΩBooleanCommandOption = [
 	() => __ΩBooleanCommandParameter,
 	"isNegativeOf",
+	"The option this negates.",
 	"skipAddingNegative",
+	"Whether to skip adding a negative option.",
 	"BooleanCommandOption",
-	"Pn!&4\"8)4#8Mw$y"
+	"Pn!&4\"8?#)4$8?%Mw&y"
 ];
 const __ΩCommandOption = [
 	() => __ΩStringCommandParameter,
@@ -172,44 +191,71 @@ const __ΩCommandArgumentConfig = [
 ];
 const __ΩCommandBase = [
 	"id",
+	"The command id.",
 	"name",
+	"The command name.",
 	"path",
+	"The full command path value.",
 	"segments",
+	"The path segments.",
 	"title",
+	"The display title.",
 	"description",
+	"The command description.",
 	"alias",
+	"Alternative command names.",
 	"icon",
+	"The command icon.",
 	"reference",
+	"A URL to the command documentation or reference.",
 	"isVirtual",
+	"Whether the command is virtual.",
 	"CommandBase",
-	"PP&,J4!&4\"P&,J4#&F4$&4%8&4&8&F4'8&4(8&4)8)4*Mw+y"
+	"PP&,J4!?\"&4#?$P&,J4%?&&F4'?(&4)8?*&4+8?,&F4-8?.&4/8?0&418?2)43?4Mw5y"
 ];
 const __ΩCommandConfig = [
 	() => __ΩCommandBase,
 	"id",
+	"The command id.",
 	"entry",
+	"The resolved entry definition.",
 	"tags",
+	"Optional tags for the command.",
+	"file",
+	"source",
+	"A string representing the source of the command, which can be \"file\", a specific plugin name, or any other string value that describes the source that added the command.",
 	"CommandConfig",
-	"Pn!&4\"!4#&F4$8Mw%y"
+	"Pn!&4\"?#!4$?%&F4&8?'P.(&J4)8?*Mw+y"
 ];
 const __ΩCommandTree = [
 	() => __ΩCommandConfig,
 	"title",
+	"The display title.",
 	"description",
+	"The command description.",
 	"alias",
+	"Alternative command names.",
 	"tags",
+	"A set of tags for the command.",
+	"file",
+	"source",
+	"A string representing the source of the command, which can be \"file\", a specific plugin name, or any other string value that describes the source that added the command.",
 	() => __ΩRecord,
 	() => __ΩCommandOption,
 	"options",
+	"The command options.",
 	() => __ΩCommandArgument,
 	"args",
+	"The positional arguments provided to the command.",
 	0,
 	"parent",
+	"The parent command.",
 	() => __ΩRecord,
 	0,
 	"children",
+	"Child commands.",
 	"CommandTree",
-	"Pn!P&4\"&4#&F4$&F4%&n'o&#4(n)F4*P,n+J4,&n.o-#4/MKw0y"
+	"Pn!P&4\"?#&4$?%&F4&?'&F4(?)P.*&J4+?,&n.o-#4/?0n1F42?3P,n4J45?6&n8o7#49?:MKw;y"
 ];
 const __ΩSerializedCommandTree = [
 	() => __ΩOmit,
@@ -217,21 +263,29 @@ const __ΩSerializedCommandTree = [
 	"parent",
 	"children",
 	"parent",
+	"The parent command id.",
 	() => __ΩRecord,
 	0,
 	"children",
+	"Serialized child commands.",
 	"SerializedCommandTree",
-	"Pn\"P.#.$Jo!#PP,&J4%&n'o&#4(MKw)y"
+	"Pn\"P.#.$Jo!#PP,&J4%?&&n(o'#4)?*MKw+y"
 ];
 const __ΩCommandMetadata = [
 	"title",
+	"The display name of the command.",
 	"description",
+	"A brief description of what the command does.",
 	"alias",
+	"One or more alternative names for the command.",
 	"tags",
+	"Optional tags for the command.",
 	"icon",
+	"An optional icon to visually represent the command in user interfaces.",
 	"reference",
+	"A URL to the command documentation or reference.",
 	"CommandMetadata",
-	"P&4!8&4\"8P&&FJ4#8&F4$8&4%8&4&8Mw'y"
+	"P&4!8?\"&4#8?$P&&FJ4%8?&&F4'8?(&4)8?*&4+8?,Mw-y"
 ];
 const __ΩCommandModule = [
 	() => __ΩCommandMetadata,

package/dist/types/command.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"command.mjs","names":[],"sources":["../../src/types/command.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { StandardJSONSchemaV1 } from \"@standard-schema/spec\";\nimport type { JsonSchema7TupleType } from \"@stryke/json\";\nimport type { AnyFunction } from \"@stryke/types/base\";\nimport type { JSONSchema7Object } from \"json-schema\";\nimport type { ResolvedEntryTypeDefinition } from \"powerlines\";\nimport type * as z3 from \"zod/v3\";\n\nexport type CommandParameterType =\n  | string\n  | number\n  | boolean\n  | (string | number)[];\n\nexport const CommandParameterKinds = {\n  string: \"string\",\n  number: \"number\",\n  boolean: \"boolean\"\n} as const;\n\nexport type CommandParameterKind =\n  (typeof CommandParameterKinds)[keyof typeof CommandParameterKinds];\n\nexport interface BaseCommandParameter {\n  /**\n   * The option name.\n   */\n  name: string;\n\n  /**\n   * The option kind.\n   */\n  kind: CommandParameterKind;\n\n  /**\n   * The display title.\n   */\n  title: string;\n\n  /**\n   * The option description.\n   */\n  description: string;\n\n  /**\n   * Alternative option names.\n   */\n  alias: string[];\n\n  /**\n   * The environment variable name or false to disable.\n   */\n  env: string | false;\n\n  /**\n   * Whether the option is optional.\n   */\n  optional: boolean;\n\n  /**\n   * Whether the option accepts multiple values.\n   */\n  variadic: boolean;\n}\n\nexport interface StringCommandParameter extends BaseCommandParameter {\n  /**\n   * The option kind.\n   */\n  kind: \"string\";\n\n  /**\n   * The default value.\n   */\n  default?: string;\n\n  /**\n   * A standard string format to validate the option value against.\n   */\n  format?:\n    | \"email\"\n    | \"uri\"\n    | \"uuid\"\n    | \"ipv4\"\n    | \"ipv6\"\n    | \"date\"\n    | \"time\"\n    | \"date-time\"\n    | \"duration\";\n\n  /**\n   * The allowed choices for the option value.\n   */\n  choices?: string[];\n}\n\nexport interface NumberCommandParameter extends BaseCommandParameter {\n  /**\n   * The option kind.\n   */\n  kind: \"number\";\n\n  /**\n   * The default value.\n   */\n  default?: number;\n\n  /**\n   * The allowed choices for the option value.\n   */\n  choices?: number[];\n}\n\nexport interface BooleanCommandParameter extends BaseCommandParameter {\n  /**\n   * The option kind.\n   */\n  kind: \"boolean\";\n\n  /**\n   * The default value.\n   */\n  default?: boolean;\n}\n\nexport type CommandParameter =\n  | StringCommandParameter\n  | NumberCommandParameter\n  | BooleanCommandParameter;\n\nexport type AsCommandParameterConfig<T extends BaseCommandParameter> = Pick<\n  T,\n  \"kind\" | \"alias\"\n> &\n  Partial<Omit<T, \"kind\" | \"alias\">> & {\n    alias?: string | string[];\n  };\n\nexport type StringCommandParameterConfig =\n  AsCommandParameterConfig<StringCommandParameter>;\nexport type NumberCommandParameterConfig =\n  AsCommandParameterConfig<NumberCommandParameter>;\nexport type BooleanCommandParameterConfig =\n  AsCommandParameterConfig<BooleanCommandParameter>;\n\nexport type CommandParameterConfig =\n  | StringCommandParameterConfig\n  | NumberCommandParameterConfig\n  | BooleanCommandParameterConfig;\n\nexport interface BooleanCommandOption extends BooleanCommandParameter {\n  /**\n   * The option this negates.\n   */\n  isNegativeOf?: string;\n\n  /**\n   * Whether to skip adding a negative option.\n   */\n  skipAddingNegative?: boolean;\n}\n\nexport type CommandOption =\n  | StringCommandParameter\n  | NumberCommandParameter\n  | BooleanCommandOption;\nexport type CommandOptionConfig = AsCommandParameterConfig<CommandOption>;\n\nexport type CommandArgument =\n  | StringCommandParameter\n  | NumberCommandParameter\n  | BooleanCommandParameter;\nexport type CommandArgumentConfig = AsCommandParameterConfig<CommandArgument>;\n\nexport interface CommandBase {\n  /**\n   * The command id.\n   */\n  id: string | null;\n\n  /**\n   * The command name.\n   */\n  name: string;\n\n  /**\n   * The full command path value.\n   */\n  path: string | null;\n\n  /**\n   * The path segments.\n   */\n  segments: string[];\n\n  /**\n   * The display title.\n   */\n  title?: string;\n\n  /**\n   * The command description.\n   */\n  description?: string;\n\n  /**\n   * Alternative command names.\n   */\n  alias?: string[];\n\n  /**\n   * The command icon.\n   */\n  icon?: string;\n\n  /**\n   * A URL to the command documentation or reference.\n   */\n  reference?: string;\n\n  /**\n   * Whether the command is virtual.\n   *\n   * @remarks\n   * Virtual commands are considered forks in the command tree and are not directly executable. They are used to group related subcommands together without having an actual command handler or entry point.\n   */\n  isVirtual: boolean;\n}\n\nexport interface CommandConfig extends CommandBase {\n  /**\n   * The command id.\n   */\n  id: string;\n\n  /**\n   * The resolved entry definition.\n   */\n  entry: ResolvedEntryTypeDefinition;\n\n  /**\n   * Optional tags for the command.\n   *\n   * @remarks\n   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.\n   */\n  tags?: string[];\n}\n\nexport type CommandTree = CommandConfig & {\n  /**\n   * The display title.\n   */\n  title: string;\n\n  /**\n   * The command description.\n   */\n  description: string;\n\n  /**\n   * Alternative command names.\n   */\n  alias: string[];\n\n  /**\n   * Optional tags for the command.\n   *\n   * @remarks\n   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.\n   */\n  tags: string[];\n\n  /**\n   * The command options.\n   */\n  options: Record<string, CommandOption>;\n\n  /**\n   * The positional arguments provided to the command.\n   */\n  args: CommandArgument[];\n\n  /**\n   * The parent command.\n   */\n  parent: null | CommandTree;\n\n  /**\n   * Child commands.\n   */\n  children: Record<string, CommandTree>;\n};\n\nexport type SerializedCommandTree = Omit<CommandTree, \"parent\" | \"children\"> & {\n  /**\n   * The parent command id.\n   */\n  parent: null | string;\n  /**\n   * Serialized child commands.\n   */\n  children: Record<string, SerializedCommandTree>;\n};\n\nexport interface CommandMetadata {\n  /**\n   * The display name of the command.\n   *\n   * @remarks\n   * This value will be used in various displays of the user interface and documentation. If not provided, a formatted value of the command name will be used.\n   */\n  title?: string;\n\n  /**\n   * A brief description of what the command does.\n   *\n   * @remarks\n   * This value will be used in various displays of the user interface and documentation. If not provided, a default message may be shown.\n   */\n  description?: string;\n\n  /**\n   * One or more alternative names for the command.\n   */\n  alias?: string | string[];\n\n  /**\n   * Optional tags for the command.\n   *\n   * @remarks\n   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.\n   */\n  tags?: string[];\n\n  /**\n   * An optional icon to visually represent the command in user interfaces.\n   *\n   * @remarks\n   * This can be a string containing an emoji, a Unicode character, or any other symbol that helps to visually identify the command. If not provided, no icon will be displayed.\n   */\n  icon?: string;\n\n  /**\n   * A URL to the command documentation or reference.\n   *\n   * @remarks\n   * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the command. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{referenceLink}/command/subcommand`.\n   */\n  reference?: string;\n}\n\nexport interface CommandModule {\n  metadata?: CommandMetadata;\n  options?:\n    | Record<string, CommandOptionConfig>\n    | JSONSchema7Object\n    | StandardJSONSchemaV1<Record<string, CommandParameterType>>\n    | z3.AnyZodObject;\n  args?:\n    | CommandArgumentConfig[]\n    | JsonSchema7TupleType\n    | StandardJSONSchemaV1<CommandParameterType[]>\n    | z3.AnyZodTuple;\n  default?: AnyFunction;\n}\n"],"mappings":";AAAA,MAAM,UAAU;CAAC;CAAK;CAAK;CAAQ;CAA4B;;;;;;AAE/D,MAAM,UAAU;CAAC;CAAG;OAAM;OAAiB;CAAA;CAAA;CAAA;;;;;;;AAE3C,MAAM,aAAS;CAAA;CAAS;CAAG;CAAY;CAA2B;AAClE,MAAI,0BAA4B,CAAC,wBAAqB,gBAAa;AAEnE,MAAK,wBAA0B;;CAE9B,QAAW;CACX,SAAY;CACZ;AACD,MAAC,0BAA+B;OAAG;OAAkB;CAAA;CAAA;CAAA;AAErD,MAAM,0BAAqB;CAAM;OAAG;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEpC,MAAM,4BAA4B;OAAO;CAAyB;CAAI;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEtE,MAAM,4BAA4B;OAAO;CAAwB;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEjE,MAAM,6BAA6B;OAAO;CAAW;CAAA;CAAA;CAAA;CAAA;CAAA;AAErD,MAAM,sBAAQ;OAAA;OAA+C;OAAA;CAAA;CAAA;CAAA;;;;;;;;;;;;;;AAI7D,MAAI,kCAAA;OAAA;OAAA;CAAA;CAAA;CAAA;AAEJ,MAAI,kCAAA;OAAA;OAAA;CAAA;CAAA;CAAA;;;;;;;AAIJ,MAAE,4BAAgB;OAAA;OAAA;OAAA;CAAA;CAAA;CAAA;AAElB,MAAE,0BAAiB;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;;;;AAInB,MAAG,yBAA4B;OAAO;OAA8B;CAAA;CAAA;CAAA;AAEpE,MAAM,qBAAW;OAAA;OAAqB;OAAA;CAAA;CAAA;CAAA;AAEtC,MAAK,2BAAe;OAAA;OAAA;CAAA;CAAA;CAAA;AAEpB,MAAM,iBAAQ;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEd,MAAI,mBAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEJ,MAAI,iBAAA;OAAA;CAAA;CAAA;CAAA;CAAA;OAAA;OAAA;CAAA;OAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;;;;;;;;;AAIJ,MAAK,qBAAiB;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEtB,MAAE,mBAAa;OAAA;CAAA;OAAA;OAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}
+{"version":3,"file":"command.mjs","names":[],"sources":["../../src/types/command.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { StandardJSONSchemaV1 } from \"@standard-schema/spec\";\nimport type { JsonSchema7TupleType } from \"@stryke/json\";\nimport type { AnyFunction } from \"@stryke/types/base\";\nimport type { JSONSchema7Object } from \"json-schema\";\nimport type { ResolvedEntryTypeDefinition } from \"powerlines\";\nimport type * as z3 from \"zod/v3\";\n\nexport type CommandParameterType =\n  | string\n  | number\n  | boolean\n  | (string | number)[];\n\nexport const CommandParameterKinds = {\n  string: \"string\",\n  number: \"number\",\n  boolean: \"boolean\"\n} as const;\n\nexport type CommandParameterKind =\n  (typeof CommandParameterKinds)[keyof typeof CommandParameterKinds];\n\nexport interface BaseCommandParameter {\n  /**\n   * The option name.\n   */\n  name: string;\n\n  /**\n   * The option kind.\n   */\n  kind: CommandParameterKind;\n\n  /**\n   * The display title.\n   */\n  title: string;\n\n  /**\n   * The option description.\n   */\n  description: string;\n\n  /**\n   * Alternative option names.\n   */\n  alias: string[];\n\n  /**\n   * The environment variable name or false to disable.\n   */\n  env: string | false;\n\n  /**\n   * Whether the option is optional.\n   */\n  optional: boolean;\n\n  /**\n   * Whether the option accepts multiple values.\n   */\n  variadic: boolean;\n}\n\nexport interface StringCommandParameter extends BaseCommandParameter {\n  /**\n   * The option kind.\n   */\n  kind: \"string\";\n\n  /**\n   * The default value.\n   */\n  default?: string;\n\n  /**\n   * A standard string format to validate the option value against.\n   */\n  format?:\n    | \"email\"\n    | \"uri\"\n    | \"uuid\"\n    | \"ipv4\"\n    | \"ipv6\"\n    | \"date\"\n    | \"time\"\n    | \"date-time\"\n    | \"duration\";\n\n  /**\n   * The allowed choices for the option value.\n   */\n  choices?: string[];\n}\n\nexport interface NumberCommandParameter extends BaseCommandParameter {\n  /**\n   * The option kind.\n   */\n  kind: \"number\";\n\n  /**\n   * The default value.\n   */\n  default?: number;\n\n  /**\n   * The allowed choices for the option value.\n   */\n  choices?: number[];\n}\n\nexport interface BooleanCommandParameter extends BaseCommandParameter {\n  /**\n   * The option kind.\n   */\n  kind: \"boolean\";\n\n  /**\n   * The default value.\n   */\n  default?: boolean;\n}\n\nexport type CommandParameter =\n  | StringCommandParameter\n  | NumberCommandParameter\n  | BooleanCommandParameter;\n\nexport type AsCommandParameterConfig<T extends BaseCommandParameter> = Pick<\n  T,\n  \"kind\" | \"alias\"\n> &\n  Partial<Omit<T, \"kind\" | \"alias\">> & {\n    alias?: string | string[];\n  };\n\nexport type StringCommandParameterConfig =\n  AsCommandParameterConfig<StringCommandParameter>;\nexport type NumberCommandParameterConfig =\n  AsCommandParameterConfig<NumberCommandParameter>;\nexport type BooleanCommandParameterConfig =\n  AsCommandParameterConfig<BooleanCommandParameter>;\n\nexport type CommandParameterConfig =\n  | StringCommandParameterConfig\n  | NumberCommandParameterConfig\n  | BooleanCommandParameterConfig;\n\nexport interface BooleanCommandOption extends BooleanCommandParameter {\n  /**\n   * The option this negates.\n   */\n  isNegativeOf?: string;\n\n  /**\n   * Whether to skip adding a negative option.\n   */\n  skipAddingNegative?: boolean;\n}\n\nexport type CommandOption =\n  | StringCommandParameter\n  | NumberCommandParameter\n  | BooleanCommandOption;\nexport type CommandOptionConfig = AsCommandParameterConfig<CommandOption>;\n\nexport type CommandArgument =\n  | StringCommandParameter\n  | NumberCommandParameter\n  | BooleanCommandParameter;\nexport type CommandArgumentConfig = AsCommandParameterConfig<CommandArgument>;\n\nexport interface CommandBase {\n  /**\n   * The command id.\n   */\n  id: string | null;\n\n  /**\n   * The command name.\n   */\n  name: string;\n\n  /**\n   * The full command path value.\n   */\n  path: string | null;\n\n  /**\n   * The path segments.\n   */\n  segments: string[];\n\n  /**\n   * The display title.\n   */\n  title?: string;\n\n  /**\n   * The command description.\n   */\n  description?: string;\n\n  /**\n   * Alternative command names.\n   */\n  alias?: string[];\n\n  /**\n   * The command icon.\n   */\n  icon?: string;\n\n  /**\n   * A URL to the command documentation or reference.\n   */\n  reference?: string;\n\n  /**\n   * Whether the command is virtual.\n   *\n   * @remarks\n   * Virtual commands are considered forks in the command tree and are not directly executable. They are used to group related subcommands together without having an actual command handler or entry point.\n   */\n  isVirtual: boolean;\n}\n\nexport interface CommandConfig extends CommandBase {\n  /**\n   * The command id.\n   */\n  id: string;\n\n  /**\n   * The resolved entry definition.\n   */\n  entry: ResolvedEntryTypeDefinition;\n\n  /**\n   * Optional tags for the command.\n   *\n   * @remarks\n   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.\n   */\n  tags?: string[];\n\n  /**\n   * A string representing the source of the command, which can be \"file\", a specific plugin name, or any other string value that describes the source that added the command.\n   */\n  source?: \"file\" | string;\n}\n\nexport type CommandTree = CommandConfig & {\n  /**\n   * The display title.\n   */\n  title: string;\n\n  /**\n   * The command description.\n   */\n  description: string;\n\n  /**\n   * Alternative command names.\n   */\n  alias: string[];\n\n  /**\n   * A set of tags for the command.\n   *\n   * @remarks\n   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.\n   */\n  tags: string[];\n\n  /**\n   * A string representing the source of the command, which can be \"file\", a specific plugin name, or any other string value that describes the source that added the command.\n   */\n  source: \"file\" | string;\n\n  /**\n   * The command options.\n   */\n  options: Record<string, CommandOption>;\n\n  /**\n   * The positional arguments provided to the command.\n   */\n  args: CommandArgument[];\n\n  /**\n   * The parent command.\n   */\n  parent: null | CommandTree;\n\n  /**\n   * Child commands.\n   */\n  children: Record<string, CommandTree>;\n};\n\nexport type SerializedCommandTree = Omit<CommandTree, \"parent\" | \"children\"> & {\n  /**\n   * The parent command id.\n   */\n  parent: null | string;\n  /**\n   * Serialized child commands.\n   */\n  children: Record<string, SerializedCommandTree>;\n};\n\nexport interface CommandMetadata {\n  /**\n   * The display name of the command.\n   *\n   * @remarks\n   * This value will be used in various displays of the user interface and documentation. If not provided, a formatted value of the command name will be used.\n   */\n  title?: string;\n\n  /**\n   * A brief description of what the command does.\n   *\n   * @remarks\n   * This value will be used in various displays of the user interface and documentation. If not provided, a default message may be shown.\n   */\n  description?: string;\n\n  /**\n   * One or more alternative names for the command.\n   */\n  alias?: string | string[];\n\n  /**\n   * Optional tags for the command.\n   *\n   * @remarks\n   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.\n   */\n  tags?: string[];\n\n  /**\n   * An optional icon to visually represent the command in user interfaces.\n   *\n   * @remarks\n   * This can be a string containing an emoji, a Unicode character, or any other symbol that helps to visually identify the command. If not provided, no icon will be displayed.\n   */\n  icon?: string;\n\n  /**\n   * A URL to the command documentation or reference.\n   *\n   * @remarks\n   * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the command. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{referenceLink}/command/subcommand`.\n   */\n  reference?: string;\n}\n\nexport interface CommandModule {\n  metadata?: CommandMetadata;\n  options?:\n    | Record<string, CommandOptionConfig>\n    | JSONSchema7Object\n    | StandardJSONSchemaV1<Record<string, CommandParameterType>>\n    | z3.AnyZodObject;\n  args?:\n    | CommandArgumentConfig[]\n    | JsonSchema7TupleType\n    | StandardJSONSchemaV1<CommandParameterType[]>\n    | z3.AnyZodTuple;\n  default?: AnyFunction;\n}\n"],"mappings":";AAAA,MAAM,UAAU;CAAC;CAAK;CAAK;CAAQ;CAA4B;;;;;;AAE/D,MAAM,UAAU;CAAC;CAAG;OAAM;OAAiB;CAAA;CAAA;CAAA;;;;;;;AAE3C,MAAM,aAAS;CAAA;CAAS;CAAG;CAAY;CAA2B;AAClE,MAAI,0BAA4B,CAAC,wBAAqB,gBAAa;AAEnE,MAAK,wBAA0B;;CAE9B,QAAW;CACX,SAAY;CACZ;AACD,MAAC,0BAA+B;OAAG;OAAkB;CAAA;CAAA;CAAA;AAErD,MAAM,0BAAqB;CAAM;CAAG;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEpC,MAAM,4BAA4B;OAAO;CAAyB;CAAI;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEtE,MAAM,4BAA4B;OAAO;CAAwB;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEjE,MAAM,6BAA6B;OAAO;CAAW;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAErD,MAAM,sBAAQ;OAAA;OAA+C;OAAA;CAAA;CAAA;CAAA;;;;;;;;;;;;;;AAI7D,MAAI,kCAAA;OAAA;OAAA;CAAA;CAAA;CAAA;AAEJ,MAAI,kCAAA;OAAA;OAAA;CAAA;CAAA;CAAA;;;;;;;AAIJ,MAAE,4BAAgB;OAAA;OAAA;OAAA;CAAA;CAAA;CAAA;AAElB,MAAE,0BAAiB;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;;;;AAInB,MAAG,yBAA4B;OAAO;OAA8B;CAAA;CAAA;CAAA;AAEpE,MAAM,qBAAW;OAAA;OAAqB;OAAA;CAAA;CAAA;CAAA;AAEtC,MAAK,2BAAe;OAAA;OAAA;CAAA;CAAA;CAAA;AAEpB,MAAM,iBAAQ;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEd,MAAI,mBAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEJ,MAAI,iBAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;OAAA;OAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;;;;;;;;;;;AAIJ,MAAK,qBAAiB;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEtB,MAAE,mBAAa;OAAA;CAAA;OAAA;OAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}

package/dist/types/config.cjs

@@ -55,9 +55,11 @@ const __ΩBuildOptions = [
 ];
 const __ΩReferenceOptions = [
 	"app",
+	"A URL to the application documentation or reference.",
 	"commands",
+	"A URL to the application command specific documentation or reference.",
 	"ReferenceOptions",
-	"P&4!&4\"8Mw#y"
+	"P&4!?\"&4#8?$Mw%y"
 ];
 const __ΩBaseOptions = [
 	() => __ΩPartial,
@@ -70,15 +72,20 @@ const __ΩBaseOptions = [
 	"",
 	false,
 	"globalOptions",
+	"A set of global command options to apply to each command.",
 	"isCaseSensitive",
 	true,
+	"Determines whether commands and option names are treated as case-sensitive.",
 	"bin",
+	"The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).",
 	true,
 	"autoAssignEnv",
+	"Should Shell Shock attempt to automatically assign environment variables to manipulate default values for command options based on the option name?",
 	() => __ΩReferenceOptions,
 	"reference",
+	"A URL to the application documentation or reference.",
 	"BaseOptions",
-	"Pn\"o!\"PP\"w#FP\"w$2%\"w&2'\"w#F/(.)J4*8)4+8>,P&&FJ4-8P..&J4/8Pn0&J418MKw2y"
+	"Pn\"o!\"PP\"w#FP\"w$2%\"w&2'\"w#F/(.)J4*8?+)4,8>-?.P&&FJ4/8?0P.1&J428?3Pn4&J458?6MKw7y"
 ];
 const __ΩOptions = [
 	() => __ΩBaseOptions,
@@ -93,8 +100,9 @@ const __ΩOutputConfig = [
 	"storage",
 	false,
 	"dts",
+	"An indicator specifying whether to generate TypeScript declaration files (.d.ts) during the build process.",
 	"OutputConfig",
-	"P!P.\".#.$Jo!#P.%4&8MKw'y"
+	"P!P.\".#.$Jo!#P.%4&8?'MKw(y"
 ];
 const __ΩUserConfig = [
 	() => __ΩBaseOptions,
@@ -103,8 +111,9 @@ const __ΩUserConfig = [
 	"root",
 	() => __ΩOutputConfig,
 	"output",
+	"Configuration for the output of the build process",
 	"UserConfig",
-	"Pn!!o\"\"!.$o##Pn%4&8MKw'y"
+	"Pn!!o\"\"!.$o##Pn%4&8?'MKw(y"
 ];
 const __ΩResolvedConfig = [
 	() => __ΩRequired,
@@ -114,13 +123,17 @@ const __ΩResolvedConfig = [
 	"reference",
 	() => __ΩRecord,
 	"bin",
+	"The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).",
 	() => __ΩReferenceOptions,
 	"reference",
+	"The URL(s) to the application documentation or reference.",
 	"appSpecificEnvPrefix",
+	"The command-line application specific environment variable prefix used for automatically assigning environment variables to command options.",
 	() => __ΩUserConfig,
 	"userConfig",
+	"The user configuration for the Shell Shock process.",
 	"ResolvedConfig",
-	"P!!!n#P.$.%Jo\"#o!\"P&&o&#4'n(4)&4*n+4,MKw-y"
+	"P!!!n#P.$.%Jo\"#o!\"P&&o&#4'?(n)4*?+&4,?-n.4/?0MKw1y"
 ];
 
 //#endregion
@@ -128,5 +141,4 @@ exports.__ΩOptions = __ΩOptions;
 exports.__ΩOutputConfig = __ΩOutputConfig;
 exports.__ΩReferenceOptions = __ΩReferenceOptions;
 exports.__ΩResolvedConfig = __ΩResolvedConfig;
-exports.__ΩUserConfig = __ΩUserConfig;
-//# sourceMappingURL=config.cjs.map
+exports.__ΩUserConfig = __ΩUserConfig;

package/dist/types/config.d.cts

@@ -1,7 +1,7 @@
 import { CommandBase, CommandOption } from "./command.cjs";
 import { Context } from "./context.cjs";
 import { OutputConfig as OutputConfig$1 } from "powerlines";
-import { AutoMDPluginResolvedConfig } from "@powerlines/plugin-automd/types/plugin";
+import { AutoMDPluginResolvedConfig } from "@powerlines/plugin-automd";
 import { NodeJsPluginOptions, NodeJsPluginResolvedConfig, NodeJsPluginUserConfig } from "@powerlines/plugin-nodejs/types/plugin";
 import { TsdownPluginResolvedConfig, TsdownPluginUserConfig } from "@powerlines/plugin-tsdown/types/plugin";
 

package/dist/types/config.d.mts

@@ -1,7 +1,7 @@
 import { CommandBase, CommandOption } from "./command.mjs";
 import { Context } from "./context.mjs";
 import { OutputConfig as OutputConfig$1 } from "powerlines";
-import { AutoMDPluginResolvedConfig } from "@powerlines/plugin-automd/types/plugin";
+import { AutoMDPluginResolvedConfig } from "@powerlines/plugin-automd";
 import { NodeJsPluginOptions, NodeJsPluginResolvedConfig, NodeJsPluginUserConfig } from "@powerlines/plugin-nodejs/types/plugin";
 import { TsdownPluginResolvedConfig, TsdownPluginUserConfig } from "@powerlines/plugin-tsdown/types/plugin";
 

package/dist/types/config.mjs

@@ -53,9 +53,11 @@ const __ΩBuildOptions = [
 ];
 const __ΩReferenceOptions = [
 	"app",
+	"A URL to the application documentation or reference.",
 	"commands",
+	"A URL to the application command specific documentation or reference.",
 	"ReferenceOptions",
-	"P&4!&4\"8Mw#y"
+	"P&4!?\"&4#8?$Mw%y"
 ];
 const __ΩBaseOptions = [
 	() => __ΩPartial,
@@ -68,15 +70,20 @@ const __ΩBaseOptions = [
 	"",
 	false,
 	"globalOptions",
+	"A set of global command options to apply to each command.",
 	"isCaseSensitive",
 	true,
+	"Determines whether commands and option names are treated as case-sensitive.",
 	"bin",
+	"The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).",
 	true,
 	"autoAssignEnv",
+	"Should Shell Shock attempt to automatically assign environment variables to manipulate default values for command options based on the option name?",
 	() => __ΩReferenceOptions,
 	"reference",
+	"A URL to the application documentation or reference.",
 	"BaseOptions",
-	"Pn\"o!\"PP\"w#FP\"w$2%\"w&2'\"w#F/(.)J4*8)4+8>,P&&FJ4-8P..&J4/8Pn0&J418MKw2y"
+	"Pn\"o!\"PP\"w#FP\"w$2%\"w&2'\"w#F/(.)J4*8?+)4,8>-?.P&&FJ4/8?0P.1&J428?3Pn4&J458?6MKw7y"
 ];
 const __ΩOptions = [
 	() => __ΩBaseOptions,
@@ -91,8 +98,9 @@ const __ΩOutputConfig = [
 	"storage",
 	false,
 	"dts",
+	"An indicator specifying whether to generate TypeScript declaration files (.d.ts) during the build process.",
 	"OutputConfig",
-	"P!P.\".#.$Jo!#P.%4&8MKw'y"
+	"P!P.\".#.$Jo!#P.%4&8?'MKw(y"
 ];
 const __ΩUserConfig = [
 	() => __ΩBaseOptions,
@@ -101,8 +109,9 @@ const __ΩUserConfig = [
 	"root",
 	() => __ΩOutputConfig,
 	"output",
+	"Configuration for the output of the build process",
 	"UserConfig",
-	"Pn!!o\"\"!.$o##Pn%4&8MKw'y"
+	"Pn!!o\"\"!.$o##Pn%4&8?'MKw(y"
 ];
 const __ΩResolvedConfig = [
 	() => __ΩRequired,
@@ -112,13 +121,17 @@ const __ΩResolvedConfig = [
 	"reference",
 	() => __ΩRecord,
 	"bin",
+	"The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).",
 	() => __ΩReferenceOptions,
 	"reference",
+	"The URL(s) to the application documentation or reference.",
 	"appSpecificEnvPrefix",
+	"The command-line application specific environment variable prefix used for automatically assigning environment variables to command options.",
 	() => __ΩUserConfig,
 	"userConfig",
+	"The user configuration for the Shell Shock process.",
 	"ResolvedConfig",
-	"P!!!n#P.$.%Jo\"#o!\"P&&o&#4'n(4)&4*n+4,MKw-y"
+	"P!!!n#P.$.%Jo\"#o!\"P&&o&#4'?(n)4*?+&4,?-n.4/?0MKw1y"
 ];
 
 //#endregion

package/dist/types/config.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"config.mjs","names":[],"sources":["../../src/types/config.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { AutoMDPluginResolvedConfig } from \"@powerlines/plugin-automd/types/plugin\";\nimport type {\n  NodeJsPluginOptions,\n  NodeJsPluginResolvedConfig,\n  NodeJsPluginUserConfig\n} from \"@powerlines/plugin-nodejs/types/plugin\";\nimport type {\n  TsdownPluginResolvedConfig,\n  TsdownPluginUserConfig\n} from \"@powerlines/plugin-tsdown/types/plugin\";\nimport type { OutputConfig as PowerlinesOutputConfig } from \"powerlines\";\nimport type { CommandBase, CommandOption } from \"./command\";\nimport type { Context } from \"./context\";\n\ntype BuildOptions = Pick<\n  TsdownPluginUserConfig,\n  | \"root\"\n  | \"name\"\n  | \"title\"\n  | \"description\"\n  | \"logLevel\"\n  | \"mode\"\n  | \"skipCache\"\n  | \"autoInstall\"\n  | \"plugins\"\n  | \"tsconfig\"\n  | \"tsconfigRaw\"\n>;\n\nexport interface ReferenceOptions {\n  /**\n   * A URL to the application documentation or reference.\n   */\n  app: string;\n\n  /**\n   * A URL to the application command specific documentation or reference.\n   *\n   * @remarks\n   * This URL is expected to contain the token `{command}`, which will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{reference}/command/subcommand`.\n   */\n  commands?: string;\n}\n\ntype BaseOptions = Partial<BuildOptions> & {\n  /**\n   * A set of global command options to apply to each command.\n   *\n   * @remarks\n   * Each command will inherit these global options. To disable the addition of these global options, set this property to `false`, or provide a custom set of options/a function that returns them. A `GlobalOptions` interface will be created by the `shell-shock types` command and added to the generated `shell-shock.d.ts` file.\n   */\n  globalOptions?:\n    | CommandOption[]\n    | ((context: Context, input: CommandBase) => CommandOption[])\n    | false;\n\n  /**\n   * Determines whether commands and option names are treated as case-sensitive.\n   *\n   * @defaultValue `false`\n   */\n  isCaseSensitive?: boolean;\n\n  /**\n   * The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).\n   *\n   * @remarks\n   * If an array is provided, each binary will be linked to the same compiled output file. If not provided, the {@link Options.name | name} option will be used.\n   *\n   * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin\n   * @see https://yarnpkg.com/cli/bin\n   * @see https://pnpm.io/package_json#bin\n   */\n  bin?: string | string[];\n\n  /**\n   * Should Shell Shock attempt to automatically assign environment variables to manipulate default values for command options based on the option name?\n   *\n   * @remarks\n   * If set to a string, Shell Shock will use the provided string as an application specific environment variable prefix, convert the option name to {@link https://stringcase.org/cases/constant/ | constant case}, and prepend the provided `string` value to determine the corresponding environment variable name. For example, if an option is named `\"configPath\"` and the `autoAssignEnv` is `\"MY_APP_\"`, Shell Shock will look for an environment variable named `\"MY_APP_CONFIG_PATH\"` and assign its value to the option if it exists. If set to `true`, Shell Shock will use a default environment variable prefix derived from the {@link Options.name | application name}.\n   *\n   * @see https://medium.com/chingu/an-introduction-to-environment-variables-and-how-to-use-them-f602f66d15fa\n   * @see https://stringcase.org/cases/constant/\n   */\n  autoAssignEnv?: true | string;\n\n  /**\n   * A URL to the application documentation or reference.\n   *\n   * @remarks\n   * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the application. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{reference}/command/subcommand`.\n   */\n  reference?: ReferenceOptions | string;\n};\n\n/**\n * The plugin options for Shell Shock.\n */\nexport type Options = BaseOptions & Partial<NodeJsPluginOptions>;\n\n/**\n * The output configuration options for Shell Shock.\n */\nexport type OutputConfig = Pick<\n  PowerlinesOutputConfig,\n  \"path\" | \"copy\" | \"storage\"\n> & {\n  /**\n   * An indicator specifying whether to generate TypeScript declaration files (.d.ts) during the build process.\n   */\n  dts?: false;\n};\n\n/**\n * The user configuration options for Shell Shock.\n */\nexport type UserConfig = BaseOptions &\n  Partial<NodeJsPluginUserConfig> &\n  Pick<NodeJsPluginUserConfig, \"root\"> & {\n    /**\n     * Configuration for the output of the build process\n     */\n    output?: OutputConfig;\n  };\n\n/**\n * The resolved configuration options for Shell Shock.\n */\nexport type ResolvedConfig = TsdownPluginResolvedConfig &\n  AutoMDPluginResolvedConfig &\n  NodeJsPluginResolvedConfig &\n  Required<Omit<Options, \"bin\" | \"reference\">> & {\n    /**\n     * The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).\n     *\n     * @remarks\n     * If an array is provided, each binary will be linked to the same compiled output file. If not provided, the {@link Options.name | name} option will be used.\n     *\n     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin\n     * @see https://yarnpkg.com/cli/bin\n     * @see https://pnpm.io/package_json#bin\n     */\n    bin: Record<string, string>;\n\n    /**\n     * The URL(s) to the application documentation or reference.\n     */\n    reference: ReferenceOptions;\n\n    /**\n     * The command-line application specific environment variable prefix used for automatically assigning environment variables to command options.\n     */\n    appSpecificEnvPrefix: string;\n\n    /**\n     * The user configuration for the Shell Shock process.\n     */\n    userConfig: UserConfig;\n  };\n"],"mappings":";AAAA,MAAM,UAAU;CAAC;CAAK;CAAK;CAAQ;CAA4B;;;;;;AAE/D,MAAM,cAAc;CAAA;CAAM;CAAW;CAAM;;;;;;;;;AAE3C,MAAM,YAAS;CAAA;CAAS;CAAG;CAAY;CAAqB;AAC5D,MAAI,aAAc;CAAA;CAAM;CAAA;CAAe;CAA4B;AACnE,MAAM,kBAAkB;OAAC;CAAa;CAAS;CAAA;CAAa;CAAO;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AACnE,MAAK,sBAAuB;CAAC;CAAE;CAAiB;CAAmB;CAAW;AAE9E,MAAC,iBAAsB;OAAI;OAAqB;CAAC;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;AACjD,MAAC,aAAkB;OAAO;OAAoB;CAAc;CAAO;CAAA;AAEnE,MAAC,kBAAuB;OAAG;CAAQ;CAAa;CAAK;CAAA;CAAA;CAAA;CAAA;CAAA;AAErD,MAAM,gBAAQ;OAAa;OAAS;OAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;AAEpC,MAAM,oBAAoB;OAAO;OAAmB;OAAe;CAAG;CAAA;OAAA;CAAA;OAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA"}
+{"version":3,"file":"config.mjs","names":[],"sources":["../../src/types/config.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { AutoMDPluginResolvedConfig } from \"@powerlines/plugin-automd\";\nimport type {\n  NodeJsPluginOptions,\n  NodeJsPluginResolvedConfig,\n  NodeJsPluginUserConfig\n} from \"@powerlines/plugin-nodejs/types/plugin\";\nimport type {\n  TsdownPluginResolvedConfig,\n  TsdownPluginUserConfig\n} from \"@powerlines/plugin-tsdown/types/plugin\";\nimport type { OutputConfig as PowerlinesOutputConfig } from \"powerlines\";\nimport type { CommandBase, CommandOption } from \"./command\";\nimport type { Context } from \"./context\";\n\ntype BuildOptions = Pick<\n  TsdownPluginUserConfig,\n  | \"root\"\n  | \"name\"\n  | \"title\"\n  | \"description\"\n  | \"logLevel\"\n  | \"mode\"\n  | \"skipCache\"\n  | \"autoInstall\"\n  | \"plugins\"\n  | \"tsconfig\"\n  | \"tsconfigRaw\"\n>;\n\nexport interface ReferenceOptions {\n  /**\n   * A URL to the application documentation or reference.\n   */\n  app: string;\n\n  /**\n   * A URL to the application command specific documentation or reference.\n   *\n   * @remarks\n   * This URL is expected to contain the token `{command}`, which will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{reference}/command/subcommand`.\n   */\n  commands?: string;\n}\n\ntype BaseOptions = Partial<BuildOptions> & {\n  /**\n   * A set of global command options to apply to each command.\n   *\n   * @remarks\n   * Each command will inherit these global options. To disable the addition of these global options, set this property to `false`, or provide a custom set of options/a function that returns them. A `GlobalOptions` interface will be created by the `shell-shock types` command and added to the generated `shell-shock.d.ts` file.\n   */\n  globalOptions?:\n    | CommandOption[]\n    | ((context: Context, input: CommandBase) => CommandOption[])\n    | false;\n\n  /**\n   * Determines whether commands and option names are treated as case-sensitive.\n   *\n   * @defaultValue `false`\n   */\n  isCaseSensitive?: boolean;\n\n  /**\n   * The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).\n   *\n   * @remarks\n   * If an array is provided, each binary will be linked to the same compiled output file. If not provided, the {@link Options.name | name} option will be used.\n   *\n   * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin\n   * @see https://yarnpkg.com/cli/bin\n   * @see https://pnpm.io/package_json#bin\n   */\n  bin?: string | string[];\n\n  /**\n   * Should Shell Shock attempt to automatically assign environment variables to manipulate default values for command options based on the option name?\n   *\n   * @remarks\n   * If set to a string, Shell Shock will use the provided string as an application specific environment variable prefix, convert the option name to {@link https://stringcase.org/cases/constant/ | constant case}, and prepend the provided `string` value to determine the corresponding environment variable name. For example, if an option is named `\"configPath\"` and the `autoAssignEnv` is `\"MY_APP_\"`, Shell Shock will look for an environment variable named `\"MY_APP_CONFIG_PATH\"` and assign its value to the option if it exists. If set to `true`, Shell Shock will use a default environment variable prefix derived from the {@link Options.name | application name}.\n   *\n   * @see https://medium.com/chingu/an-introduction-to-environment-variables-and-how-to-use-them-f602f66d15fa\n   * @see https://stringcase.org/cases/constant/\n   */\n  autoAssignEnv?: true | string;\n\n  /**\n   * A URL to the application documentation or reference.\n   *\n   * @remarks\n   * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the application. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{reference}/command/subcommand`.\n   */\n  reference?: ReferenceOptions | string;\n};\n\n/**\n * The plugin options for Shell Shock.\n */\nexport type Options = BaseOptions & Partial<NodeJsPluginOptions>;\n\n/**\n * The output configuration options for Shell Shock.\n */\nexport type OutputConfig = Pick<\n  PowerlinesOutputConfig,\n  \"path\" | \"copy\" | \"storage\"\n> & {\n  /**\n   * An indicator specifying whether to generate TypeScript declaration files (.d.ts) during the build process.\n   */\n  dts?: false;\n};\n\n/**\n * The user configuration options for Shell Shock.\n */\nexport type UserConfig = BaseOptions &\n  Partial<NodeJsPluginUserConfig> &\n  Pick<NodeJsPluginUserConfig, \"root\"> & {\n    /**\n     * Configuration for the output of the build process\n     */\n    output?: OutputConfig;\n  };\n\n/**\n * The resolved configuration options for Shell Shock.\n */\nexport type ResolvedConfig = TsdownPluginResolvedConfig &\n  AutoMDPluginResolvedConfig &\n  NodeJsPluginResolvedConfig &\n  Required<Omit<Options, \"bin\" | \"reference\">> & {\n    /**\n     * The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).\n     *\n     * @remarks\n     * If an array is provided, each binary will be linked to the same compiled output file. If not provided, the {@link Options.name | name} option will be used.\n     *\n     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin\n     * @see https://yarnpkg.com/cli/bin\n     * @see https://pnpm.io/package_json#bin\n     */\n    bin: Record<string, string>;\n\n    /**\n     * The URL(s) to the application documentation or reference.\n     */\n    reference: ReferenceOptions;\n\n    /**\n     * The command-line application specific environment variable prefix used for automatically assigning environment variables to command options.\n     */\n    appSpecificEnvPrefix: string;\n\n    /**\n     * The user configuration for the Shell Shock process.\n     */\n    userConfig: UserConfig;\n  };\n"],"mappings":";AAAA,MAAM,UAAU;CAAC;CAAK;CAAK;CAAQ;CAA4B;;;;;;AAE/D,MAAM,cAAc;CAAA;CAAM;CAAW;CAAM;;;;;;;;;AAE3C,MAAM,YAAS;CAAA;CAAS;CAAG;CAAY;CAAqB;AAC5D,MAAI,aAAc;CAAA;CAAM;CAAA;CAAe;CAA4B;AACnE,MAAM,kBAAkB;OAAC;CAAa;CAAS;CAAA;CAAa;CAAO;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AACnE,MAAK,sBAAuB;CAAC;CAAE;CAA+C;CAAA;CAAA;CAAA;CAAA;AAE9E,MAAC,iBAAsB;OAAI;OAAqB;CAAC;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AACjD,MAAC,aAAkB;OAAO;OAAoB;CAAc;CAAO;CAAA;AAEnE,MAAC,kBAAuB;OAAG;CAAQ;CAAa;CAAK;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAErD,MAAM,gBAAQ;OAAa;OAAS;OAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEpC,MAAM,oBAAoB;OAAO;OAAmB;OAAe;CAAG;CAAA;OAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}

package/dist/types/context.cjs

@@ -11,15 +11,19 @@ const __ΩContext = [
 	"ResolvedConfig",
 	"TResolvedConfig",
 	"commandsPath",
+	"The root path where commands are located.",
 	"CommandOption",
 	"options",
+	"The default command arguments to apply to all application commands.",
 	"CommandConfig",
 	"inputs",
+	"The list of commands discovered in the project.",
 	() => __ΩRecord,
 	"CommandTree",
 	"commands",
+	"The command-line application structure.",
 	"Context",
-	"\"w!c\"P!!P&4#\"w$F4%\"w&F4'&\"w)o(#4*MKw+y"
+	"\"w!c\"P!!P&4#?$\"w%F4&?'\"w(F4)?*&\"w,o+#4-?.MKw/y"
 ];
 const __ΩUnresolvedContext = [
 	"ResolvedConfig",
@@ -30,5 +34,4 @@ const __ΩUnresolvedContext = [
 
 //#endregion
 exports.__ΩContext = __ΩContext;
-exports.__ΩUnresolvedContext = __ΩUnresolvedContext;
-//# sourceMappingURL=context.cjs.map
+exports.__ΩUnresolvedContext = __ΩUnresolvedContext;

package/dist/types/context.mjs

@@ -9,15 +9,19 @@ const __ΩContext = [
 	"ResolvedConfig",
 	"TResolvedConfig",
 	"commandsPath",
+	"The root path where commands are located.",
 	"CommandOption",
 	"options",
+	"The default command arguments to apply to all application commands.",
 	"CommandConfig",
 	"inputs",
+	"The list of commands discovered in the project.",
 	() => __ΩRecord,
 	"CommandTree",
 	"commands",
+	"The command-line application structure.",
 	"Context",
-	"\"w!c\"P!!P&4#\"w$F4%\"w&F4'&\"w)o(#4*MKw+y"
+	"\"w!c\"P!!P&4#?$\"w%F4&?'\"w(F4)?*&\"w,o+#4-?.MKw/y"
 ];
 const __ΩUnresolvedContext = [
 	"ResolvedConfig",

package/dist/types/env.cjs

@@ -3,15 +3,20 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 //#region src/types/env.ts
 const __ΩShellShockEnv = [
 	"PATHEXT",
+	"The system PATHEXT variable, used to determine which file extensions are considered executable on Windows.",
 	"PATH",
+	"The system PATH variable, used to locate executable files.",
 	"npm_config_user_agent",
+	"The npm user agent string, which can be used to detect if the environment is running within an npm script.",
 	"npm_config_fund",
+	"The npm_config_fund environment variable, which can be used to control npm's funding behavior.",
 	"npm_execpath",
+	"The npm execution path, which can be used to determine the location of the npm executable.",
 	"COMSPEC",
+	"The COMSPEC environment variable, which specifies the command-line interpreter to use on Windows.",
 	"ShellShockEnv",
-	"P&4!8&4\"8&4#8&4$8&4%8&4&8Mw'y"
+	"P!&4!8?\"&4#8?$&4%8?&&4'8?(&4)8?*&4+8?,Mw-y"
 ];
 
 //#endregion
-exports.__ΩShellShockEnv = __ΩShellShockEnv;
-//# sourceMappingURL=env.cjs.map
+exports.__ΩShellShockEnv = __ΩShellShockEnv;

package/dist/types/env.d.cts

@@ -1,5 +1,7 @@
+import { EnvInterface } from "@powerlines/plugin-env/types/runtime";
+
 //#region src/types/env.d.ts
-interface ShellShockEnv {
+interface ShellShockEnv extends EnvInterface {
   /**
    * The system PATHEXT variable, used to determine which file extensions are considered executable on Windows.
    *

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

@@ -1 +1 @@
-{"version":3,"file":"env.d.cts","names":[],"sources":["../../src/types/env.ts"],"mappings":";UAkBiB,aAAA;EAAA;;;;;;;;;;EAWf,OAAA;EAyDO;;;;;;;EAhDP,IAAA;;;;;;;;;;;EAYA,qBAAA;;;;;;;;;;;EAYA,eAAA;;;;;;;;;;;EAYA,YAAA;;;;;;;;;;;EAYA,OAAA;AAAA"}
+{"version":3,"file":"env.d.cts","names":[],"sources":["../../src/types/env.ts"],"mappings":";;;UAqBiB,aAAA,SAAsB,YAAA;;AAAvC;;;;;;;;;EAWE,OAAA;EAyDA;;;;;;;EAhDA,IAAA;;;;;;;;;;;EAYA,qBAAA;;;;;;;;;;;EAYA,eAAA;;;;;;;;;;;EAYA,YAAA;;;;;;;;;;;EAYA,OAAA;AAAA"}

package/dist/types/env.d.mts

@@ -1,5 +1,7 @@
+import { EnvInterface } from "@powerlines/plugin-env/types/runtime";
+
 //#region src/types/env.d.ts
-interface ShellShockEnv {
+interface ShellShockEnv extends EnvInterface {
   /**
    * The system PATHEXT variable, used to determine which file extensions are considered executable on Windows.
    *

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

@@ -1 +1 @@
-{"version":3,"file":"env.d.mts","names":[],"sources":["../../src/types/env.ts"],"mappings":";UAkBiB,aAAA;EAAA;;;;;;;;;;EAWf,OAAA;EAyDO;;;;;;;EAhDP,IAAA;;;;;;;;;;;EAYA,qBAAA;;;;;;;;;;;EAYA,eAAA;;;;;;;;;;;EAYA,YAAA;;;;;;;;;;;EAYA,OAAA;AAAA"}
+{"version":3,"file":"env.d.mts","names":[],"sources":["../../src/types/env.ts"],"mappings":";;;UAqBiB,aAAA,SAAsB,YAAA;;AAAvC;;;;;;;;;EAWE,OAAA;EAyDA;;;;;;;EAhDA,IAAA;;;;;;;;;;;EAYA,qBAAA;;;;;;;;;;;EAYA,eAAA;;;;;;;;;;;EAYA,YAAA;;;;;;;;;;;EAYA,OAAA;AAAA"}