apex-auditor 0.2.3 → 0.2.5

package/dist/bin.js

@@ -33,6 +33,8 @@ function printHelp() {
         "  --no-color         Disable ANSI colours in console output (default in CI mode)",
         "  --color            Force ANSI colours in console output",
         "  --log-level <lvl>  Override Lighthouse log level: silent|error|info|verbose",
+        "  --mobile-only      Run audits only for 'mobile' devices defined in the config",
+        "  --desktop-only     Run audits only for 'desktop' devices defined in the config",
     ].join("\n"));
 }
 export async function runBin(argv) {

package/dist/cli.js

@@ -21,6 +21,7 @@ function parseArgs(argv) {
     let ci = false;
     let colorMode = "auto";
     let logLevelOverride;
+    let deviceFilter;
     for (let i = 2; i < argv.length; i += 1) {
         const arg = argv[i];
         if ((arg === "--config" || arg === "-c") && i + 1 < argv.length) {
@@ -46,9 +47,21 @@ function parseArgs(argv) {
             }
             i += 1;
         }
+        else if (arg === "--mobile-only") {
+            if (deviceFilter !== undefined && deviceFilter !== "mobile") {
+                throw new Error("Cannot combine --mobile-only and --desktop-only");
+            }
+            deviceFilter = "mobile";
+        }
+        else if (arg === "--desktop-only") {
+            if (deviceFilter !== undefined && deviceFilter !== "desktop") {
+                throw new Error("Cannot combine --mobile-only and --desktop-only");
+            }
+            deviceFilter = "desktop";
+        }
     }
     const finalConfigPath = configPath ?? "apex.config.json";
-    return { configPath: finalConfigPath, ci, colorMode, logLevelOverride };
+    return { configPath: finalConfigPath, ci, colorMode, logLevelOverride, deviceFilter };
 }
 /**
  * Runs the ApexAuditor audit CLI.
@@ -64,7 +77,14 @@ export async function runAuditCli(argv) {
         ...config,
         logLevel: effectiveLogLevel,
     };
-    const summary = await runAuditsForConfig({ config: effectiveConfig, configPath });
+    const filteredConfig = filterConfigDevices(effectiveConfig, args.deviceFilter);
+    if (filteredConfig.pages.length === 0) {
+        // eslint-disable-next-line no-console
+        console.error("No pages remain after applying device filter. Check your config and device flags.");
+        process.exitCode = 1;
+        return;
+    }
+    const summary = await runAuditsForConfig({ config: filteredConfig, configPath });
     const outputDir = resolve(".apex-auditor");
     await mkdir(outputDir, { recursive: true });
     await writeFile(resolve(outputDir, "summary.json"), JSON.stringify(summary, null, 2), "utf8");
@@ -87,6 +107,28 @@ export async function runAuditCli(argv) {
     // eslint-disable-next-line no-console
     console.log(`\nCompleted in ${elapsedDisplay} (${comboCount} page/device combinations x ${runsPerTarget} runs = ${totalRuns} Lighthouse runs).`);
 }
+function filterConfigDevices(config, deviceFilter) {
+    if (deviceFilter === undefined) {
+        return config;
+    }
+    const filteredPages = config.pages
+        .map((page) => filterPageDevices(page, deviceFilter))
+        .filter((page) => page !== undefined);
+    return {
+        ...config,
+        pages: filteredPages,
+    };
+}
+function filterPageDevices(page, deviceFilter) {
+    const devices = page.devices.filter((device) => device === deviceFilter);
+    if (devices.length === 0) {
+        return undefined;
+    }
+    return {
+        ...page,
+        devices,
+    };
+}
 function buildMarkdown(results) {
     const header = [
         "| Label | Path | Device | P | A | BP | SEO | LCP (s) | FCP (s) | TBT (ms) | CLS | Error | Top issues |",
@@ -97,10 +139,19 @@ function buildMarkdown(results) {
 }
 function buildConsoleTable(results, useColor) {
     const header = [
-        "| Label | Path | Device | P | A | BP | SEO | LCP (s) | FCP (s) | TBT (ms) | CLS |",
-        "|-------|------|--------|---|---|----|-----|---------|---------|----------|-----|",
+        "| Label | Path | Device | P | A | BP | SEO |",
+        "|-------|------|--------|---|---|----|-----|",
     ].join("\n");
-    const rows = results.map((result) => buildConsoleRow(result, useColor));
+    const rows = [];
+    let previousKey;
+    for (const result of results) {
+        const key = `${result.label}:::${result.path}`;
+        if (previousKey !== undefined && key !== previousKey) {
+            rows.push("");
+        }
+        rows.push(buildConsoleRow(result, useColor));
+        previousKey = key;
+    }
     return `${header}\n${rows.join("\n")}`;
 }
 function buildRow(result) {
@@ -135,7 +186,7 @@ function buildConsoleScoreLine(result, useColor) {
     const bestPracticesText = colourScore(scores.bestPractices, useColor);
     const seoText = colourScore(scores.seo, useColor);
     const deviceText = formatDeviceLabel(result.device, useColor);
-    return `| ${result.label} | ${result.path} | ${deviceText} | ${performanceText} | ${accessibilityText} | ${bestPracticesText} | ${seoText} |  |  |  |  |`;
+    return `| ${result.label} | ${result.path} | ${deviceText} | ${performanceText} | ${accessibilityText} | ${bestPracticesText} | ${seoText} |`;
 }
 function buildConsoleMetricsLine(result, useColor) {
     const metrics = result.metrics;
@@ -143,7 +194,8 @@ function buildConsoleMetricsLine(result, useColor) {
     const fcpText = formatMetricSeconds(metrics.fcpMs, FCP_GOOD_MS, FCP_WARN_MS, useColor);
     const tbtText = formatMetricMilliseconds(metrics.tbtMs, TBT_GOOD_MS, TBT_WARN_MS, useColor);
     const clsText = formatMetricRatio(metrics.cls, CLS_GOOD, CLS_WARN, useColor);
-    return `|  |  |  |  |  |  |  | ${lcpText} | ${fcpText} | ${tbtText} | ${clsText} |`;
+    const parts = [`LCP ${lcpText}`, `FCP ${fcpText}`, `TBT ${tbtText}`, `CLS ${clsText}`];
+    return `  ↳ Metrics: ${parts.join("  |  ")}`;
 }
 function buildConsoleErrorLine(result, useColor) {
     const errorCode = result.runtimeErrorCode;
@@ -166,15 +218,38 @@ function formatTopIssues(opportunities) {
     if (opportunities.length === 0) {
         return "";
     }
-    const items = opportunities.map((opp) => {
-        const savingsMs = opp.estimatedSavingsMs !== undefined ? `${Math.round(opp.estimatedSavingsMs)}ms` : "";
-        const savingsBytes = opp.estimatedSavingsBytes !== undefined ? `${Math.round(opp.estimatedSavingsBytes / 1024)}KB` : "";
-        const parts = [savingsMs, savingsBytes].filter((p) => p.length > 0);
-        const suffix = parts.length > 0 ? ` (${parts.join(", ")})` : "";
-        return `${opp.id}${suffix}`;
-    });
+    const meaningful = opportunities.filter((opp) => hasMeaningfulSavings(opp));
+    const source = meaningful.length > 0 ? meaningful : opportunities;
+    const sorted = [...source].sort(compareOpportunitiesByImpact);
+    const limit = 2;
+    const top = sorted.slice(0, limit);
+    const items = top.map((opp) => formatOpportunityLabel(opp));
     return items.join("; ");
 }
+function hasMeaningfulSavings(opportunity) {
+    const savingsMs = opportunity.estimatedSavingsMs ?? 0;
+    const savingsBytes = opportunity.estimatedSavingsBytes ?? 0;
+    return savingsMs > 0 || savingsBytes > 0;
+}
+function compareOpportunitiesByImpact(a, b) {
+    const aMs = a.estimatedSavingsMs ?? 0;
+    const bMs = b.estimatedSavingsMs ?? 0;
+    if (aMs !== bMs) {
+        return bMs - aMs;
+    }
+    const aBytes = a.estimatedSavingsBytes ?? 0;
+    const bBytes = b.estimatedSavingsBytes ?? 0;
+    return bBytes - aBytes;
+}
+function formatOpportunityLabel(opportunity) {
+    const savingsMs = opportunity.estimatedSavingsMs !== undefined ? `${Math.round(opportunity.estimatedSavingsMs)}ms` : "";
+    const savingsBytes = opportunity.estimatedSavingsBytes !== undefined
+        ? `${Math.round(opportunity.estimatedSavingsBytes / 1024)}KB`
+        : "";
+    const parts = [savingsMs, savingsBytes].filter((part) => part.length > 0);
+    const suffix = parts.length > 0 ? ` (${parts.join(", ")})` : "";
+    return `${opportunity.id}${suffix}`;
+}
 function formatMetricSeconds(valueMs, goodThresholdMs, warnThresholdMs, useColor) {
     if (valueMs === undefined) {
         return "-";

package/package.json

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