@shell-shock/core 0.17.6 → 0.17.8

package/README.md

@@ -249,7 +249,7 @@ generation of development tools, please reach out on our
 
 <div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/storm-software/icon-circle-fill-dark.png" alt="Storm Software" width="200px"/></a></div>
 <br />
-<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
+<div align="center"><a href="https://stormsoftware.com" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://public.storm-cdn.com/misc/text/visit-us-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://public.storm-cdn.com/misc/text/visit-us-light.png"><img src="https://public.storm-cdn.com/misc/text/visit-us-dark.png" height="90px" alt="Visit us at stormsoftware.com" /></picture></a></div>
 
 <br />
 

package/dist/_virtual/_rolldown/runtime.cjs

@@ -1,29 +1 @@
-//#region \0rolldown/runtime.js
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") {
-		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-			key = keys[i];
-			if (!__hasOwnProp.call(to, key) && key !== except) {
-				__defProp(to, key, {
-					get: ((k) => from[k]).bind(null, key),
-					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-				});
-			}
-		}
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-
-//#endregion
-
-exports.__toESM = __toESM;
+var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));exports.__toESM=s;

package/dist/api.cjs

@@ -1,95 +1 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
-const require_plugin = require('./plugin.cjs');
-let powerlines = require("powerlines");
-
-//#region src/api.ts
-const __ΩPartial = [
-	"T",
-	"Partial",
-	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
-];
-/**
-* The Shell Shock API 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 ShellShockAPI = class ShellShockAPI {
-	#powerlines;
-	static async from(config, workspaceRoot) {
-		const userConfig = {
-			framework: "shell-shock",
-			...config,
-			plugins: [require_plugin.default(), ...config.plugins ?? []]
-		};
-		return new ShellShockAPI(await (workspaceRoot ? powerlines.PowerlinesAPI.from(workspaceRoot, userConfig) : (0, powerlines.createPowerlines)(userConfig)));
-	}
-	constructor(powerlines$1) {
-		this.#powerlines = powerlines$1;
-	}
-	async clean(inlineConfig) {
-		return this.#powerlines.clean(inlineConfig);
-	}
-	async prepare(inlineConfig) {
-		return this.#powerlines.prepare(inlineConfig);
-	}
-	async lint(inlineConfig) {
-		return this.#powerlines.lint(inlineConfig);
-	}
-	async build(inlineConfig) {
-		return this.#powerlines.build(inlineConfig);
-	}
-	async docs(inlineConfig) {
-		return this.#powerlines.docs(inlineConfig);
-	}
-	async finalize() {
-		return this.#powerlines.finalize();
-	}
-	static __type = [
-		"#powerlines",
-		"UserConfig",
-		"config",
-		"workspaceRoot",
-		() => ShellShockAPI,
-		"from",
-		"powerlines",
-		"constructor",
-		"inlineConfig",
-		"clean",
-		"prepare",
-		"lint",
-		"build",
-		"docs",
-		"finalize",
-		"ShellShockAPI",
-		"The Shell Shock API class.",
-		"!3!P\"w\"2#&2$8P7%`0&sP!2'\"0(P!2)$`0*P!2)$`0+P!2)$`0,P!2)$`0-P!2)$`0.P$`0/5w0?1"
-	];
-};
-/**
-* Creates a new {@link ShellShockAPI} instance.
-*
-* @param options - The user configuration options.
-* @returns A promise that resolves to a {@link ShellShockAPI} instance.
-*/
-async function createShellShock(options = {}) {
-	return ShellShockAPI.from({
-		root: process.cwd(),
-		...options
-	});
-}
-createShellShock.__type = [
-	() => __ΩPartial,
-	"UserConfig",
-	"options",
-	() => ({}),
-	() => ShellShockAPI,
-	"createShellShock",
-	"Creates a new {@link ShellShockAPI} instance.",
-	"P\"w\"o!\"2#>$P7%`/&?'"
-];
-
-//#endregion
-exports.ShellShockAPI = ShellShockAPI;
-exports.createShellShock = createShellShock;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`}),require(`./_virtual/_rolldown/runtime.cjs`);const e=require(`./plugin.cjs`);let t=require(`powerlines`);var n=class n{#e;static async fromOptions(r){return new n(await(0,t.createAPI)({...r,framework:`shell-shock`},{plugins:[e.default()]}))}get context(){return this.#e.context}constructor(e){this.#e=e}async clean(e){return this.#e.clean(e)}async prepare(e){return this.#e.prepare(e)}async lint(e){return this.#e.lint(e)}async build(e){return this.#e.build(e)}async docs(e){return this.#e.docs(e)}async finalize(){return this.#e.finalize()}static __type=[`#powerlines`,`options`,()=>n,`fromOptions`,`Creates a new instance of the {@link ShellShockAPI} 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.`,`ShellShockAPI`,`The Shell Shock API class.`,'!3!P!2"P7#`0$s?%!P!2&"0\'P!2($`0)?*P!2($`0+?,P!2($`0-?.P!2($`0/?0P!2($`01?2P$`03?45w5?6']};async function r(e){return n.fromOptions({framework:`shell-shock`,cwd:process.cwd(),...e})}r.__type=[`options`,()=>n,`createShellShock`,`Creates a new {@link ShellShockAPI} instance.`,'P!2!P7"`/#?$'],exports.ShellShockAPI=n,exports.createShellShock=r;

