Skip to content

CHANGELOG.md

Latest commit

 

History

History
322 lines (205 loc) · 15 KB

CHANGELOG.md

File metadata and controls

322 lines (205 loc) · 15 KB
Raw

@open-press/cli

3.0.3

Patch Changes

  • Updated dependencies [2b64a11]
  • Updated dependencies [8ffa2a4]
  • Updated dependencies [f450eaf]
  • Updated dependencies [8d42c06]
  • Updated dependencies [137db83]
    • @open-press/core@3.0.3

3.0.2

Patch Changes

  • Updated dependencies [a58fbb1]
    • @open-press/core@3.0.2

3.0.1

Patch Changes

  • Updated dependencies [552abcd]
    • @open-press/core@3.0.1

3.0.0

Patch Changes

  • Updated dependencies [079d75c]
  • Updated dependencies [079d75c]
    • @open-press/core@3.0.0

2.0.5

Patch Changes

  • Updated dependencies [36726b0]
    • @open-press/core@2.0.5

2.0.4

Patch Changes

  • 4fcd954: Clean the workspace object authoring API around frame keys, labels, theme tokens, and slide template scaffolds.
  • Updated dependencies [4fcd954]
    • @open-press/core@2.0.4

2.0.3

Patch Changes

  • Updated dependencies [3674b30]
    • @open-press/core@2.0.3

2.0.2

Patch Changes

  • 9edc747: Finalize the release-bound Press CSS and skill boundary: scope exported CSS per Press, keep generic page shell/prose/print behavior framework-owned, retire bundled starter skills from the active catalog, and document custom Press geometry for project-specific formats.
  • Updated dependencies [9edc747]
    • @open-press/core@2.0.2

2.0.1

Patch Changes

  • @open-press/core@2.0.1

2.0.0

Major Changes

  • Release the CLI alongside the Tailwind-first OpenPress 2.0 runtime. Workspace commands continue to delegate into @open-press/core, while generated slide workspaces now align with protocol layouts and the shared op-* slide style layer.
  • Treat @open-press/create, @open-press/cli, and @open-press/core as one release train for major framework updates.

Patch Changes

  • Updated dependencies
    • @open-press/core@2.0.0

1.2.1

Patch Changes

  • Updated dependencies [10130dd]
    • @open-press/core@1.2.1

1.2.0

Patch Changes

  • Updated dependencies [b4248f6]
  • Updated dependencies [7ba9434]
  • Updated dependencies [c11b33b]
  • Updated dependencies [0f01b4b]
  • Updated dependencies [d97f282]
  • Updated dependencies [9c6fd9b]
  • Updated dependencies [99d7c34]
    • @open-press/core@1.2.0

1.1.4

Patch Changes

  • Updated dependencies [408f6f4]
    • @open-press/core@1.1.4

1.1.3

Patch Changes

  • Updated dependencies [39bbf0d]
  • Updated dependencies [68435a1]
  • Updated dependencies [2eac5df]
    • @open-press/core@1.1.3

1.1.2

Patch Changes

  • 11dbcb1: Fix workbench routing and slide thumbnail overflow. The dev URL now opens /workspace, document previews use /<press-slug>/preview, and thumbnail navigation scrolls within the left panel without overlapping the page counter.
  • Updated dependencies [11dbcb1]
    • @open-press/core@1.1.2

1.1.1

Patch Changes

  • Generate a package-owned TypeScript project config for workspaces that do not vendor tsconfig.json.
  • Updated dependencies
    • @open-press/core@1.1.1

1.1.0

Minor Changes

  • Move OpenPress workspaces to a package-owned runtime model.

    The CLI now scaffolds a workspace that depends on @open-press/core and @open-press/cli instead of copying framework internals such as engine/, src/openpress/, index.html, and vite.config.ts into the user project. Runtime commands exposed by open-press delegate into @open-press/core, whose packaged Vite entry, browser shell, render engine, and static server are used directly from node_modules.

Patch Changes

  • Updated dependencies
    • @open-press/core@1.1.0

1.0.0

