@open-press/cli 0.8.0 → 1.1.0

package/template/core/engine/runtime/source-workspace.mjs

@@ -1,159 +0,0 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import { loadReactDocumentEntry } from "../react/document-entry.mjs";
-import { walkFiles } from "./file-walk.mjs";
-import { resolveDocumentRelativePath, rootRelativePath } from "./path-utils.mjs";
-
-export { rootRelativePath };
-
-export const REACT_MDX_CONTENT_EXTENSIONS = new Set([".mdx"]);
-
-export async function resolveActiveSourceWorkspace(config) {
-  const reactEntry = await loadReactDocumentEntry(config.root);
-  if (!reactEntry) {
-    throw new Error(
-      "React/MDX document entry not found. Expected document/index.tsx with a Press default export before using workspace source tools.",
-    );
-  }
-  const contentRoots = contentRootsFromSources(reactEntry.sources, reactEntry.config);
-  const sourceDir = firstDirectoryRoot(contentRoots) ?? reactEntry.config.paths.documentRoot;
-
-  return {
-    kind: "react-mdx",
-    checkedName: "react-source",
-    config: reactEntry.config,
-    entryPath: reactEntry.entryPath,
-    sourceDir,
-    contentRoots,
-    contentExtensions: REACT_MDX_CONTENT_EXTENSIONS,
-    contentLabel: "React MDX chapter source",
-    missingCode: "react-source.missing",
-    emptyCode: "react-source.empty",
-    missingMessage: "Registered React MDX sources do not exist yet; create the files or roots declared in document/index.tsx `sources` before running export.",
-    emptyMessage: "Registered React MDX sources contain no `*.mdx` files; the document will export with zero source blocks.",
-  };
-}
-
-export async function collectActiveContentFiles(sourceWorkspace, { skipUnderscoreFiles = false } = {}) {
-  const files = [];
-  const seen = new Set();
-  for (const root of sourceWorkspace.contentRoots ?? [{ kind: "dir", absolutePath: sourceWorkspace.sourceDir }]) {
-    const visit = async (absolutePath) => {
-      if (seen.has(absolutePath)) return;
-      if (!sourceWorkspace.contentExtensions.has(path.extname(absolutePath))) return;
-      const name = path.basename(absolutePath);
-      if (skipUnderscoreFiles && name.startsWith("_")) return;
-      seen.add(absolutePath);
-      files.push({
-        absolutePath,
-        name,
-        relativePath: rootRelativePath(sourceWorkspace.config, absolutePath),
-        sourceRelativePath: path.relative(root.basePath ?? path.dirname(absolutePath), absolutePath).replaceAll("\\", "/"),
-        text: await fs.readFile(absolutePath, "utf8"),
-      });
-    };
-    if (root.kind === "file") {
-      try {
-        const stat = await fs.stat(root.absolutePath);
-        if (stat.isFile()) await visit(root.absolutePath);
-      } catch (error) {
-        if (error?.code !== "ENOENT") throw error;
-      }
-      continue;
-    }
-    await walkFiles(root.absolutePath, visit);
-  }
-  files.sort((a, b) => a.relativePath.localeCompare(b.relativePath));
-  return files;
-}
-
-export async function sourceDirectoryExists(sourceWorkspace) {
-  const roots = sourceWorkspace.contentRoots ?? [{ kind: "dir", absolutePath: sourceWorkspace.sourceDir }];
-  for (const root of roots) {
-    try {
-      const stat = await fs.stat(root.absolutePath);
-      if (root.kind === "file" ? stat.isFile() : stat.isDirectory()) return true;
-    } catch (error) {
-      if (error?.code === "ENOENT") continue;
-      throw error;
-    }
-  }
-  return false;
-}
-
-function contentRootsFromSources(sources, config) {
-  const entries = Object.entries(sources ?? {});
-  if (entries.length === 0) {
-    return [{
-      kind: "dir",
-      absolutePath: config.paths.sourceDir,
-      basePath: config.paths.sourceDir,
-      sourceId: "default",
-      preset: "section-folders",
-    }];
-  }
-
-  const roots = [];
-  for (const [sourceId, descriptor] of entries) {
-    if (!descriptor || descriptor.type !== "mdx") continue;
-    if (descriptor.preset === "section-folders") {
-      roots.push(directoryRoot(config, descriptor.root ?? "chapters", sourceId, descriptor.preset));
-      continue;
-    }
-    if (descriptor.preset === "section-files") {
-      roots.push(directoryRoot(config, descriptor.root ?? "content", sourceId, descriptor.preset));
-      continue;
-    }
-    if (descriptor.preset === "file-list") {
-      for (const file of descriptor.files ?? []) {
-        roots.push(fileRoot(config, file, sourceId, descriptor.preset));
-      }
-      continue;
-    }
-  }
-  return dedupeRoots(roots);
-}
-
-function directoryRoot(config, rel, sourceId, preset) {
-  const absolutePath = resolveDocumentRelativePath(config.paths.documentRoot, rel, `Source "${sourceId}" ${preset} root`);
-  return {
-    kind: "dir",
-    absolutePath,
-    basePath: absolutePath,
-    sourceId,
-    preset,
-  };
-}
-
-function fileRoot(config, rel, sourceId, preset) {
-  if (typeof rel !== "string" || !rel.trim()) {
-    throw new Error(`Source "${sourceId}" file-list contains an empty or invalid entry.`);
-  }
-  if (!rel.endsWith(".mdx")) {
-    throw new Error(`Source "${sourceId}" file-list path "${rel}" must end with .mdx.`);
-  }
-  const absolutePath = resolveDocumentRelativePath(config.paths.documentRoot, rel, `Source "${sourceId}" file-list path "${rel}"`);
-  return {
-    kind: "file",
-    absolutePath,
-    basePath: path.dirname(absolutePath),
-    sourceId,
-    preset,
-  };
-}
-
-function dedupeRoots(roots) {
-  const seen = new Set();
-  const out = [];
-  for (const root of roots) {
-    const key = `${root.kind}:${root.absolutePath}`;
-    if (seen.has(key)) continue;
-    seen.add(key);
-    out.push(root);
-  }
-  return out;
-}
-
-function firstDirectoryRoot(roots) {
-  return roots.find((root) => root.kind === "dir")?.absolutePath ?? null;
-}

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

