@shell-shock/plugin-completions 0.2.24 → 0.3.0

package/dist/components/fish-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, InterfaceMember, 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 { TSDoc, TSDocDefaultValue } from "@powerlines/plugin-alloy/typescript";
+import { joinPaths } from "@stryke/path";
+import { TypescriptFile as TypescriptFile$1 } from "@powerlines/plugin-alloy/typescript/components/typescript-file";
+
+//#region src/components/fish-config-command.tsx
+/**
+* The Fish Completions - Configuration command's handler wrapper for the Shell Shock project.
+*/
+function FishConfigCompletionsCommand() {
+	const context = usePowerlines();
+	return createComponent(TypescriptFile$1, {
+		get path() {
+			return joinPaths(context.entryPath, "completions", "fish", "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, { heading: "Options for the Fish Completions - Configuration command." }),
+				createComponent(InterfaceDeclaration, {
+					"export": true,
+					name: "FishConfigCompletionsOptions",
+					get children() {
+						return [createComponent(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 createComponent(TSDocDefaultValue, {
+									get type() {
+										return ReflectionKind.boolean;
+									},
+									defaultValue: false
+								});
+							}
+						}), createComponent(InterfaceMember, {
+							name: "display",
+							optional: true,
+							type: "boolean"
+						})];
+					}
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc, { heading: "Handler logic for the \\`completions fish config\\` command." }),
+				createComponent(FunctionDeclaration, {
+					"export": true,
+					"default": true,
+					async: true,
+					name: "handler",
+					parameters: [{
+						name: "options",
+						type: "FishConfigCompletionsOptions",
+						default: "{}"
+					}, {
+						name: "path",
+						type: "string",
+						default: `"~/.config/fish/config.fish"`
+					}],
+					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, ".config", "fish", "config.fish");`
+									}),
+									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)} Fish Completions ###\\n\\n\${SHELL_COMPLETIONS} \\n\\n### End - ${getAppTitle(context)} Fish Completions ###\`);
+
+          success(\`${getAppTitle(context)} shell completions have been applied to Fish 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)} Fish Completions ###\`);
+            writeLine("");
+            SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
+            writeLine("");
+            writeLine(\`### End - ${getAppTitle(context)} Fish Completions ###\`);
+            writeLine(" ------------------------------------------------- ");`;
+						} })];
+					}
+				})
+			];
+		}
+	});
+}
+
+//#endregion
+export { FishConfigCompletionsCommand };
+//# sourceMappingURL=fish-config-command.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fish-config-command.mjs","names":[],"sources":["../../src/components/fish-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  InterfaceMember,\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 { TSDoc, TSDocDefaultValue } from \"@powerlines/plugin-alloy/typescript\";\nimport { TypescriptFile } from \"@powerlines/plugin-alloy/typescript/components/typescript-file\";\nimport { getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport type { CompletionsPluginContext } from \"../types/plugin\";\n\n/**\n * The Fish Completions - Configuration command's handler wrapper for the Shell Shock project.\n */\nexport function FishConfigCompletionsCommand() {\n  const context = usePowerlines<CompletionsPluginContext>();\n\n  return (\n    <TypescriptFile\n      path={joinPaths(\n        context.entryPath,\n        \"completions\",\n        \"fish\",\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 Fish Completions - Configuration command.\" />\n      <InterfaceDeclaration export name=\"FishConfigCompletionsOptions\">\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 fish config\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"FishConfigCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"~/.config/fish/config.fish\"`\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, \".config\", \"fish\", \"config.fish\");`}\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)} Fish Completions ###\\\\n\\\\n\\${SHELL_COMPLETIONS} \\\\n\\\\n### End - ${getAppTitle(\n            context\n          )} Fish Completions ###\\`);\n\n          success(\\`${getAppTitle(\n            context\n          )} shell completions have been applied to Fish 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)} Fish Completions ###\\`);\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\"\");\n            writeLine(\\`### End - ${getAppTitle(context)} Fish Completions ###\\`);\n            writeLine(\" ------------------------------------------------- \");`}\n        </ElseClause>\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;AAiCA,SAAS,+BAA+B;CACxC,MAAO,UAAO,eAA0C;;EAEtD,IAAA,OAAA;AACI,UAAM,UAAW,QAAG,WAAc,eAAiB,QAAQ,UAAS,aAAY;;EAEtF,SAAO;GACL,WAAe;;GAEf,oBAAO,CAAA,YAAA,YAAA;GACJ,aAAA,CAAA,qBAAA,4BAAA;GACA;EACD,gBAAY,EACV,uBAAe;GAAA;GAAA;GAAA;GAAA;GAAA,EAChB;EACD,IAAI,WAAQ;AACV,UAAG;IAAA,gBAAU,OAAA,EACZ,SAAA,6DACD,CAAA;IAAA,gBAAS,sBAAA;KACP,UAAU;KACV,MAAM;KACN,IAAC,WAAQ;AACP,aAAE,CAAM,gBAAK,OAAoB;OACpC,SAAA;OACD,IAAA,WAAgB;AACR,eAAO,gBAAkB,mBAAiB;SAChD,IAAA,OAAA;AACK,iBAAS,eAAgB;;SAEvB,cAAe;SACnB,CAAA;;OAEA,CAAC,EAAA,gBAAmB,iBAAA;OACpB,MAAA;OACD,UAAK;OACN,MAAA;OACD,CAAA,CAAA;;KAED,CAAA;IAAA,gBAAe,SAAc,EAAG,CAAC;IAAA,gBAAkB,OAAK,EACxD,SAAA,gEACA,CAAC;IAAA,gBAAA,qBAAA;KACA,UAAA;KACA,WAAA;KACA,OAAM;KACN,MAAA;KACA,YAAE,CAAA;MACA,MAAM;MACN,MAAM;MACN,SAAS;MACV,EAAE;MACD,MAAA;MACA,MAAM;MACN,SAAS;MACV,CAAC;KACF,IAAE,WAAA;AACA,aAAA,CAAA,gBAAA,aAAA;OACD,WAAY,IAAA;OACV,IAAA,WAAA;AACC,eAAA;SAAA,gBAAA,gBAAA;UACI,OAAE;UACF,MAAE;UACN,MAAA;UACD,aAAA,IAAA;UACA,CAAA;SAAO,gBAAE,SAAA,EAAA,CAAA;SAAA,gBAAA,aAAA;UACT,WAAY,IAAA;UACV,UAAK,IAAY;UAClB,CAAA;SAAA,gBAAW,SAAA,EAAA,CAAA;SAAA,gBAAA,gBAAA;UACZ,OAAS;UACT,MAAA;UACC,MAAA;UACI,aAAS,IAAA;UACb,CAAI;SAAE,gBAAM,SAAA,EAAA,CAAA;SAAA,WAAA,IAAA;;;;;;;;;;;uEAWM,YAAA,QAAA,CAAA,mEAAA,YAAA,QAAA,CAAA;;sBAEpB,YAAA,QAAA,CAAA,wMAAA;SAAA;;OAEA,CAAA,EAAA,gBAAgB,YAAiB,EAC/B,IAAA,WAAA;AACC,cAAK,IAAA;;;;;oCAKG,YAAA,QAAA,CAAA;;SAGV,CAAC,CAAA;;KAEL,CAAC;IAAC;;EAEN,CAAC"}

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

