@shell-shock/plugin-completions 0.2.23 → 0.3.0

package/dist/components/zsh-config-command.mjs

@@ -0,0 +1,132 @@
+import { createComponent, memo } from "@alloy-js/core/jsx-runtime";
+import { getAppTitle } from "@shell-shock/core/plugin-utils";
+import { code } from "@alloy-js/core";
+import { ElseClause, FunctionDeclaration, IfStatement, InterfaceDeclaration, VarDeclaration } from "@alloy-js/typescript";
+import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import { Spacing } from "@powerlines/plugin-alloy/core";
+import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
+import { InterfaceMember as InterfaceMember$1, TypescriptFile } from "@powerlines/plugin-alloy/typescript";
+import { TSDoc as TSDoc$1, TSDocDefaultValue as TSDocDefaultValue$1 } from "@powerlines/plugin-alloy/typescript/components/tsdoc";
+import { joinPaths } from "@stryke/path";
+
+//#region src/components/zsh-config-command.tsx
+/**
+* The Zsh Completions - Configuration command's handler wrapper for the Shell Shock project.
+*/
+function ZshConfigCompletionsCommand() {
+	const context = usePowerlines();
+	return createComponent(TypescriptFile, {
+		get path() {
+			return joinPaths(context.entryPath, "completions", "zsh", "config", "command.ts");
+		},
+		imports: {
+			"node:os": "os",
+			"node:path": ["join"],
+			"node:fs/promises": ["readFile", "writeFile"],
+			"../shared": ["SHELL_COMPLETIONS", "SHELL_COMPLETIONS_DISPLAY"]
+		},
+		builtinImports: { "shell-shock:console": [
+			"colors",
+			"writeLine",
+			"success",
+			"warn"
+		] },
+		get children() {
+			return [
+				createComponent(TSDoc$1, { heading: "Options for the Zsh Completions - Configuration command." }),
+				createComponent(InterfaceDeclaration, {
+					"export": true,
+					name: "ZshConfigCompletionsOptions",
+					get children() {
+						return [createComponent(TSDoc$1, {
+							heading: "Should the generated completion script be written to console output instead of an actual file on disk? This is useful for debugging purposes or if you want to manually handle the output.",
+							get children() {
+								return createComponent(TSDocDefaultValue$1, {
+									get type() {
+										return ReflectionKind.boolean;
+									},
+									defaultValue: false
+								});
+							}
+						}), createComponent(InterfaceMember$1, {
+							name: "display",
+							optional: true,
+							type: "boolean"
+						})];
+					}
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc$1, { heading: "Handler logic for the \\`completions zsh config\\` command." }),
+				createComponent(FunctionDeclaration, {
+					"export": true,
+					"default": true,
+					async: true,
+					name: "handler",
+					parameters: [{
+						name: "options",
+						type: "ZshConfigCompletionsOptions",
+						default: "{}"
+					}, {
+						name: "path",
+						type: "string",
+						default: `"~/.zshrc"`
+					}],
+					get children() {
+						return [createComponent(IfStatement, {
+							condition: code`options.display !== true`,
+							get children() {
+								return [
+									createComponent(VarDeclaration, {
+										"let": true,
+										name: "configPath",
+										type: "string",
+										initializer: code` path.includes(".") ? path : join(path, ".zshrc");`
+									}),
+									createComponent(Spacing, {}),
+									createComponent(IfStatement, {
+										condition: code`configPath.startsWith("~")`,
+										children: code`configPath = join(os.homedir(), configPath.replace("~", "")); `
+									}),
+									createComponent(Spacing, {}),
+									createComponent(VarDeclaration, {
+										"let": true,
+										name: "content",
+										type: "string",
+										initializer: code`"";`
+									}),
+									createComponent(Spacing, {}),
+									memo(() => code`try {
+            content = await readFile(configPath, "utf8");
+          } catch (error) {
+            if (typeof error === "object" && error !== null && "code" in error && error.code === "ENOENT") {
+              // If the file doesn't exist, we can create it later when writing the completion script.
+              warn(\`Configuration file \${colors.bold(configPath)} does not exist. It will be created when the completion script is written.\`);
+            } else {
+              return { error };
+            }
+          }
+
+          await writeFile(configPath, \`\${content}\\n\\n### Begin - ${getAppTitle(context)} Shell Completions ###\\n\\n\${SHELL_COMPLETIONS} \\n\\n### End - ${getAppTitle(context)} Zsh Completions ###\`);
+
+          success(\`${getAppTitle(context)} shell completions have been applied to Zsh configuration file at \${colors.bold(configPath)}. Please restart your terminal or run \\\`source \${configPath}\\\` for the changes to take effect.\`); `)
+								];
+							}
+						}), createComponent(ElseClause, { get children() {
+							return code`writeLine(" ------------------------------------------------- ");
+            writeLine(\`### Begin - ${getAppTitle(context)} Zsh Completions ###\`);
+            writeLine("");
+            SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
+            writeLine("");
+            writeLine(\`### End - ${getAppTitle(context)} Zsh Completions ###\`);
+            writeLine(" ------------------------------------------------- ");`;
+						} })];
+					}
+				})
+			];
+		}
+	});
+}
+
+//#endregion
+export { ZshConfigCompletionsCommand };
+//# sourceMappingURL=zsh-config-command.mjs.map

package/dist/components/zsh-config-command.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"zsh-config-command.mjs","names":[],"sources":["../../src/components/zsh-config-command.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 { code } from \"@alloy-js/core\";\nimport {\n  ElseClause,\n  FunctionDeclaration,\n  IfStatement,\n  InterfaceDeclaration,\n  VarDeclaration\n} from \"@alloy-js/typescript\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport {\n  InterfaceMember,\n  TypescriptFile\n} from \"@powerlines/plugin-alloy/typescript\";\nimport {\n  TSDoc,\n  TSDocDefaultValue\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport type { CompletionsPluginContext } from \"../types/plugin\";\n\n/**\n * The Zsh Completions - Configuration command's handler wrapper for the Shell Shock project.\n */\nexport function ZshConfigCompletionsCommand() {\n  const context = usePowerlines<CompletionsPluginContext>();\n\n  return (\n    <TypescriptFile\n      path={joinPaths(\n        context.entryPath,\n        \"completions\",\n        \"zsh\",\n        \"config\",\n        \"command.ts\"\n      )}\n      imports={{\n        \"node:os\": \"os\",\n        \"node:path\": [\"join\"],\n        \"node:fs/promises\": [\"readFile\", \"writeFile\"],\n        \"../shared\": [\"SHELL_COMPLETIONS\", \"SHELL_COMPLETIONS_DISPLAY\"]\n      }}\n      builtinImports={{\n        \"shell-shock:console\": [\"colors\", \"writeLine\", \"success\", \"warn\"]\n      }}>\n      <TSDoc heading=\"Options for the Zsh Completions - Configuration command.\" />\n      <InterfaceDeclaration export name=\"ZshConfigCompletionsOptions\">\n        <TSDoc heading=\"Should the generated completion script be written to console output instead of an actual file on disk? This is useful for debugging purposes or if you want to manually handle the output.\">\n          <TSDocDefaultValue\n            type={ReflectionKind.boolean}\n            defaultValue={false}\n          />\n        </TSDoc>\n        <InterfaceMember name=\"display\" optional type=\"boolean\" />\n      </InterfaceDeclaration>\n      <Spacing />\n      <TSDoc heading=\"Handler logic for the \\`completions zsh config\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"ZshConfigCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"~/.zshrc\"`\n          }\n        ]}>\n        <IfStatement condition={code`options.display !== true`}>\n          <VarDeclaration\n            let\n            name=\"configPath\"\n            type=\"string\"\n            initializer={code` path.includes(\".\") ? path : join(path, \".zshrc\");`}\n          />\n          <Spacing />\n          <IfStatement condition={code`configPath.startsWith(\"~\")`}>\n            {code`configPath = join(os.homedir(), configPath.replace(\"~\", \"\")); `}\n          </IfStatement>\n          <Spacing />\n          <VarDeclaration\n            let\n            name=\"content\"\n            type=\"string\"\n            initializer={code`\"\";`}\n          />\n          <Spacing />\n          {code`try {\n            content = await readFile(configPath, \"utf8\");\n          } catch (error) {\n            if (typeof error === \"object\" && error !== null && \"code\" in error && error.code === \"ENOENT\") {\n              // If the file doesn't exist, we can create it later when writing the completion script.\n              warn(\\`Configuration file \\${colors.bold(configPath)} does not exist. It will be created when the completion script is written.\\`);\n            } else {\n              return { error };\n            }\n          }\n\n          await writeFile(configPath, \\`\\${content}\\\\n\\\\n### Begin - ${getAppTitle(context)} Shell Completions ###\\\\n\\\\n\\${SHELL_COMPLETIONS} \\\\n\\\\n### End - ${getAppTitle(\n            context\n          )} Zsh Completions ###\\`);\n\n          success(\\`${getAppTitle(\n            context\n          )} shell completions have been applied to Zsh configuration file at \\${colors.bold(configPath)}. Please restart your terminal or run \\\\\\`source \\${configPath}\\\\\\` for the changes to take effect.\\`); `}\n        </IfStatement>\n        <ElseClause>\n          {code`writeLine(\" ------------------------------------------------- \");\n            writeLine(\\`### Begin - ${getAppTitle(context)} Zsh Completions ###\\`);\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\"\");\n            writeLine(\\`### End - ${getAppTitle(context)} Zsh Completions ###\\`);\n            writeLine(\" ------------------------------------------------- \");`}\n        </ElseClause>\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;AAiCA,SAAO,8BAAA;CACL,MAAK,UAAA,eAAA;AACL,QAAA,gBAAA,gBAAA;EACA,IAAM,OAAC;AACH,UAAG,UAAc,QAAO,WAAY,eAAY,OAAM,UAAA,aAAA;;EAE5D,SAAa;;GAEX,aAAA,CAAA,OAAA;GACI,oBAAmB,CAAA,YAAc,YAAU;GAC/C,aAAA,CAAA,qBAAA,4BAAA;GACF;EACE,gBAAgB;;;;;KAEhB;EACE,IAAC,WAAA;AACC,UAAM;IAAA,gBAAS,SAAA,EACb,SAAQ,4DACT,CAAC;IAAC,gBAAY,sBAAA;KACb,UAAK;KACL,MAAC;KACD,IAAC,WAAU;AACZ,aAAA,CAAA,gBAAA,SAAA;OACD,SAAS;OACN,IAAO,WAAO;AACT,eAAO,gBAAQ,qBAAA;SACb,IAAC,OAAU;AACT,iBAAK,eAAiB;;SAElC,cAAgB;SACP,CAAA;;OAER,CAAK,EAAC,gBAAiB,mBAAY;OACnC,MAAA;OACE,UAAa;OACX,MAAA;OACA,CAAC,CAAA;;KAEL,CAAC;IAAE,gBAAC,SAAA,EAAA,CAAA;IAAA,gBAAA,SAAA,EACH,SAAO,+DACR,CAAC;IAAC,gBAAgB,qBAAwB;KACzC,UAAA;KACD,WAAS;KACT,OAAM;KACN,MAAA;KACC,YAAA,CAAA;MACA,MAAA;MACA,MAAA;MACA,SAAM;MACN,EAAA;MACE,MAAA;MACA,MAAM;MACN,SAAS;MACV,CAAC;KACF,IAAG,WAAA;AACD,aAAA,CAAA,gBAAA,aAAA;OACE,WAAW,IAAC;OACZ,IAAI,WAAU;AACd,eAAS;SAAC,gBAAU,gBAAA;UACtB,OAAA;UACA,MAAA;UACD,MAAY;UACV,aAAA,IAAA;UACC,CAAA;SAAA,gBAAA,SAAA,EAAA,CAAA;SAAA,gBAAA,aAAA;UACI,WAAE,IAAU;UACZ,UAAQ,IAAA;UACZ,CAAA;SAAA,gBAAwB,SAAS,EAAE,CAAC;SAAE,gBAAkB,gBAAa;UACtE,OAAA;UACA,MAAS;UACT,MAAW;UACT,aAAgB,IAAE;UACnB,CAAA;SAAA,gBAAW,SAAA,EAAA,CAAA;SAAA,WAAA,IAAA;;;;;;;;;;;uEAWG,YAAA,QAAA,CAAA,oEAAA,YAAA,QAAA,CAAA;;sBAEN,YAAc,QAAQ,CAAC,uMAA0D;SAAA;;OAE1F,CAAC,EAAE,gBAAK,YAAA,EACP,IAAE,WAAS;AACX,cAAA,IAAA;sCACF,YAAA,QAAA,CAAA;;;;oCAIyB,YAAA,QAAA,CAAA;;SAGxB,CAAC,CAAA;;KAEL,CAAC;IAAC;;EAEN,CAAC"}

package/dist/components/zsh-script-command.cjs

@@ -0,0 +1,111 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let _alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let _shell_shock_core_plugin_utils = require("@shell-shock/core/plugin-utils");
+let _alloy_js_core = require("@alloy-js/core");
+let _alloy_js_typescript = require("@alloy-js/typescript");
+let _powerlines_deepkit_vendor_type = require("@powerlines/deepkit/vendor/type");
+let _powerlines_plugin_alloy_core = require("@powerlines/plugin-alloy/core");
+let _powerlines_plugin_alloy_core_contexts_context = require("@powerlines/plugin-alloy/core/contexts/context");
+let _powerlines_plugin_alloy_typescript = require("@powerlines/plugin-alloy/typescript");
+let _powerlines_plugin_alloy_typescript_components_tsdoc = require("@powerlines/plugin-alloy/typescript/components/tsdoc");
+let _stryke_path = require("@stryke/path");
+let _stryke_string_format_snake_case = require("@stryke/string-format/snake-case");
+
+//#region src/components/zsh-script-command.tsx
+/**
+* The Zsh Completions - Script command's handler wrapper for the Shell Shock project.
+*/
+function ZshScriptCompletionsCommand() {
+	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	const bin = (0, _alloy_js_core.computed)(() => (0, _shell_shock_core_plugin_utils.getAppBin)(context));
+	const name = (0, _alloy_js_core.computed)(() => (0, _stryke_string_format_snake_case.snakeCase)(bin.value));
+	return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TypescriptFile, {
+		get path() {
+			return (0, _stryke_path.joinPaths)(context.entryPath, "completions", "zsh", "script", "command.ts");
+		},
+		imports: {
+			"node:os": "os",
+			"node:path": ["join"],
+			"node:fs/promises": ["readFile", "writeFile"],
+			"../shared": ["SHELL_COMPLETIONS", "SHELL_COMPLETIONS_DISPLAY"]
+		},
+		builtinImports: { "shell-shock:console": [
+			"colors",
+			"writeLine",
+			"success",
+			"warn"
+		] },
+		get children() {
+			return [
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, { heading: "Options for the Zsh Completions - Script command." }),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.InterfaceDeclaration, {
+					"export": true,
+					name: "ZshScriptCompletionsOptions",
+					get children() {
+						return [(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, {
+							heading: "Should the generated completion script be written to console output instead of an actual file on disk? This is useful for debugging purposes or if you want to manually handle the output.",
+							get children() {
+								return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocDefaultValue, {
+									get type() {
+										return _powerlines_deepkit_vendor_type.ReflectionKind.boolean;
+									},
+									defaultValue: false
+								});
+							}
+						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.InterfaceMember, {
+							name: "display",
+							optional: true,
+							type: "boolean"
+						})];
+					}
+				}),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, { heading: "Handler logic for the \\`completions zsh script\\` command." }),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
+					"export": true,
+					"default": true,
+					async: true,
+					name: "handler",
+					get parameters() {
+						return [{
+							name: "options",
+							type: "ZshScriptCompletionsOptions",
+							default: "{}"
+						}, {
+							name: "path",
+							type: "string",
+							default: `"${bin.value}-completions.zsh"`
+						}];
+					},
+					get children() {
+						return [(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
+							condition: _alloy_js_core.code`options.display !== true`,
+							get children() {
+								return [(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
+									"const": true,
+									name: "scriptPath",
+									type: "string",
+									initializer: _alloy_js_core.code` path.includes(".") ? \`\${path}.zsh\` : path;`
+								}), (0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`await writeFile(scriptPath, \`# Zsh script to add completions for ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)}\\n\\n\${SHELL_COMPLETIONS}\`);
+
+            success(\`${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Zsh completion script has been generated at \${colors.bold(scriptPath)}.\`);`)];
+							}
+						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.ElseClause, { get children() {
+							return _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
+            writeLine("#compdef ${bin.value} ");
+            writeLine("#compdef _${name.value} ${bin.value}");
+            writeLine("");
+            writeLine("# Zsh completion for ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)}");
+            writeLine("");
+            SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
+            writeLine(" ------------------------------------------------- ");`;
+						} })];
+					}
+				})
+			];
+		}
+	});
+}
+
+//#endregion
+exports.ZshScriptCompletionsCommand = ZshScriptCompletionsCommand;

package/dist/components/zsh-script-command.d.cts

@@ -0,0 +1,10 @@
+import * as _$_alloy_js_core0 from "@alloy-js/core";
+
+//#region src/components/zsh-script-command.d.ts
+/**
+ * The Zsh Completions - Script command's handler wrapper for the Shell Shock project.
+ */
+declare function ZshScriptCompletionsCommand(): _$_alloy_js_core0.Children;
+//#endregion
+export { ZshScriptCompletionsCommand };
+//# sourceMappingURL=zsh-script-command.d.cts.map

package/dist/components/zsh-script-command.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zsh-script-command.d.cts","names":[],"sources":["../../src/components/zsh-script-command.tsx"],"mappings":";;;;;;iBA6CgB,2BAAA,CAAA,GAA2B,iBAAA,CAAA,QAAA"}

package/dist/components/zsh-script-command.d.mts

@@ -0,0 +1,10 @@
+import * as _$_alloy_js_core0 from "@alloy-js/core";
+
+//#region src/components/zsh-script-command.d.ts
+/**
+ * The Zsh Completions - Script command's handler wrapper for the Shell Shock project.
+ */
+declare function ZshScriptCompletionsCommand(): _$_alloy_js_core0.Children;
+//#endregion
+export { ZshScriptCompletionsCommand };
+//# sourceMappingURL=zsh-script-command.d.mts.map

package/dist/components/zsh-script-command.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zsh-script-command.d.mts","names":[],"sources":["../../src/components/zsh-script-command.tsx"],"mappings":";;;;;;iBA6CgB,2BAAA,CAAA,GAA2B,iBAAA,CAAA,QAAA"}

package/dist/components/zsh-script-command.mjs

@@ -0,0 +1,111 @@
+import { createComponent, memo } from "@alloy-js/core/jsx-runtime";
+import { getAppBin, getAppTitle } from "@shell-shock/core/plugin-utils";
+import { code, computed } from "@alloy-js/core";
+import { ElseClause, FunctionDeclaration, IfStatement, InterfaceDeclaration, VarDeclaration } from "@alloy-js/typescript";
+import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import { Spacing } from "@powerlines/plugin-alloy/core";
+import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
+import { InterfaceMember as InterfaceMember$1, TypescriptFile } from "@powerlines/plugin-alloy/typescript";
+import { TSDoc as TSDoc$1, TSDocDefaultValue as TSDocDefaultValue$1 } from "@powerlines/plugin-alloy/typescript/components/tsdoc";
+import { joinPaths } from "@stryke/path";
+import { snakeCase } from "@stryke/string-format/snake-case";
+
+//#region src/components/zsh-script-command.tsx
+/**
+* The Zsh Completions - Script command's handler wrapper for the Shell Shock project.
+*/
+function ZshScriptCompletionsCommand() {
+	const context = usePowerlines();
+	const bin = computed(() => getAppBin(context));
+	const name = computed(() => snakeCase(bin.value));
+	return createComponent(TypescriptFile, {
+		get path() {
+			return joinPaths(context.entryPath, "completions", "zsh", "script", "command.ts");
+		},
+		imports: {
+			"node:os": "os",
+			"node:path": ["join"],
+			"node:fs/promises": ["readFile", "writeFile"],
+			"../shared": ["SHELL_COMPLETIONS", "SHELL_COMPLETIONS_DISPLAY"]
+		},
+		builtinImports: { "shell-shock:console": [
+			"colors",
+			"writeLine",
+			"success",
+			"warn"
+		] },
+		get children() {
+			return [
+				createComponent(TSDoc$1, { heading: "Options for the Zsh Completions - Script command." }),
+				createComponent(InterfaceDeclaration, {
+					"export": true,
+					name: "ZshScriptCompletionsOptions",
+					get children() {
+						return [createComponent(TSDoc$1, {
+							heading: "Should the generated completion script be written to console output instead of an actual file on disk? This is useful for debugging purposes or if you want to manually handle the output.",
+							get children() {
+								return createComponent(TSDocDefaultValue$1, {
+									get type() {
+										return ReflectionKind.boolean;
+									},
+									defaultValue: false
+								});
+							}
+						}), createComponent(InterfaceMember$1, {
+							name: "display",
+							optional: true,
+							type: "boolean"
+						})];
+					}
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc$1, { heading: "Handler logic for the \\`completions zsh script\\` command." }),
+				createComponent(FunctionDeclaration, {
+					"export": true,
+					"default": true,
+					async: true,
+					name: "handler",
+					get parameters() {
+						return [{
+							name: "options",
+							type: "ZshScriptCompletionsOptions",
+							default: "{}"
+						}, {
+							name: "path",
+							type: "string",
+							default: `"${bin.value}-completions.zsh"`
+						}];
+					},
+					get children() {
+						return [createComponent(IfStatement, {
+							condition: code`options.display !== true`,
+							get children() {
+								return [createComponent(VarDeclaration, {
+									"const": true,
+									name: "scriptPath",
+									type: "string",
+									initializer: code` path.includes(".") ? \`\${path}.zsh\` : path;`
+								}), memo(() => code`await writeFile(scriptPath, \`# Zsh script to add completions for ${getAppTitle(context)}\\n\\n\${SHELL_COMPLETIONS}\`);
+
+            success(\`${getAppTitle(context)} Zsh completion script has been generated at \${colors.bold(scriptPath)}.\`);`)];
+							}
+						}), createComponent(ElseClause, { get children() {
+							return code`writeLine(" ------------------------------------------------- ");
+            writeLine("#compdef ${bin.value} ");
+            writeLine("#compdef _${name.value} ${bin.value}");
+            writeLine("");
+            writeLine("# Zsh completion for ${getAppTitle(context)}");
+            writeLine("");
+            SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
+            writeLine(" ------------------------------------------------- ");`;
+						} })];
+					}
+				})
+			];
+		}
+	});
+}
+
+//#endregion
+export { ZshScriptCompletionsCommand };
+//# sourceMappingURL=zsh-script-command.mjs.map