@@ -1,174 +0,0 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import { loadConfig } from "./config.mjs";
-import { createIssue, createIssueReport } from "./issue-report.mjs";
-import { collectSourceTextFiles } from "./source-text-tools.mjs";
-import { collectActiveContentFiles, resolveActiveSourceWorkspace, sourceDirectoryExists } from "./source-workspace.mjs";
-
-// Adapters that publish the document to a URL anyone on the internet can reach.
-// `deploy.requiresConfirmation: true` is mandatory for these so an automated
-// pipeline (or a careless command) cannot ship without an explicit human step.
-// Adapters not in this set (local file copy, custom in-house tooling, null)
-// can opt out of the confirmation gate.
-const PUBLIC_DEPLOY_ADAPTERS = new Set([
-  "cloudflare-pages",
-  "github-pages",
-  "netlify",
-  "vercel",
-]);
-
-export async function discoverWorkspace(startPath = ".") {
-  let current = path.resolve(startPath);
-  try {
-    const stat = await fs.stat(current);
-    if (!stat.isDirectory()) current = path.dirname(current);
-  } catch {
-    current = path.dirname(current);
-  }
-  while (true) {
-    const configPath = path.join(current, "openpress.config.mjs");
-    try {
-      await fs.access(configPath);
-      return current;
-    } catch {
-      const parent = path.dirname(current);
-      if (parent === current) throw new Error(`No OpenPress workspace found from ${startPath}`);
-      current = parent;
-    }
-  }
-}
-
-export async function validateWorkspace(root) {
-  const config = await loadConfig(root);
-  const sourceWorkspace = await resolveActiveSourceWorkspace(config);
-  const activeConfig = sourceWorkspace.config;
-  const issues = [];
-  const checked = [];
-  const mark = (name) => {
-    if (!checked.includes(name)) checked.push(name);
-  };
-  const add = (level, code, message, filePath = null, detail = undefined) => issues.push(createIssue({ level, code, message, path: filePath, detail }));
-
-  mark("config");
-  for (const [key, target] of [
-    ["sourceDir", sourceWorkspace.sourceDir],
-    ["mediaDir", activeConfig.paths.mediaDir],
-    ["themeDir", activeConfig.paths.themeDir],
-    ["designDoc", activeConfig.paths.designDoc],
-    ["componentsDir", activeConfig.paths.componentsDir],
-  ]) {
-    if (!(await exists(target))) add("error", `config.${key}`, `Configured OpenPress path \`${key}\` does not exist.`, target);
-  }
-
-  mark("design-doc");
-  const designDoc = activeConfig.paths.designDoc;
-  if (!(await exists(designDoc))) {
-    add("error", "design-doc.missing", "Design document must exist.", designDoc);
-  }
-
-  mark("deploy-gate");
-  if (PUBLIC_DEPLOY_ADAPTERS.has(config.deploy.adapter) && config.deploy.requiresConfirmation !== true) {
-    add(
-      "error",
-      "deploy.confirmation",
-      `Public deploy adapter \`${config.deploy.adapter}\` must require user confirmation (set deploy.requiresConfirmation: true).`,
-      config.configPath,
-    );
-  }
-
-  mark(sourceWorkspace.checkedName);
-  if (!(typeof activeConfig.title === "string" && activeConfig.title.trim())) {
-    add("warning", "config.title", "openpress.config.mjs `title` is empty; the workbench will show the default placeholder.", activeConfig.configPath);
-  }
-  if (!(await sourceDirectoryExists(sourceWorkspace))) {
-    add("warning", sourceWorkspace.missingCode, sourceWorkspace.missingMessage, sourceWorkspace.sourceDir);
-  } else {
-    const contentFiles = await collectActiveContentFiles(sourceWorkspace, { skipUnderscoreFiles: true });
-    if (contentFiles.length === 0) {
-      add("warning", sourceWorkspace.emptyCode, sourceWorkspace.emptyMessage, sourceWorkspace.sourceDir);
-    }
-  }
-
-  if (sourceWorkspace.kind === "react-mdx") {
-    mark("react-comments");
-    const sourceFiles = await collectSourceTextFiles(activeConfig, { scope: "all" });
-    for (const file of sourceFiles) {
-      for (const marker of findCommentMarkers(file.text)) {
-        add(
-          "warning",
-          "react-comments.pending",
-          `Pending OpenPress comment \`${marker.id}\` remains in React source; run apply-comments or resolve it manually before publishing.`,
-          file.absolutePath,
-          {
-            id: marker.id,
-            line: marker.line,
-            path: file.path ?? file.relativePath,
-          },
-        );
-      }
-    }
-  }
-
-  mark("react-source");
-  const documentJsonPath = path.join(activeConfig.paths.publicDir, "document.json");
-  const exportedDocument = await readJsonIfExists(documentJsonPath);
-  const pressWarnings = exportedDocument?.source?.warnings;
-  if (Array.isArray(pressWarnings)) {
-    for (const warning of pressWarnings) {
-      const code = typeof warning?.code === "string" && warning.code ? warning.code : "warning";
-      add(
-        "warning",
-        `react-source.${code}`,
-        pressWarningMessage(warning),
-        documentJsonPath,
-        warning,
-      );
-    }
-  }
-
-  return createIssueReport({
-    kind: "validation",
-    checked,
-    issues,
-    okMessage: "OpenPress validation OK",
-  });
-}
-
-function findCommentMarkers(text) {
-  const markers = [];
-  const lines = String(text ?? "").split(/\r?\n/);
-  for (const [index, line] of lines.entries()) {
-    const match = line.match(/@openpress-comment\b[^}]*\bid="([^"]+)"/);
-    if (!match) continue;
-    markers.push({ id: match[1], line: index + 1 });
-  }
-  return markers;
-}
-
-function pressWarningMessage(warning) {
-  if (warning?.code === "chain-overflowed") {
-    return `Content chain \`${warning.chainId ?? "(unknown)"}\` overflowed during Press Tree allocation.`;
-  }
-  if (warning?.code === "chain-has-no-area") {
-    return `Content chain \`${warning.chainId ?? "(unknown)"}\` has blocks but no matching MdxArea.`;
-  }
-  return `Press Tree export warning: ${warning?.code ?? "warning"}.`;
-}
-
-async function readJsonIfExists(filePath) {
-  try {
-    return JSON.parse(await fs.readFile(filePath, "utf8"));
-  } catch (error) {
-    if (error?.code === "ENOENT") return null;
-    throw error;
-  }
-}
-
-async function exists(filePath) {
-  try {
-    await fs.access(filePath);
-    return true;
-  } catch {
-    return false;
-  }
-}

