@magentrix-corp/magentrix-cli 1.3.16 → 1.3.17

package/actions/help.js

@@ -1,165 +1,165 @@
-import chalk from "chalk";
-import { ensureValidCredentials } from "../utils/cli/helpers/ensureCredentials.js";
-
-/* ─────────────────────────────
-   🎨  COLOR & STYLE SHORTCUTS
-   ───────────────────────────── */
-const style = {
-    header: chalk.bold.magenta,
-    section: chalk.underline.bold,
-    label: chalk.gray,
-    command: chalk.cyan,
-    highlight: chalk.yellow,
-    bullet: chalk.green("●"),
-    dim: chalk.dim,
-};
-
-/* ─────────────────────────────
-   📋  DATA SOURCES
-   ───────────────────────────── */
-
-/** All CLI commands with their one-line descriptions.  */
-const COMMANDS = [
-    { command: "magentrix", description: "Show current environment and status" },
-    { command: "magentrix setup", description: "Configure / update URL & API key" },
-    { command: "magentrix pull", description: "Fetch all code into this folder" },
-    { command: "magentrix lint", description: "Check for stale files or conflicts" },
-    { command: "magentrix autopublish", description: "Automatically push local file changes safely to Magentrix" },
-    { command: "magentrix status", description: "Show local vs remote differences" },
-    { command: "magentrix create", description: "Interactive wizard for new files" },
-    { command: "magentrix --help", description: "Show this comprehensive help guide" },
-];
-
-/** Key folders that appear after a successful `magentrix pull`. */
-const FOLDERS = [
-    { path: "src/pages", note: "Active Pages (.aspx)" },
-    { path: "src/controllers", note: "Controller_*.cls files" },
-    { path: "src/classes", note: "Utility / helper .cls files" },
-    { path: "src/triggers", note: "Trigger_*.cls files" },
-    { path: ".magentrix/index.json", note: "Mapping & metadata" },
-];
-
-/* ─────────────────────────────
-   🖨️  PRINT HELPERS
-   ───────────────────────────── */
-
-/**
- * Renders the comprehensive help header with current environment info.
- *
- * @param {string} maskedKey  – API key with only last 4 chars visible.
- * @param {string} hostname   – Magentrix instance hostname.
- */
-const printHelpHeader = (maskedKey, hostname) => {
-    console.log(style.header("\n📚  Magentrix CLI - Help & Usage Guide"));
-    console.log(style.dim("─────────────────────────────────────────────"));
-    console.log(
-        `${style.label("API Key:")} ${style.highlight(maskedKey)}    ` +
-        `${style.label("Environment:")} ${style.highlight(hostname)}\n`,
-    );
-};
-
-/** Prints a comprehensive description of what this tool does. */
-const printDescription = () => {
-    console.log(
-        style.section("What is Magentrix CLI?"),
-        "\n" +
-        chalk.cyanBright(
-            "Sync Active Pages & Classes between Magentrix and your editor—",
-        ) +
-        "edit locally, lint, then publish back safely.\n" +
-        style.dim("No built-in Git hooks—manage Git however you like.\n"),
-    );
-};
-
-/** Prints the 5-step recommended workflow. */
-const printWorkflow = () => {
-    console.log(style.section("Typical Workflow:"));
-    const STEPS = [
-        { label: "Setup", cmd: "magentrix setup", detail: "Enter URL & API key (one-time)" },
-        { label: "Pull", cmd: "magentrix pull", detail: "Fetch code locally" },
-        { label: "Edit", cmd: "—", detail: "Use any code editor" },
-        { label: "Lint", cmd: "magentrix lint", detail: "Check for conflicts" },
-        { label: "Publish", cmd: "magentrix publish", detail: "Push changes safely" },
-    ];
-    STEPS.forEach(({ label, cmd, detail }) => {
-        console.log(
-            `  ${style.bullet} ${label.padEnd(7)}  ${style.command(cmd.padEnd(20))} ${style.dim(detail)}`,
-        );
-    });
-    console.log(); // blank line
-};
-
-/** Prints the local folder overview in an uncluttered list. */
-const printFolders = () => {
-    console.log(style.section("Local Folder Structure:"));
-    FOLDERS.forEach(({ path, note }) => {
-        console.log(`  ${style.command(path.padEnd(22))} ${style.dim(note)}`);
-    });
-    console.log();
-};
-
-/** Prints the full command table. */
-const printCommands = () => {
-    console.log(style.section("Available Commands:"));
-    COMMANDS.forEach(({ command, description }) => {
-        console.log(`  ${style.command(command.padEnd(22))} ${description}`);
-    });
-    console.log();
-};
-
-/** Prints quick best-practice reminders. */
-const printTips = () => {
-    console.log(style.section("Best Practices:"));
-    [
-        "Always pull before editing.",
-        "Lint before publishing.",
-        "Optional: enable auto-publish on save during setup.",
-        "Magentrix is the source of truth; Git lives beside it.",
-    ].forEach(tip => console.log(`  ${style.bullet} ${tip}`));
-    console.log();
-};
-
-/** Prints additional resources and support info. */
-const printFooter = () => {
-    console.log(
-        style.dim("Need more details? See the project README or documentation.\n"),
-    );
-};
-
-/* ─────────────────────────────
-   🚀  HELP ENTRY POINT
-   ───────────────────────────── */
-
-/**
- * Magentrix CLI comprehensive help display.
- *
- * 1. Ensure credentials are configured (to show current environment).
- * 2. Display detailed usage guide, commands, workflow, and best practices.
- *
- * @async
- * @returns {Promise<void>}
- */
-export const showHelp = async () => {
-    const { apiKey, instanceUrl } = await ensureValidCredentials();
-
-    /* Mask the key except last 4 chars */
-    const maskedKey = `****${apiKey.slice(-4)}`;
-
-    /* Extract hostname from URL—for display only */
-    const hostname = (() => {
-        try {
-            return new URL(instanceUrl).hostname;
-        } catch {
-            return instanceUrl.replace(/^https?:\/\//, "").split("/")[0];
-        }
-    })();
-
-    /* Render comprehensive help sections */
-    printHelpHeader(maskedKey, hostname);
-    printDescription();
-    printWorkflow();
-    printFolders();
-    printCommands();
-    printTips();
-    printFooter();
+import chalk from "chalk";
+import { ensureValidCredentials } from "../utils/cli/helpers/ensureCredentials.js";
+
+/* ─────────────────────────────
+   🎨  COLOR & STYLE SHORTCUTS
+   ───────────────────────────── */
+const style = {
+    header: chalk.bold.magenta,
+    section: chalk.underline.bold,
+    label: chalk.gray,
+    command: chalk.cyan,
+    highlight: chalk.yellow,
+    bullet: chalk.green("●"),
+    dim: chalk.dim,
+};
+
+/* ─────────────────────────────
+   📋  DATA SOURCES
+   ───────────────────────────── */
+
+/** All CLI commands with their one-line descriptions.  */
+const COMMANDS = [
+    { command: "magentrix", description: "Show current environment and status" },
+    { command: "magentrix setup", description: "Configure / update URL & API key" },
+    { command: "magentrix pull", description: "Fetch all code into this folder" },
+    { command: "magentrix lint", description: "Check for stale files or conflicts" },
+    { command: "magentrix autopublish", description: "Automatically push local file changes safely to Magentrix" },
+    { command: "magentrix status", description: "Show local vs remote differences" },
+    { command: "magentrix create", description: "Interactive wizard for new files" },
+    { command: "magentrix --help", description: "Show this comprehensive help guide" },
+];
+
+/** Key folders that appear after a successful `magentrix pull`. */
+const FOLDERS = [
+    { path: "src/pages", note: "Active Pages (.aspx)" },
+    { path: "src/controllers", note: "Controller_*.cls files" },
+    { path: "src/classes", note: "Utility / helper .cls files" },
+    { path: "src/triggers", note: "Trigger_*.cls files" },
+    { path: ".magentrix/index.json", note: "Mapping & metadata" },
+];
+
+/* ─────────────────────────────
+   🖨️  PRINT HELPERS
+   ───────────────────────────── */
+
+/**
+ * Renders the comprehensive help header with current environment info.
+ *
+ * @param {string} maskedKey  – API key with only last 4 chars visible.
+ * @param {string} hostname   – Magentrix instance hostname.
+ */
+const printHelpHeader = (maskedKey, hostname) => {
+    console.log(style.header("\n📚  Magentrix CLI - Help & Usage Guide"));
+    console.log(style.dim("─────────────────────────────────────────────"));
+    console.log(
+        `${style.label("API Key:")} ${style.highlight(maskedKey)}    ` +
+        `${style.label("Environment:")} ${style.highlight(hostname)}\n`,
+    );
+};
+
+/** Prints a comprehensive description of what this tool does. */
+const printDescription = () => {
+    console.log(
+        style.section("What is Magentrix CLI?"),
+        "\n" +
+        chalk.cyanBright(
+            "Sync Active Pages & Classes between Magentrix and your editor—",
+        ) +
+        "edit locally, lint, then publish back safely.\n" +
+        style.dim("No built-in Git hooks—manage Git however you like.\n"),
+    );
+};
+
+/** Prints the 5-step recommended workflow. */
+const printWorkflow = () => {
+    console.log(style.section("Typical Workflow:"));
+    const STEPS = [
+        { label: "Setup", cmd: "magentrix setup", detail: "Enter URL & API key (one-time)" },
+        { label: "Pull", cmd: "magentrix pull", detail: "Fetch code locally" },
+        { label: "Edit", cmd: "—", detail: "Use any code editor" },
+        { label: "Lint", cmd: "magentrix lint", detail: "Check for conflicts" },
+        { label: "Publish", cmd: "magentrix publish", detail: "Push changes safely" },
+    ];
+    STEPS.forEach(({ label, cmd, detail }) => {
+        console.log(
+            `  ${style.bullet} ${label.padEnd(7)}  ${style.command(cmd.padEnd(20))} ${style.dim(detail)}`,
+        );
+    });
+    console.log(); // blank line
+};
+
+/** Prints the local folder overview in an uncluttered list. */
+const printFolders = () => {
+    console.log(style.section("Local Folder Structure:"));
+    FOLDERS.forEach(({ path, note }) => {
+        console.log(`  ${style.command(path.padEnd(22))} ${style.dim(note)}`);
+    });
+    console.log();
+};
+
+/** Prints the full command table. */
+const printCommands = () => {
+    console.log(style.section("Available Commands:"));
+    COMMANDS.forEach(({ command, description }) => {
+        console.log(`  ${style.command(command.padEnd(22))} ${description}`);
+    });
+    console.log();
+};
+
+/** Prints quick best-practice reminders. */
+const printTips = () => {
+    console.log(style.section("Best Practices:"));
+    [
+        "Always pull before editing.",
+        "Lint before publishing.",
+        "Optional: enable auto-publish on save during setup.",
+        "Magentrix is the source of truth; Git lives beside it.",
+    ].forEach(tip => console.log(`  ${style.bullet} ${tip}`));
+    console.log();
+};
+
+/** Prints additional resources and support info. */
+const printFooter = () => {
+    console.log(
+        style.dim("Need more details? See the project README or documentation.\n"),
+    );
+};
+
+/* ─────────────────────────────
+   🚀  HELP ENTRY POINT
+   ───────────────────────────── */
+
+/**
+ * Magentrix CLI comprehensive help display.
+ *
+ * 1. Ensure credentials are configured (to show current environment).
+ * 2. Display detailed usage guide, commands, workflow, and best practices.
+ *
+ * @async
+ * @returns {Promise<void>}
+ */
+export const showHelp = async () => {
+    const { apiKey, instanceUrl } = await ensureValidCredentials();
+
+    /* Mask the key except last 4 chars */
+    const maskedKey = `****${apiKey.slice(-4)}`;
+
+    /* Extract hostname from URL—for display only */
+    const hostname = (() => {
+        try {
+            return new URL(instanceUrl).hostname;
+        } catch {
+            return instanceUrl.replace(/^https?:\/\//, "").split("/")[0];
+        }
+    })();
+
+    /* Render comprehensive help sections */
+    printHelpHeader(maskedKey, hostname);
+    printDescription();
+    printWorkflow();
+    printFolders();
+    printCommands();
+    printTips();
+    printFooter();
 };