package/dist/components/zsh-script-command.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"zsh-script-command.mjs","names":[],"sources":["../../src/components/zsh-script-command.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 { code, computed } from \"@alloy-js/core\";\nimport {\n  ElseClause,\n  FunctionDeclaration,\n  IfStatement,\n  InterfaceDeclaration,\n  VarDeclaration\n} from \"@alloy-js/typescript\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport {\n  InterfaceMember,\n  TypescriptFile\n} from \"@powerlines/plugin-alloy/typescript\";\nimport {\n  TSDoc,\n  TSDocDefaultValue\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { getAppBin, getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport type { CompletionsPluginContext } from \"../types/plugin\";\n\n/**\n * The Zsh Completions - Script command's handler wrapper for the Shell Shock project.\n */\nexport function ZshScriptCompletionsCommand() {\n  const context = usePowerlines<CompletionsPluginContext>();\n\n  const bin = computed(() => getAppBin(context));\n  const name = computed(() => snakeCase(bin.value));\n\n  return (\n    <TypescriptFile\n      path={joinPaths(\n        context.entryPath,\n        \"completions\",\n        \"zsh\",\n        \"script\",\n        \"command.ts\"\n      )}\n      imports={{\n        \"node:os\": \"os\",\n        \"node:path\": [\"join\"],\n        \"node:fs/promises\": [\"readFile\", \"writeFile\"],\n        \"../shared\": [\"SHELL_COMPLETIONS\", \"SHELL_COMPLETIONS_DISPLAY\"]\n      }}\n      builtinImports={{\n        \"shell-shock:console\": [\"colors\", \"writeLine\", \"success\", \"warn\"]\n      }}>\n      <TSDoc heading=\"Options for the Zsh Completions - Script command.\" />\n      <InterfaceDeclaration export name=\"ZshScriptCompletionsOptions\">\n        <TSDoc heading=\"Should the generated completion script be written to console output instead of an actual file on disk? This is useful for debugging purposes or if you want to manually handle the output.\">\n          <TSDocDefaultValue\n            type={ReflectionKind.boolean}\n            defaultValue={false}\n          />\n        </TSDoc>\n        <InterfaceMember name=\"display\" optional type=\"boolean\" />\n      </InterfaceDeclaration>\n      <Spacing />\n      <TSDoc heading=\"Handler logic for the \\`completions zsh script\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"ZshScriptCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"${bin.value}-completions.zsh\"`\n          }\n        ]}>\n        <IfStatement condition={code`options.display !== true`}>\n          <VarDeclaration\n            const\n            name=\"scriptPath\"\n            type=\"string\"\n            initializer={code` path.includes(\".\") ? \\`\\${path}.zsh\\` : path;`}\n          />\n          {code`await writeFile(scriptPath, \\`# Zsh script to add completions for ${getAppTitle(context)}\\\\n\\\\n\\${SHELL_COMPLETIONS}\\`);\n\n            success(\\`${getAppTitle(\n              context\n            )} Zsh completion script has been generated at \\${colors.bold(scriptPath)}.\\`);`}\n        </IfStatement>\n        <ElseClause>\n          {code`writeLine(\" ------------------------------------------------- \");\n            writeLine(\"#compdef ${bin.value} \");\n            writeLine(\"#compdef _${name.value} ${bin.value}\");\n            writeLine(\"\");\n            writeLine(\"# Zsh completion for ${getAppTitle(context)}\");\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\" ------------------------------------------------- \");`}\n        </ElseClause>\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAkCA,SAAO,8BAAA;CACL,MAAA,UAAA,eAAA;CACA,MAAM,MAAC,eAAkB,UAAM,QAAW,CAAA;CAC5C,MAAQ,OAAC,eAAW,UAAoB,IAAC,MAAM,CAAA;AAC/C,QAAS,gBAAkB,gBAAa;EACxC,IAAQ,OAAC;AACH,UAAO,UAAC,QAAA,WAA2B,eAAe,OAAO,UAAA,aAAA;;EAE7D,SAAA;GACI,WAAK;GACT,aAAA,CAAA,OAAA;GACI,oBAAU,CAAA,YAAA,YAA8B;GAC5C,aAAgB,CAAA,qBAAc,4BAA2B;;EAEzD,gBAAY,EACZ,uBAA2B;GAAC;GAAU;GAAW;GAAA;GAAA;EAEjD,IAAM,WAAC;AACJ,UAAA;IAAA,gBAAA,SAAA,EACC,SAAM,qDACL,CAAC;IAAA,gBAAiB,sBAAA;KACjB,UAAC;KACD,MAAK;KACL,IAAC,WAAO;AACP,aAAQ,CAAA,gBAAE,SAAA;OACZ,SAAA;OACD,IAAS,WAAA;AACD,eAAM,gBAAG,qBAAA;SACT,IAAM,OAAO;AACV,iBAAQ,eAAe;;SAEjC,cAAA;SACD,CAAA;;OAEE,CAAA,EAAA,gBAAA,mBAAA;OACI,MAAC;OACN,UAAA;OACE,MAAM;OACJ,CAAA,CAAA;;KAEJ,CAAC;IAAE,gBAAgB,SAAK,EAAA,CAAA;IAAA,gBAAA,SAAA,EACvB,SAAG,+DACJ,CAAC;IAAE,gBAAK,qBAAA;KACP,UAAC;KACD,WAAA;KACD,OAAQ;KACR,MAAM;KACN,IAAA,aAAA;AACC,aAAA,CAAA;OACA,MAAA;OACA,MAAA;OACI,SAAS;OACb,EAAA;OACE,MAAA;OACE,MAAM;OACN,SAAO,IAAA,IAAA,MAAA;OACR,CAAC;;KAEJ,IAAE,WAAA;AACA,aAAO,CAAC,gBAAM,aAAA;OACZ,WAAO,IAAO;OACd,IAAA,WAAa;AACf,eAAA,CAAA,gBAAA,gBAAA;SACA,SAAA;SACD,MAAY;SACV,MAAA;SACC,aAAA,IAAA;SACA,CAAI,EAAE,WAAU,IAAA,qEAAA,YAAA,QAAA,CAAA;;wBAEJ,YAAY,QAAQ,CAAC,+EAAgC,CAAA;;OAElE,CAAA,EAAA,gBAAqB,YAAY;AAEhC,cAAS,IAAG;kCACV,IAAA,MAAA;mCACgB,KAAU,MAAM,GAAA,IAAA,MAAa;;8CAExC,YAAA,QAAA,CAAA;;;;SAKR,CAAC,CAAA;;KAEL,CAAC;IAAC;;EAEN,CAAC"}