package/template/core/index.html

@@ -1,13 +0,0 @@
-<!doctype html>
-<html lang="zh-Hant">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
-    <title>OpenPress Workspace</title>
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-  </body>
-</html>

package/template/core/openpress.config.mjs

@@ -1,12 +0,0 @@
-// Root pointer. The real workspace config lives at document/openpress.config.mjs.
-//
-// document/ is git-ignored in this framework checkout. Populate it locally
-// from a style pack's React/MDX document starter:
-//   cp -R skills/editorial-monograph/starter/document/. document/
-// Or create a separate workspace:
-//   node engine/cli.mjs init ../my-openpress-document
-
-export default {
-  documentDir: "document",
-  config: "document/openpress.config.mjs",
-};

package/template/core/package.json

@@ -1,91 +0,0 @@
-{
-  "name": "@open-press/core",
-  "version": "0.8.0",
-  "type": "module",
-  "description": "open-press core — runtime primitives, CLI, and render pipeline for AI-first fixed-layout documents.",
-  "license": "MIT",
-  "author": "quan0715",
-  "homepage": "https://github.com/quan0715/open-press#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/quan0715/open-press.git",
-    "directory": "packages/core"
-  },
-  "bugs": {
-    "url": "https://github.com/quan0715/open-press/issues"
-  },
-  "keywords": [
-    "document",
-    "mdx",
-    "react",
-    "pdf",
-    "a4",
-    "fixed-layout",
-    "ai-first"
-  ],
-  "main": "./src/openpress/core/index.tsx",
-  "types": "./src/openpress/core/index.tsx",
-  "exports": {
-    ".": "./src/openpress/core/index.tsx",
-    "./mdx": "./src/openpress/mdx/index.ts",
-    "./manuscript": "./src/openpress/manuscript/index.tsx",
-    "./numbering": "./src/openpress/numbering/index.ts"
-  },
-  "bin": {
-    "open-press": "engine/cli.mjs"
-  },
-  "files": [
-    "engine",
-    "src/openpress",
-    "src/styles",
-    "index.html",
-    "vite.config.ts",
-    "tsconfig.json"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "dev": "node engine/cli.mjs dev . --renderer react",
-    "build": "node engine/cli.mjs render . --renderer react",
-    "preview": "node engine/cli.mjs preview . --renderer react",
-    "typecheck": "node engine/cli.mjs typecheck .",
-    "test": "pnpm run test:node && pnpm run test:react",
-    "test:e2e:reader": "playwright test --config playwright.reader.config.ts",
-    "test:node": "node --test tests/*.test.mjs",
-    "test:react": "vitest run",
-    "openpress:validate": "node engine/cli.mjs validate .",
-    "openpress:export": "node engine/cli.mjs export .",
-    "openpress:pdf": "node engine/cli.mjs pdf .",
-    "openpress:render": "node engine/cli.mjs render . --renderer react",
-    "openpress:preview": "node engine/cli.mjs preview . --renderer react",
-    "openpress:deploy": "node engine/cli.mjs deploy .",
-    "openpress:deploy:dry-run": "node engine/cli.mjs deploy . --confirm --dry-run"
-  },
-  "dependencies": {
-    "@mdx-js/mdx": "^3.1.1",
-    "@mdx-js/react": "^3.1.1",
-    "js-yaml": "^4.1.1",
-    "katex": "^0.16.47",
-    "lucide-react": "^1.16.0",
-    "playwright": "^1.60.0",
-    "postcss": "^8.5.6",
-    "react": "^19.2.6",
-    "react-dom": "^19.2.6",
-    "rehype-katex": "^7.0.1",
-    "remark-gfm": "^4.0.1",
-    "remark-math": "^6.0.0"
-  },
-  "devDependencies": {
-    "@playwright/test": "^1.60.0",
-    "@testing-library/react": "^16.3.2",
-    "@types/node": "^25.8.0",
-    "@types/react": "^19.2.14",
-    "@types/react-dom": "^19.2.3",
-    "@vitejs/plugin-react": "^6.0.2",
-    "jsdom": "^26.1.0",
-    "typescript": "^6.0.3",
-    "vite": "^8.0.13",
-    "vitest": "^4.1.6"
-  }
-}

