@shell-shock/core 0.2.1 → 0.4.0

package/dist/types/config.d.mts

@@ -1,10 +1,16 @@
 import { CommandBase, CommandOption } from "./command.mjs";
 import { Context } from "./context.mjs";
-import { TsdownPluginResolvedConfig, TsdownPluginUserConfig } from "@powerlines/plugin-tsdown";
-import { NodeJsPluginOptions, NodeJsPluginResolvedConfig, NodeJsPluginUserConfig } from "@powerlines/plugin-nodejs/types/plugin";
+import { OutputConfig as OutputConfig$1 } from "powerlines/types/config";
+import { AutoMDPluginResolvedConfig } from "@powerlines/plugin-automd/types/plugin";
+import { NodeJsPluginResolvedConfig } from "@powerlines/plugin-nodejs/types/plugin";
+import { TsdownPluginResolvedConfig, TsdownPluginUserConfig } from "@powerlines/plugin-tsdown/types/plugin";
 
 //#region src/types/config.d.ts
-interface Options extends NodeJsPluginOptions {
+type BaseConfig = Pick<TsdownPluginUserConfig, "root" | "name" | "title" | "description" | "logLevel" | "mode" | "skipCache" | "autoInstall" | "entry" | "plugins" | "tsconfig" | "tsconfigRaw">;
+/**
+ * The plugin options for Shell Shock.
+ */
+type Options = Partial<BaseConfig> & {
   /**
    * A set of default command options to apply to each command.
    *
@@ -13,13 +19,71 @@ interface Options extends NodeJsPluginOptions {
    */
   defaultOptions?: CommandOption[] | ((context: Context, input: CommandBase) => CommandOption[]) | false;
   /**
-   * The name(s) of the binary that will be generated to run the CLI
+   * Determines whether commands and option names are treated as case-sensitive.
+   *
+   * @defaultValue `false`
+   */
+  isCaseSensitive?: boolean;
+  /**
+   * 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).
+   *
+   * @remarks
+   * 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.
+   *
+   * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin
+   * @see https://yarnpkg.com/cli/bin
+   * @see https://pnpm.io/package_json#bin
    */
   bin?: string | string[];
-}
-type UserConfig = Partial<Omit<TsdownPluginUserConfig, "type" | "framework" | "singleBuild" | "environments">> & Partial<NodeJsPluginUserConfig> & Omit<Options, "env">;
-type ResolvedConfig = TsdownPluginResolvedConfig & NodeJsPluginResolvedConfig & Required<Omit<Options, "bin" | "env"> & {
-  bin: string[];
-}>;
+  /**
+   * An application specific prefix to check for environment variables.
+   *
+   * @remarks
+   * If not provided, Shell Shock will convert {@link Options.name | name} to {@link https://stringcase.org/cases/constant/ | constant case} format and append an underscore (`_`). If the provided {@link Options.name | name} is `"my-app"`, environment variables starting with `"MY_APP_"` will be used - for example: `"MY_APP_CONFIG_NAME"`. If a trailing underscore already exists in the user provided value, it will result in two consecutive underscores - for example: `"MY_APP__CONFIG_NAME"` (this was done intentionally so that users who specifically want multiple underscores have a way to do so).
+   *
+   * @see https://medium.com/chingu/an-introduction-to-environment-variables-and-how-to-use-them-f602f66d15fa
+   * @see https://stringcase.org/cases/constant/
+   */
+  envPrefix?: string;
+};
+/**
+ * The output configuration options for Shell Shock.
+ */
+type OutputConfig = Pick<OutputConfig$1, "outputPath" | "assets" | "storage"> & {
+  /**
+   * An indicator specifying whether to generate TypeScript declaration files (.d.ts) during the build process.
+   */
+  dts?: false;
+};
+/**
+ * The user configuration options for Shell Shock.
+ */
+type UserConfig = Options & {
+  /**
+   * Configuration for the output of the build process
+   */
+  output?: OutputConfig;
+};
+/**
+ * The resolved configuration options for Shell Shock.
+ */
+type ResolvedConfig = TsdownPluginResolvedConfig & NodeJsPluginResolvedConfig & AutoMDPluginResolvedConfig & Required<Omit<Options, "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).
+   *
+   * @remarks
+   * 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.
+   *
+   * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin
+   * @see https://yarnpkg.com/cli/bin
+   * @see https://pnpm.io/package_json#bin
+   */
+  bin: Record<string, string>;
+  /**
+   * The user configuration for the Shell Shock process.
+   */
+  userConfig: UserConfig & NodeJsPluginResolvedConfig;
+};
 //#endregion
