@schalkneethling/miyagi-core 4.8.0 → 4.9.0

package/lib/cli/budget.js

@@ -1,157 +0,0 @@
-import { writeFile } from "node:fs/promises";
-import getConfig from "../config.js";
-import log from "../logger.js";
-import { EXIT_CODES } from "../errors.js";
-import { runPerformance } from "../performance/index.js";
-import { generatePerformanceReport } from "../performance/report.js";
-import { formatSize } from "../performance/parse-size.js";
-
-const VALID_COMPRESSIONS = ["raw", "gzip", "brotli"];
-
-/**
- * `miyagi budget` — on-demand performance budget check.
- * By default walks the configured global CSS/JS and asset folders, measures
- * them, and compares against `config.performance.budgets`. The HTML category
- * (post-build pages) is opt-in via `--build-folder`.
- * @param {object} args
- * @returns {Promise<object>}
- */
-export default async function budgetCli(args) {
-  const config = await getConfig(args);
-  global.config = config;
-
-  if (args.compression && !VALID_COMPRESSIONS.includes(args.compression)) {
-    log(
-      "error",
-      `Unknown --compression "${args.compression}". Use one of: ${VALID_COMPRESSIONS.join(", ")}`,
-    );
-    return {
-      success: false,
-      code: EXIT_CODES.CLI_USAGE_ERROR,
-      shouldExit: true,
-    };
-  }
-
-  if (args.compression) {
-    config.performance = {
-      ...(config.performance || {}),
-      compression: args.compression,
-    };
-  }
-
-  const result = runPerformance({
-    config,
-    html: Boolean(args.buildFolder),
-    buildFolder: args.buildFolder,
-    listAllPages: args.listAllPages,
-  });
-
-  if (args.json) {
-    process.stdout.write(`${JSON.stringify(result, null, 2)}\n`);
-  } else {
-    printTable(result);
-  }
-
-  if (args.output) {
-    const report = generatePerformanceReport(result);
-    try {
-      await writeFile(args.output, report, "utf-8");
-      log("info", `Performance report written to ${args.output}`);
-    } catch (error) {
-      log("error", `Failed to write report: ${error.message}`);
-    }
-  }
-
-  const exceeded = result.summary.exceed > 0;
-  const shouldFail =
-    args.fail || config.performance?.report?.failOnExceed;
-
-  if (exceeded && shouldFail) {
-    return {
-      success: false,
-      code: EXIT_CODES.VALIDATION_ERROR,
-      shouldExit: true,
-    };
-  }
-
-  if (exceeded) {
-    log(
-      "warn",
-      `Performance budget exceeded in ${result.summary.exceed} categor${result.summary.exceed === 1 ? "y" : "ies"}.`,
-    );
-  }
-
-  return {
-    success: true,
-    code: EXIT_CODES.SUCCESS,
-    shouldExit: true,
-  };
-}
-
-/**
- * @param {import("../performance/index.js").PerformanceResult} result
- * @returns {void}
- */
-function printTable(result) {
-  const { evaluations, compression, summary } = result;
-
-  log("info", `Performance budget — measured at ${compression}.`);
-
-  const header = ["Category", "Item", "Actual", "Budget", "Status"];
-  const rows = evaluations.map((row) => [
-    row.category,
-    row.key === "total" ? "Total" : shortLabel(row.label),
-    formatSize(row.actual),
-    formatSize(row.budget),
-    statusLabel(row.status),
-  ]);
-
-  const columnWidths = header.map((heading, index) =>
-    Math.max(heading.length, ...rows.map((row) => row[index].length)),
-  );
-
-  const padCell = (text, width) => text + " ".repeat(width - text.length);
-  const renderRow = (columns) =>
-    columns.map((cell, index) => padCell(cell, columnWidths[index])).join("  ");
-
-  process.stdout.write(`${renderRow(header)}\n`);
-  process.stdout.write(
-    `${columnWidths.map((width) => "-".repeat(width)).join("  ")}\n`,
-  );
-  for (const row of rows) {
-    process.stdout.write(`${renderRow(row)}\n`);
-  }
-  process.stdout.write(
-    `\nOK: ${summary.ok}  Warn: ${summary.warn}  Exceed: ${summary.exceed}  Unbudgeted: ${summary.unbudgeted}\n`,
-  );
-}
-
-const MAX_LABEL_LENGTH = 60;
-
-/**
- * @param {string} label
- * @returns {string}
- */
-function shortLabel(label) {
-  if (label.length <= MAX_LABEL_LENGTH) {
-    return label;
-  }
-  return `…${label.slice(-(MAX_LABEL_LENGTH - 1))}`;
-}
-
-/**
- * @param {string} status
- * @returns {string}
- */
-function statusLabel(status) {
-  switch (status) {
-    case "ok":
-      return "OK";
-    case "warn":
-      return "WARN";
-    case "exceed":
-      return "EXCEED";
-    default:
-      return "—";
-  }
-}