package/template/core/src/main.tsx

@@ -1,16 +0,0 @@
-import { StrictMode } from "react";
-import { createRoot } from "react-dom/client";
-import { OpenPressApp } from "./openpress/app";
-import "./styles/openpress.css";
-
-const rootElement = document.getElementById("root");
-
-if (!rootElement) {
-  throw new Error("OpenPress renderer requires a #root element.");
-}
-
-createRoot(rootElement).render(
-  <StrictMode>
-    <OpenPressApp />
-  </StrictMode>,
-);

package/template/core/src/openpress/app/OpenPressApp.tsx

@@ -1,140 +0,0 @@
-import { useCallback, useEffect, useState } from "react";
-import { OpenPressRuntime } from "./OpenPressRuntime";
-import { isLocalWorkspaceHost } from "../shared";
-import type { DeploymentInfo, ReaderDocument } from "../document-model";
-
-type LoadState =
-  | { status: "loading" }
-  | {
-      status: "ready";
-      document: ReaderDocument;
-      deploymentInfo: DeploymentInfo;
-    }
-  | { status: "error"; message: string };
-
-interface DeployConfig {
-  pdf?: string;
-  deployed_at?: string;
-  public_url?: string;
-  dirty?: boolean;
-  deploy_configured?: boolean;
-  deploy_adapter?: string;
-  deploy_source?: string;
-  deploy_project_name?: string | null;
-  deploy_setup_message?: string;
-}
-
-const offlineDeploymentInfo: DeploymentInfo = { online: false };
-
-function LoadingScreen() {
-  return (
-    <div className="openpress-loading-screen" aria-label="載入中" role="status">
-      <div className="openpress-loading-screen__inner">
-        <div className="openpress-loading-dots" aria-hidden="true">
-          <span /><span /><span />
-        </div>
-        <span className="openpress-loading-screen__label">載入文件</span>
-      </div>
-    </div>
-  );
-}
-
-export function OpenPressApp() {
-  const [state, setState] = useState<LoadState>({ status: "loading" });
-
-  const refreshDocument = useCallback(async () => {
-    const document = await loadReaderDocument();
-    setState((current) => {
-      if (current.status !== "ready") return current;
-      return { ...current, document };
-    });
-  }, []);
-
-  useEffect(() => {
-    let cancelled = false;
-
-    async function loadDocument() {
-      try {
-        const [document, deploymentInfo] = await Promise.all([
-          loadReaderDocument(),
-          loadDeploymentInfo(),
-        ]);
-        if (!cancelled) {
-          setState({ status: "ready", document, deploymentInfo });
-        }
-      } catch (error) {
-        if (!cancelled) {
-          setState({
-            status: "error",
-            message: error instanceof Error ? error.message : "Unable to load OpenPress document.",
-          });
-        }
-      }
-    }
-
-    void loadDocument();
-    return () => {
-      cancelled = true;
-    };
-  }, []);
-
-  if (state.status === "loading") return <LoadingScreen />;
-
-  if (state.status === "error") {
-    return <div className="openpress-load-state openpress-load-state--error">{state.message}</div>;
-  }
-
-  return (
-    <OpenPressRuntime
-      document={state.document}
-      deploymentInfo={state.deploymentInfo}
-      onDocumentRefresh={refreshDocument}
-    />
-  );
-}
-
-async function loadReaderDocument(): Promise<ReaderDocument> {
-  const response = await fetch("/openpress/document.json", { cache: "no-store" });
-  if (!response.ok) {
-    throw new Error(`Unable to load /openpress/document.json (${response.status})`);
-  }
-  return (await response.json()) as ReaderDocument;
-}
-
-async function loadDeploymentInfo(): Promise<DeploymentInfo> {
-  if (typeof window !== "undefined" && isLocalWorkspaceHost(window.location.hostname)) {
-    const localInfo = await loadDeploymentInfoFrom("/__openpress/status");
-    if (localInfo) return localInfo;
-  }
-
-  return (await loadDeploymentInfoFrom("/openpress/deploy.json")) ?? offlineDeploymentInfo;
-}
-
-async function loadDeploymentInfoFrom(path: string): Promise<DeploymentInfo | null> {
-  try {
-    const response = await fetch(path, { cache: "no-store" });
-    if (!response.ok) {
-      return null;
-    }
-    const config = (await response.json()) as DeployConfig;
-    return deploymentConfigToInfo(config);
-  } catch {
-    return null;
-  }
-}
-
-function deploymentConfigToInfo(config: DeployConfig): DeploymentInfo {
-  const configured = config.deploy_configured !== false;
-  return {
-    online: configured && Boolean(config.deployed_at || config.public_url),
-    deployedAt: config.deployed_at,
-    pdf: typeof config.pdf === "string" ? config.pdf : undefined,
-    publicUrl: typeof config.public_url === "string" ? config.public_url : undefined,
-    dirty: config.dirty === true,
-    configured,
-    adapter: typeof config.deploy_adapter === "string" ? config.deploy_adapter : undefined,
-    source: typeof config.deploy_source === "string" ? config.deploy_source : undefined,
-    projectName: typeof config.deploy_project_name === "string" ? config.deploy_project_name : undefined,
-    setupMessage: typeof config.deploy_setup_message === "string" ? config.deploy_setup_message : undefined,
-  };
-}