apex-auditor 0.1.3 → 0.1.6

package/dist/cli.js

@@ -2,6 +2,10 @@ import { mkdir, writeFile } from "node:fs/promises";
 import { resolve } from "node:path";
 import { loadConfig } from "./config.js";
 import { runAuditsForConfig } from "./lighthouse-runner.js";
+const ANSI_RESET = "\u001B[0m";
+const ANSI_RED = "\u001B[31m";
+const ANSI_YELLOW = "\u001B[33m";
+const ANSI_GREEN = "\u001B[32m";
 function parseArgs(argv) {
     let configPath;
     for (let i = 2; i < argv.length; i += 1) {
@@ -28,18 +32,28 @@ export async function runAuditCli(argv) {
     await writeFile(resolve(outputDir, "summary.json"), JSON.stringify(summary, null, 2), "utf8");
     const markdown = buildMarkdown(summary.results);
     await writeFile(resolve(outputDir, "summary.md"), markdown, "utf8");
-    // Also echo a compact table to stdout for quick viewing.
+    // Also echo a compact, colourised table to stdout for quick viewing.
+    const consoleTable = buildConsoleTable(summary.results);
     // eslint-disable-next-line no-console
-    console.log(markdown);
+    console.log(consoleTable);
+    printRedIssues(summary.results);
 }
 function buildMarkdown(results) {
     const header = [
-        "| Label | Path | Device | P | A | BP | SEO | LCP (s) | FCP (s) | TBT (ms) | CLS | Top issues |",
-        "|-------|------|--------|---|---|----|-----|---------|---------|----------|-----|-----------|",
+        "| Label | Path | Device | P | A | BP | SEO | LCP (s) | FCP (s) | TBT (ms) | CLS | Error | Top issues |",
+        "|-------|------|--------|---|---|----|-----|---------|---------|----------|-----|-------|-----------|",
     ].join("\n");
     const lines = results.map((result) => buildRow(result));
     return `${header}\n${lines.join("\n")}`;
 }
+function buildConsoleTable(results) {
+    const header = [
+        "| Label | Path | Device | P | A | BP | SEO | LCP (s) | FCP (s) | TBT (ms) | CLS | Error | Top issues |",
+        "|-------|------|--------|---|---|----|-----|---------|---------|----------|-----|-------|-----------|",
+    ].join("\n");
+    const lines = results.map((result) => buildConsoleRow(result));
+    return `${header}\n${lines.join("\n")}`;
+}
 function buildRow(result) {
     const scores = result.scores;
     const metrics = result.metrics;
@@ -48,7 +62,23 @@ function buildRow(result) {
     const tbtMs = metrics.tbtMs !== undefined ? Math.round(metrics.tbtMs).toString() : "-";
     const cls = metrics.cls !== undefined ? metrics.cls.toFixed(3) : "-";
     const issues = formatTopIssues(result.opportunities);
-    return `| ${result.label} | ${result.path} | ${result.device} | ${scores.performance ?? "-"} | ${scores.accessibility ?? "-"} | ${scores.bestPractices ?? "-"} | ${scores.seo ?? "-"} | ${lcpSeconds} | ${fcpSeconds} | ${tbtMs} | ${cls} | ${issues} |`;
+    const error = result.runtimeErrorCode ?? (result.runtimeErrorMessage !== undefined ? result.runtimeErrorMessage : "");
+    return `| ${result.label} | ${result.path} | ${result.device} | ${scores.performance ?? "-"} | ${scores.accessibility ?? "-"} | ${scores.bestPractices ?? "-"} | ${scores.seo ?? "-"} | ${lcpSeconds} | ${fcpSeconds} | ${tbtMs} | ${cls} | ${error} | ${issues} |`;
+}
+function buildConsoleRow(result) {
+    const scores = result.scores;
+    const metrics = result.metrics;
+    const lcpSeconds = metrics.lcpMs !== undefined ? (metrics.lcpMs / 1000).toFixed(1) : "-";
+    const fcpSeconds = metrics.fcpMs !== undefined ? (metrics.fcpMs / 1000).toFixed(1) : "-";
+    const tbtMs = metrics.tbtMs !== undefined ? Math.round(metrics.tbtMs).toString() : "-";
+    const cls = metrics.cls !== undefined ? metrics.cls.toFixed(3) : "-";
+    const issues = formatTopIssues(result.opportunities);
+    const error = result.runtimeErrorCode ?? (result.runtimeErrorMessage !== undefined ? result.runtimeErrorMessage : "");
+    const performanceText = colourScore(scores.performance);
+    const accessibilityText = colourScore(scores.accessibility);
+    const bestPracticesText = colourScore(scores.bestPractices);
+    const seoText = colourScore(scores.seo);
+    return `| ${result.label} | ${result.path} | ${result.device} | ${performanceText} | ${accessibilityText} | ${bestPracticesText} | ${seoText} | ${lcpSeconds} | ${fcpSeconds} | ${tbtMs} | ${cls} | ${error} | ${issues} |`;
 }
 function formatTopIssues(opportunities) {
     if (opportunities.length === 0) {
@@ -63,3 +93,57 @@ function formatTopIssues(opportunities) {
     });
     return items.join("; ");
 }
+function colourScore(score) {
+    if (score === undefined) {
+        return "-";
+    }
+    const value = score;
+    const text = value.toString();
+    let colour;
+    if (value < 50) {
+        colour = ANSI_RED;
+    }
+    else if (value < 90) {
+        colour = ANSI_YELLOW;
+    }
+    else {
+        colour = ANSI_GREEN;
+    }
+    return `${colour}${text}${ANSI_RESET}`;
+}
+function isRedScore(score) {
+    return typeof score === "number" && score < 50;
+}
+function printRedIssues(results) {
+    const redResults = results.filter((result) => {
+        const scores = result.scores;
+        return (isRedScore(scores.performance) ||
+            isRedScore(scores.accessibility) ||
+            isRedScore(scores.bestPractices) ||
+            isRedScore(scores.seo));
+    });
+    if (redResults.length === 0) {
+        return;
+    }
+    // eslint-disable-next-line no-console
+    console.log("\nRed issues (scores below 50):");
+    for (const result of redResults) {
+        const scores = result.scores;
+        const badParts = [];
+        if (isRedScore(scores.performance)) {
+            badParts.push(`P:${scores.performance}`);
+        }
+        if (isRedScore(scores.accessibility)) {
+            badParts.push(`A:${scores.accessibility}`);
+        }
+        if (isRedScore(scores.bestPractices)) {
+            badParts.push(`BP:${scores.bestPractices}`);
+        }
+        if (isRedScore(scores.seo)) {
+            badParts.push(`SEO:${scores.seo}`);
+        }
+        const issues = formatTopIssues(result.opportunities);
+        // eslint-disable-next-line no-console
+        console.log(`- ${result.label} ${result.path} [${result.device}] – ${badParts.join(", ")} – ${issues}`);
+    }
+}

package/dist/config.js

@@ -27,11 +27,16 @@ function normaliseConfig(input, absolutePath) {
     const query = typeof maybeConfig.query === "string" ? maybeConfig.query : undefined;
     const chromePort = typeof maybeConfig.chromePort === "number" ? maybeConfig.chromePort : undefined;
     const runs = typeof maybeConfig.runs === "number" && maybeConfig.runs > 0 ? maybeConfig.runs : undefined;
+    const rawLogLevel = maybeConfig.logLevel;
+    const logLevel = rawLogLevel === "silent" || rawLogLevel === "error" || rawLogLevel === "info" || rawLogLevel === "verbose"
+        ? rawLogLevel
+        : undefined;
     return {
         baseUrl,
         query,
         chromePort,
         runs,
+        logLevel,
         pages,
     };
 }

package/dist/lighthouse-runner.js

@@ -1,3 +1,5 @@
+import { request as httpRequest } from "node:http";
+import { request as httpsRequest } from "node:https";
 import lighthouse from "lighthouse";
 import { launch as launchChrome } from "chrome-launcher";
 async function createChromeSession(chromePort) {
@@ -19,16 +21,55 @@ async function createChromeSession(chromePort) {
     return {
         port: chrome.port,
         close: async () => {
-            await chrome.kill();
+            try {
+                await chrome.kill();
+            }
+            catch {
+                return;
+            }
         },
     };
 }
+async function ensureUrlReachable(url) {
+    const parsed = new URL(url);
+    const client = parsed.protocol === "https:" ? httpsRequest : httpRequest;
+    await new Promise((resolve, reject) => {
+        const request = client({
+            hostname: parsed.hostname,
+            port: parsed.port ? Number(parsed.port) : parsed.protocol === "https:" ? 443 : 80,
+            path: `${parsed.pathname}${parsed.search}`,
+            method: "GET",
+        }, (response) => {
+            const statusCode = response.statusCode ?? 0;
+            response.resume();
+            if (statusCode >= 200 && statusCode < 400) {
+                resolve();
+            }
+            else {
+                reject(new Error(`HTTP ${statusCode}`));
+            }
+        });
+        request.on("error", (error) => {
+            reject(error);
+        });
+        request.end();
+    }).catch((error) => {
+        // eslint-disable-next-line no-console
+        console.error(`Could not reach ${url}. Is your dev server running?`, error);
+        throw error instanceof Error ? error : new Error(`URL not reachable: ${url}`);
+    });
+}
 /**
  * Run audits for all pages defined in the config and return a structured summary.
  */
 export async function runAuditsForConfig({ config, configPath, }) {
     const runs = config.runs ?? 1;
     const results = [];
+    const firstPage = config.pages[0];
+    const healthCheckUrl = buildUrl({ baseUrl: config.baseUrl, path: firstPage.path, query: config.query });
+    await ensureUrlReachable(healthCheckUrl);
+    const totalSteps = config.pages.reduce((sum, page) => sum + page.devices.length * runs, 0);
+    let completedSteps = 0;
     const session = await createChromeSession(config.chromePort);
     try {
         for (const page of config.pages) {
@@ -42,8 +83,16 @@ export async function runAuditsForConfig({ config, configPath, }) {
                         label: page.label,
                         device,
                         port: session.port,
+                        logLevel: config.logLevel ?? "error",
                     });
                     summaries.push(summary);
+                    completedSteps += 1;
+                    logProgress({
+                        completed: completedSteps,
+                        total: totalSteps,
+                        path: page.path,
+                        device,
+                    });
                 }
                 results.push(aggregateSummaries(summaries));
             }
@@ -62,11 +111,25 @@ function buildUrl({ baseUrl, path, query }) {
     const queryPart = query && query.length > 0 ? query : "";
     return `${cleanBase}${cleanPath}${queryPart}`;
 }
+function logProgress({ completed, total, path, device, }) {
+    const percentage = total > 0 ? Math.round((completed / total) * 100) : 0;
+    const message = `Running audits ${completed}/${total} (${percentage}%) – ${path} [${device}]`;
+    if (typeof process !== "undefined" && process.stdout && typeof process.stdout.write === "function" && process.stdout.isTTY) {
+        const padded = message.padEnd(80, " ");
+        process.stdout.write(`\r${padded}`);
+        if (completed === total) {
+            process.stdout.write("\n");
+        }
+        return;
+    }
+    // eslint-disable-next-line no-console
+    console.log(message);
+}
 async function runSingleAudit(params) {
     const options = {
         port: params.port,
         output: "json",
-        logLevel: "error",
+        logLevel: params.logLevel,
         onlyCategories: ["performance", "accessibility", "best-practices", "seo"],
         emulatedFormFactor: params.device,
     };
@@ -87,6 +150,8 @@ async function runSingleAudit(params) {
         scores,
         metrics,
         opportunities,
+        runtimeErrorCode: typeof lhr.runtimeError?.code === "string" ? lhr.runtimeError.code : undefined,
+        runtimeErrorMessage: typeof lhr.runtimeError?.message === "string" ? lhr.runtimeError.message : undefined,
     };
 }
 function extractScores(lhr) {
@@ -168,6 +233,8 @@ function aggregateSummaries(summaries) {
         scores: aggregateScores,
         metrics: aggregateMetrics,
         opportunities,
+        runtimeErrorCode: base.runtimeErrorCode,
+        runtimeErrorMessage: base.runtimeErrorMessage,
     };
 }
 function averageOf(values) {

package/dist/wizard-cli.js

@@ -246,7 +246,8 @@ async function selectDetectedRoutes(routes) {
         type: "multiselect",
         name: "indexes",
         message: "Select routes to include",
-        instructions: false,
+        instructions: true,
+        hint: "Use Space to toggle, ↑/↓ to move, and Enter to confirm.",
         min: 1,
         choices: buildRouteChoices(routes),
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apex-auditor",
-  "version": "0.1.3",
+  "version": "0.1.6",
   "private": false,
   "description": "CLI to run structured Lighthouse audits (Performance, Accessibility, Best Practices, SEO) across routes.",
   "type": "module",