@open-press/cli 0.8.0 → 1.1.0

package/template/core/engine/runtime/inspection.mjs

@@ -1,328 +0,0 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import { evaluateUrlWithChrome, stopChildProcess } from "../output/chrome-pdf.mjs";
-import { buildReactStatic, startStaticServer } from "../commands/_shared.mjs";
-import { walkFiles } from "./file-walk.mjs";
-import { createIssue, createIssueReport } from "./issue-report.mjs";
-import { collectActiveContentFiles, resolveActiveSourceWorkspace } from "./source-workspace.mjs";
-
-const MEDIA_EXTENSIONS = new Set([".avif", ".gif", ".jpeg", ".jpg", ".png", ".svg", ".webp"]);
-const SOURCE_EXTENSIONS = new Set([".css", ".html", ".js", ".json", ".md", ".mjs", ".ts", ".tsx"]);
-
-export async function inspectWorkspace({ root, config, options = {}, recurse = null }) {
-  const checked = [];
-  const issues = [];
-
-  const sourceScan = await collectInspectionSources(config);
-  checked.push(sourceScan.checkedName);
-  sourceScan.contentFiles.forEach((file) => {
-    if (!file.text.trim()) {
-      issues.push(createIssue({
-        level: "warning",
-        code: "react-source.empty-file",
-        message: `${sourceScan.contentLabel} \`${file.relativePath}\` is empty.`,
-        path: file.absolutePath,
-      }));
-    }
-  });
-
-  checked.push("media");
-  const mediaFiles = await readMediaFiles(sourceScan.config.paths.mediaDir);
-  const sourceText = sourceScan.sourceFiles.map((file) => file.text).join("\n");
-  const unusedMedia = mediaFiles.filter((file) => !sourceText.includes(file.name) && !sourceText.includes(file.relativePath));
-  unusedMedia.forEach((file) => {
-    issues.push(createIssue({
-      level: "warning",
-      code: "media.unused",
-      message: `Media asset \`${file.relativePath}\` is not referenced by document sources.`,
-      path: file.absolutePath,
-      detail: {
-        file: file.name,
-        relativePath: file.relativePath,
-      },
-    }));
-  });
-
-  checked.push("components");
-  const componentUsage = sourceScan.componentUsage;
-
-  const summary = {
-    ...sourceScan.summary,
-    mediaFiles: mediaFiles.length,
-    unusedMedia: unusedMedia.length,
-    componentUsage,
-  };
-
-  checked.push("overflow");
-  const renderCode = await buildReactStatic({
-    root,
-    noBuild: options.noBuild,
-    recurse,
-    silent: options.json,
-  });
-  if (renderCode !== 0) {
-    issues.push(createIssue({
-      level: "error",
-      code: "inspect.render",
-      message: `React render failed before overflow inspection (exit code ${renderCode}).`,
-      path: config.configPath,
-    }));
-    return createIssueReport({
-      kind: "inspection",
-      checked,
-      issues,
-      summary,
-      okMessage: "OpenPress inspection OK",
-    });
-  }
-
-  const overflowMeasurements = await inspectRenderedOverflow({
-    root,
-    config,
-    host: options.host ?? "127.0.0.1",
-    port: options.port ?? "5186",
-  });
-  issues.push(...overflowIssuesFromMeasurements(overflowMeasurements));
-  summary.pages = overflowMeasurements.length;
-  summary.overflowPages = overflowMeasurements.filter((page) => (page.overflows ?? []).length > 0).length;
-
-  return createIssueReport({
-    kind: "inspection",
-    checked,
-    issues,
-    summary,
-    okMessage: "OpenPress inspection OK",
-  });
-}
-
-export async function collectInspectionSources(config) {
-  const sourceWorkspace = await resolveActiveSourceWorkspace(config);
-  const sourceConfig = sourceWorkspace.config;
-  const contentFiles = await collectActiveContentFiles(sourceWorkspace);
-  const sourceFiles = [
-    ...contentFiles,
-    ...await readSourceFiles(sourceConfig.paths.componentsDir),
-    ...await readSingleFile(sourceConfig.paths.designDoc),
-  ];
-  const componentUsage = summarizeComponentUsage(contentFiles);
-
-  return {
-    sourceKind: sourceWorkspace.kind,
-    checkedName: sourceWorkspace.checkedName,
-    contentLabel: sourceWorkspace.contentLabel,
-    config: sourceConfig,
-    contentFiles,
-    sourceFiles,
-    componentUsage,
-    summary: {
-      sourceKind: sourceWorkspace.kind,
-      sourceFiles: contentFiles.length,
-      mdxFiles: contentFiles.length,
-    },
-  };
-}
-
-export async function inspectRenderedOverflow({ root, config, host = "127.0.0.1", port = "5186" }) {
-  const server = await startStaticServer(root, config, host, port);
-  try {
-    return await evaluateUrlWithChrome({
-      root,
-      url: `http://${host}:${port}/?print=1`,
-      debuggingPortBase: 9900,
-      debuggingPortRange: 600,
-      profilePrefix: "chrome-inspect",
-      emulatedMedia: "print",
-      evaluate: waitForInspectionReady,
-    });
-  } finally {
-    await stopChildProcess(server);
-  }
-}
-
-export async function waitForInspectionReady(client) {
-  const deadline = Date.now() + 30000;
-  while (Date.now() < deadline) {
-    const result = await client.send("Runtime.evaluate", {
-      returnByValue: true,
-      awaitPromise: true,
-      expression: inspectionExpression(),
-    });
-    const value = result.result?.value;
-    if (Array.isArray(value)) return value;
-    await delay(100);
-  }
-  throw new Error("Timed out waiting for OpenPress pagination before inspection.");
-}
-
-export function overflowIssuesFromMeasurements(measurements) {
-  return measurements.flatMap((page) => {
-    const pageLabel = String(page.pageNumber).padStart(2, "0");
-    return (page.overflows ?? []).map((overflow) => createIssue({
-      level: "warning",
-      code: `overflow.${overflow.code}`,
-      message: `Page ${pageLabel} exceeds ${humanOverflowTarget(overflow.code)} by ${Math.ceil(overflow.overflowPx)}px.`,
-      path: page.source?.path,
-      detail: {
-        pageNumber: page.pageNumber,
-        title: page.title,
-        sourceFile: page.source?.file,
-        selector: overflow.selector,
-        tagName: overflow.tagName,
-        text: overflow.text,
-        overflowPx: Math.ceil(overflow.overflowPx),
-      },
-    }));
-  });
-}
-
-async function readSourceFiles(directory, extension = null) {
-  const files = [];
-  await walkFiles(directory, async (absolutePath) => {
-    if (extension && path.extname(absolutePath) !== extension) return;
-    if (!SOURCE_EXTENSIONS.has(path.extname(absolutePath))) return;
-    files.push({
-      absolutePath,
-      relativePath: path.relative(directory, absolutePath).replaceAll("\\", "/"),
-      text: await fs.readFile(absolutePath, "utf8"),
-    });
-  });
-  files.sort((a, b) => a.relativePath.localeCompare(b.relativePath));
-  return files;
-}
-
-async function readSingleFile(absolutePath) {
-  try {
-    const text = await fs.readFile(absolutePath, "utf8");
-    return [{
-      absolutePath,
-      relativePath: path.basename(absolutePath),
-      text,
-    }];
-  } catch (error) {
-    if (error?.code === "ENOENT") return [];
-    throw error;
-  }
-}
-
-async function readMediaFiles(directory) {
-  const files = [];
-  await walkFiles(directory, async (absolutePath) => {
-    if (!MEDIA_EXTENSIONS.has(path.extname(absolutePath).toLowerCase())) return;
-    files.push({
-      absolutePath,
-      name: path.basename(absolutePath),
-      relativePath: path.relative(directory, absolutePath).replaceAll("\\", "/"),
-    });
-  });
-  files.sort((a, b) => a.relativePath.localeCompare(b.relativePath));
-  return files;
-}
-
-function summarizeComponentUsage(contentFiles) {
-  const usages = new Map();
-  for (const file of contentFiles) {
-    for (const match of file.text.matchAll(/<([A-Z][A-Za-z0-9]*)\b/g)) {
-      const name = match[1];
-      const current = usages.get(name) ?? { name, count: 0, files: [] };
-      current.count += 1;
-      if (!current.files.includes(file.relativePath)) current.files.push(file.relativePath);
-      usages.set(name, current);
-    }
-  }
-  return Array.from(usages.values()).sort((a, b) => a.name.localeCompare(b.name));
-}
-
-function humanOverflowTarget(code) {
-  if (code === "page-body") return "page body";
-  if (code === "page-frame") return "page frame";
-  return code.replaceAll("-", " ");
-}
-
-function inspectionExpression() {
-  return `Promise.resolve().then(async () => {
-    const root = document.querySelector('[data-openpress-print-document="true"]');
-    if (!root || root.querySelectorAll('.openpress-html-page').length === 0) return null;
-
-    await document.fonts?.ready;
-    await Promise.all(Array.from(document.images).map(async (img) => {
-      if (!img.complete) {
-        await new Promise((resolve) => {
-          const settle = () => {
-            img.removeEventListener('load', settle);
-            img.removeEventListener('error', settle);
-            resolve();
-          };
-          img.addEventListener('load', settle, { once: true });
-          img.addEventListener('error', settle, { once: true });
-        });
-      }
-      await img.decode?.().catch(() => undefined);
-    }));
-    await new Promise((resolve) => requestAnimationFrame(() => requestAnimationFrame(resolve)));
-
-    const textFor = (element) => (element?.textContent || '').replace(/\\s+/g, ' ').trim().slice(0, 120);
-    const overflowAmount = (outer, inner) => {
-      if (!outer || !inner) return 0;
-      const outerRect = outer.getBoundingClientRect();
-      const innerRect = inner.getBoundingClientRect();
-      return Math.max(0, innerRect.bottom - outerRect.bottom, innerRect.right - outerRect.right);
-    };
-    const contentBottomOverflow = (body) => {
-      if (!body) return 0;
-      const bodyRect = body.getBoundingClientRect();
-      const contentBottom = Array.from(body.children).reduce((bottom, child) => {
-        if (getComputedStyle(child).display === 'none') return bottom;
-        const marginBottom = Number.parseFloat(getComputedStyle(child).marginBottom) || 0;
-        return Math.max(bottom, child.getBoundingClientRect().bottom + marginBottom);
-      }, bodyRect.top);
-      return Math.max(0, contentBottom - bodyRect.bottom);
-    };
-    const addElementOverflow = (overflows, code, selector, container, element) => {
-      const px = overflowAmount(container, element);
-      if (px <= 1) return;
-      overflows.push({
-        code,
-        selector,
-        overflowPx: Math.ceil(px),
-        tagName: element.tagName,
-        text: textFor(element),
-      });
-    };
-
-    const wrappers = Array.from(document.querySelectorAll('.openpress-public-page > .openpress-html-page'));
-    if (wrappers.length === 0) return null;
-    return wrappers.map((wrapper, index) => {
-      const page = wrapper.querySelector('.reader-page') || wrapper;
-      const frame = page.querySelector('.page-frame') || page;
-      const body = page.querySelector('.page-body') || frame;
-      const sourcePath = wrapper.getAttribute('data-source-path') || undefined;
-      const sourceFile = wrapper.getAttribute('data-source-file') || sourcePath?.split('/').pop();
-      const overflows = [];
-      const bodyOverflow = contentBottomOverflow(body);
-      if (bodyOverflow > 1) {
-        overflows.push({
-          code: 'page-body',
-          selector: '.page-body',
-          overflowPx: Math.ceil(bodyOverflow),
-          tagName: body.tagName,
-          text: textFor(body),
-        });
-      }
-      addElementOverflow(overflows, 'page-frame', '.page-frame', page, frame);
-      body.querySelectorAll('table, img, pre, figure, [data-openpress-component]').forEach((element) => {
-        const tag = element.tagName.toLowerCase();
-        addElementOverflow(overflows, tag, tag, body, element);
-      });
-      return {
-        pageNumber: index + 1,
-        title: page.getAttribute('data-page-title') || wrapper.getAttribute('aria-label') || '',
-        source: sourcePath ? { file: sourceFile, path: sourcePath } : undefined,
-        overflows,
-      };
-    });
-  })`;
-}
-
-function delay(ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}

