@shell-shock/plugin-completions 0.3.1 → 0.4.0

package/dist/components/bash-config-command.cjs

@@ -30,7 +30,8 @@ function BashConfigCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -114,12 +115,20 @@ function BashConfigCompletionsCommand() {
 							}
 						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.ElseClause, { get children() {
 							return _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
-            writeLine(\`### Begin - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Bash Completions ###\`);
-            writeLine("");
-            SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
-            writeLine("");
-            writeLine(\`### End - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Bash Completions ###\`);
-            writeLine(" ------------------------------------------------- ");`;
+          writeLine("");
+          writeLine(\`### Begin - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Bash Completions ###\`);
+          writeLine("");
+          SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
+          writeLine("");
+          writeLine(\`### End - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Bash Completions ###\`);
+          writeLine("");
+          writeLine(" ------------------------------------------------- ");
+
+          writeLine("");
+          help(\`To enable these completions, perform one of the following actions:
+
+          1) Copy and paste the above script into your shell configuration file (e.g., ~/.bashrc)
+          2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -29,7 +29,8 @@ function BashConfigCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -113,12 +114,20 @@ function BashConfigCompletionsCommand() {
 							}
 						}), createComponent(ElseClause, { get children() {
 							return code`writeLine(" ------------------------------------------------- ");
-            writeLine(\`### Begin - ${getAppTitle(context)} Bash Completions ###\`);
-            writeLine("");
-            SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
-            writeLine("");
-            writeLine(\`### End - ${getAppTitle(context)} Bash Completions ###\`);
-            writeLine(" ------------------------------------------------- ");`;
+          writeLine("");
+          writeLine(\`### Begin - ${getAppTitle(context)} Bash Completions ###\`);
+          writeLine("");
+          SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
+          writeLine("");
+          writeLine(\`### End - ${getAppTitle(context)} Bash Completions ###\`);
+          writeLine("");
+          writeLine(" ------------------------------------------------- ");
+
+          writeLine("");
+          help(\`To enable these completions, perform one of the following actions:
+
+          1) Copy and paste the above script into your shell configuration file (e.g., ~/.bashrc)
+          2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -1 +1 @@
-{"version":3,"file":"bash-config-command.mjs","names":[],"sources":["../../src/components/bash-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 Bash Completions - Configuration command's handler wrapper for the Shell Shock project.\n */\nexport function BashConfigCompletionsCommand() {\n  const context = usePowerlines<CompletionsPluginContext>();\n\n  return (\n    <TypescriptFile\n      path={joinPaths(\n        context.entryPath,\n        \"completions\",\n        \"bash\",\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_DISPLAY\", \"SHELL_COMPLETIONS\"]\n      }}\n      builtinImports={{\n        \"shell-shock:console\": [\"colors\", \"writeLine\", \"success\", \"warn\"]\n      }}>\n      <TSDoc heading=\"Options for the Bash Completions - Configuration command.\" />\n      <InterfaceDeclaration export name=\"BashConfigCompletionsOptions\">\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 bash config\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"BashConfigCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"~/.bashrc\"`\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, \".bashrc\");`}\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          )} Bash Completions ###\\`);\n\n          success(\\`${getAppTitle(\n            context\n          )} shell completions have been applied to Bash 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)} Bash Completions ###\\`);\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\"\");\n            writeLine(\\`### End - ${getAppTitle(context)} Bash Completions ###\\`);\n            writeLine(\" ------------------------------------------------- \");`}\n        </ElseClause>\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;AAiCA,SAAO,+BAAA;CACL,MAAK,UAAA,eAAA;AACL,QAAA,gBAAA,gBAAA;EACA,IAAM,OAAC;AACH,UAAG,UAAc,QAAO,WAAY,eAAY,QAAM,UAAA,aAAA;;EAE5D,SAAa;;GAEX,aAAA,CAAA,OAAA;GACI,oBAAoB,CAAA,YAAa,YAAW;GAChD,aAAA,CAAA,6BAAA,oBAAA;GACF;EACE,gBAAgB;;;;;KAEhB;EACE,IAAC,WAAA;AACC,UAAM;IAAA,gBAAS,SAAA,EACb,SAAQ,6DACT,CAAC;IAAC,gBAAY,sBAAA;KACb,UAAM;KACN,MAAC;KACD,IAAC,WAAU;AACZ,aAAA,CAAA,gBAAA,SAAA;OACD,SAAS;OACN,IAAO,WAAO;AACT,eAAO,gBAAQ,qBAAA;SACb,IAAC,OAAU;AACT,iBAAK,eAAA;;SAEjB,cAAgB;SACP,CAAA;;OAER,CAAK,EAAC,gBAAiB,mBAAa;OACpC,MAAA;OACE,UAAa;OACX,MAAA;OACA,CAAC,CAAA;;KAEL,CAAC;IAAE,gBAAC,SAAA,EAAA,CAAA;IAAA,gBAAA,SAAA,EACH,SAAO,gEACR,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,gBAAW,gBAAA;UACvB,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,gBAAc;UACvE,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,wMAA0D;SAAA;;OAE1F,CAAC,EAAE,gBAAK,YAAA,EACP,IAAE,WAAS;AACX,cAAA,IAAA;sCACF,YAAA,QAAA,CAAA;;;;oCAI0B,YAAA,QAAA,CAAA;;SAGzB,CAAC,CAAA;;KAEL,CAAC;IAAC;;EAEN,CAAC"}
+{"version":3,"file":"bash-config-command.mjs","names":[],"sources":["../../src/components/bash-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 Bash Completions - Configuration command's handler wrapper for the Shell Shock project.\n */\nexport function BashConfigCompletionsCommand() {\n  const context = usePowerlines<CompletionsPluginContext>();\n\n  return (\n    <TypescriptFile\n      path={joinPaths(\n        context.entryPath,\n        \"completions\",\n        \"bash\",\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_DISPLAY\", \"SHELL_COMPLETIONS\"]\n      }}\n      builtinImports={{\n        \"shell-shock:console\": [\n          \"colors\",\n          \"writeLine\",\n          \"success\",\n          \"warn\",\n          \"help\"\n        ]\n      }}>\n      <TSDoc heading=\"Options for the Bash Completions - Configuration command.\" />\n      <InterfaceDeclaration export name=\"BashConfigCompletionsOptions\">\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 bash config\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"BashConfigCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"~/.bashrc\"`\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, \".bashrc\");`}\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          )} Bash Completions ###\\`);\n\n          success(\\`${getAppTitle(\n            context\n          )} shell completions have been applied to Bash 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(\"\");\n          writeLine(\\`### Begin - ${getAppTitle(context)} Bash Completions ###\\`);\n          writeLine(\"\");\n          SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n          writeLine(\"\");\n          writeLine(\\`### End - ${getAppTitle(context)} Bash Completions ###\\`);\n          writeLine(\"\");\n          writeLine(\" ------------------------------------------------- \");\n\n          writeLine(\"\");\n          help(\\`To enable these completions, perform one of the following actions:\n\n          1) Copy and paste the above script into your shell configuration file (e.g., ~/.bashrc)\n          2) Save the above script to a file and source it from your shell configuration file \\`); `}\n        </ElseClause>\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;AAiCA,SAAO,+BAAA;CACL,MAAK,UAAA,eAAA;AACL,QAAA,gBAAA,gBAAA;EACA,IAAM,OAAC;AACH,UAAG,UAAc,QAAO,WAAY,eAAY,QAAM,UAAA,aAAA;;EAE5D,SAAa;;GAEX,aAAA,CAAA,OAAA;GACI,oBAAoB,CAAA,YAAa,YAAW;GAChD,aAAA,CAAA,6BAAA,oBAAA;GACF;EACE,gBAAgB;;;;;;KAEhB;EACE,IAAC,WAAA;AACC,UAAM;IAAA,gBAAS,SAAA,EACb,SAAQ,6DACT,CAAC;IAAC,gBAAY,sBAAA;KACb,UAAM;KACN,MAAC;KACD,IAAC,WAAU;AACZ,aAAA,CAAA,gBAAA,SAAA;OACD,SAAS;OACN,IAAO,WAAO;AACT,eAAO,gBAAQ,qBAAA;SACb,IAAC,OAAU;AACT,iBAAK,eAAA;;SAEjB,cAAgB;SACP,CAAA;;OAEJ,CAAA,EAAA,gBAAU,mBAAA;OACV,MAAO;OACP,UAAK;OACL,MAAI;OACP,CAAA,CAAA;;KAED,CAAA;IAAA,gBAAe,SAAe,EAAC,CAAA;IAAI,gBAAe,SAAA,EAClD,SAAA,gEACA,CAAC;IAAC,gBAAe,qBAAqB;KACrC,UAAG;KACH,WAAU;KACV,OAAI;KACJ,MAAG;KACH,YAAO,CAAA;MACN,MAAA;MACD,MAAA;MACD,SAAS;MACT,EAAA;MACA,MAAA;MACC,MAAA;MACA,SAAA;MACA,CAAA;KACA,IAAI,WAAS;AACb,aAAA,CAAU,gBAAE,aAAA;OACV,WAAA,IAAA;OACE,IAAI,WAAW;AACf,eAAO;SAAA,gBAAA,gBAA6B;UACpC,OAAW;UACZ,MAAA;UACD,MAAA;UACM,aAAQ,IAAA;UACZ,CAAI;SAAE,gBAAQ,SAAA,EAAA,CAAA;SAAA,gBAAA,aAAA;UACd,WAAc,IAAA;UAChB,UAAA,IAAA;UACA,CAAA;SAAA,gBAAA,SAAA,EAAA,CAAA;SAAA,gBAAA,gBAAA;UACD,OAAY;UACV,MAAA;UACC,MAAA;UACI,aAAY,IAAA;UAChB,CAAI;SAAE,gBAAM,SAAA,EAAA,CAAA;SAAA,WAAA,IAAA;;;;;;;;;;;uEAWA,YAAA,QAAA,CAAA,oEAAA,YAAA,QAAA,CAAA;;sBAEb,YAAA,QAAA,CAAA,wMAAA;SAAA;;OAEA,CAAA,EAAA,gBAAS,YAAA,EACR,IAAA,WAAe;AACf,cAAO,IAAM;;oCAEW,YAAW,QAAI,CAAM;;;;kCAI7C,YAAA,QAAA,CAAA;;;;;;;;;SAUF,CAAA,CAAA;;KAEH,CAAC;IAAC;;EAEN,CAAC"}

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

@@ -31,7 +31,8 @@ function BashScriptCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -84,16 +85,25 @@ function BashScriptCompletionsCommand() {
 									name: "scriptPath",
 									type: "string",
 									initializer: _alloy_js_core.code` path.includes(".") ? \`\${path}.bash\` : path;`
-								}), (0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`await writeFile(scriptPath, \`# Bash script to add completions for ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)}\\n\\n\${SHELL_COMPLETIONS}\`);
+								}), (0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`
+          await writeFile(scriptPath, \`# Bash 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)} Bash completion script has been generated at \${colors.bold(scriptPath)}.\`);`)];
+          success(\`${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Bash 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("");
             writeLine(\`# Bash completion for ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)}\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.bashrc)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -30,7 +30,8 @@ function BashScriptCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -83,16 +84,25 @@ function BashScriptCompletionsCommand() {
 									name: "scriptPath",
 									type: "string",
 									initializer: code` path.includes(".") ? \`\${path}.bash\` : path;`
-								}), memo(() => code`await writeFile(scriptPath, \`# Bash script to add completions for ${getAppTitle(context)}\\n\\n\${SHELL_COMPLETIONS}\`);
+								}), memo(() => code`
+          await writeFile(scriptPath, \`# Bash script to add completions for ${getAppTitle(context)}\\n\\n\${SHELL_COMPLETIONS}\`);
 
-            success(\`${getAppTitle(context)} Bash completion script has been generated at \${colors.bold(scriptPath)}.\`);`)];
+          success(\`${getAppTitle(context)} Bash completion script has been generated at \${colors.bold(scriptPath)}.\`); `)];
 							}
 						}), createComponent(ElseClause, { get children() {
 							return code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`# Bash completion for ${getAppTitle(context)}\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.bashrc)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -1 +1 @@
-{"version":3,"file":"bash-script-command.mjs","names":[],"sources":["../../src/components/bash-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 Bash Completions - Script command's handler wrapper for the Shell Shock project.\n */\nexport function BashScriptCompletionsCommand() {\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        \"bash\",\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 Bash Completions - Script command.\" />\n      <InterfaceDeclaration export name=\"BashScriptCompletionsOptions\">\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 bash script\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"BashScriptCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"${bin.value}-completions.bash\"`\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}.bash\\` : path;`}\n          />\n          {code`await writeFile(scriptPath, \\`# Bash script to add completions for ${getAppTitle(context)}\\\\n\\\\n\\${SHELL_COMPLETIONS}\\`);\n\n            success(\\`${getAppTitle(\n              context\n            )} Bash completion script has been generated at \\${colors.bold(scriptPath)}.\\`);`}\n        </IfStatement>\n        <ElseClause>\n          {code`writeLine(\" ------------------------------------------------- \");\n            writeLine(\\`# Bash 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"}
+{"version":3,"file":"bash-script-command.mjs","names":[],"sources":["../../src/components/bash-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 Bash Completions - Script command's handler wrapper for the Shell Shock project.\n */\nexport function BashScriptCompletionsCommand() {\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        \"bash\",\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\": [\n          \"colors\",\n          \"writeLine\",\n          \"success\",\n          \"warn\",\n          \"help\"\n        ]\n      }}>\n      <TSDoc heading=\"Options for the Bash Completions - Script command.\" />\n      <InterfaceDeclaration export name=\"BashScriptCompletionsOptions\">\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 bash script\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"BashScriptCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"${bin.value}-completions.bash\"`\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}.bash\\` : path;`}\n          />\n          {code`\n          await writeFile(scriptPath, \\`# Bash script to add completions for ${getAppTitle(context)}\\\\n\\\\n\\${SHELL_COMPLETIONS}\\`);\n\n          success(\\`${getAppTitle(\n            context\n          )} Bash completion script has been generated at \\${colors.bold(scriptPath)}.\\`); `}\n        </IfStatement>\n        <ElseClause>\n          {code`writeLine(\" ------------------------------------------------- \");\n            writeLine(\"\");\n            writeLine(\\`# Bash completion for ${getAppTitle(context)}\\`);\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\"\");\n            writeLine(\" ------------------------------------------------- \");\n\n            writeLine(\"\");\n            help(\\`To enable these completions, perform one of the following actions:\n\n            1) Copy and paste the above script into your shell configuration file (e.g., ~/.bashrc)\n            2) Save the above script to a file and source it from your shell configuration file \\`); `}\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;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;;OAEK,CAAA,EAAA,gBAAO,mBAAA;OACP,MAAA;OACA,UAAQ;OACR,MAAK;OACL,CAAA,CAAA;;KAEJ,CAAC;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,SAAA,EACD,SAAM,gEACN,CAAA;IAAA,gBAAqB,qBAAa;KACjC,UAAO;KACP,WAAG;KACH,OAAI;KACJ,MAAI;KACJ,IAAG,aAAA;AACD,aAAK,CAAA;OACN,MAAA;OACD,MAAA;OACD,SAAS;OACT,EAAM;OACN,MAAA;OACC,MAAA;OACA,SAAA,IAAA,IAAA,MAAA;OACA,CAAA;;KAEA,IAAA,WAAY;AACV,aAAA,CAAA,gBAAA,aAAA;OACE,WAAO,IAAQ;OACf,IAAI,WAAG;AACP,eAAS,CAAC,gBAAE,gBAAA;SACb,SAAA;SACD,MAAA;SACM,MAAG;SACH,aAAU,IAAA;SACd,CAAA,EAAA,WAAiB,IAAM;+EACzB,YAAA,QAAA,CAAA;;sBAEW,YAAW,QAAK,CAAA,iFAA0B,CAAA;;OAEpD,CAAC,EAAA,gBAAA,YAAA,EACA,IAAI,WAAE;AACN,cAAM,IAAM;;gDAEb,YAAA,QAAA,CAAA;;;;;;;;;;;SAYA,CAAC,CAAA;;KAEL,CAAC;IAAC"}

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

@@ -30,7 +30,8 @@ function FishConfigCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -114,12 +115,20 @@ function FishConfigCompletionsCommand() {
 							}
 						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.ElseClause, { get children() {
 							return _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`### Begin - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Fish Completions ###\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
             writeLine("");
             writeLine(\`### End - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Fish Completions ###\`);
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/fish/config.fish)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -29,7 +29,8 @@ function FishConfigCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -113,12 +114,20 @@ function FishConfigCompletionsCommand() {
 							}
 						}), createComponent(ElseClause, { get children() {
 							return code`writeLine(" ------------------------------------------------- ");
+            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(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/fish/config.fish)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -1 +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"}
+{"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\": [\n          \"colors\",\n          \"writeLine\",\n          \"success\",\n          \"warn\",\n          \"help\"\n        ]\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(\"\");\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            writeLine(\" ------------------------------------------------- \");\n\n            writeLine(\"\");\n            help(\\`To enable these completions, perform one of the following actions:\n\n            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/fish/config.fish)\n            2) Save the above script to a file and source it from your shell configuration file \\`); `}\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;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,gBAAU,mBAAA;SACpB,IAAO,OAAA;AACP,iBAAU,eAAA;;SAEL,cAAA;SACD,CAAA;;OAEP,CAAA,EAAA,gBAAA,iBAAA;OACI,MAAC;OACN,UAAA;OACE,MAAM;OACJ,CAAA,CAAA;;KAEJ,CAAC;IAAE,gBAAgB,SAAK,EAAA,CAAA;IAAA,gBAAA,OAAA,EACvB,SAAG,gEACJ,CAAC;IAAE,gBAAK,qBAAA;KACP,UAAC;KACD,WAAA;KACD,OAAQ;KACR,MAAM;KACN,YAAA,CAAA;MACC,MAAA;MACA,MAAA;MACA,SAAA;MACA,EAAA;MACA,MAAA;MACE,MAAA;MACA,SAAS;MACV,CAAC;KACF,IAAI,WAAW;AACb,aAAC,CAAA,gBAAA,aAAA;OACD,WAAA,IAAA;OACE,IAAI,WAAQ;AACZ,eAAO;SAAA,gBAAO,gBAAA;UACd,OAAW;UACb,MAAA;UACA,MAAA;UACD,aAAY,IAAW;UACrB,CAAA;SAAA,gBAAA,SAAA,EAAA,CAAA;SAAA,gBAAA,aAAA;UACC,WAAA,IAAA;UACI,UAAE,IAAU;UAChB,CAAI;SAAE,gBAAM,SAAA,EAAA,CAAA;SAAA,gBAAA,gBAAA;UACZ,OAAW;UACZ,MAAA;UACA,MAAS;UACT,aAAY,IAAU;UACpB,CAAA;SAAK,gBAAkB,SAAG,EAAQ,CAAC;SAAE,WAAW,IAAA;;;;;;;;;;;uEAWL,YAAA,QAAA,CAAA,mEAAA,YAAA,QAAA,CAAA;;sBAElC,YAAY,QAAQ,CAAC,wMAAgE;SAAA;;OAEhG,CAAC,EAAE,gBAAO,YAAsB,EAC/B,IAAE,WAAK;AACL,cAAO,IAAE;;sCAEb,YAAA,QAAA,CAAA;;;;oCAI0B,YAAA,QAAA,CAAA;;;;;;;;;SAUzB,CAAC,CAAA;;KAEL,CAAC;IAAC;;EAEN,CAAC"}

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

@@ -31,7 +31,8 @@ function FishScriptCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -90,10 +91,18 @@ function FishScriptCompletionsCommand() {
 							}
 						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.ElseClause, { get children() {
 							return _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`# Fish completion for ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)}\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/fish/config.fish)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -30,7 +30,8 @@ function FishScriptCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -89,10 +90,18 @@ function FishScriptCompletionsCommand() {
 							}
 						}), createComponent(ElseClause, { get children() {
 							return code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`# Fish completion for ${getAppTitle(context)}\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/fish/config.fish)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -1 +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"}
+{"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\": [\n          \"colors\",\n          \"writeLine\",\n          \"success\",\n          \"warn\",\n          \"help\"\n        ]\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(\"\");\n            writeLine(\\`# Fish completion for ${getAppTitle(context)}\\`);\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\"\");\n            writeLine(\" ------------------------------------------------- \");\n\n            writeLine(\"\");\n            help(\\`To enable these completions, perform one of the following actions:\n\n            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/fish/config.fish)\n            2) Save the above script to a file and source it from your shell configuration file \\`); `}\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;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;;OAEK,CAAA,EAAA,gBAAO,mBAAA;OACP,MAAA;OACA,UAAQ;OACR,MAAK;OACL,CAAA,CAAA;;KAEJ,CAAC;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,SAAA,EACD,SAAM,gEACN,CAAA;IAAA,gBAAqB,qBAAa;KACjC,UAAO;KACP,WAAG;KACH,OAAI;KACJ,MAAI;KACJ,IAAG,aAAA;AACD,aAAK,CAAA;OACN,MAAA;OACD,MAAA;OACD,SAAS;OACT,EAAM;OACN,MAAA;OACC,MAAA;OACA,SAAA,IAAA,IAAA,MAAA;OACA,CAAA;;KAEA,IAAA,WAAY;AACV,aAAA,CAAA,gBAAA,aAAA;OACE,WAAO,IAAQ;OACf,IAAI,WAAG;AACP,eAAS,CAAC,gBAAE,gBAAA;SACb,SAAA;SACD,MAAA;SACM,MAAG;SACH,aAAU,IAAA;SACd,CAAA,EAAA,WAAiB,IAAM,sEAAkB,YAAA,QAAA,CAAA;;wBAE3C,YAAA,QAAA,CAAA,gFAAA,CAAA;;OAEC,CAAA,EAAA,gBAAA,YAAA,EACC,IAAA,WAAA;AACA,cAAM,IAAA;;gDAE8B,YAAS,QAAW,CAAC;;;;;;;;;;;SAY1D,CAAC,CAAA;;KAEL,CAAC;IAAC"}

package/dist/components/powershell-config-command.cjs

@@ -26,7 +26,8 @@ function PowerShellConfigCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -110,12 +111,20 @@ function PowerShellConfigCompletionsCommand() {
 							}
 						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.ElseClause, { get children() {
 							return _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`### Begin - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} PowerShell Completions ###\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
             writeLine("");
             writeLine(\`### End - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} PowerShell Completions ###\`);
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/powershell/Microsoft.PowerShell_profile.ps1)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -25,7 +25,8 @@ function PowerShellConfigCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -109,12 +110,20 @@ function PowerShellConfigCompletionsCommand() {
 							}
 						}), createComponent(ElseClause, { get children() {
 							return code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`### Begin - ${getAppTitle(context)} PowerShell Completions ###\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
             writeLine("");
             writeLine(\`### End - ${getAppTitle(context)} PowerShell Completions ###\`);
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/powershell/Microsoft.PowerShell_profile.ps1)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -1 +1 @@
-{"version":3,"file":"powershell-config-command.mjs","names":[],"sources":["../../src/components/powershell-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 {\n  TSDoc,\n  TSDocDefaultValue,\n  TypescriptFile\n} from \"@powerlines/plugin-alloy/typescript\";\nimport { getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport type { CompletionsPluginContext } from \"../types\";\n\nexport function PowerShellConfigCompletionsCommand() {\n  const context = usePowerlines<CompletionsPluginContext>();\n\n  return (\n    <TypescriptFile\n      path={joinPaths(\n        context.entryPath,\n        \"completions\",\n        \"powershell\",\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 PowerShell Completions - Configuration command.\" />\n      <InterfaceDeclaration export name=\"PowerShellConfigCompletionsOptions\">\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 powershell config\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"PowerShellConfigCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"~/.config/powershell/Microsoft.PowerShell_profile.ps1\"`\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, \"Microsoft.PowerShell_profile.ps1\");`}\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)} PowerShell Completions ###\\\\n\\\\n\\${SHELL_COMPLETIONS} \\\\n\\\\n### End - ${getAppTitle(\n            context\n          )} PowerShell Completions ###\\`);\n\n          success(\\`${getAppTitle(\n            context\n          )} shell completions have been applied to PowerShell 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)} PowerShell Completions ###\\`);\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\"\");\n            writeLine(\\`### End - ${getAppTitle(context)} PowerShell Completions ###\\`);\n            writeLine(\" ------------------------------------------------- \");`}\n        </ElseClause>\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;AA4BA,SAAgB,qCAAkC;CAClD,MAAQ,UAAC,eAA+C;AACxD,QAAO,gBAAA,gBAAA;EACL,IAAK,OAAA;AACL,UAAA,UAAiB,QAAA,WAAA,eAAA,cAAA,UAAA,aAAA;;EAEjB,SAAO;GACH,WAAG;GACH,aAAa,CAAC,OAAO;GACrB,oBAAQ,CAAA,YAAyB,YAAW;;GAElD;EACE,gBAAgB;;;;;KAEhB;EACE,IAAC,WAAA;AACC,UAAM;IAAA,gBAAS,OAAA,EACb,SAAQ,mEACT,CAAC;IAAC,gBAAY,sBAAA;KACb,UAAC;KACD,MAAC;KACD,IAAC,WAAU;AACZ,aAAA,CAAA,gBAAA,OAAA;OACD,SAAS;OACN,IAAO,WAAO;AACT,eAAO,gBAAQ,mBAAA;SACb,IAAC,OAAU;AACT,iBAAK,eAAiB;;SAElC,cAAgB;SACP,CAAA;;OAER,CAAK,EAAC,gBAAiB,iBAAmB;OAC1C,MAAA;OACE,UAAa;OACX,MAAA;OACA,CAAC,CAAA;;KAEL,CAAC;IAAE,gBAAC,SAAA,EAAA,CAAA;IAAA,gBAAA,OAAA,EACH,SAAO,sEACR,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,gBAAW,gBAAqB;UAC5C,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,yEAAA,YAAA,QAAA,CAAA;;sBAEN,YAAc,QAAQ,CAAC,8MAA0D;SAAA;;OAE1F,CAAC,EAAE,gBAAK,YAAA,EACP,IAAE,WAAS;AACX,cAAA,IAAA;sCACF,YAAA,QAAA,CAAA;;;;oCAI0B,YAAM,QAAA,CAAA;;SAG/B,CAAC,CAAA;;KAEL,CAAC;IAAC;;EAEN,CAAC"}
+{"version":3,"file":"powershell-config-command.mjs","names":[],"sources":["../../src/components/powershell-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 {\n  TSDoc,\n  TSDocDefaultValue,\n  TypescriptFile\n} from \"@powerlines/plugin-alloy/typescript\";\nimport { getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport type { CompletionsPluginContext } from \"../types\";\n\nexport function PowerShellConfigCompletionsCommand() {\n  const context = usePowerlines<CompletionsPluginContext>();\n\n  return (\n    <TypescriptFile\n      path={joinPaths(\n        context.entryPath,\n        \"completions\",\n        \"powershell\",\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\": [\n          \"colors\",\n          \"writeLine\",\n          \"success\",\n          \"warn\",\n          \"help\"\n        ]\n      }}>\n      <TSDoc heading=\"Options for the PowerShell Completions - Configuration command.\" />\n      <InterfaceDeclaration export name=\"PowerShellConfigCompletionsOptions\">\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 powershell config\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"PowerShellConfigCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"~/.config/powershell/Microsoft.PowerShell_profile.ps1\"`\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, \"Microsoft.PowerShell_profile.ps1\");`}\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)} PowerShell Completions ###\\\\n\\\\n\\${SHELL_COMPLETIONS} \\\\n\\\\n### End - ${getAppTitle(\n            context\n          )} PowerShell Completions ###\\`);\n\n          success(\\`${getAppTitle(\n            context\n          )} shell completions have been applied to PowerShell 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(\"\");\n            writeLine(\\`### Begin - ${getAppTitle(context)} PowerShell Completions ###\\`);\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\"\");\n            writeLine(\\`### End - ${getAppTitle(context)} PowerShell Completions ###\\`);\n            writeLine(\"\");\n            writeLine(\" ------------------------------------------------- \");\n\n            writeLine(\"\");\n            help(\\`To enable these completions, perform one of the following actions:\n\n            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/powershell/Microsoft.PowerShell_profile.ps1)\n            2) Save the above script to a file and source it from your shell configuration file \\`); `}\n        </ElseClause>\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;AA4BA,SAAgB,qCAAkC;CAClD,MAAQ,UAAC,eAA+C;AACxD,QAAO,gBAAA,gBAAA;EACL,IAAK,OAAA;AACL,UAAA,UAAiB,QAAA,WAAA,eAAA,cAAA,UAAA,aAAA;;EAEjB,SAAO;GACH,WAAG;GACH,aAAa,CAAC,OAAO;GACrB,oBAAQ,CAAA,YAAyB,YAAW;;GAElD;EACE,gBAAgB;;;;;;KAEhB;EACE,IAAC,WAAA;AACC,UAAM;IAAA,gBAAS,OAAA,EACb,SAAQ,mEACT,CAAC;IAAC,gBAAY,sBAAA;KACb,UAAC;KACD,MAAC;KACD,IAAC,WAAU;AACZ,aAAA,CAAA,gBAAA,OAAA;OACD,SAAS;OACN,IAAO,WAAO;AACT,eAAO,gBAAQ,mBAAA;SACb,IAAC,OAAU;AACT,iBAAK,eAAiB;;SAElC,cAAgB;SACP,CAAA;;OAEJ,CAAA,EAAA,gBAAU,iBAAA;OACV,MAAO;OACP,UAAK;OACL,MAAI;OACP,CAAA,CAAA;;KAED,CAAA;IAAA,gBAAe,SAAe,EAAC,CAAA;IAAA,gBAAsB,OAAG,EACxD,SAAA,sEACA,CAAC;IAAC,gBAAe,qBAAqB;KACrC,UAAG;KACH,WAAU;KACV,OAAI;KACJ,MAAG;KACH,YAAO,CAAA;MACN,MAAA;MACD,MAAA;MACD,SAAS;MACT,EAAA;MACA,MAAA;MACC,MAAA;MACA,SAAA;MACA,CAAA;KACA,IAAI,WAAS;AACb,aAAA,CAAU,gBAAE,aAAA;OACV,WAAA,IAAA;OACE,IAAI,WAAW;AACf,eAAO;SAAA,gBAAA,gBAAmC;UAC1C,OAAW;UACZ,MAAA;UACD,MAAA;UACM,aAAQ,IAAA;UACZ,CAAI;SAAE,gBAAQ,SAAA,EAAA,CAAA;SAAA,gBAAA,aAAA;UACd,WAAc,IAAA;UAChB,UAAA,IAAA;UACA,CAAA;SAAA,gBAAA,SAAA,EAAA,CAAA;SAAA,gBAAA,gBAAA;UACD,OAAY;UACV,MAAA;UACC,MAAA;UACI,aAAY,IAAA;UAChB,CAAI;SAAE,gBAAM,SAAA,EAAA,CAAA;SAAA,WAAA,IAAA;;;;;;;;;;;uEAWA,YAAA,QAAA,CAAA,yEAAA,YAAA,QAAA,CAAA;;sBAEb,YAAA,QAAA,CAAA,8MAAA;SAAA;;OAEA,CAAA,EAAA,gBAAS,YAAA,EACR,IAAA,WAAe;AACf,cAAO,IAAM;;sCAEY,YAAa,QAAQ,CAAA;;;;oCAI9C,YAAA,QAAA,CAAA;;;;;;;;;SAUF,CAAA,CAAA;;KAEH,CAAC;IAAC;;EAEN,CAAC"}

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

@@ -31,7 +31,8 @@ function PowerShellScriptCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -90,10 +91,18 @@ function PowerShellScriptCompletionsCommand() {
 							}
 						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.ElseClause, { get children() {
 							return _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`# PowerShell completions for ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)}\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/powershell/Microsoft.PowerShell_profile.ps1)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -30,7 +30,8 @@ function PowerShellScriptCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -89,10 +90,18 @@ function PowerShellScriptCompletionsCommand() {
 							}
 						}), createComponent(ElseClause, { get children() {
 							return code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`# PowerShell completions for ${getAppTitle(context)}\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/powershell/Microsoft.PowerShell_profile.ps1)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -1 +1 @@
-{"version":3,"file":"powershell-script-command.mjs","names":[],"sources":["../../src/components/powershell-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 PowerShell Completions - Script command's handler wrapper for the Shell Shock project.\n */\nexport function PowerShellScriptCompletionsCommand() {\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        \"powershell\",\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 PowerShell Completions - Script command.\" />\n      <InterfaceDeclaration export name=\"PowerShellScriptCompletionsOptions\">\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 powershell script\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"PowerShellScriptCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"${bin.value}-completions.ps1\"`\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}.ps1\\` : path;`}\n          />\n          {code`await writeFile(scriptPath, \\`# PowerShell script to add completions for ${getAppTitle(context)}\\\\n\\\\n\\${SHELL_COMPLETIONS}\\`);\n\n            success(\\`${getAppTitle(\n              context\n            )} PowerShell completion script has been generated at \\${colors.bold(scriptPath)}.\\`);`}\n        </IfStatement>\n        <ElseClause>\n          {code`writeLine(\" ------------------------------------------------- \");\n            writeLine(\\`# PowerShell completions 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,qCAAA;CACL,MAAK,UAAA,eAAA;CACL,MAAA,MAAA,eAAA,UAAA,QAAA,CAAA;AACA,QAAO,gBAAkB,gBAAgB;EAC3C,IAAQ,OAAC;AACH,UAAG,UAAY,QAAO,WAAY,eAAA,cAAA,UAAA,aAAA;;;GAGtC,WAAA;GACI,aAAY,CAAA,OAAA;GAChB,oBAAA,CAAA,YAAA,YAAA;GACI,aAAU,CAAA,qBAAA,4BAAqC;GACnD;oBAEA,uBAA2B;GAAA;GAAU;GAAS;GAAA;GAAA;EAE9C,IAAM,WAAC;AACJ,UAAA;IAAA,gBAAA,SAAA,EACC,SAAM,4DACL,CAAC;IAAA,gBAAiB,sBAAA;KACjB,UAAC;KACD,MAAC;KACD,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,sEACJ,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,4EAAA,YAAA,QAAA,CAAA;;wBAEJ,YAAY,QAAQ,CAAC,sFAAgC,CAAA;;OAElE,CAAA,EAAA,gBAAqB,YAAY;AAEhC,cAAS,IAAG;uDACV,YAAA,QAAA,CAAA;;;;SAKH,CAAC,CAAA;;KAEL,CAAC;IAAC;;EAEN,CAAC"}
+{"version":3,"file":"powershell-script-command.mjs","names":[],"sources":["../../src/components/powershell-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 PowerShell Completions - Script command's handler wrapper for the Shell Shock project.\n */\nexport function PowerShellScriptCompletionsCommand() {\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        \"powershell\",\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\": [\n          \"colors\",\n          \"writeLine\",\n          \"success\",\n          \"warn\",\n          \"help\"\n        ]\n      }}>\n      <TSDoc heading=\"Options for the PowerShell Completions - Script command.\" />\n      <InterfaceDeclaration export name=\"PowerShellScriptCompletionsOptions\">\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 powershell script\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[\n          {\n            name: \"options\",\n            type: \"PowerShellScriptCompletionsOptions\",\n            default: \"{}\"\n          },\n          {\n            name: \"path\",\n            type: \"string\",\n            default: `\"${bin.value}-completions.ps1\"`\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}.ps1\\` : path;`}\n          />\n          {code`await writeFile(scriptPath, \\`# PowerShell script to add completions for ${getAppTitle(context)}\\\\n\\\\n\\${SHELL_COMPLETIONS}\\`);\n\n            success(\\`${getAppTitle(\n              context\n            )} PowerShell completion script has been generated at \\${colors.bold(scriptPath)}.\\`);`}\n        </IfStatement>\n        <ElseClause>\n          {code`writeLine(\" ------------------------------------------------- \");\n            writeLine(\"\");\n            writeLine(\\`# PowerShell completions for ${getAppTitle(context)}\\`);\n            writeLine(\"\");\n            SHELL_COMPLETIONS_DISPLAY.split(\"\\\\n\").map(line => writeLine(line));\n            writeLine(\"\");\n            writeLine(\" ------------------------------------------------- \");\n\n            writeLine(\"\");\n            help(\\`To enable these completions, perform one of the following actions:\n\n            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/powershell/Microsoft.PowerShell_profile.ps1)\n            2) Save the above script to a file and source it from your shell configuration file \\`); `}\n        </ElseClause>\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;AAiCA,SAAO,qCAAA;CACL,MAAK,UAAA,eAAA;CACL,MAAA,MAAA,eAAA,UAAA,QAAA,CAAA;AACA,QAAO,gBAAkB,gBAAgB;EAC3C,IAAQ,OAAC;AACH,UAAG,UAAY,QAAO,WAAY,eAAA,cAAA,UAAA,aAAA;;;GAGtC,WAAA;GACI,aAAY,CAAA,OAAA;GAChB,oBAAA,CAAA,YAAA,YAAA;GACI,aAAU,CAAA,qBAAA,4BAAqC;GACnD;oBAEA,uBAA2B;GAAA;GAAU;GAAS;GAAA;GAAA;GAAA;EAE9C,IAAM,WAAC;AACJ,UAAA;IAAA,gBAAA,SAAA,EACC,SAAM,4DACL,CAAC;IAAA,gBAAiB,sBAAA;KACjB,UAAC;KACD,MAAC;KACD,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;;OAEK,CAAA,EAAA,gBAAO,mBAAA;OACP,MAAA;OACA,UAAQ;OACR,MAAK;OACL,CAAA,CAAA;;KAEJ,CAAC;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,SAAA,EACD,SAAM,sEACN,CAAA;IAAA,gBAAqB,qBAAa;KACjC,UAAO;KACP,WAAG;KACH,OAAI;KACJ,MAAI;KACJ,IAAG,aAAA;AACD,aAAK,CAAA;OACN,MAAA;OACD,MAAA;OACD,SAAS;OACT,EAAM;OACN,MAAA;OACC,MAAA;OACA,SAAA,IAAA,IAAA,MAAA;OACA,CAAA;;KAEA,IAAA,WAAY;AACV,aAAA,CAAA,gBAAA,aAAA;OACE,WAAO,IAAQ;OACf,IAAI,WAAG;AACP,eAAS,CAAC,gBAAE,gBAAA;SACb,SAAA;SACD,MAAA;SACM,MAAG;SACH,aAAU,IAAA;SACd,CAAA,EAAA,WAAiB,IAAM,4EAAiB,YAAA,QAAA,CAAA;;wBAE1C,YAAA,QAAA,CAAA,sFAAA,CAAA;;OAEC,CAAA,EAAA,gBAAA,YAAA,EACC,IAAA,WAAA;AACA,cAAM,IAAA;;uDAEqC,YAAY,QAAQ,CAAC;;;;;;;;;;;SAYjE,CAAC,CAAA;;KAEL,CAAC;IAAC"}

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

@@ -30,7 +30,8 @@ function ZshConfigCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -114,12 +115,20 @@ function ZshConfigCompletionsCommand() {
 							}
 						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.ElseClause, { get children() {
 							return _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
+            writeLine("");
             writeLine(\`### Begin - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Zsh Completions ###\`);
             writeLine("");
             SHELL_COMPLETIONS_DISPLAY.split("\\n").map(line => writeLine(line));
             writeLine("");
             writeLine(\`### End - ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context)} Zsh Completions ###\`);
-            writeLine(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/zsh/.zshrc)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -29,7 +29,8 @@ function ZshConfigCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -113,12 +114,20 @@ function ZshConfigCompletionsCommand() {
 							}
 						}), createComponent(ElseClause, { get children() {
 							return code`writeLine(" ------------------------------------------------- ");
+            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(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/zsh/.zshrc)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -1 +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"}
+{"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\": [\n          \"colors\",\n          \"writeLine\",\n          \"success\",\n          \"warn\",\n          \"help\"\n        ]\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(\"\");\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            writeLine(\" ------------------------------------------------- \");\n\n            writeLine(\"\");\n            help(\\`To enable these completions, perform one of the following actions:\n\n            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/zsh/.zshrc)\n            2) Save the above script to a file and source it from your shell configuration file \\`); `}\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;;OAEJ,CAAA,EAAA,gBAAU,mBAAA;OACV,MAAO;OACP,UAAK;OACL,MAAI;OACP,CAAA,CAAA;;KAED,CAAA;IAAA,gBAAe,SAAe,EAAC,CAAA;IAAI,gBAAc,SAAA,EACjD,SAAA,+DACA,CAAC;IAAC,gBAAe,qBAAqB;KACrC,UAAG;KACH,WAAU;KACV,OAAI;KACJ,MAAG;KACH,YAAO,CAAA;MACN,MAAA;MACD,MAAA;MACD,SAAS;MACT,EAAA;MACA,MAAA;MACC,MAAA;MACA,SAAA;MACA,CAAA;KACA,IAAI,WAAS;AACb,aAAA,CAAU,gBAAE,aAAA;OACV,WAAA,IAAA;OACE,IAAI,WAAW;AACf,eAAO;SAAA,gBAAA,gBAA4B;UACnC,OAAW;UACZ,MAAA;UACD,MAAA;UACM,aAAQ,IAAA;UACZ,CAAI;SAAE,gBAAQ,SAAA,EAAA,CAAA;SAAA,gBAAA,aAAA;UACd,WAAc,IAAK;UACrB,UAAA,IAAA;UACA,CAAA;SAAA,gBAAA,SAAA,EAAA,CAAA;SAAA,gBAAA,gBAAA;UACD,OAAY;UACV,MAAA;UACC,MAAA;UACI,aAAY,IAAA;UAChB,CAAI;SAAE,gBAAM,SAAA,EAAA,CAAA;SAAA,WAAA,IAAA;;;;;;;;;;;uEAWA,YAAA,QAAA,CAAA,oEAAA,YAAA,QAAA,CAAA;;sBAEb,YAAA,QAAA,CAAA,uMAAA;SAAA;;OAEA,CAAA,EAAA,gBAAS,YAAA,EACR,IAAA,WAAe;AACf,cAAO,IAAM;;sCAEY,YAAa,QAAQ,CAAA;;;;oCAI9C,YAAA,QAAA,CAAA;;;;;;;;;SAUF,CAAA,CAAA;;KAEH,CAAC;IAAC;;EAEN,CAAC"}

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

@@ -33,7 +33,8 @@ function ZshScriptCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -92,13 +93,21 @@ function ZshScriptCompletionsCommand() {
 							}
 						}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.ElseClause, { get children() {
 							return _alloy_js_core.code`writeLine(" ------------------------------------------------- ");
+            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(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/zsh/.zshrc)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -32,7 +32,8 @@ function ZshScriptCompletionsCommand() {
 			"colors",
 			"writeLine",
 			"success",
-			"warn"
+			"warn",
+			"help"
 		] },
 		get children() {
 			return [
@@ -91,13 +92,21 @@ function ZshScriptCompletionsCommand() {
 							}
 						}), createComponent(ElseClause, { get children() {
 							return code`writeLine(" ------------------------------------------------- ");
+            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(" ------------------------------------------------- ");`;
+            writeLine("");
+            writeLine(" ------------------------------------------------- ");
+
+            writeLine("");
+            help(\`To enable these completions, perform one of the following actions:
+
+            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/zsh/.zshrc)
+            2) Save the above script to a file and source it from your shell configuration file \`); `;
 						} })];
 					}
 				})

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

@@ -1 +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"}
+{"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\": [\n          \"colors\",\n          \"writeLine\",\n          \"success\",\n          \"warn\",\n          \"help\"\n        ]\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(\"\");\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            writeLine(\" ------------------------------------------------- \");\n\n            writeLine(\"\");\n            help(\\`To enable these completions, perform one of the following actions:\n\n            1) Copy and paste the above script into your shell configuration file (e.g., ~/.config/zsh/.zshrc)\n            2) Save the above script to a file and source it from your shell configuration file \\`); `}\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;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;;OAEK,CAAA,EAAA,gBAAO,mBAAA;OACP,MAAA;OACA,UAAQ;OACR,MAAK;OACL,CAAA,CAAA;;KAEJ,CAAC;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,SAAA,EACD,SAAM,+DACN,CAAA;IAAA,gBAAqB,qBAAa;KACjC,UAAO;KACP,WAAG;KACH,OAAI;KACJ,MAAI;KACJ,IAAG,aAAA;AACD,aAAK,CAAA;OACN,MAAA;OACD,MAAA;OACD,SAAS;OACT,EAAM;OACN,MAAA;OACC,MAAA;OACA,SAAA,IAAA,IAAA,MAAA;OACA,CAAA;;KAEA,IAAA,WAAY;AACV,aAAA,CAAA,gBAAA,aAAA;OACE,WAAO,IAAQ;OACf,IAAI,WAAG;AACP,eAAS,CAAC,gBAAE,gBAAA;SACb,SAAA;SACD,MAAA;SACM,MAAG;SACH,aAAU,IAAA;SACd,CAAA,EAAA,WAAiB,IAAM,qEAAiB,YAAA,QAAA,CAAA;;wBAE1C,YAAA,QAAA,CAAA,+EAAA,CAAA;;OAEC,CAAA,EAAA,gBAAA,YAAA,EACC,IAAA,WAAA;AACA,cAAM,IAAA;;kCAEa,IAAK,MAAQ;mCACjC,KAAA,MAAA,GAAA,IAAA,MAAA;;;;;;;;;;;;;SAcA,CAAC,CAAA;;KAEL,CAAC;IAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shell-shock/plugin-completions",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "type": "module",
   "description": "A package containing a Shell Shock plugin to generate source code given a list design tokens.",
   "repository": {
@@ -338,7 +338,7 @@
     "@powerlines/deepkit": "^0.6.163",
     "@powerlines/plugin-alloy": "^0.26.0",
     "@powerlines/plugin-plugin": "^0.12.335",
-    "@shell-shock/core": "^0.14.4",
+    "@shell-shock/core": "^0.14.5",
     "@stryke/path": "^0.27.3",
     "@stryke/string-format": "^0.17.7",
     "powerlines": "^0.42.25"
@@ -362,5 +362,5 @@
       "./package.json": "./package.json"
     }
   },
-  "gitHead": "f6c65cf00def6dda8f7cba780d815be265855b43"
+  "gitHead": "7c942f2fc1b4f65700076cd29604ce47025cd584"
 }