-export { Options, ResolvedConfig, UserConfig };
+export { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig };
+//# sourceMappingURL=config.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.mts","names":[],"sources":["../../src/types/config.ts"],"sourcesContent":[],"mappings":";;;;;;;;KA4BY,UAAA,GAAa,KACvB;;AADF;AAmBA;AAA8B,KAAlB,OAAA,GAAU,OAAQ,CAAA,UAAA,CAAA,GAAA;EAAR;;;;;;EA8CV,cAAA,CAAY,EAtClB,aAuCJ,EAAA,GAAA,CAAA,CAAA,OADyB,EArCV,OAqCc,EAAA,KAAA,EArCE,WAqCF,EAAA,GArCkB,aAqClB,EAAA,CAAA,GAAA,KAAA;EAanB;AAUZ;;;;EAGgB,eAAA,CAAA,EAAA,OAAA;EAAL;;;;;;;;;;;;;;;;;;;;;;;;;KA1BC,YAAA,GAAe,KACzB;;;;;;;;;KAYU,UAAA,GAAa;;;;WAId;;;;;KAMC,cAAA,GAAiB,6BAC3B,6BACA,6BACA,SAAS,KAAK;;;;;;;;;;;OAWP;;;;cAKO,aAAa"}

package/dist/types/context.d.cts

@@ -1,10 +1,11 @@
 import { CommandInput, CommandOption, CommandTree } from "./command.cjs";
 import { ResolvedConfig } from "./config.cjs";
-import { TsdownPluginContext } from "@powerlines/plugin-tsdown";
-import { EnvPluginContext } from "@powerlines/plugin-env/types/plugin";
+import { NodeJsPluginContext } from "@powerlines/plugin-nodejs/types/plugin";
+import { TsdownPluginContext } from "@powerlines/plugin-tsdown/types/plugin";
+import { UnresolvedContext as UnresolvedContext$1 } from "powerlines/types/context";
 
 //#region src/types/context.d.ts
