@shell-shock/core 0.17.10 → 0.17.12

package/dist/config.d.cts

@@ -1,16 +1,37 @@
-import { UserConfig } from "./types/config.cjs";
+import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.cjs";
 
 //#region src/config.d.ts
 /**
- * A utility function to define a Shell Shock user configuration.
+ * Type helper to make it easier to use `shell-shock.config.ts` files. Accepts a direct {@link UserConfig} object, or a function that returns it. The function receives a {@link ConfigParams} object.
  *
- * @remarks
- * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+ * @example
+ * ```ts
+ * import { defineConfig } from '@shell-shock/core/config';
  *
- * @param config - A partial user configuration object.
- * @returns A complete user configuration object.
+ * export default defineConfig({
+ *   // Your configuration here
+ * });
+ *
+ * // Or with a function
+ * export default defineConfig((env) => {
+ *   console.log(`Running command: ${env.command} in mode: ${env.mode}`);
+ *   return {
+ *     // Your configuration here
+ *   };
+ * });
+ * ```
+ *
+ * @param config - The user configuration object or a function that returns it.
+ * @returns The provided configuration, unmodified.
  */
-declare function defineConfig(config: Partial<UserConfig>): UserConfig;
+declare function defineConfig(config: UserConfig): UserConfig;
+declare function defineConfig(config: UserConfig[]): UserConfig[];
+declare function defineConfig(config: Promise<UserConfig>): Promise<UserConfig>;
+declare function defineConfig(config: Promise<UserConfig[]>): Promise<UserConfig[]>;
+declare function defineConfig(config: UserConfigFnObject): UserConfigFnObject;
+declare function defineConfig(config: UserConfigFnPromise): UserConfigFnPromise;
+declare function defineConfig(config: UserConfigFn): UserConfigFn;
+declare function defineConfig(config: UserConfigExport): UserConfigExport;
 //#endregion
-export { defineConfig };
+export { type EngineOptions, type Options, type OutputConfig, type ReferenceOptions, type ResolvedConfig, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, defineConfig };
 //# sourceMappingURL=config.d.cts.map

package/dist/config.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.cts","names":[],"sources":["../src/config.ts"],"mappings":";;;;;AA6BA;;;;;;;iBAAgB,YAAA,CAAa,MAAA,EAAQ,OAAA,CAAQ,UAAA,IAAc,UAAA"}
+{"version":3,"file":"config.d.cts","names":[],"sources":["../src/config.ts"],"mappings":";;;;AAmDA;;;;;;;;AAA4D;AAC5D;;;;;;;;AAA8D;AAC9D;;;;iBAFgB,YAAA,CAAa,MAAA,EAAQ,UAAA,GAAa,UAAU;AAAA,iBAC5C,YAAA,CAAa,MAAA,EAAQ,UAAA,KAAe,UAAU;AAAA,iBAC9C,YAAA,CAAa,MAAA,EAAQ,OAAA,CAAQ,UAAA,IAAc,OAAA,CAAQ,UAAA;AAAA,iBACnD,YAAA,CACd,MAAA,EAAQ,OAAA,CAAQ,UAAA,MACf,OAAA,CAAQ,UAAA;AAAA,iBACK,YAAA,CAAa,MAAA,EAAQ,kBAAA,GAAqB,kBAAkB;AAAA,iBAC5D,YAAA,CAAa,MAAA,EAAQ,mBAAA,GAAsB,mBAAmB;AAAA,iBAC9D,YAAA,CAAa,MAAA,EAAQ,YAAA,GAAe,YAAY;AAAA,iBAChD,YAAA,CAAa,MAAA,EAAQ,gBAAA,GAAmB,gBAAgB"}

package/dist/config.d.mts

