@shell-shock/plugin-banner 0.1.0

package/dist/index.mjs

@@ -0,0 +1,64 @@
+import { BannerBuiltin } from "./components/banner-builtin.mjs";
+import "./components/index.mjs";
+import { createComponent } from "@alloy-js/core/jsx-runtime";
+import { For, computed } from "@alloy-js/core";
+import { Spacing } from "@powerlines/plugin-alloy/core/components";
+import { render } from "@powerlines/plugin-alloy/render";
+import { getAppDescription, getAppName, getAppTitle, getCommandList } from "@shell-shock/core/plugin-utils";
+import console from "@shell-shock/plugin-console";
+import theme from "@shell-shock/plugin-theme";
+import { joinPaths } from "@stryke/path/join";
+
+//#region src/index.tsx
+/**
+* The Banner - Shell Shock plugin to add a banner command to the application.
+*/
+const plugin = (options = {}) => {
+	return [
+		...theme(options.theme),
+		console(options.console),
+		{
+			name: "shell-shock:banner",
+			enforce: "post",
+			prepare: {
+				order: "post",
+				async handler() {
+					const commands = await getCommandList(this);
+					this.debug(`Rendering \`banner\` built-ins for each of the ${commands.length} command modules.`);
+					const bin = computed(() => ({
+						id: "",
+						name: getAppName(this),
+						title: getAppTitle(this),
+						description: getAppDescription(this),
+						isVirtual: true,
+						path: null,
+						segments: [],
+						alias: [],
+						options: Object.fromEntries(this.options.map((option) => [option.name, option])),
+						entry: { file: joinPaths(this.entryPath, "bin.ts") },
+						args: [],
+						parent: null,
+						children: this.commands
+					}));
+					return render(this, [
+						createComponent(BannerBuiltin, { get command() {
+							return bin.value;
+						} }),
+						createComponent(Spacing, {}),
+						createComponent(For, {
+							get each() {
+								return commands.sort((a, b) => a.name.localeCompare(b.name));
+							},
+							doubleHardline: true,
+							children: (command) => createComponent(BannerBuiltin, { command })
+						})
+					]);
+				}
+			}
+		}
+	];
+};
+
+//#endregion
+export { plugin as default, plugin };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.tsx"],"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 { computed, For } from \"@alloy-js/core\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport {\n  getAppDescription,\n  getAppName,\n  getAppTitle,\n  getCommandList\n} from \"@shell-shock/core/plugin-utils\";\nimport console from \"@shell-shock/plugin-console\";\nimport theme from \"@shell-shock/plugin-theme\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport type { Plugin } from \"powerlines\";\nimport { BannerBuiltin } from \"./components\";\nimport type { BannerPluginContext, BannerPluginOptions } from \"./types/plugin\";\n\nexport type * from \"./types\";\n\n/**\n * The Banner - Shell Shock plugin to add a banner command to the application.\n */\nexport const plugin = <\n  TContext extends BannerPluginContext = BannerPluginContext\n>(\n  options: BannerPluginOptions = {}\n) => {\n  return [\n    ...theme(options.theme),\n    console(options.console),\n    {\n      name: \"shell-shock:banner\",\n      enforce: \"post\",\n      prepare: {\n        order: \"post\",\n        async handler() {\n          const commands = await getCommandList(this);\n          this.debug(\n            `Rendering \\`banner\\` built-ins for each of the ${\n              commands.length\n            } command modules.`\n          );\n\n          const bin = computed(() => ({\n            id: \"\",\n            name: getAppName(this),\n            title: getAppTitle(this),\n            description: getAppDescription(this),\n            isVirtual: true,\n            path: null,\n            segments: [],\n            alias: [],\n            options: Object.fromEntries(\n              this.options.map(option => [option.name, option])\n            ),\n            entry: {\n              file: joinPaths(this.entryPath, \"bin.ts\")\n            },\n            args: [],\n            parent: null,\n            children: this.commands\n          }));\n\n          return render(\n            this,\n            <>\n              <BannerBuiltin command={bin.value} />\n              <Spacing />\n              <For\n                each={commands.sort((a, b) => a.name.localeCompare(b.name))}\n                doubleHardline>\n                {command => <BannerBuiltin command={command} />}\n              </For>\n            </>\n          );\n        }\n      }\n    }\n  ] as Plugin<TContext>[];\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;AAkCA,MAAa,UAAe,UAAA,EAAA,KAAA;;;;;GAE1B,MAAA;GACC,SAAU;GACX,SAAA;IACI,OAAO;IACX,MAAS,UAAQ;KAClB,MAAA,WAAA,MAAA,eAAA,KAAA;AACC,UAAS,MAAA,kDAAuB,SAAA,OAAA,mBAAA;KAC7B,MAAA,MAAA,gBAAA;MACI,IAAA;MACF,MAAM,WAAc,KAAA;MACvB,OAAQ,YAAgB,KAAA;MACxB,aAAA,kBAAA,KAAA;MACM,WAAS;MACb,MAAU;MACV,UAAS,EAAA;MACP,OAAQ,EAAA;MACR,SAAM,OAAU,YAAA,KAAA,QAAA,KAAA,WAAA,CAAA,OAAA,MAAA,OAAA,CAAA,CAAA;MACd,OAAM,EACN,MAAK,UAAK,KAAA,WAAA,SAAA,EACT;MACD,MAAI,EAAA;MACJ,QAAI;MACJ,UAAC,KAAA;;AAEH,YAAO,OAAO,MAAA;MAAA,gBAAgB,eAAA,EAC5B,IAAI,UAAI;AACN,cAAM,IAAA;SAET,CAAC;MAAE,gBAAa,SAAA,EAAA,CAAiB;MAAC,gBAAK,KAAA;OACtC,IAAE,OAAS;AACT,eAAM,SAAI,MAAA,GAAA,MAAA,EAAA,KAAA,cAAA,EAAA,KAAA,CAAA;;OAEZ,gBAAW;OACX,WAAU,YAAQ,gBAAW,eAAA,EACpB,SACR,CAAC;OACH,CAAC;MAAC,CAAC;;IAEP;GACF;EAAC"}