package/lib/performance/report.js

@@ -1,102 +0,0 @@
-/**
- * Generate a Markdown performance-budget report.
- * Mirrors the shape of lib/validator/html-report.js so the two read the same at
- * a glance: one summary table, then per-category detail tables. The report is
- * a stable artefact that can be committed by CI or linked from PRs.
- * @module performance/report
- */
-
-import path from "node:path";
-import { formatSize } from "./parse-size.js";
-
-const STATUS_LABEL = {
-  ok: "OK",
-  warn: "WARN",
-  exceed: "EXCEED",
-  unbudgeted: "—",
-};
-
-/**
- * @param {"raw"|"gzip"|"brotli"} compression
- * @returns {string}
- */
-function compressionLabel(compression) {
-  return compression.charAt(0).toUpperCase() + compression.slice(1);
-}
-
-/**
- * @param {import("./index.js").PerformanceResult} result
- * @param {object} [options]
- * @param {string} [options.cwd] - used to relativize reported file paths
- * @returns {string} Markdown
- */
-export function generatePerformanceReport(result, options = {}) {
-  const cwd = options.cwd || process.cwd();
-  const { measurement, evaluations, compression, summary } = result;
-  const lines = [];
-
-  lines.push("# Performance Budget Report");
-  lines.push("");
-  lines.push(`**Date:** ${new Date().toISOString().split("T")[0]}`);
-  lines.push(`**Compression:** ${compressionLabel(compression)}`);
-  lines.push(
-    `**OK:** ${summary.ok} | **Warn:** ${summary.warn} | **Exceed:** ${summary.exceed} | **Unbudgeted:** ${summary.unbudgeted}`,
-  );
-  lines.push("");
-
-  // Evaluation summary
-  lines.push("## Evaluations");
-  lines.push("");
-  lines.push("| Category | Item | Actual | Budget | Status |");
-  lines.push("|----------|------|--------|--------|--------|");
-
-  for (const row of evaluations) {
-    let itemLabel;
-    if (row.key === "total") {
-      itemLabel = "Total";
-    } else if (row.key === "perPage") {
-      itemLabel = "Per page";
-    } else {
-      itemLabel = escapePipe(row.label);
-    }
-
-    lines.push(
-      `| ${escapePipe(row.category)} | ${itemLabel} | ${formatSize(row.actual)} | ${formatSize(row.budget)} | ${STATUS_LABEL[row.status]} |`,
-    );
-  }
-  lines.push("");
-
-  // Per-category file breakdown
-  for (const [category, data] of Object.entries(measurement.categories)) {
-    if (data.files.length === 0) {
-      continue;
-    }
-
-    lines.push(`## ${escapePipe(category)}`);
-    lines.push("");
-    lines.push("| File | Raw | Gzip | Brotli |");
-    lines.push("|------|-----|------|--------|");
-
-    for (const file of data.files) {
-      const rel = path.relative(cwd, file.path);
-      const label = file.missing ? `${rel} (missing)` : rel;
-      lines.push(
-        `| ${escapePipe(label)} | ${formatSize(file.raw)} | ${formatSize(file.gzip)} | ${formatSize(file.brotli)} |`,
-      );
-    }
-    lines.push(
-      `| **Total** | ${formatSize(data.totals.raw)} | ${formatSize(data.totals.gzip)} | ${formatSize(data.totals.brotli)} |`,
-    );
-    lines.push("");
-  }
-
-  return lines.join("\n");
-}
-
-/**
- * @param {string} text
- * @returns {string}
- */
-function escapePipe(text) {
-  return String(text).replace(/\\/g, "\\\\").replace(/\|/g, "\\|");
-}