@@ -1,16 +1,37 @@
-import { UserConfig } from "./types/config.mjs";
+import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.mjs";
 
 //#region src/config.d.ts
 /**
- * A utility function to define a Shell Shock user configuration.
+ * Type helper to make it easier to use `shell-shock.config.ts` files. Accepts a direct {@link UserConfig} object, or a function that returns it. The function receives a {@link ConfigParams} object.
  *
- * @remarks
- * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
+ * @example
+ * ```ts
+ * import { defineConfig } from '@shell-shock/core/config';
  *
- * @param config - A partial user configuration object.
- * @returns A complete user configuration object.
+ * export default defineConfig({
+ *   // Your configuration here
+ * });
+ *
+ * // Or with a function
+ * export default defineConfig((env) => {
+ *   console.log(`Running command: ${env.command} in mode: ${env.mode}`);
+ *   return {
+ *     // Your configuration here
+ *   };
+ * });
+ * ```
+ *
+ * @param config - The user configuration object or a function that returns it.
+ * @returns The provided configuration, unmodified.
  */
-declare function defineConfig(config: Partial<UserConfig>): UserConfig;
+declare function defineConfig(config: UserConfig): UserConfig;
+declare function defineConfig(config: UserConfig[]): UserConfig[];
+declare function defineConfig(config: Promise<UserConfig>): Promise<UserConfig>;
+declare function defineConfig(config: Promise<UserConfig[]>): Promise<UserConfig[]>;
+declare function defineConfig(config: UserConfigFnObject): UserConfigFnObject;
+declare function defineConfig(config: UserConfigFnPromise): UserConfigFnPromise;
+declare function defineConfig(config: UserConfigFn): UserConfigFn;
+declare function defineConfig(config: UserConfigExport): UserConfigExport;
 //#endregion
-export { defineConfig };
+export { type EngineOptions, type Options, type OutputConfig, type ReferenceOptions, type ResolvedConfig, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, defineConfig };
 //# sourceMappingURL=config.d.mts.map

package/dist/config.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.mts","names":[],"sources":["../src/config.ts"],"mappings":";;;;;AA6BA;;;;;;;iBAAgB,YAAA,CAAa,MAAA,EAAQ,OAAA,CAAQ,UAAA,IAAc,UAAA"}
+{"version":3,"file":"config.d.mts","names":[],"sources":["../src/config.ts"],"mappings":""}

package/dist/config.mjs

@@ -1,28 +1,61 @@
 //#region src/config.ts
-const __ΩPartial = [
-	"T",
-	"Partial",
-	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
-];
-/**
-* A utility function to define a Shell Shock user configuration.
-*
-* @remarks
-* This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.
-*
-* @param config - A partial user configuration object.
-* @returns A complete user configuration object.
-*/
+defineConfig.__type = [
+	"UserConfig",
+	"config",
+	"defineConfig",
+	"Type helper to make it easier to use `shell-shock.config.ts` files. Accepts a direct {@link UserConfig} object, or a function that returns it. The function receives a {@link ConfigParams} object.",
+	"P\"w!2\"\"w!/#?$"
+];
+defineConfig.__type = [
+	"UserConfig",
+	"config",
+	"defineConfig",
+	"P\"w!F2\"\"w!F/#"
+];
+defineConfig.__type = [
+	"UserConfig",
+	"config",
+	"defineConfig",
+	"P\"w!`2\"\"w!`/#"
+];
+defineConfig.__type = [
+	"UserConfig",
+	"config",
+	"defineConfig",
+	"P\"w!F`2\"\"w!F`/#"
+];
+defineConfig.__type = [
+	"UserConfigFnObject",
+	"config",
+	"defineConfig",
+	"P\"w!2\"\"w!/#"
+];
+defineConfig.__type = [
+	"UserConfigFnPromise",
+	"config",
+	"defineConfig",
+	"P\"w!2\"\"w!/#"
+];
+defineConfig.__type = [
+	"UserConfigFn",
+	"config",
+	"defineConfig",
+	"P\"w!2\"\"w!/#"
+];
+defineConfig.__type = [
+	"UserConfigExport",
+	"config",
+	"defineConfig",
+	"P\"w!2\"\"w!/#"
+];
 function defineConfig(config) {
 	return config;
 }
 defineConfig.__type = [
-	() => __ΩPartial,
-	"UserConfig",
+	"UserConfigExport",
 	"config",
 	"defineConfig",
-	"A utility function to define a Shell Shock user configuration.",
-	"P\"w\"o!\"2#\"w\"/$?%"
+	"P\"w!2\"\"w!/#"
 ];
 
 //#endregion