package/dist/types/index.d.cts

@@ -0,0 +1,2 @@
+import { BannerPluginContext, BannerPluginOptions, BannerPluginResolvedConfig, BannerPluginUserConfig } from "./plugin.cjs";
+export { BannerPluginContext, BannerPluginOptions, BannerPluginResolvedConfig, BannerPluginUserConfig };

package/dist/types/index.d.mts

@@ -0,0 +1,2 @@
+import { BannerPluginContext, BannerPluginOptions, BannerPluginResolvedConfig, BannerPluginUserConfig } from "./plugin.mjs";
+export { BannerPluginContext, BannerPluginOptions, BannerPluginResolvedConfig, BannerPluginUserConfig };

package/dist/types/index.mjs

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

package/dist/types/plugin.d.cts

@@ -0,0 +1,22 @@
+import { ResolvedConfig, UserConfig } from "@shell-shock/core";
+import { Context } from "@shell-shock/core/types/context";
+import { ConsolePluginContext, ConsolePluginOptions, ConsolePluginResolvedConfig, ConsolePluginUserConfig } from "@shell-shock/plugin-console";
+import { ThemePluginContext, ThemePluginOptions, ThemePluginResolvedConfig, ThemePluginUserConfig } from "@shell-shock/plugin-theme";
+
+//#region src/types/plugin.d.ts
+interface BannerPluginOptions {
+  /**
+   * Theme plugin options.
+   */
+  theme?: ThemePluginOptions;
+  /**
+   * Console plugin options.
+   */
+  console?: ConsolePluginOptions;
+}
+type BannerPluginUserConfig = ThemePluginUserConfig & ConsolePluginUserConfig & UserConfig;
+type BannerPluginResolvedConfig = ThemePluginResolvedConfig & ConsolePluginResolvedConfig & ResolvedConfig;
+type BannerPluginContext<TResolvedConfig extends BannerPluginResolvedConfig = BannerPluginResolvedConfig> = ThemePluginContext<TResolvedConfig> & ConsolePluginContext<TResolvedConfig> & Context<TResolvedConfig>;
+//#endregion
+export { BannerPluginContext, BannerPluginOptions, BannerPluginResolvedConfig, BannerPluginUserConfig };
+//# sourceMappingURL=plugin.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/types/plugin.ts"],"mappings":";;;;;;UAiCiB,mBAAA;;AAAjB;;EAIE,KAAA,GAAQ,kBAAA;EAKsB;;;EAA9B,OAAA,GAAU,oBAAA;AAAA;AAAA,KAGA,sBAAA,GAAyB,qBAAA,GACnC,uBAAA,GACA,UAAA;AAAA,KAEU,0BAAA,GAA6B,yBAAA,GACvC,2BAAA,GACA,cAAA;AAAA,KAEU,mBAAA,yBACc,0BAAA,GACtB,0BAAA,IACA,kBAAA,CAAmB,eAAA,IACrB,oBAAA,CAAqB,eAAA,IACrB,OAAA,CAAQ,eAAA"}