package/lib/render/views/iframe/performance.js

@@ -1,74 +0,0 @@
-import config from "../../../default-config.js";
-import { getUserUiConfig, getThemeMode } from "../../helpers.js";
-import { runPerformance } from "../../../performance/index.js";
-import { formatSize } from "../../../performance/parse-size.js";
-
-/**
- * Renders the iframe-side Performance panel. Computed on-request so the
- * numbers reflect the current on-disk state without any extra cache plumbing;
- * `measure.js` has an mtime cache so repeat renders are cheap.
- * @param {object} o
- * @param {object} o.res
- * @param {Function} [o.cb]
- * @param {object} o.cookies
- * @returns {Promise<void>}
- */
-export default async function renderIframePerformance({ res, cb, cookies }) {
-  const themeMode = getThemeMode(cookies);
-
-  const result = runPerformance({ config: global.config });
-
-  const viewData = {
-    compression: result.compression,
-    evaluations: result.evaluations.map((row) => ({
-      ...row,
-      actualFormatted: formatSize(row.actual),
-      budgetFormatted: formatSize(row.budget),
-      ratioPercent:
-        row.ratio == null ? null : Math.round(row.ratio * 100),
-    })),
-    categories: Object.entries(result.measurement.categories).map(
-      ([category, data]) => ({
-        category,
-        files: data.files.map((file) => ({
-          path: file.path,
-          raw: formatSize(file.raw),
-          gzip: formatSize(file.gzip),
-          brotli: formatSize(file.brotli),
-          missing: !!file.missing,
-        })),
-        totals: {
-          raw: formatSize(data.totals.raw),
-          gzip: formatSize(data.totals.gzip),
-          brotli: formatSize(data.totals.brotli),
-        },
-      }),
-    ),
-    summary: result.summary,
-  };
-
-  await res.render(
-    "performance.twig.miyagi",
-    {
-      ...viewData,
-      isBuild: global.config.isBuild,
-      lang: global.config.ui.lang,
-      miyagiDev: !!process.env.MIYAGI_DEVELOPMENT,
-      projectName: config.projectName,
-      userUiConfig: getUserUiConfig(cookies),
-      theme: themeMode
-        ? Object.assign(global.config.ui.theme, { mode: themeMode })
-        : global.config.ui.theme,
-      uiTextDirection: global.config.ui.textDirection,
-    },
-    (html) => {
-      if (res.send) {
-        res.send(html);
-      }
-
-      if (cb) {
-        cb(null, html);
-      }
-    },
-  );
-}

package/lib/render/views/main/performance.js

@@ -1,51 +0,0 @@
-import config from "../../../default-config.js";
-import { getUserUiConfig, getThemeMode } from "../../helpers.js";
-
-/**
- * Renders the main Performance page — the standard chrome (menu etc.) with
- * the iframe pointed at the Performance panel view.
- * @param {object} object
- * @param {object} object.res
- * @param {Function} [object.cb]
- * @param {object} [object.cookies]
- * @returns {void}
- */
-export default function renderMainPerformance({ res, cb, cookies }) {
-  const themeMode = getThemeMode(cookies);
-
-  res.render(
-    "main.twig.miyagi",
-    {
-      lang: global.config.ui.lang,
-      folders: global.state.menu,
-      components: global.state.components,
-      flatUrlPattern: global.config.isBuild
-        ? "/show-{{component}}.html"
-        : "/show?file={{component}}",
-      iframeSrc: "/iframe/performance",
-      showAll: true,
-      projectName: config.projectName,
-      userProjectName: global.config.projectName,
-      indexPath: global.config.indexPath.embedded,
-      miyagiDev: !!process.env.MIYAGI_DEVELOPMENT,
-      isBuild: global.config.isBuild,
-      userUiConfig: getUserUiConfig(cookies),
-      theme: themeMode
-        ? Object.assign(global.config.ui.theme, { mode: themeMode })
-        : global.config.ui.theme,
-      basePath: global.config.isBuild ? global.config.build.basePath : "/",
-      uiTextDirection: global.config.ui.textDirection,
-      requestedComponent: "performance",
-      requestedVariation: null,
-    },
-    (html) => {
-      if (res.send) {
-        res.send(html);
-      }
-
-      if (cb) {
-        cb(null, html);
-      }
-    },
-  );
-}