package/dist/api.d.cts

@@ -1,5 +1,6 @@
-import { UserConfig } from "./types/config.cjs";
-import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfig, PrepareInlineConfig } from "powerlines";
+import * as _$powerlines from "powerlines";
+import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, EngineOptions, LintInlineConfig, PrepareInlineConfig } from "powerlines";
+import { PartialKeys } from "@stryke/types";
 
 //#region src/api.d.ts
 /**
@@ -10,13 +11,60 @@ import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfi
  */
 declare class ShellShockAPI {
   #private;
-  static from(config: UserConfig, workspaceRoot?: string): Promise<ShellShockAPI>;
+  /**
+   * Creates a new instance of the {@link ShellShockAPI} 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 ShellShockAPI} instance.
+   */
+  static fromOptions(options: EngineOptions): Promise<ShellShockAPI>;
+  /**
+   * 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(): _$powerlines.ExecutionContext<_$powerlines.ResolvedConfig>;
   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>;
 }
 /**
@@ -25,7 +73,7 @@ declare class ShellShockAPI {
  * @param options - The user configuration options.
  * @returns A promise that resolves to a {@link ShellShockAPI} instance.
  */
-declare function createShellShock(options?: Partial<UserConfig>): Promise<ShellShockAPI>;
+declare function createShellShock(options: PartialKeys<EngineOptions, "cwd" | "framework">): Promise<ShellShockAPI>;
 //#endregion
 export { ShellShockAPI, createShellShock };
 //# sourceMappingURL=api.d.cts.map

package/dist/api.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.cts","names":[],"sources":["../src/api.ts"],"mappings":";;;;;;AAoCA;;;;cAAa,aAAA;EAAA;SAGS,IAAA,CAClB,MAAA,EAAQ,UAAA,EACR,aAAA,YACC,OAAA,CAAQ,aAAA;EAAA,QAcJ,WAAA,CAAA;EAIM,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAIxC,OAAA,CAAQ,YAAA,EAAc,mBAAA,GAAsB,OAAA;EAI5C,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAItC,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAIxC,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAItC,QAAA,CAAA,GAAY,OAAA;AAAA;;;;;;;iBAWL,gBAAA,CACpB,OAAA,GAAS,OAAA,CAAQ,UAAA,IAChB,OAAA,CAAQ,aAAA"}
+{"version":3,"file":"api.d.cts","names":[],"sources":["../src/api.ts"],"mappings":";;;;;;;;AAqCA;;;cAAa,aAAA;EAAA;EAWR;;;;;;EAAA,OAFiB,WAAA,CAClB,OAAA,EAAS,aAAA,GACR,OAAA,CAAQ,aAAA;EAkDqB;;;;;EAAA,IAlCrB,OAAA,CAAA,GAAO,YAAA,CAAA,gBAAA,CAhBR,YAAA,CAgBQ,cAAA;EAAA,QAIX,WAAA,CAAA;EA2DyB;;;;;;EAjDnB,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EA9B1C;;;;;;EAwCE,OAAA,CAAQ,YAAA,EAAc,mBAAA,GAAsB,OAAA;EAVtC;;;;;;EAoBN,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAAnB;;;;;;EAUnB,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAUxC;;;;;;EAAA,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EASnB;AAWlC;;;;EAXe,QAAA,CAAA,GAAY,OAAA;AAAA;;;;;;;iBAWL,gBAAA,CACpB,OAAA,EAAS,WAAA,CAAY,aAAA,yBACpB,OAAA,CAAQ,aAAA"}

package/dist/api.d.mts

@@ -1,5 +1,6 @@
-import { UserConfig } from "./types/config.mjs";
-import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfig, PrepareInlineConfig } from "powerlines";
+import * as _$powerlines from "powerlines";
+import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, EngineOptions, LintInlineConfig, PrepareInlineConfig } from "powerlines";
+import { PartialKeys } from "@stryke/types";
 
 //#region src/api.d.ts
 /**
@@ -10,13 +11,60 @@ import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfi
  */
 declare class ShellShockAPI {
   #private;
-  static from(config: UserConfig, workspaceRoot?: string): Promise<ShellShockAPI>;
+  /**
+   * Creates a new instance of the {@link ShellShockAPI} 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 ShellShockAPI} instance.
+   */
+  static fromOptions(options: EngineOptions): Promise<ShellShockAPI>;
+  /**
+   * 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(): _$powerlines.ExecutionContext<_$powerlines.ResolvedConfig>;
   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>;
 }
 /**
@@ -25,7 +73,7 @@ declare class ShellShockAPI {
  * @param options - The user configuration options.
  * @returns A promise that resolves to a {@link ShellShockAPI} instance.
  */
-declare function createShellShock(options?: Partial<UserConfig>): Promise<ShellShockAPI>;
+declare function createShellShock(options: PartialKeys<EngineOptions, "cwd" | "framework">): Promise<ShellShockAPI>;
 //#endregion
 export { ShellShockAPI, createShellShock };
 //# sourceMappingURL=api.d.mts.map

package/dist/api.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.mts","names":[],"sources":["../src/api.ts"],"mappings":";;;;;;AAoCA;;;;cAAa,aAAA;EAAA;SAGS,IAAA,CAClB,MAAA,EAAQ,UAAA,EACR,aAAA,YACC,OAAA,CAAQ,aAAA;EAAA,QAcJ,WAAA,CAAA;EAIM,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAIxC,OAAA,CAAQ,YAAA,EAAc,mBAAA,GAAsB,OAAA;EAI5C,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAItC,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAIxC,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAItC,QAAA,CAAA,GAAY,OAAA;AAAA;;;;;;;iBAWL,gBAAA,CACpB,OAAA,GAAS,OAAA,CAAQ,UAAA,IAChB,OAAA,CAAQ,aAAA"}
+{"version":3,"file":"api.d.mts","names":[],"sources":["../src/api.ts"],"mappings":";;;;;;;;AAqCA;;;cAAa,aAAA;EAAA;EAWR;;;;;;EAAA,OAFiB,WAAA,CAClB,OAAA,EAAS,aAAA,GACR,OAAA,CAAQ,aAAA;EAkDqB;;;;;EAAA,IAlCrB,OAAA,CAAA,GAAO,YAAA,CAAA,gBAAA,CAhBR,YAAA,CAgBQ,cAAA;EAAA,QAIX,WAAA,CAAA;EA2DyB;;;;;;EAjDnB,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EA9B1C;;;;;;EAwCE,OAAA,CAAQ,YAAA,EAAc,mBAAA,GAAsB,OAAA;EAVtC;;;;;;EAoBN,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAAnB;;;;;;EAUnB,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAUxC;;;;;;EAAA,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EASnB;AAWlC;;;;EAXe,QAAA,CAAA,GAAY,OAAA;AAAA;;;;;;;iBAWL,gBAAA,CACpB,OAAA,EAAS,WAAA,CAAY,aAAA,yBACpB,OAAA,CAAQ,aAAA"}

package/dist/api.mjs

@@ -1,93 +1,2 @@
-import plugin from "./plugin.mjs";
-import { PowerlinesAPI, createPowerlines } from "powerlines";
-
-//#region src/api.ts
-const __ΩPartial = [
-	"T",
-	"Partial",
-	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
-];
-/**
-* The Shell Shock API 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 ShellShockAPI = class ShellShockAPI {
-	#powerlines;
-	static async from(config, workspaceRoot) {
-		const userConfig = {
-			framework: "shell-shock",
-			...config,
-			plugins: [plugin(), ...config.plugins ?? []]
-		};
-		return new ShellShockAPI(await (workspaceRoot ? PowerlinesAPI.from(workspaceRoot, userConfig) : createPowerlines(userConfig)));
-	}
-	constructor(powerlines) {
-		this.#powerlines = powerlines;
-	}
-	async clean(inlineConfig) {
-		return this.#powerlines.clean(inlineConfig);
-	}
-	async prepare(inlineConfig) {
-		return this.#powerlines.prepare(inlineConfig);
-	}
-	async lint(inlineConfig) {
-		return this.#powerlines.lint(inlineConfig);
-	}
-	async build(inlineConfig) {
-		return this.#powerlines.build(inlineConfig);
-	}
-	async docs(inlineConfig) {
-		return this.#powerlines.docs(inlineConfig);
-	}
-	async finalize() {
-		return this.#powerlines.finalize();
-	}
-	static __type = [
-		"#powerlines",
-		"UserConfig",
-		"config",
-		"workspaceRoot",
-		() => ShellShockAPI,
-		"from",
-		"powerlines",
-		"constructor",
-		"inlineConfig",
-		"clean",
-		"prepare",
-		"lint",
-		"build",
-		"docs",
-		"finalize",
-		"ShellShockAPI",
-		"The Shell Shock API class.",
-		"!3!P\"w\"2#&2$8P7%`0&sP!2'\"0(P!2)$`0*P!2)$`0+P!2)$`0,P!2)$`0-P!2)$`0.P$`0/5w0?1"
-	];
-};
-/**
-* Creates a new {@link ShellShockAPI} instance.
-*
-* @param options - The user configuration options.
-* @returns A promise that resolves to a {@link ShellShockAPI} instance.
-*/
-async function createShellShock(options = {}) {
-	return ShellShockAPI.from({
-		root: process.cwd(),
-		...options
-	});
-}
-createShellShock.__type = [
-	() => __ΩPartial,
-	"UserConfig",
-	"options",
-	() => ({}),
-	() => ShellShockAPI,
-	"createShellShock",
-	"Creates a new {@link ShellShockAPI} instance.",
-	"P\"w\"o!\"2#>$P7%`/&?'"
-];
-
-//#endregion
-export { ShellShockAPI, createShellShock };
+import e from"./plugin.mjs";import{createAPI as t}from"powerlines";var n=class n{#e;static async fromOptions(r){return new n(await t({...r,framework:`shell-shock`},{plugins:[e()]}))}get context(){return this.#e.context}constructor(e){this.#e=e}async clean(e){return this.#e.clean(e)}async prepare(e){return this.#e.prepare(e)}async lint(e){return this.#e.lint(e)}async build(e){return this.#e.build(e)}async docs(e){return this.#e.docs(e)}async finalize(){return this.#e.finalize()}static __type=[`#powerlines`,`options`,()=>n,`fromOptions`,`Creates a new instance of the {@link ShellShockAPI} 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.`,`ShellShockAPI`,`The Shell Shock API class.`,'!3!P!2"P7#`0$s?%!P!2&"0\'P!2($`0)?*P!2($`0+?,P!2($`0-?.P!2($`0/?0P!2($`01?2P$`03?45w5?6']};async function r(e){return n.fromOptions({framework:`shell-shock`,cwd:process.cwd(),...e})}r.__type=[`options`,()=>n,`createShellShock`,`Creates a new {@link ShellShockAPI} instance.`,'P!2!P7"`/#?$'];export{n as ShellShockAPI,r as createShellShock};
 //# sourceMappingURL=api.mjs.map

package/dist/api.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"api.mjs","names":[],"sources":["../src/api.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 {\n  BuildInlineConfig,\n  CleanInlineConfig,\n  DocsInlineConfig,\n  LintInlineConfig,\n  PluginConfig,\n  PrepareInlineConfig\n} from \"powerlines\";\nimport { createPowerlines, PowerlinesAPI } from \"powerlines\";\nimport { plugin } from \"./plugin\";\nimport type { UserConfig } from \"./types/config\";\n\n/**\n * The Shell Shock API class.\n *\n * @remarks\n * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.\n */\nexport class ShellShockAPI {\n  #powerlines: PowerlinesAPI;\n\n  public static async from(\n    config: UserConfig,\n    workspaceRoot?: string\n  ): Promise<ShellShockAPI> {\n    const userConfig = {\n      framework: \"shell-shock\",\n      ...config,\n      plugins: [plugin(), ...(config.plugins ?? [])] as PluginConfig<any>[]\n    };\n\n    const powerlines = await (workspaceRoot\n      ? PowerlinesAPI.from(workspaceRoot, userConfig)\n      : createPowerlines(userConfig));\n\n    return new ShellShockAPI(powerlines);\n  }\n\n  private constructor(powerlines: PowerlinesAPI) {\n    this.#powerlines = powerlines;\n  }\n\n  public async clean(inlineConfig: CleanInlineConfig): Promise<void> {\n    return this.#powerlines.clean(inlineConfig);\n  }\n\n  public async prepare(inlineConfig: PrepareInlineConfig): Promise<void> {\n    return this.#powerlines.prepare(inlineConfig);\n  }\n\n  public async lint(inlineConfig: LintInlineConfig): Promise<void> {\n    return this.#powerlines.lint(inlineConfig);\n  }\n\n  public async build(inlineConfig: BuildInlineConfig): Promise<void> {\n    return this.#powerlines.build(inlineConfig);\n  }\n\n  public async docs(inlineConfig: DocsInlineConfig): Promise<void> {\n    return this.#powerlines.docs(inlineConfig);\n  }\n\n  public async finalize(): Promise<void> {\n    return this.#powerlines.finalize();\n  }\n}\n\n/**\n * Creates a new {@link ShellShockAPI} instance.\n *\n * @param options - The user configuration options.\n * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n */\nexport async function createShellShock(\n  options: Partial<UserConfig> = {}\n): Promise<ShellShockAPI> {\n  return ShellShockAPI.from({ root: process.cwd(), ...options });\n}\n"],"mappings":";;;;AAAA,MAAM,aAAa;CAAC;CAAK;CAAW;CAA2B;;;;;;;AAS/D,IAAa,gBAAb,MAAa,cAAc;CAC1B;CACA,aAAgB,KAAK,QAAK,eAAa;EAChC,MAAM,aAAa;;GAErB,GAAQ;;GAEL;AAIP,SAAA,IAAiB,qCAFP,cAAA,KAAA,eAAA,WAAA,GACV,iBAAiB,WAAA,EACA;;CAEjB,YAAA,YAAgB;AAChB,QAAA,aAAY;;CAEZ,MAAM,MAAA,cAAW;AACX,SAAC,MAAA,WAAkB,MAAA,aAAsB;;CAEjD,MAAO,QAAO,cAAkB;;;CAG7B,MAAI,KAAM,cAAe;AAC3B,SAAA,MAAA,WAAA,KAAA,aAAA;;CAEE,MAAK,MAAM,cAAgB;AAC5B,SAAA,MAAA,WAAA,MAAA,aAAA;;CAEC,MAAA,KAAY,cAAa;;;CAGxB,MAAM,WAAE;AACR,SAAA,MAAgB,WAAA,UAAA;;CAEhB,OAAM,SAAU;EAAC;EAAE;EAAA;EAAA;QAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;;;;;;;;AAQvB,eAAQ,iBAA6B,UAAA,EAAA,EAAA;;;;;;AAGrC,iBAAE,SAAA;OAAA;CAAA;CAAA;QAAA,EAAA;OAAA;CAAA;CAAA;CAAA;CAAA"}
+{"version":3,"file":"api.mjs","names":[],"sources":["../src/api.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 { PartialKeys } from \"@stryke/types\";\nimport type {\n  BuildInlineConfig,\n  CleanInlineConfig,\n  DocsInlineConfig,\n  EngineOptions,\n  LintInlineConfig,\n  PowerlinesAPI,\n  PrepareInlineConfig\n} from \"powerlines\";\nimport { createAPI } from \"powerlines\";\nimport { plugin } from \"./plugin\";\n\n/**\n * The Shell Shock API class.\n *\n * @remarks\n * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.\n */\nexport class ShellShockAPI {\n  #powerlines: PowerlinesAPI;\n\n  /**\n   * Creates a new instance of the {@link ShellShockAPI} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.\n   *\n   * @param options - The user configuration options.\n   * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n   */\n  public static async fromOptions(\n    options: EngineOptions\n  ): Promise<ShellShockAPI> {\n    const powerlines = await createAPI(\n      { ...options, framework: \"shell-shock\" },\n      {\n        plugins: [plugin()]\n      }\n    );\n\n    return new ShellShockAPI(powerlines);\n  }\n\n  /**\n   * 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.\n   *\n   * @returns The current build context.\n   */\n  public get context() {\n    return this.#powerlines.context;\n  }\n\n  private constructor(powerlines: PowerlinesAPI) {\n    this.#powerlines = powerlines;\n  }\n\n  /**\n   * 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.\n   *\n   * @param inlineConfig - The inline configuration options for the clean operation.\n   * @returns A promise that resolves when the clean operation is complete.\n   */\n  public async clean(inlineConfig: CleanInlineConfig): Promise<void> {\n    return this.#powerlines.clean(inlineConfig);\n  }\n\n  /**\n   * 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.\n   *\n   * @param inlineConfig - The inline configuration options for the prepare operation.\n   * @returns A promise that resolves when the prepare operation is complete.\n   */\n  public async prepare(inlineConfig: PrepareInlineConfig): Promise<void> {\n    return this.#powerlines.prepare(inlineConfig);\n  }\n\n  /**\n   * 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.\n   *\n   * @param inlineConfig - The inline configuration options for the lint operation.\n   * @returns A promise that resolves when the lint operation is complete.\n   */\n  public async lint(inlineConfig: LintInlineConfig): Promise<void> {\n    return this.#powerlines.lint(inlineConfig);\n  }\n\n  /**\n   * 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.\n   *\n   * @param inlineConfig - The inline configuration options for the build operation.\n   * @returns A promise that resolves when the build operation is complete.\n   */\n  public async build(inlineConfig: BuildInlineConfig): Promise<void> {\n    return this.#powerlines.build(inlineConfig);\n  }\n\n  /**\n   * 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.\n   *\n   * @param inlineConfig - The inline configuration options for the documentation operation.\n   * @returns A promise that resolves when the documentation generation is complete.\n   */\n  public async docs(inlineConfig: DocsInlineConfig): Promise<void> {\n    return this.#powerlines.docs(inlineConfig);\n  }\n\n  /**\n   * 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.\n   *\n   * @returns A promise that resolves when the finalize operation is complete.\n   */\n  public async finalize(): Promise<void> {\n    return this.#powerlines.finalize();\n  }\n}\n\n/**\n * Creates a new {@link ShellShockAPI} instance.\n *\n * @param options - The user configuration options.\n * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n */\nexport async function createShellShock(\n  options: PartialKeys<EngineOptions, \"cwd\" | \"framework\">\n): Promise<ShellShockAPI> {\n  return ShellShockAPI.fromOptions({\n    framework: \"shell-shock\",\n    cwd: process.cwd(),\n    ...options\n  });\n}\n"],"mappings":"mEAyBA,IAAE,EAAF,MAAE,CAAa,CACb,GAOD,aAAA,YAAA,EAAA,CAOG,OAAA,IAAA,EAAA,MANA,EAAA,CACD,GAAK,EACN,UAAA,cACF,CAAO,CACJ,QAAY,CAAA,GAAA,CAAA,CAAA,CAAA,CAEX,CAOF,IAAE,SAAS,CACT,OAAC,MAAA,EAAuB,QAE1B,YAAS,EAAS,CAChB,MAAA,EAAE,EAQJ,MAAE,MAAA,EAAA,CACA,OAAM,MAAA,EAAkB,MAAA,EAAe,CAQzC,MAAA,QAAQ,EAAY,CAClB,OAAM,MAAA,EAAa,QAAU,EAAA,CAQ/B,MAAE,KAAA,EAAA,CACF,OAAO,MAAA,EAAY,KAAY,EAAE,CAQjC,MAAI,MAAQ,EAAc,CACxB,OAAA,MAAA,EAAA,MAAA,EAAA,CAQF,MAAI,KAAM,EAAe,CACvB,OAAE,MAAA,EAAsB,KAAC,EAAiB,CAO5C,MAAG,UAAa,CACf,OAAA,MAAA,EAAA,UAAA,CAED,OAAI,OAAU,CAAA,cAAa,cAAkB,EAAmB,cAAQ,uNAAA,aAAA,cAAA,eAAA,QAAA,sPAAA,UAAA,0PAAA,OAAA,mOAAA,QAAA,+OAAA,OAAA,+QAAA,WAAA,0LAAA,gBAAA,6BAAA,0FAAA,EAQ1E,eAAG,EAAA,EAAA,CACD,OAAI,EAAM,YAAmB,CAC3B,UAAW,cACX,IAAA,QAAA,KAAA,CACF,GAAA,EACC,CAAC"}