package/dist/types/plugin.d.mts

@@ -0,0 +1,22 @@
+import { ConsolePluginContext, ConsolePluginOptions, ConsolePluginResolvedConfig, ConsolePluginUserConfig } from "@shell-shock/plugin-console";
+import { ThemePluginContext, ThemePluginOptions, ThemePluginResolvedConfig, ThemePluginUserConfig } from "@shell-shock/plugin-theme";
+import { ResolvedConfig, UserConfig } from "@shell-shock/core";
+import { Context } from "@shell-shock/core/types/context";
+
+//#region src/types/plugin.d.ts
+interface BannerPluginOptions {
+  /**
+   * Theme plugin options.
+   */
+  theme?: ThemePluginOptions;
+  /**
+   * Console plugin options.
+   */
+  console?: ConsolePluginOptions;
+}
+type BannerPluginUserConfig = ThemePluginUserConfig & ConsolePluginUserConfig & UserConfig;
+type BannerPluginResolvedConfig = ThemePluginResolvedConfig & ConsolePluginResolvedConfig & ResolvedConfig;
+type BannerPluginContext<TResolvedConfig extends BannerPluginResolvedConfig = BannerPluginResolvedConfig> = ThemePluginContext<TResolvedConfig> & ConsolePluginContext<TResolvedConfig> & Context<TResolvedConfig>;
+//#endregion
+export { BannerPluginContext, BannerPluginOptions, BannerPluginResolvedConfig, BannerPluginUserConfig };
+//# sourceMappingURL=plugin.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/types/plugin.ts"],"mappings":";;;;;;UAiCiB,mBAAA;;AAAjB;;EAIE,KAAA,GAAQ,kBAAA;EAKsB;;;EAA9B,OAAA,GAAU,oBAAA;AAAA;AAAA,KAGA,sBAAA,GAAyB,qBAAA,GACnC,uBAAA,GACA,UAAA;AAAA,KAEU,0BAAA,GAA6B,yBAAA,GACvC,2BAAA,GACA,cAAA;AAAA,KAEU,mBAAA,yBACc,0BAAA,GACtB,0BAAA,IACA,kBAAA,CAAmB,eAAA,IACrB,oBAAA,CAAqB,eAAA,IACrB,OAAA,CAAQ,eAAA"}

package/dist/types/plugin.mjs

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

package/package.json