@@ -0,0 +1,106 @@
+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");
+
+//#region src/components/fish-script-command.tsx
+/**
+* The Fish Completions - Script command's handler wrapper for the Shell Shock project.
+*/
+function FishScriptCompletionsCommand() {
+	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));
+	return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TypescriptFile, {
+		get path() {
+			return (0, _stryke_path.joinPaths)(context.entryPath, "completions", "fish", "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 Fish Completions - Script command." }),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.InterfaceDeclaration, {
+					"export": true,
+					name: "FishScriptCompletionsOptions",
+					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 fish 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: "FishScriptCompletionsOptions",
+							default: "{}"
+						}, {
+							name: "path",
+							type: "string",
+							default: `"${bin.value}-completions.fish"`
+						}];
+					},
+					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}.fish\` : path;`
+								}), (0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`await writeFile(scriptPath, \`# Fish 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)} Fish 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(\`# Fish completion for ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)}\`);
+            writeLine("");
+            SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
+            writeLine(" ------------------------------------------------- ");`;
+						} })];
+					}
+				})
+			];
+		}
+	});
+}
+
+//#endregion
+exports.FishScriptCompletionsCommand = FishScriptCompletionsCommand;

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,106 @@
+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";
+
+//#region src/components/fish-script-command.tsx
+/**
+* The Fish Completions - Script command's handler wrapper for the Shell Shock project.
+*/
+function FishScriptCompletionsCommand() {
+	const context = usePowerlines();
+	const bin = computed(() => getAppBin(context));
+	return createComponent(TypescriptFile, {
+		get path() {
+			return joinPaths(context.entryPath, "completions", "fish", "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 Fish Completions - Script command." }),
+				createComponent(InterfaceDeclaration, {
+					"export": true,
+					name: "FishScriptCompletionsOptions",
+					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 fish script\\` command." }),
+				createComponent(FunctionDeclaration, {
+					"export": true,
+					"default": true,
+					async: true,
+					name: "handler",
+					get parameters() {
+						return [{
+							name: "options",
+							type: "FishScriptCompletionsOptions",
+							default: "{}"
+						}, {
+							name: "path",
+							type: "string",
+							default: `"${bin.value}-completions.fish"`
+						}];
+					},
+					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}.fish\` : path;`
+								}), memo(() => code`await writeFile(scriptPath, \`# Fish script to add completions for ${getAppTitle(context)}\\n\\n\${SHELL_COMPLETIONS}\`);
+
+            success(\`${getAppTitle(context)} Fish completion script has been generated at \${colors.bold(scriptPath)}.\`);`)];
+							}
+						}), createComponent(ElseClause, { get children() {
+							return code`writeLine(" ------------------------------------------------- ");
+            writeLine(\`# Fish completion for ${getAppTitle(context)}\`);
+            writeLine("");
+            SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
+            writeLine(" ------------------------------------------------- ");`;
+						} })];
+					}
+				})
+			];
+		}
+	});
+}
+
+//#endregion
+export { FishScriptCompletionsCommand };
+//# sourceMappingURL=fish-script-command.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fish-script-command.mjs","names":[],"sources":["../../src/components/fish-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 type { CompletionsPluginContext } from \"../types/plugin\";\n\n/**\n * The Fish Completions - Script command's handler wrapper for the Shell Shock project.\n */\nexport function FishScriptCompletionsCommand() {\n  const context = usePowerlines<CompletionsPluginContext>();\n\n  const bin = computed(() => getAppBin(context));\n\n  return (\n    <TypescriptFile\n      path={joinPaths(\n        context.entryPath,\n        \"completions\",\n        \"fish\",\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 Fish Completions - Script command.\" />\n      <InterfaceDeclaration export name=\"FishScriptCompletionsOptions\">\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 fish script\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"FishScriptCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"${bin.value}-completions.fish\"`\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}.fish\\` : path;`}\n          />\n          {code`await writeFile(scriptPath, \\`# Fish script to add completions for ${getAppTitle(context)}\\\\n\\\\n\\${SHELL_COMPLETIONS}\\`);\n\n            success(\\`${getAppTitle(\n              context\n            )} Fish completion script has been generated at \\${colors.bold(scriptPath)}.\\`);`}\n        </IfStatement>\n        <ElseClause>\n          {code`writeLine(\" ------------------------------------------------- \");\n            writeLine(\\`# Fish 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":";;;;;;;;;;;;;;;AAiCA,SAAO,+BAAA;CACL,MAAK,UAAA,eAAA;CACL,MAAA,MAAA,eAAA,UAAA,QAAA,CAAA;AACA,QAAO,gBAAkB,gBAAgB;EAC3C,IAAQ,OAAC;AACH,UAAG,UAAY,QAAO,WAAY,eAAA,QAAA,UAAA,aAAA;;;GAGtC,WAAA;GACI,aAAM,CAAA,OAAc;GACxB,oBAAA,CAAA,YAAA,YAAA;GACI,aAAU,CAAA,qBAAA,4BAA+B;GAC7C;oBAEA,uBAA2B;GAAA;GAAU;GAAS;GAAA;GAAA;EAE9C,IAAM,WAAC;AACJ,UAAA;IAAA,gBAAA,SAAA,EACC,SAAM,sDACL,CAAC;IAAA,gBAAiB,sBAAA;KACjB,UAAC;KACD,MAAM;KACN,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,gEACJ,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,sEAAA,YAAA,QAAA,CAAA;;wBAEJ,YAAY,QAAQ,CAAC,gFAAiC,CAAA;;OAEnE,CAAA,EAAA,gBAAqB,YAAY;AAEhC,cAAS,IAAG;gDACV,YAAA,QAAA,CAAA;;;;SAKH,CAAC,CAAA;;KAEL,CAAC;IAAC;;EAEN,CAAC"}