Major Changes

  • 8c528ad: 1.0 contract release. Breaking changes:

    • <Workspace> is now required at the root of press/index.tsx; <Press> lives as a child, and multi-Press workspaces are first-class (each <Press> exports to /openpress/<slug>/document.json).
    • Document metadata (title / subtitle / organization / page / sources / captionNumbering) moves onto <Press> JSX props. export const config and export const sources are removed.
    • openpress.config.mjs is removed. Operational settings (deploy / pdf) live in the workspace package.json under the "openpress" field; paths are convention (press/, press/<slug>/chapters/, press/theme/, public/openpress/, dist-react/).
    • Workspace folder renamed from document/ → press/. The dogfood and starter skills are migrated.
    • Reader gains a workspace gallery for multi-Press projects, per-page PNG export, page thumbnails for canvas-style Press, and a back-to-workspace button.
    • New built-in page presets a4, social-square, slide-16-9 and improved scaffold metadata propagation.

  • 03017cd: Remove the bundled social-post and slide-deck starter-bearing skills from the framework repo. Social-card projects should install the external skill instead:

    npx -y skills@latest add quan0715/openpress-social-card-skill

    The external social-card skill targets 1080x1350 (4:5 portrait), not the removed 1080x1080 square starter. There is no direct slide-deck replacement; initialize an OpenPress workspace without a removed pack name and edit the Press tree manually or use a dedicated external skill. Existing workspaces are unaffected.

0.8.0

Minor Changes

  • Tracks @open-press/core@0.8.0. The scaffolder ships the new module barrels (@open-press/core/{app,document-model,reader,shared,workbench}) and the refreshed workbench panel architecture.
  • The academic-paper starter is documented and surfaced alongside the existing editorial-monograph and claude-document starters.
  • CLI prerequisites are documented up front in docs/cli.md (Node 20+).

Patch Changes

  • Carries forward the 0.7.1 measurement + pagination fixes shipped via @open-press/core.

0.7.1

Patch Changes

  • Measurement pipeline + pagination fixes:
    • Measurement: wait on document.fonts.ready, image load/error + decode(), and two requestAnimationFrame ticks before sampling block heights so figures no longer under-measure on cold loads.
    • Measurement: inline relative media/, ./media/, and /openpress/media/ image sources during the SSR measurement pass (previously only the absolute /openpress/media/... form was rewritten, leaving relative refs as broken).
    • MDX compile: split bullet/numbered lists into per-item paginable blocks so long lists can break across pages without losing ordered numbering.
    • Debug: new OPENPRESS_DEBUG_ALLOC env var prints per-iteration allocator state (mdxArea capacities, block heights, pagination hints, warnings).
    • Academic-paper starter: <MdxArea overflow="extend"> on the body and the single-column .reader-page--content .page-body override removed so content paginates naturally with the new allocator.

0.7.0

Minor Changes

  • 718d2d1: Press Tree render architecture — full refresh of the React export pipeline (clean break, no v0.5 compatibility).

    The render kernel no longer knows about cover, toc, chapter, or back-cover as built-in concepts. Workspaces describe their document as a React tree using three primitives:

    • Press — root composition boundary.
    • Frame — a single fixed-layout surface (replaces BasePage and friends).
    • MdxArea — a measurable slot consuming a content chain, with overflow="extend|truncate|error" control.

    Sources are now declarative descriptors:

    export const sources = {
  story: mdxSource({ preset: "section-folders", root: "chapters" }),
};