package/template/core/engine/runtime/issue-report.mjs

@@ -1,44 +0,0 @@
-export function createIssue({ level = "warning", code, message, path = null, detail = undefined }) {
-  return {
-    level,
-    code,
-    message,
-    ...(path ? { path } : {}),
-    ...(detail !== undefined ? { detail } : {}),
-  };
-}
-
-export function createIssueReport({ kind, checked = [], issues = [], summary = undefined, okMessage = undefined }) {
-  const report = {
-    kind,
-    ok: issues.every((issue) => issue.level !== "error"),
-    checked,
-    issues,
-    ...(summary !== undefined ? { summary } : {}),
-  };
-  return {
-    ...report,
-    format() {
-      return formatIssueReport(report, { okMessage });
-    },
-  };
-}
-
-export function exitCodeForIssueReport(report) {
-  return report.ok ? 0 : 1;
-}
-
-export function formatIssueReport(report, { okMessage } = {}) {
-  if (report.issues.length === 0) return okMessage ?? `${capitalize(report.kind)} OK`;
-  return report.issues.map(formatIssue).join("\n");
-}
-
-function formatIssue(issue) {
-  const suffix = issue.path ? ` (${issue.path})` : "";
-  return `[${issue.level}] ${issue.code}: ${issue.message}${suffix}`;
-}
-
-function capitalize(value) {
-  const text = String(value ?? "");
-  return text ? `${text.charAt(0).toUpperCase()}${text.slice(1)}` : "Report";
-}