-type Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = TsdownPluginContext<TResolvedConfig> & EnvPluginContext<TResolvedConfig> & {
+type Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = TsdownPluginContext<TResolvedConfig> & NodeJsPluginContext<TResolvedConfig> & {
   /**
    * The root path where commands are located.
    */
@@ -22,5 +23,7 @@ type Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = TsdownPl
    */
   commands: Record<string, CommandTree>;
 };
+type UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = UnresolvedContext$1<TResolvedConfig>;
 //#endregion
-export { Context };
+export { Context, UnresolvedContext };
+//# sourceMappingURL=context.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.cts","names":[],"sources":["../../src/types/context.ts"],"sourcesContent":[],"mappings":";;;;;;;KAwBY,gCAAgC,iBAAiB,kBAC3D,oBAAoB,mBAClB,oBAAoB;;AAFxB;;EAA6D,YAAA,EAAA,MAAA;EACvC;;;EAClB,OAAA,EASW,aATX,EAAA;EASW;;;EAUC,MAAA,EALF,YAKE,EAAA;EAAM;AAGtB;;EAC2C,QAAA,EAJ3B,MAI2B,CAAA,MAAA,EAJZ,WAIY,CAAA;CACX;AAA5B,KAFQ,iBAER,CAAA,wBADsB,cACtB,GADuC,cACvC,CAAA,GAAA,mBAAA,CAA4B,eAA5B,CAAA"}

package/dist/types/context.d.mts

@@ -1,10 +1,11 @@
 import { CommandInput, CommandOption, CommandTree } from "./command.mjs";
 import { ResolvedConfig } from "./config.mjs";
-import { TsdownPluginContext } from "@powerlines/plugin-tsdown";
-import { EnvPluginContext } from "@powerlines/plugin-env/types/plugin";
+import { NodeJsPluginContext } from "@powerlines/plugin-nodejs/types/plugin";
+import { TsdownPluginContext } from "@powerlines/plugin-tsdown/types/plugin";
+import { UnresolvedContext as UnresolvedContext$1 } from "powerlines/types/context";
 
 //#region src/types/context.d.ts
-type Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = TsdownPluginContext<TResolvedConfig> & EnvPluginContext<TResolvedConfig> & {
+type Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = TsdownPluginContext<TResolvedConfig> & NodeJsPluginContext<TResolvedConfig> & {
   /**
    * The root path where commands are located.
    */
@@ -22,5 +23,7 @@ type Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = TsdownPl
    */
   commands: Record<string, CommandTree>;
 };
+type UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = UnresolvedContext$1<TResolvedConfig>;
 //#endregion
-export { Context };
+export { Context, UnresolvedContext };
+//# sourceMappingURL=context.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.mts","names":[],"sources":["../../src/types/context.ts"],"sourcesContent":[],"mappings":";;;;;;;KAwBY,gCAAgC,iBAAiB,kBAC3D,oBAAoB,mBAClB,oBAAoB;;AAFxB;;EAA6D,YAAA,EAAA,MAAA;EACvC;;;EAClB,OAAA,EASW,aATX,EAAA;EASW;;;EAUC,MAAA,EALF,YAKE,EAAA;EAAM;AAGtB;;EAC2C,QAAA,EAJ3B,MAI2B,CAAA,MAAA,EAJZ,WAIY,CAAA;CACX;AAA5B,KAFQ,iBAER,CAAA,wBADsB,cACtB,GADuC,cACvC,CAAA,GAAA,mBAAA,CAA4B,eAA5B,CAAA"}

package/dist/types/index.d.cts

@@ -1,5 +1,5 @@
-import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandTree, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./command.cjs";
-import { Context } from "./context.cjs";
-import { Options, ResolvedConfig, UserConfig } from "./config.cjs";
+import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandPath, CommandTree, CommandTreePath, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./command.cjs";
+import { Context, UnresolvedContext } from "./context.cjs";
+import { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig } from "./config.cjs";
 import { BaseCommandOptions } from "./options.cjs";
-export { BaseCommandOption, BaseCommandOptions, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandTree, Context, NumberCommandOption, Options, ResolvedConfig, SerializedCommandTree, StringCommandOption, UserConfig };
+export { BaseCommandOption, BaseCommandOptions, BaseConfig, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandPath, CommandTree, CommandTreePath, Context, NumberCommandOption, Options, OutputConfig, ResolvedConfig, SerializedCommandTree, StringCommandOption, UnresolvedContext, UserConfig };

package/dist/types/index.d.mts

@@ -1,5 +1,5 @@
-import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandTree, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./command.mjs";
-import { Context } from "./context.mjs";
-import { Options, ResolvedConfig, UserConfig } from "./config.mjs";
+import { BaseCommandOption, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandPath, CommandTree, CommandTreePath, NumberCommandOption, SerializedCommandTree, StringCommandOption } from "./command.mjs";
+import { Context, UnresolvedContext } from "./context.mjs";
+import { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig } from "./config.mjs";
 import { BaseCommandOptions } from "./options.mjs";
-export { BaseCommandOption, BaseCommandOptions, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandTree, Context, NumberCommandOption, Options, ResolvedConfig, SerializedCommandTree, StringCommandOption, UserConfig };
+export { BaseCommandOption, BaseCommandOptions, BaseConfig, BooleanCommandOption, CommandBase, CommandInput, CommandOption, CommandParam, CommandPath, CommandTree, CommandTreePath, Context, NumberCommandOption, Options, OutputConfig, ResolvedConfig, SerializedCommandTree, StringCommandOption, UnresolvedContext, UserConfig };

package/dist/types/internal.d.cts

@@ -0,0 +1,24 @@
+import { Context } from "./context.cjs";
+import { ResolvedConfig } from "./config.cjs";
+
+//#region src/types/internal.d.ts
+
+/**
+ * An internal representation of the plugin context, used for managing hooks and environment data.
+ *
+ * @internal
+ */
+interface UNSAFE_ContextInternal {
+  id: string;
+}
+/**
+ * An internal representation of the plugin context, used for managing hooks and environment data.
+ *
+ * @internal
+ */
+interface UNSAFE_Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> extends Context<TResolvedConfig> {
+  $$internal: UNSAFE_ContextInternal;
+}
+//#endregion
+export { UNSAFE_Context, UNSAFE_ContextInternal };
+//# sourceMappingURL=internal.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.cts","names":[],"sources":["../../src/types/internal.ts"],"sourcesContent":[],"mappings":";;;;;;;AA4BA;AASA;;AAC2C,UAV1B,sBAAA,CAU0B;EACzB,EAAA,EAAA,MAAA;;;;;;;UAFD,uCACS,iBAAiB,wBACjC,QAAQ;cACJ"}

package/dist/types/internal.d.mts

@@ -0,0 +1,24 @@
+import { Context } from "./context.mjs";
+import { ResolvedConfig } from "./config.mjs";
+
+//#region src/types/internal.d.ts
+
+/**
+ * An internal representation of the plugin context, used for managing hooks and environment data.
+ *
+ * @internal
+ */
+interface UNSAFE_ContextInternal {
+  id: string;
+}
+/**
+ * An internal representation of the plugin context, used for managing hooks and environment data.
+ *
+ * @internal
+ */
+interface UNSAFE_Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> extends Context<TResolvedConfig> {
+  $$internal: UNSAFE_ContextInternal;
+}
+//#endregion
+export { UNSAFE_Context, UNSAFE_ContextInternal };
+//# sourceMappingURL=internal.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.mts","names":[],"sources":["../../src/types/internal.ts"],"sourcesContent":[],"mappings":";;;;;;;AA4BA;AASA;;AAC2C,UAV1B,sBAAA,CAU0B;EACzB,EAAA,EAAA,MAAA;;;;;;;UAFD,uCACS,iBAAiB,wBACjC,QAAQ;cACJ"}

package/dist/types/internal.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/types/options.d.cts

@@ -4,4 +4,5 @@ interface BaseCommandOptions {
   version: boolean;
 }
 //#endregion
-export { BaseCommandOptions };
+export { BaseCommandOptions };
+//# sourceMappingURL=options.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.cts","names":[],"sources":["../../src/types/options.ts"],"sourcesContent":[],"mappings":";UAkBiB,kBAAA;EAAA,IAAA,EAAA,OAAA"}

package/dist/types/options.d.mts

@@ -4,4 +4,5 @@ interface BaseCommandOptions {
   version: boolean;
 }
 //#endregion
-export { BaseCommandOptions };
+export { BaseCommandOptions };
+//# sourceMappingURL=options.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.mts","names":[],"sources":["../../src/types/options.ts"],"sourcesContent":[],"mappings":";UAkBiB,kBAAA;EAAA,IAAA,EAAA,OAAA"}

package/dist/types/runtime.d.cts

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

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

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

package/dist/types/runtime.d.mts

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

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

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

package/dist/types/runtime.mjs

@@ -0,0 +1 @@
+export {  };