@@ -0,0 +1,158 @@
+{
+  "name": "@shell-shock/plugin-banner",
+  "version": "0.1.0",
+  "private": false,
+  "description": "A package containing a Shell Shock plugin to generate banner built-in modules that display information about the application.",
+  "keywords": [
+    "shell-shock",
+    "shell-shock-plugin",
+    "powerlines",
+    "storm-software"
+  ],
+  "homepage": "https://stormsoftware.com",
+  "bugs": {
+    "url": "https://stormsoftware.com/support",
+    "email": "support@stormsoftware.com"
+  },
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/storm-software/shell-shock.git",
+    "directory": "packages/plugin-banner"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/storm-software"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Storm Software",
+    "email": "contact@stormsoftware.com",
+    "url": "https://stormsoftware.com"
+  },
+  "maintainers": [
+    {
+      "name": "Storm Software",
+      "email": "contact@stormsoftware.com",
+      "url": "https://stormsoftware.com"
+    }
+  ],
+  "contributors": [
+    {
+      "name": "Storm Software",
+      "email": "contact@stormsoftware.com",
+      "url": "https://stormsoftware.com"
+    }
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "typings": "dist/index.d.mts",
+  "files": ["dist/**/*"],
+  "dependencies": {
+    "@alloy-js/core": "0.23.0-dev.8",
+    "@alloy-js/typescript": "0.23.0-dev.4",
+    "@powerlines/deepkit": "^0.6.146",
+    "@powerlines/plugin-alloy": "^0.25.53",
+    "@powerlines/plugin-plugin": "^0.12.318",
+    "@shell-shock/core": "^0.13.2",
+    "@shell-shock/plugin-theme": "^0.3.17",
+    "@shell-shock/plugin-console": "^0.1.13",
+    "@stryke/path": "^0.27.2",
+    "defu": "^6.1.4",
+    "powerlines": "^0.42.8"
+  },
+  "devDependencies": {
+    "@powerlines/plugin-deepkit": "^0.11.246",
+    "@types/node": "^25.5.0"
+  },
+  "publishConfig": { "access": "public" },
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "default": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
+    },
+    "./components": {
+      "require": {
+        "types": "./dist/components/index.d.cts",
+        "default": "./dist/components/index.cjs"
+      },
+      "import": {
+        "types": "./dist/components/index.d.mts",
+        "default": "./dist/components/index.mjs"
+      },
+      "default": {
+        "types": "./dist/components/index.d.mts",
+        "default": "./dist/components/index.mjs"
+      }
+    },
+    "./components/banner-builtin": {
+      "require": {
+        "types": "./dist/components/banner-builtin.d.cts",
+        "default": "./dist/components/banner-builtin.cjs"
+      },
+      "import": {
+        "types": "./dist/components/banner-builtin.d.mts",
+        "default": "./dist/components/banner-builtin.mjs"
+      },
+      "default": {
+        "types": "./dist/components/banner-builtin.d.mts",
+        "default": "./dist/components/banner-builtin.mjs"
+      }
+    },
+    "./components/banner-function-declaration": {
+      "require": {
+        "types": "./dist/components/banner-function-declaration.d.cts",
+        "default": "./dist/components/banner-function-declaration.cjs"
+      },
+      "import": {
+        "types": "./dist/components/banner-function-declaration.d.mts",
+        "default": "./dist/components/banner-function-declaration.mjs"
+      },
+      "default": {
+        "types": "./dist/components/banner-function-declaration.d.mts",
+        "default": "./dist/components/banner-function-declaration.mjs"
+      }
+    },
+    "./package.json": "./package.json",
+    "./types": {
+      "require": {
+        "types": "./dist/types/index.d.cts",
+        "default": "./dist/types/index.cjs"
+      },
+      "import": {
+        "types": "./dist/types/index.d.mts",
+        "default": "./dist/types/index.mjs"
+      },
+      "default": {
+        "types": "./dist/types/index.d.mts",
+        "default": "./dist/types/index.mjs"
+      }
+    },
+    "./types/plugin": {
+      "require": {
+        "types": "./dist/types/plugin.d.cts",
+        "default": "./dist/types/plugin.cjs"
+      },
+      "import": {
+        "types": "./dist/types/plugin.d.mts",
+        "default": "./dist/types/plugin.mjs"
+      },
+      "default": {
+        "types": "./dist/types/plugin.d.mts",
+        "default": "./dist/types/plugin.mjs"
+      }
+    }
+  },
+  "gitHead": "64e1ac187a12cd18acfd8134768bb793bbda3947"
+}