package/template/core/engine/runtime/path-utils.mjs

@@ -1,20 +0,0 @@
-import path from "node:path";
-
-export function rootRelativePath(config, absolutePath) {
-  return path.relative(config.root, absolutePath).replaceAll("\\", "/");
-}
-
-export function documentRelativePath(absolutePath, documentRoot) {
-  return path.relative(documentRoot, absolutePath).split(path.sep).join("/");
-}
-
-export function resolveDocumentRelativePath(documentRoot, rel, label) {
-  if (typeof rel !== "string" || !rel.trim()) throw new Error(`${label} must be a non-empty document-relative path.`);
-  if (rel.includes("..")) throw new Error(`${label} contains "..", rejected.`);
-  const absolutePath = path.resolve(documentRoot, rel);
-  const relCheck = path.relative(documentRoot, absolutePath);
-  if (relCheck.startsWith("..") || path.isAbsolute(relCheck)) {
-    throw new Error(`${label} escapes the document root.`);
-  }
-  return absolutePath;
-}

package/template/core/engine/runtime/source-text-tools.d.mts

@@ -1,102 +0,0 @@
-import type { ResolvedConfig } from "./config.mjs";
-
-export type SourceTextScope = "content" | "all";
-
-export type SourceTextMatch = {
-  id: string;
-  scope: string;
-  file: string;
-  path: string;
-  line: number;
-  column: number;
-  index: number;
-  text: string;
-  preview: string;
-};
-
-export type SourceTextFileSummary = {
-  scope: string;
-  file: string;
-  path: string;
-  matchCount: number;
-};
-
-export type SourceSearchReport = {
-  kind: "search";
-  query: string;
-  scope: SourceTextScope;
-  caseSensitive: boolean;
-  matchCount: number;
-  files: Array<SourceTextFileSummary>;
-  matches: Array<SourceTextMatch>;
-};
-
-export type SourceBlockTextEditInput = {
-  config: ResolvedConfig;
-  path: string;
-  source: {
-    line: number;
-    column?: number;
-    endLine?: number;
-    endColumn?: number;
-  };
-  text: string;
-  kind?: string;
-  name?: string;
-  blockId?: string;
-  cellIndex?: number;
-  sourceMode?: boolean;
-};
-
-export type SourceBlockTextEdit = {
-  blockId?: string;
-  path: string;
-  requestedPath: string;
-  file: string;
-  line: number;
-  column: number;
-  endLine: number;
-  endColumn: number;
-  before: string;
-  after: string;
-  text: string;
-  cellIndex?: number;
-};
-
-export function searchSourceText(options: {
-  config: ResolvedConfig;
-  query: string;
-  scope?: SourceTextScope;
-  caseSensitive?: boolean;
-}): Promise<SourceSearchReport>;
-
-export function applySourceBlockTextEdit(options: SourceBlockTextEditInput): Promise<SourceBlockTextEdit>;
-
-export function applySourceBlockTextEditToText(documentText: string, options: Omit<SourceBlockTextEditInput, "config" | "path">): {
-  text: string;
-  edit: Omit<SourceBlockTextEdit, "path" | "requestedPath" | "file">;
-};
-
-export function readSourceBlockText(options: Pick<SourceBlockTextEditInput, "config" | "path" | "source">): Promise<{
-  path: string;
-  requestedPath: string;
-  file: string;
-  text: string;
-}>;
-
-export function readSourceBlockTextFromText(documentText: string, options: Pick<SourceBlockTextEditInput, "source">): string;
-
-export function applySourceBlockSourceEditToText(documentText: string, options: Pick<SourceBlockTextEditInput, "source" | "text" | "blockId">): {
-  text: string;
-  edit: Omit<SourceBlockTextEdit, "path" | "requestedPath" | "file">;
-};
-
-export function collectSourceTextFiles(config: ResolvedConfig, options?: {
-  scope?: SourceTextScope;
-}): Promise<Array<{
-  scope: string;
-  name: string;
-  absolutePath: string;
-  relativePath: string;
-  text: string;
-}>>;