package/dist/components/{fish-command.cjs → fish-shared.cjs}

@@ -1,109 +1,39 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_helpers_complete_command = require('../helpers/complete-command.cjs');
 const require_helpers_completion_directive_constants = require('../helpers/completion-directive-constants.cjs');
+require('../helpers/index.cjs');
 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/fish-command.tsx
+//#region src/components/fish-shared.tsx
 /**
-* The Fish Completions commands' handler wrapper for the Shell Shock project.
+* The Fish Completions generation for the Shell Shock project.
 */
-function FishCompletionsCommand() {
+function FishCompletionsShared() {
 	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", "fish", "command.ts");
+			return (0, _stryke_path.joinPaths)(context.entryPath, "completions", "fish", "shared.ts");
 		},
-		imports: {
-			"node:os": "os",
-			"node:path": ["join"],
-			"node:fs/promises": ["readFile", "writeFile"]
-		},
-		builtinImports: { "shell-shock:console": [
-			"colors",
-			"writeLine",
-			"success",
-			"warn",
-			"stripAnsi"
-		] },
+		builtinImports: { console: ["colors"] },
 		get children() {
 			return [
-				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, { heading: "Options for the Fish completions command." }),
-				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.InterfaceDeclaration, {
-					"export": true,
-					name: "FishCompletionsOptions",
-					get children() {
-						return [
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, {
-								heading: "The path to write the completion script to.",
-								get children() {
-									return [(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocRemarks, { children: `If no extension is provided, the \`.fish\` extension will be used.` }), (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocDefaultValue, {
-										get type() {
-											return _powerlines_deepkit_vendor_type.ReflectionKind.string;
-										},
-										get defaultValue() {
-											return `${bin.value}-completions.fish`;
-										}
-									})];
-								}
-							}),
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.InterfaceMember, {
-								name: "script",
-								optional: true,
-								type: "string | true"
-							}),
-							(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: "The Fish configuration file to append the completion script to.",
-								get children() {
-									return [(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocRemarks, { children: `The generated completion script will be appended to the specified configuration file. Possible values for the Fish configuration file include: \\n- \`~/.config/fish/config.fish\`` }), (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocDefaultValue, {
-										get type() {
-											return _powerlines_deepkit_vendor_type.ReflectionKind.string;
-										},
-										defaultValue: "~/.config/fish/config.fish"
-									})];
-								}
-							}),
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.InterfaceMember, {
-								name: "config",
-								optional: true,
-								type: "string | true"
-							})
-						];
-					}
-				}),
 				(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 fish\\` command." }),
-				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
+					"const": true,
 					"export": true,
-					"default": true,
-					async: true,
-					name: "handler",
-					parameters: [{
-						name: "options",
-						type: "FishCompletionsOptions"
-					}],
-					get children() {
-						return [
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
-								"const": true,
-								name: "completions",
-								type: "string",
-								get initializer() {
-									return _alloy_js_core.code` \`# fish completion for ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} -*- shell-script -*-
-
-function __${name.value}_debug
+					name: "SHELL_COMPLETIONS",
+					get initializer() {
+						return _alloy_js_core.code` \`function __${name.value}_debug
     set -l file "$BASH_COMP_DEBUG_FILE"
     if test -n "$file"
         echo "$argv" >> $file
@@ -195,8 +125,7 @@ function __${name.value}_requires_order_preservation
         return 1
     end
 
-    set -l directive (string sub --start 2 $__$
-    {name.value}_perform_completion_once_result[-1])
+    set -l directive (string sub --start 2 $__${name.value}_perform_completion_once_result[-1])
     __${name.value}_debug "Directive is: $directive"
 
     set -l shellCompDirectiveKeepOrder ${require_helpers_completion_directive_constants.CompletionDirective.CompletionDirectiveKeepOrder}
@@ -335,68 +264,35 @@ complete -c ${(0, _shell_shock_core_plugin_utils.getAppBin)(context)} -n 'not __
 # Otherwise we use the -k flag
 complete -k -c ${bin.value} -n '__${name.value}_requires_order_preservation && __${name.value}_prepare_completions' -f -a '$__${name.value}_comp_results'
 \`; `;
-								}
-							}),
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
-								condition: _alloy_js_core.code`options.config`,
-								get children() {
-									return [
-										(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
-											"let": true,
-											name: "configFilePath",
-											type: "string",
-											initializer: _alloy_js_core.code`options.config === true ? "~/.config/fish/config.fish" : options.config`
-										}),
-										(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
-										(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
-											condition: _alloy_js_core.code`configFilePath.startsWith("~")`,
-											children: _alloy_js_core.code`configFilePath = join(os.homedir(), configFilePath.replace("~", "")); `
-										}),
-										(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
-										(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
-											"let": true,
-											name: "configFileContent",
-											type: "string",
-											initializer: _alloy_js_core.code`"";`
-										}),
-										(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
-										(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`try {
-            configFileContent = await readFile(configFilePath, "utf8");
-          } catch (error) {
-            if (Error.isError(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(configFilePath)} does not exist. It will be created when the completion script is written.\`);
-            } else {
-              return { error };
-            }
+					}
+				}),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
+					"export": true,
+					"const": true,
+					name: "SHELL_COMPLETIONS_DISPLAY",
+					initializer: _alloy_js_core.code` SHELL_COMPLETIONS.split("\\n").map(line => {
+          if (!line.trim()) {
+            return "";
+          }
+          if (line.trim().startsWith("#")) {
+            return \`\${colors.dim(line)}\`;
           }
 
-          await writeFile(configFilePath, \`\${configFileContent}\\n\\n\${stripAnsi(completions)}\`);
-
-          success(\`${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Fish completion script has been generated and appended to \${colors.bold(configFilePath)}. Please restart your terminal or run \`source \${configFilePath}\` to apply the changes.\`); `)
-									];
-								}
-							}),
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
-								condition: _alloy_js_core.code`options.script`,
-								get children() {
-									return _alloy_js_core.code`const outputPath = options.script === true ? "${bin.value}-completions.fish" : options.script;
-          await writeFile(outputPath, stripAnsi(completions));
-
-          success(\`${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Fish completion script has been generated at \${colors.bold(outputPath)}.\`);`;
-								}
-							}),
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
-							(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
-								condition: _alloy_js_core.code`!options.config && !options.script`,
-								children: _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
-          writeLine(completions);
-          writeLine(" ------------------------------------------------- ");`
-							})
-						];
-					}
+          return colors.white(line).replaceAll(/(?<=\\\$(\\{|\\()).*(?=(\\}\\)))/g, colors.green("$&"))
+            .replaceAll(/(\\"|\\').*(\\"|\\')/g, colors.cyan("$&"))
+            .replaceAll(/(\\[|\\]|\\(|\\)|\\||<|>|\\$\\(|\\$?\\{|\\}|\\+|=|;|:)/g, colors.bold(colors.gray("$&")))
+            .replaceAll(/(function|complete)\\s+/g, colors.green("$&"))
+            .replaceAll(/(?<=(function|complete)\\s+)\\w/g, colors.bold(colors.greenBright("$&")))
+            .replaceAll(/set\\s+/g, colors.red("$&"))
+            .replaceAll(/(?<=set\\s+)\\w/g, colors.bold(colors.redBright("$&")))
+            .replaceAll(/while\\s+/g, colors.cyan("$&"))
+            .replaceAll(/(?<=while\\s+)\\w/g, colors.bold(colors.cyanBright("$&")))
+            .replaceAll(/(if|fi|else|elif|then|done)\\s+/g, colors.green("$&"))
+            .replaceAll(/\\s__\\w/g, colors.bold(colors.magentaBright("$&")))
+            .replaceAll(/(?<=\\s)(-\\w|--\\w[\\w-]*)(?=\\s|$)/g, colors.bold(colors.magenta("$&")));
+
+        }).join("\\n"); `
 				})
 			];
 		}
@@ -404,4 +300,4 @@ complete -k -c ${bin.value} -n '__${name.value}_requires_order_preservation && _
 }
 
 //#endregion
-exports.FishCompletionsCommand = FishCompletionsCommand;
+exports.FishCompletionsShared = FishCompletionsShared;