@wpmoo/toolkit 0.9.5 → 0.9.7

package/dist/system-prerequisites.js

@@ -0,0 +1,189 @@
+import { execFile } from 'node:child_process';
+const minimumNodeVersion = '20.17.0';
+const ANSI_RESET = '\u001B[0m';
+const ANSI_DEFAULT_FOREGROUND = '\u001B[39m';
+const ANSI_DIM_YELLOW = '\u001B[2m\u001B[38;2;226;184;96m';
+const ANSI_STRONG_YELLOW = '\u001B[38;2;226;184;96m';
+const ANSI_CYAN = '\u001B[36m';
+const ANSI_GREEN = '\u001B[32m';
+const ANSI_LIGHT_GREEN = '\u001B[38;2;125;231;152m';
+const ANSI_RED = '\u001B[38;2;224;92;120m';
+const ANSI_DIM = '\u001B[2m';
+export const realSystemCommandRunner = (command, args) => new Promise((resolve, reject) => {
+    execFile(command, args, { windowsHide: true }, (error, stdout, stderr) => {
+        if (error) {
+            reject(error);
+            return;
+        }
+        resolve({ stdout, stderr });
+    });
+});
+function parseVersionParts(value) {
+    const [major = '0', minor = '0', patch = '0'] = value.replace(/^v/u, '').split('.');
+    return [Number(major) || 0, Number(minor) || 0, Number(patch) || 0];
+}
+function isNodeVersionSupported(version) {
+    const current = parseVersionParts(version);
+    const minimum = parseVersionParts(minimumNodeVersion);
+    for (let index = 0; index < minimum.length; index += 1) {
+        if (current[index] > minimum[index])
+            return true;
+        if (current[index] < minimum[index])
+            return false;
+    }
+    return true;
+}
+function forcedMissingTools(env) {
+    return new Set((env.WPMOO_TEST_MISSING_TOOLS ?? '')
+        .split(/[,\s]+/u)
+        .map((tool) => tool.trim().toLowerCase())
+        .filter(Boolean));
+}
+function issueForCheck(check) {
+    if (check.status === 'found')
+        return undefined;
+    return { tool: check.tool, reason: check.status };
+}
+async function checkCommand(runner, tool, label, command, args, forcedMissing, missingAlias = tool) {
+    if (forcedMissing.has(tool) || forcedMissing.has(missingAlias)) {
+        return { tool, label, status: 'missing' };
+    }
+    try {
+        const result = await runner(command, args);
+        return {
+            tool,
+            label,
+            status: 'found',
+            detail: result.stdout.trim() || undefined,
+        };
+    }
+    catch {
+        return { tool, label, status: 'missing' };
+    }
+}
+async function checkDockerEngine(runner, forcedMissing) {
+    if (forcedMissing.has('docker-engine')) {
+        return { tool: 'docker-engine', label: 'Docker Engine', status: 'not-running' };
+    }
+    try {
+        const result = await runner('docker', ['info', '--format', '{{.ServerVersion}}']);
+        return {
+            tool: 'docker-engine',
+            label: 'Docker Engine',
+            status: 'found',
+            detail: result.stdout.trim() || undefined,
+        };
+    }
+    catch {
+        return { tool: 'docker-engine', label: 'Docker Engine', status: 'not-running' };
+    }
+}
+export async function getSystemPrerequisiteStatus(options = {}) {
+    const runner = options.runner ?? realSystemCommandRunner;
+    const env = options.env ?? process.env;
+    const forcedMissing = forcedMissingTools(env);
+    const checks = [];
+    const nodeVersion = options.nodeVersion ?? process.versions.node;
+    checks.push({
+        tool: 'node',
+        label: 'Node.js 20+',
+        status: isNodeVersionSupported(nodeVersion) ? 'found' : 'unsupported-version',
+        detail: `v${nodeVersion}`,
+    });
+    checks.push(await checkCommand(runner, 'git', 'Git', 'git', ['--version'], forcedMissing));
+    const dockerCheck = await checkCommand(runner, 'docker', 'Docker Desktop', 'docker', ['--version'], forcedMissing, 'docker-desktop');
+    checks.push(dockerCheck);
+    if (dockerCheck.status === 'found') {
+        checks.push(await checkCommand(runner, 'docker-compose', 'Docker Compose', 'docker', ['compose', 'version'], forcedMissing, 'compose'));
+        checks.push(await checkDockerEngine(runner, forcedMissing));
+    }
+    const issues = checks.map(issueForCheck).filter((issue) => Boolean(issue));
+    return {
+        ok: issues.length === 0,
+        checks,
+        issues,
+    };
+}
+function statusLabel(check) {
+    if (check.status === 'found')
+        return 'ok';
+    if (check.status === 'not-running')
+        return 'Not running';
+    if (check.status === 'unsupported-version')
+        return 'Unsupported version';
+    return 'Missing';
+}
+function hasIssue(status, tool) {
+    return status.issues.some((issue) => issue.tool === tool);
+}
+function supportsAnsi() {
+    return Boolean(process.stdout.isTTY) && process.env.NO_COLOR === undefined;
+}
+function ansi(value, open, close = ANSI_DEFAULT_FOREGROUND) {
+    if (!supportsAnsi())
+        return value;
+    return `${open}${value}${close}`;
+}
+function dim(value) {
+    return ansi(value, ANSI_DIM, ANSI_RESET);
+}
+function cyan(value) {
+    return ansi(value, ANSI_CYAN);
+}
+function green(value) {
+    return ansi(value, ANSI_GREEN);
+}
+function red(value) {
+    return ansi(value, ANSI_RED);
+}
+function mutedWarning(value) {
+    return ansi(value, ANSI_DIM_YELLOW, ANSI_RESET);
+}
+function yellow(value) {
+    return ansi(value, ANSI_STRONG_YELLOW);
+}
+function okText() {
+    return ansi('ok', ANSI_LIGHT_GREEN);
+}
+function downloadUrlForCheck(check) {
+    if (check.status === 'found') {
+        return undefined;
+    }
+    if (check.tool === 'node') {
+        return 'https://nodejs.org/en/download';
+    }
+    if (check.tool === 'git') {
+        return 'https://git-scm.com/downloads';
+    }
+    if (check.tool === 'docker' || check.tool === 'docker-compose') {
+        return 'https://www.docker.com/products/docker-desktop/';
+    }
+    return undefined;
+}
+function renderStatusLine(check) {
+    const symbol = check.status === 'found' ? green('✓') : red('✕');
+    const url = downloadUrlForCheck(check);
+    const status = check.status === 'found' ? okText() : url ? `${yellow('↗')} ${cyan(url)}` : dim(statusLabel(check));
+    return `${symbol} ${cyan(check.label.padEnd(18))} ${status}`;
+}
+export function renderSystemPrerequisiteGuidance(status) {
+    if (status.ok) {
+        return 'All required system prerequisites are available.';
+    }
+    const lines = [
+        'Required tools before environment setup starts',
+        '',
+        ...status.checks.map(renderStatusLine),
+        '',
+    ];
+    if (hasIssue(status, 'docker-engine')) {
+        lines.push(mutedWarning('Docker Desktop is installed, but Docker Engine is not running.'));
+        lines.push(mutedWarning('Start Docker Desktop, then check again.'));
+    }
+    else {
+        lines.push(mutedWarning('Environment setup has not started yet.'));
+        lines.push(mutedWarning('Install the missing tools, restart your terminal if PATH changed,'));
+        lines.push(mutedWarning('start Docker Desktop, then run WPMoo Toolkit again.'));
+    }
+    return lines.join('\n');
+}