package/dist/config.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"config.mjs","names":[],"sources":["../src/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 { UserConfig } from \"./types/config\";\n\n/**\n * A utility function to define a Shell Shock user configuration.\n *\n * @remarks\n * This function is used to create a user configuration object for Shell Shock projects. It ensures that the configuration adheres to the expected structure.\n *\n * @param config - A partial user configuration object.\n * @returns A complete user configuration object.\n */\nexport function defineConfig(config: Partial<UserConfig>): UserConfig {\n  return config as UserConfig;\n}\n"],"mappings":";AAAA,MAAM,aAAa;CAAC;CAAK;CAAW;CAA2B;;;;;;;;;;AAU/D,SAAgB,aAAW,QAAQ;AAClC,QAAA"}
+{"version":3,"file":"config.mjs","names":[],"sources":[],"mappings":""}

package/dist/contexts/command.cjs

@@ -1,5 +1,4 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
 let _alloy_js_core = require("@alloy-js/core");
 
 //#region src/contexts/command.ts
@@ -23,4 +22,5 @@ useCommand.__type = [
 
 //#endregion
 exports.CommandContext = CommandContext;
-exports.useCommand = useCommand;
+exports.useCommand = useCommand;
+//# sourceMappingURL=command.cjs.map

package/dist/contexts/command.cjs.map

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

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

@@ -1 +1 @@
-{"version":3,"file":"command.d.cts","names":[],"sources":["../../src/contexts/command.ts"],"mappings":";;;;;;AAyBA;cAAa,cAAA,EAAgB,gBAAA,CAAiB,WAAA;;;;AAQ9C;;iBAAgB,UAAA,CAAA,GAAU,WAAA"}
+{"version":3,"file":"command.d.cts","names":[],"sources":["../../src/contexts/command.ts"],"mappings":";;;;;;AAyBA;cAAa,cAAA,EAAgB,gBAAgB,CAAC,WAAA;;;AAAW;AAQzD;;iBAAgB,UAAA,IAAU,WAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"command.d.mts","names":[],"sources":["../../src/contexts/command.ts"],"mappings":";;;;;;AAyBA;cAAa,cAAA,EAAgB,gBAAA,CAAiB,WAAA;;;;AAQ9C;;iBAAgB,UAAA,CAAA,GAAU,WAAA"}
+{"version":3,"file":"command.d.mts","names":[],"sources":["../../src/contexts/command.ts"],"mappings":""}

package/dist/contexts/command.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"command.mjs","names":[],"sources":["../../src/contexts/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 { ComponentContext } from \"@alloy-js/core\";\nimport { createNamedContext, useContext } from \"@alloy-js/core\";\nimport type { CommandTree } from \"../types/command\";\n\n/**\n * The reflection parameter context used in template rendering.\n */\nexport const CommandContext: ComponentContext<CommandTree | undefined> =\n  createNamedContext<CommandTree | undefined>(\"Command\");\n\n/**\n * Hook to access the Command context.\n *\n * @returns A reactive version of the current reflection.\n */\nexport function useCommand() {\n  return useContext<CommandTree | undefined>(CommandContext)!;\n}\n"],"mappings":";;;;;;;;;;;;;AA4BE,QAAA,WAAA,IAAA,CAAA,CAAA,eAAA,UAAA,CAAA,EAAA,WAAA,eAAA;;AAEF,WAAC,SAAA;CAAA;CAAA;CAAA;CAAA"}
+{"version":3,"file":"command.mjs","names":[],"sources":[],"mappings":""}

package/dist/contexts/options.cjs

@@ -1,11 +1,10 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
-const require_types_command = require('../types/command.cjs');
+let _alloy_js_core = require("@alloy-js/core");
 let _stryke_string_format_camel_case = require("@stryke/string-format/camel-case");
 let _stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
 let defu = require("defu");
 defu = require_runtime.__toESM(defu, 1);
-let _alloy_js_core = require("@alloy-js/core");
 
 //#region src/contexts/options.ts
 function __assignType(fn, args) {
@@ -35,7 +34,7 @@ useExistingOptions.__type = [
 function computedOptions(options) {
 	return options.reduce(__assignType((ret, option) => {
 		ret[(0, _stryke_string_format_camel_case.camelCase)(option.name)] ??= (0, defu.default)({ name: (0, _stryke_string_format_camel_case.camelCase)(option.name) }, ret[option.name] ?? {}, option);
-		if (option.kind === require_types_command.CommandParameterKinds.boolean && !option.variadic && option.isNegativeOf) ret[(0, _stryke_string_format_camel_case.camelCase)(option.isNegativeOf)] = (0, defu.default)({ name: (0, _stryke_string_format_camel_case.camelCase)(option.isNegativeOf) }, ret[option.isNegativeOf] ?? {}, {
+		if (option.type === "boolean" && !option.variadic && option.isNegativeOf) ret[(0, _stryke_string_format_camel_case.camelCase)(option.isNegativeOf)] = (0, defu.default)({ name: (0, _stryke_string_format_camel_case.camelCase)(option.isNegativeOf) }, ret[option.isNegativeOf] ?? {}, {
 			...option,
 			env: (0, _stryke_type_checks_is_set_string.isSetString)(option.env) ? `NO_${option.env}` : false,
 			description: `${option.description.replace(/\.+$/, "")}. This property is the negative form of ${option.name}.`,
@@ -60,4 +59,5 @@ computedOptions.__type = [
 //#endregion
 exports.ExistingOptionsContext = ExistingOptionsContext;
 exports.computedOptions = computedOptions;
-exports.useExistingOptions = useExistingOptions;
+exports.useExistingOptions = useExistingOptions;
+//# sourceMappingURL=options.cjs.map

package/dist/contexts/options.cjs.map

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

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

@@ -1 +1 @@
-{"version":3,"file":"options.d.cts","names":[],"sources":["../../src/contexts/options.ts"],"mappings":";;;;;;AA6BA;cAAa,sBAAA,EAAwB,gBAAA;;;;AAWrC;;;;;iBAAgB,kBAAA,CAAA;AAAA,iBAIA,eAAA,CAAgB,OAAA,EAAS,aAAA,KAAe,MAAA,SAAA,aAAA"}
+{"version":3,"file":"options.d.cts","names":[],"sources":["../../src/contexts/options.ts"],"mappings":";;;;;;AA4BA;cAAa,sBAAA,EAAwB,gBAAgB;;;AAAA;AAWrD;;;;AAAkC;iBAAlB,kBAAA;AAAA,iBAIA,eAAA,CAAgB,OAAA,EAAS,aAAA,KAAe,MAAA,SAAA,aAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"options.d.mts","names":[],"sources":["../../src/contexts/options.ts"],"mappings":";;;;;;AA6BA;cAAa,sBAAA,EAAwB,gBAAA;;;;AAWrC;;;;;iBAAgB,kBAAA,CAAA;AAAA,iBAIA,eAAA,CAAgB,OAAA,EAAS,aAAA,KAAe,MAAA,SAAA,aAAA"}
+{"version":3,"file":"options.d.mts","names":[],"sources":["../../src/contexts/options.ts"],"mappings":""}

package/dist/contexts/options.mjs

@@ -1,8 +1,7 @@
-import { CommandParameterKinds } from "../types/command.mjs";
+import { createNamedContext, useContext } from "@alloy-js/core";
 import { camelCase } from "@stryke/string-format/camel-case";
 import { isSetString } from "@stryke/type-checks/is-set-string";
 import defu$1 from "defu";
-import { createNamedContext, useContext } from "@alloy-js/core";
 
 //#region src/contexts/options.ts
 function __assignType(fn, args) {
@@ -32,7 +31,7 @@ useExistingOptions.__type = [
 function computedOptions(options) {
 	return options.reduce(__assignType((ret, option) => {
 		ret[camelCase(option.name)] ??= defu$1({ name: camelCase(option.name) }, ret[option.name] ?? {}, option);
-		if (option.kind === CommandParameterKinds.boolean && !option.variadic && option.isNegativeOf) ret[camelCase(option.isNegativeOf)] = defu$1({ name: camelCase(option.isNegativeOf) }, ret[option.isNegativeOf] ?? {}, {
+		if (option.type === "boolean" && !option.variadic && option.isNegativeOf) ret[camelCase(option.isNegativeOf)] = defu$1({ name: camelCase(option.isNegativeOf) }, ret[option.isNegativeOf] ?? {}, {
 			...option,
 			env: isSetString(option.env) ? `NO_${option.env}` : false,
 			description: `${option.description.replace(/\.+$/, "")}. This property is the negative form of ${option.name}.`,

package/dist/contexts/options.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"options.mjs","names":[],"sources":["../../src/contexts/options.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 { ComponentContext } from \"@alloy-js/core\";\nimport { createNamedContext, useContext } from \"@alloy-js/core\";\nimport { camelCase } from \"@stryke/string-format/camel-case\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport defu from \"defu\";\nimport type { BooleanCommandOption, CommandOption } from \"../types/command\";\nimport { CommandParameterKinds } from \"../types/command\";\n\n/**\n * The reflection parameter context used in template rendering.\n */\nexport const ExistingOptionsContext: ComponentContext<string[]> =\n  createNamedContext<string[]>(\"ExistingOptions\", []);\n\n/**\n * Hook to access the ExistingOptions context.\n *\n * @remarks\n * This context provides a list of option names that already exist on the interface definition.\n *\n * @returns A reactive version of the current reflection.\n */\nexport function useExistingOptions() {\n  return useContext<string[]>(ExistingOptionsContext)!;\n}\n\nexport function computedOptions(options: CommandOption[]) {\n  return options.reduce(\n    (ret, option) => {\n      ret[camelCase(option.name)] ??= defu(\n        {\n          name: camelCase(option.name)\n        },\n        ret[option.name] ?? {},\n        option\n      );\n\n      if (\n        option.kind === CommandParameterKinds.boolean &&\n        !option.variadic &&\n        option.isNegativeOf\n      ) {\n        ret[camelCase(option.isNegativeOf)] = defu(\n          {\n            name: camelCase(option.isNegativeOf)\n          },\n          ret[option.isNegativeOf] ?? {},\n          {\n            ...option,\n            env: isSetString(option.env) ? `NO_${option.env}` : false,\n            description: `${option.description.replace(\n              /\\.+$/,\n              \"\"\n            )}. This property is the negative form of ${option.name}.`,\n            isNegativeOf: camelCase(option.name),\n            default: !option.default\n          }\n        ) as BooleanCommandOption;\n      }\n\n      return ret;\n    },\n    {} as Record<string, CommandOption>\n  );\n}\n"],"mappings":";;;;;;;AAAA,SAAS,aAAa,IAAI,MAAM;;AAE9B,QAAO;;;;;AAUT,MAAa,0BAAsB,mBAAkB,IAAA,CAAA,CAAA,KAAA,CAAA,EAAA,mBAAA,mBAAA,EAAA,CAAA;;;;;;;;;AASrD,SAAS,qBAA4B;AACrC,QAAO,WAAW,IAAK,CAAA,CAAA,KAAA,CAAA,EAAA,WAAA,uBAAA;;AAEvB,mBAAS,SAAA;CAAA;CAAuC;CAAQ;CAAA;;AAEtD,QAAA,QAAA,OAAA,cAAA,KAAA,WAAA;AACC,MAAI,UAAW,OAAA,KAAU,MAAQ,OAAK,EACvC,MAAA,UAAA,OAAA,KAAA,EACF,EAAO,IAAA,OAAM,SAAA,EAAA,EAAA,OAAwB;AACnC,MAAA,OAAA,SAAmB,sBAAW,WAAqB,CAAA,OAAA,YAAA,OAAA,6DAEnD,MAAA,UAAA,OAAA,aAAA,EACK,EAAC,IAAG,OAAO,iBAAmB,EAAC,EAAA;GACrC,GAAA;GACG,KAAA,YAAA,OAAA,IAAA,GAAA,MAAA,OAAA,QAAA;GACI,aAAQ,GAAQ,OAAO,YAAW,QAAM,QAAK,GAAQ,CAAA,0CAAiC,OAAA,KAAA;GAC7F,cAAA,UAAA,OAAA,KAAA;GACG,SAAU,CAAA,OAAS;GACrB,CAAA;AAEA,SAAO;IACT;EAAA;EAAA;EAAA;EAAA;EAAA,CAAA,EAAA,EAAA,CAAA;;AAEA,gBAAgB,SAAA;CAAA;CAAyB;CAAa;CAAI;CAAA"}
+{"version":3,"file":"options.mjs","names":[],"sources":[],"mappings":""}

package/dist/engine.cjs

@@ -0,0 +1,138 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_get_framework = require('./helpers/get-framework.cjs');
+let _powerlines_engine = require("@powerlines/engine");
+
+//#region src/engine.ts
+/**
+* The Shell Shock Engine class.
+*
+* @remarks
+* This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
+*/
+var Engine = class Engine {
+	#powerlines;
+	/**
+	* Creates a new instance of the {@link Engine} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.
+	*
+	* @param options - The user configuration options.
+	* @returns A promise that resolves to a {@link Engine} instance.
+	*/
+	static async from(options) {
+		return new Engine(await (0, _powerlines_engine.createEngine)({
+			...options,
+			framework: require_get_framework.getFramework()
+		}, "@shell-shock/core/api"));
+	}
+	/**
+	* Gets the current build context, which includes information about the project, environment, and configuration. This context is used internally by the Shell Shock API to manage the build process and provide relevant data to plugins and other components.
+	*
+	* @returns The current build context.
+	*/
+	get context() {
+		return this.#powerlines.context;
+	}
+	constructor(powerlines) {
+		this.#powerlines = powerlines;
+	}
+	/**
+	* Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.
+	*
+	* @param inlineConfig - The inline configuration options for the clean operation.
+	* @returns A promise that resolves when the clean operation is complete.
+	*/
+	async clean(inlineConfig) {
+		return this.#powerlines.clean(inlineConfig);
+	}
+	/**
+	* Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.
+	*
+	* @param inlineConfig - The inline configuration options for the prepare operation.
+	* @returns A promise that resolves when the prepare operation is complete.
+	*/
+	async prepare(inlineConfig) {
+		return this.#powerlines.prepare(inlineConfig);
+	}
+	/**
+	* Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.
+	*
+	* @param inlineConfig - The inline configuration options for the lint operation.
+	* @returns A promise that resolves when the lint operation is complete.
+	*/
+	async lint(inlineConfig) {
+		return this.#powerlines.lint(inlineConfig);
+	}
+	/**
+	* Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.
+	*
+	* @param inlineConfig - The inline configuration options for the build operation.
+	* @returns A promise that resolves when the build operation is complete.
+	*/
+	async build(inlineConfig) {
+		return this.#powerlines.build(inlineConfig);
+	}
+	/**
+	* Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.
+	*
+	* @param inlineConfig - The inline configuration options for the documentation operation.
+	* @returns A promise that resolves when the documentation generation is complete.
+	*/
+	async docs(inlineConfig) {
+		return this.#powerlines.docs(inlineConfig);
+	}
+	/**
+	* Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.
+	*
+	* @returns A promise that resolves when the finalize operation is complete.
+	*/
+	async finalize() {
+		return this.#powerlines.finalize();
+	}
+	static __type = [
+		"#powerlines",
+		"EngineOptions",
+		"options",
+		() => Engine,
+		"from",
+		"Creates a new instance of the {@link Engine} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.",
+		"powerlines",
+		"constructor",
+		"inlineConfig",
+		"clean",
+		"Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.",
+		"prepare",
+		"Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.",
+		"lint",
+		"Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.",
+		"build",
+		"Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.",
+		"docs",
+		"Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.",
+		"finalize",
+		"Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.",
+		"Engine",
+		"The Shell Shock Engine class.",
+		"!3!P\"w\"2#P7$`0%s?&!P!2'\"0(P!2)$`0*?+P!2)$`0,?-P!2)$`0.?/P!2)$`00?1P!2)$`02?3P$`04?55w6?7"
+	];
+};
+/**
+* Creates a new {@link Engine} instance.
+*
+* @param options - The user configuration options.
+* @returns A promise that resolves to a {@link Engine} instance.
+*/
+async function createEngine(options) {
+	return Engine.from(options);
+}
+createEngine.__type = [
+	"EngineOptions",
+	"options",
+	() => Engine,
+	"createEngine",
+	"Creates a new {@link Engine} instance.",
+	"P\"w!2\"P7#`/$?%"
+];
+
+//#endregion
+exports.Engine = Engine;
+exports.createEngine = createEngine;
+//# sourceMappingURL=engine.cjs.map

package/dist/engine.cjs.map

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

package/dist/engine.d.cts

@@ -0,0 +1,79 @@
+import { EngineOptions } from "./types/config.cjs";
+import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfig, PrepareInlineConfig } from "powerlines";
+import { EngineContext } from "@powerlines/engine";
+
+//#region src/engine.d.ts
+/**
+ * The Shell Shock Engine class.
+ *
+ * @remarks
+ * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
+ */
+declare class Engine {
+  #private;
+  /**
+   * Creates a new instance of the {@link Engine} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.
+   *
+   * @param options - The user configuration options.
+   * @returns A promise that resolves to a {@link Engine} instance.
+   */
+  static from(options: EngineOptions): Promise<Engine>;
+  /**
+   * Gets the current build context, which includes information about the project, environment, and configuration. This context is used internally by the Shell Shock API to manage the build process and provide relevant data to plugins and other components.
+   *
+   * @returns The current build context.
+   */
+  get context(): EngineContext;
+  private constructor();
+  /**
+   * Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.
+   *
+   * @param inlineConfig - The inline configuration options for the clean operation.
+   * @returns A promise that resolves when the clean operation is complete.
+   */
+  clean(inlineConfig: CleanInlineConfig): Promise<void>;
+  /**
+   * Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.
+   *
+   * @param inlineConfig - The inline configuration options for the prepare operation.
+   * @returns A promise that resolves when the prepare operation is complete.
+   */
+  prepare(inlineConfig: PrepareInlineConfig): Promise<void>;
+  /**
+   * Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.
+   *
+   * @param inlineConfig - The inline configuration options for the lint operation.
+   * @returns A promise that resolves when the lint operation is complete.
+   */
+  lint(inlineConfig: LintInlineConfig): Promise<void>;
+  /**
+   * Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.
+   *
+   * @param inlineConfig - The inline configuration options for the build operation.
+   * @returns A promise that resolves when the build operation is complete.
+   */
+  build(inlineConfig: BuildInlineConfig): Promise<void>;
+  /**
+   * Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.
+   *
+   * @param inlineConfig - The inline configuration options for the documentation operation.
+   * @returns A promise that resolves when the documentation generation is complete.
+   */
+  docs(inlineConfig: DocsInlineConfig): Promise<void>;
+  /**
+   * Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.
+   *
+   * @returns A promise that resolves when the finalize operation is complete.
+   */
+  finalize(): Promise<void>;
+}
+/**
+ * Creates a new {@link Engine} instance.
+ *
+ * @param options - The user configuration options.
+ * @returns A promise that resolves to a {@link Engine} instance.
+ */
+declare function createEngine(options: EngineOptions): Promise<Engine>;
+//#endregion
+export { Engine, createEngine };
+//# sourceMappingURL=engine.d.cts.map

package/dist/engine.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.cts","names":[],"sources":["../src/engine.ts"],"mappings":";;;;;;;AAoCA;;;;cAAa,MAAA;EAAA;EA0BW;;;;;;EAAA,OAjBF,IAAA,CAAK,OAAA,EAAS,aAAA,GAAgB,OAAA,CAAQ,MAAA;EA6DzB;;;;;EAAA,IA5CtB,OAAA,IAAW,aAAA;EAAA,QAIf,WAAA;;;;;;;EAUM,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAd/B;;;;;;EAwBT,OAAA,CAAQ,YAAA,EAAc,mBAAA,GAAsB,OAAA;EAAtB;;;;;;EAUtB,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAUtC;;;;;;EAAA,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAUF;;;;AASnB;AAWlC;EApBe,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;;;;;;EAStC,QAAA,IAAY,OAAA;AAAA;;;;;AAW+C;;iBAApD,YAAA,CAAa,OAAA,EAAS,aAAA,GAAgB,OAAA,CAAQ,MAAA"}

package/dist/engine.d.mts

@@ -0,0 +1,79 @@
+import { EngineOptions } from "./types/config.mjs";
+import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfig, PrepareInlineConfig } from "powerlines";
+import { EngineContext } from "@powerlines/engine";
+
+//#region src/engine.d.ts
+/**
+ * The Shell Shock Engine class.
+ *
+ * @remarks
+ * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
+ */
+declare class Engine {
+  #private;
+  /**
+   * Creates a new instance of the {@link Engine} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.
+   *
+   * @param options - The user configuration options.
+   * @returns A promise that resolves to a {@link Engine} instance.
+   */
+  static from(options: EngineOptions): Promise<Engine>;
+  /**
+   * Gets the current build context, which includes information about the project, environment, and configuration. This context is used internally by the Shell Shock API to manage the build process and provide relevant data to plugins and other components.
+   *
+   * @returns The current build context.
+   */
+  get context(): EngineContext;
+  private constructor();
+  /**
+   * Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.
+   *
+   * @param inlineConfig - The inline configuration options for the clean operation.
+   * @returns A promise that resolves when the clean operation is complete.
+   */
+  clean(inlineConfig: CleanInlineConfig): Promise<void>;
+  /**
+   * Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.
+   *
+   * @param inlineConfig - The inline configuration options for the prepare operation.
+   * @returns A promise that resolves when the prepare operation is complete.
+   */
+  prepare(inlineConfig: PrepareInlineConfig): Promise<void>;
+  /**
+   * Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.
+   *
+   * @param inlineConfig - The inline configuration options for the lint operation.
+   * @returns A promise that resolves when the lint operation is complete.
+   */
+  lint(inlineConfig: LintInlineConfig): Promise<void>;
+  /**
+   * Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.
+   *
+   * @param inlineConfig - The inline configuration options for the build operation.
+   * @returns A promise that resolves when the build operation is complete.
+   */
+  build(inlineConfig: BuildInlineConfig): Promise<void>;
+  /**
+   * Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.
+   *
+   * @param inlineConfig - The inline configuration options for the documentation operation.
+   * @returns A promise that resolves when the documentation generation is complete.
+   */
+  docs(inlineConfig: DocsInlineConfig): Promise<void>;
+  /**
+   * Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.
+   *
+   * @returns A promise that resolves when the finalize operation is complete.
+   */
+  finalize(): Promise<void>;
+}
+/**
+ * Creates a new {@link Engine} instance.
+ *
+ * @param options - The user configuration options.
+ * @returns A promise that resolves to a {@link Engine} instance.
+ */
+declare function createEngine(options: EngineOptions): Promise<Engine>;
+//#endregion
+export { Engine, createEngine };
+//# sourceMappingURL=engine.d.mts.map

package/dist/engine.d.mts.map

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