export default function MyPress() {
  return (
    <Press>
      <Cover />
      <Toc source="story" />
      <Sections source="story" page={Page} />
      <BackCover />
    </Press>
  );
}

    Three mdxSource() presets: section-folders (existing convention), section-files (flat file-per-section), file-list (explicit ordering).

    Manuscript helpers (Toc, Sections, Chapters alias) ship in @open-press/core/manuscript. mdxSource() lives in @open-press/core/mdx. Subpath exports keep the public surface tight without committing to separate npm packages.

    Toc is implemented as a manuscript helper, not a core kernel special case. Registered sources generate a synthetic toc:<sourceId> chain; TocArea consumes it with the same allocation path as MdxArea.

    Reader-side pagination is removed. The export pipeline writes final frame HTML into document.json; the reader displays that HTML and no longer mutates headings/captions, injects footers, or reflows pages at runtime. Page shell belongs to workspace components.

    MDX source resolution now derives manuscript TOC entries from actual ## / ### headings, not folder slugs. Heading numbering is written during export as data-chapter="01" / data-section="1.1" attributes so themes can render numbering with CSS without reader-side mutation.

    Removed (no compatibility layer):

    • BasePage, BaseCoverPage, BaseTocPage, BaseContentPage, BaseBackCoverPage.
    • Legacy named exports (cover, toc, backCover) from document/index.tsx.
    • The migrate-to-react CLI command.
    • Implicit chapter discovery as the only source mechanism.
    • Legacy chapter.tsx meta/opener auto-discovery. Section openers are explicit workspace components in the Press tree.

    The top-level purity gate remains: config must be data, sources must be pure mdxSource() descriptors, and filesystem/network/process side effects are rejected before module execution. Default-exported function bodies can contain normal React component logic, including hooks and .map().

    All <Frame> instances require a stable frameKey; source roots and file-list entries must stay inside document/.

    Workspace data attributes:

    • data-frame-role (new, opaque role like "manuscript.content").
    • data-page-kind (derived from role's last segment — reader CSS keeps using this).
    • data-section-id replaces data-chapter-slug for section-scoped CSS.

    Migration: Workspaces written for v0.5.x must rewrite document/index.tsx to default-export a Press component. Pre-1.0 minor bump is acceptable per repo policy; no production deployments exist to break.

0.6.0

Minor Changes

  • f8fdecd: Third bundled pack: academic-paper.

    A single-column A4 academic / research paper starter — serif title block, abstract band, index terms, numbered sections (I, II, III), italic sub-sections (A, B, C), [N] numeric references, sample chapters derived from the IEEE conference template structure (Introduction, Methods, Results & Discussion, Acknowledgment, References).

    Suitable for: draft / preprint / iteration. Not suitable for camera-ready IEEE / ACM submission — those still need LaTeX with the publisher's class file.

    Two-column body and other paged-document features (footnotes, cross-references with page numbers, running headers) are intentionally out of scope for this release. They'll be designed as a self-maintained engine evolution + multi-mode architecture in a separate spec round, rather than depending on a third-party pagination polyfill.

  • c490653: The scaffolder accepts third-party style packs via --pack github:owner/repo.

    The cli fetches starter/document/ from the named repo (default branch, or #ref for a specific branch/tag) and copies it into the new workspace. If the pack repo also publishes SKILL files at skills/<name>/, they're installed via npx skills add <owner>/<repo> after the framework skills, so the agent picks them up automatically.

    Repo layout convention for third-party packs is documented in docs/style-pack-authoring.md. Empty-result extraction (the named repo exists but has no starter/document/ at root) fails with a clear error pointing at the expected layout.

    The two bundled packs (editorial-monograph, claude-document) keep their current short-name behaviour; only the cli's validator widened to accept the github: prefix.

0.5.0

Minor Changes

  • 0169cba: Agent-driven upgrade flow.

    New commands:

    • npx open-press doctor — diagnose workspace against latest framework state. Reports @open-press/core version vs npm latest, installed skill count, and any pending docs/migrations/<version>.md notes between current and latest. --json for machine-readable output, --no-cache to bypass the 24h cache. Always exits 0 (informational only).

    • npx open-press upgrade — orchestrate the upgrade. Runs npm update @open-press/core (when the workspace declares the dep) and npx skills upgrade, then surfaces the list of migration notes for the agent to read. Does not auto-edit document/ content — the agent reads the surfaced docs/migrations/<version>.md notes and proposes edits to the user with confirmation. Use --dry-run to preview, --no-deps / --no-skills to target one layer.

    Dev startup notice:

    open-press dev now runs doctor before starting Vite. When the workspace is behind, a single line prints: ○ open-press: @open-press/core 0.4.0 → 0.5.0 · 1 migration note(s) — run npx open-press doctor for details. Cached for 24h, network failure is silent, never blocks dev.

    Migration docs:

    • New docs/migrations/_template.md — each release with breaking changes ships a docs/migrations/<version>.md file with sections the agent reads.
    • New docs/migrations/0.4.0.md — backfilled. Documents the SKILL fold (no document or CLI changes).

    SKILL update:

    openpress skill's "Updating An Existing Workspace" section rewritten around the new commands: detect (doctor), apply (upgrade), interpret migration notes, propose document edits with user confirmation. Concrete agent workflow + breaking-change reference table.

0.4.0

Minor Changes

  • 3cb4939: Consolidate internal skills (13 → 11).

    • openpress-update folded into openpress as an "Updating An Existing Workspace" section. The release-upgrade flow, pre-flight checks, breaking-change reference, and do-not list are now part of the system-operation skill where they naturally belong.
    • Document hierarchy rules folded into the writing workflow. Hierarchy decisions (H2/H3/H4 model, TOC depth, appendix placement, H4 granularity) and prose decisions happen together.
    • references/data-structures-outline.md moved into the writing references.

    Lower maintenance surface: 2 fewer SKILL.md files to keep in sync, ~5 fewer cross-references to police. No content lost — same rules, fewer files.

    User impact: agents already in workspaces with openpress-update or openpress-document-hierarchy SKILL files installed should run npx skills upgrade to refresh the catalog.

0.3.0

Minor Changes

  • Initial monorepo release of @open-press/cli and @open-press/core on npm.

    @open-press/cli (new): scaffolder for open-press workspaces. Supports editorial-monograph and claude-document style packs, metadata flags, and AI-agent skill installation under .claude/skills/ and .agents/skills/.

    @open-press/core (new): framework runtime, CLI engine, render pipeline, and document primitives. Consumed transitively by workspaces scaffolded via @open-press/cli. Exposes the open-press bin (dev / build / preview / validate / pdf / deploy / export).