package/dist/templates.js

@@ -285,6 +285,9 @@ const ANSI_WARNING = '\u001B[33m';
 const ANSI_DEFAULT_FOREGROUND = '\u001B[39m';
 const ANSI_RESET = '\u001B[0m';
 const BANNER_TAGLINE = 'Development, staging and production workflows for Odoo projects.';
+function shouldRenderBannerColor(options) {
+    return options.color ?? process.env.NO_COLOR === undefined;
+}
 function gradientColor(column, width) {
     const ratio = width <= 1 ? 0 : column / (width - 1);
     const [startR, startG, startB] = BANNER_GRADIENT_START;
@@ -294,7 +297,10 @@ function gradientColor(column, width) {
     const b = Math.round(startB + (endB - startB) * ratio);
     return `\u001B[38;2;${r};${g};${b}m`;
 }
-function applyBannerGradient(banner) {
+function applyBannerGradient(banner, color) {
+    if (!color) {
+        return banner;
+    }
     const lines = banner.split('\n');
     return lines
         .map((line) => {
@@ -305,28 +311,40 @@ function applyBannerGradient(banner) {
     })
         .join('\n');
 }
-function renderDimInfo(value) {
+function renderDimInfo(value, color) {
+    if (!color)
+        return value;
     return `${ANSI_DIM}${ANSI_INFO}${value}${ANSI_RESET}`;
 }
-function renderMetaInfo(value) {
+function renderMetaInfo(value, color) {
+    if (!color)
+        return value;
     return `${ANSI_META}${value}${ANSI_RESET}`;
 }
-function renderSuccessInfo(value) {
+function renderSuccessInfo(value, color) {
+    if (!color)
+        return value;
     return `${ANSI_SUCCESS}${value}${ANSI_DEFAULT_FOREGROUND}`;
 }
-function renderErrorInfo(value) {
+function renderErrorInfo(value, color) {
+    if (!color)
+        return value;
     return `${ANSI_ERROR}${value}${ANSI_DEFAULT_FOREGROUND}`;
 }
-function renderWarningInfo(value) {
+function renderWarningInfo(value, color) {
+    if (!color)
+        return value;
     return `${ANSI_WARNING}${value}${ANSI_DEFAULT_FOREGROUND}`;
 }
-function renderTaglineInfo(value) {
+function renderTaglineInfo(value, color) {
+    if (!color)
+        return value;
     return `${ANSI_TAGLINE}${value}${ANSI_RESET}`;
 }
-function renderBannerDetail(value) {
+function renderBannerDetail(value, color) {
     const match = /^(Environment|Status|Last):(.*)$/u.exec(value);
     if (!match) {
-        return renderDimInfo(value);
+        return renderDimInfo(value, color);
     }
     const label = match[1];
     const detail = match[2] ?? '';
@@ -336,36 +354,37 @@ function renderBannerDetail(value) {
             const marker = statusMatch[1] ?? '';
             const message = statusMatch[2] ?? '';
             const renderMarker = message === 'Services running' ? renderSuccessInfo : renderWarningInfo;
-            return `${renderMetaInfo(`${label}:`)} ${renderMarker(marker)}${renderTaglineInfo(` ${message}`)}`;
+            return `${renderMetaInfo(`${label}:`, color)} ${renderMarker(marker, color)}${renderTaglineInfo(` ${message}`, color)}`;
         }
     }
     if (label === 'Last') {
         const completedMatch = /^(.*?)( ✓ completed)$/u.exec(detail);
         if (completedMatch) {
-            return `${renderMetaInfo(`${label}:`)}${renderDimInfo(completedMatch[1] ?? '')}${renderSuccessInfo(completedMatch[2] ?? '')}`;
+            return `${renderMetaInfo(`${label}:`, color)}${renderDimInfo(completedMatch[1] ?? '', color)}${renderSuccessInfo(completedMatch[2] ?? '', color)}`;
         }
         const errorMatch = /^(.*?)( ✗ Error)(: .*)?$/u.exec(detail);
         if (errorMatch) {
             return [
-                renderMetaInfo(`${label}:`),
-                renderDimInfo(errorMatch[1] ?? ''),
-                renderErrorInfo(errorMatch[2] ?? ''),
-                renderTaglineInfo(errorMatch[3] ?? ''),
+                renderMetaInfo(`${label}:`, color),
+                renderDimInfo(errorMatch[1] ?? '', color),
+                renderErrorInfo(errorMatch[2] ?? '', color),
+                renderTaglineInfo(errorMatch[3] ?? '', color),
             ].join('');
         }
     }
-    return `${renderMetaInfo(`${label}:`)}${renderDimInfo(detail)}`;
+    return `${renderMetaInfo(`${label}:`, color)}${renderDimInfo(detail, color)}`;
 }
 export function renderBanner(details = [], options = {}) {
-    const title = `${applyBannerGradient('WPMoo Toolkit')}${options.version ? `  ${renderDimInfo(options.version)}` : ''}`;
+    const color = shouldRenderBannerColor(options);
+    const title = `${applyBannerGradient('WPMoo Toolkit', color)}${options.version ? `  ${renderDimInfo(options.version, color)}` : ''}`;
     const header = [
         title,
-        applyBannerGradient('Workflow Platform · Micro Object Oriented'),
-        renderTaglineInfo(BANNER_TAGLINE),
-        applyBannerGradient('━'.repeat(BANNER_TAGLINE.length)),
+        applyBannerGradient('Workflow Platform · Micro Object Oriented', color),
+        renderTaglineInfo(BANNER_TAGLINE, color),
+        applyBannerGradient('━'.repeat(BANNER_TAGLINE.length), color),
     ].join('\n');
-    const detailsBlock = details.length > 0 ? `\n${details.map((line) => renderBannerDetail(line)).join('\n')}` : '';
-    return `\n${ANSI_BOLD}${header}${ANSI_RESET}${detailsBlock}`;
+    const detailsBlock = details.length > 0 ? `\n${details.map((line) => renderBannerDetail(line, color)).join('\n')}` : '';
+    return color ? `\n${ANSI_BOLD}${header}${ANSI_RESET}${detailsBlock}` : `\n${header}${detailsBlock}`;
 }
 export function renderGitignore() {
     return `# macOS/editor noise
@@ -431,7 +450,7 @@ usage() {
     "psql") echo "Usage: ./moo psql [db]" ;;
     "install") echo "Usage: ./moo install <module[,module]> [db]" ;;
     "update") echo "Usage: ./moo update <module[,module]> [db]" ;;
-    "test") echo "Usage: ./moo test <module[,module]> [--db <db>] [--mode init|update] [--tags <tags>]" ;;
+    "test") echo "Usage: ./moo test <module[,module]> [--db <db>] [--mode auto|init|update] [--tags <tags>]" ;;
     "resetdb") echo "Usage: ./moo resetdb [db] [module[,module]]" ;;
     "snapshot") echo "Usage: ./moo snapshot [db] [snapshot-name]" ;;
     "restore-snapshot") echo "Usage: ./moo restore-snapshot [--dry-run] <snapshot-name> [db]" ;;
@@ -506,8 +525,8 @@ validate_test_args() {
           echo "Missing value for --mode" >&2
           exit 2
         fi
-        if [[ "$2" != "init" && "$2" != "update" ]]; then
-          echo "Invalid value for --mode: expected init or update" >&2
+        if [[ "$2" != "auto" && "$2" != "init" && "$2" != "update" ]]; then
+          echo "Invalid value for --mode: expected auto, init, or update" >&2
           exit 2
         fi
         shift 2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wpmoo/toolkit",
-  "version": "0.9.5",
+  "version": "0.9.7",
   "description": "WPMoo Toolkit for development, staging, and production lifecycle workflows.",
   "type": "module",
   "repository": {