@gordonkit/docforge 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 SlideForge contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+DocForge
+Copyright 2026 DocForge contributors
+
+Dependency copyright and license terms remain with their respective owners.

package/README.md

@@ -1,3 +1,46 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# DocForge
+
+> **Status: early release (v0.1.2).** The CLI, schema, lint and DOCX export work and are
+> verified in Word. See the [roadmap](docs/plan.md) and [changelog](CHANGELOG.md).
+
+DocForge is an AI-ready framework for creating consistent, **editable Word (DOCX)**
+documents. It is the document sibling of [SlideForge](https://github.com/gordonkit/slideforge)
+(HTML/CSS → PPTX): an AI writes strict, validated content, and DocForge renders,
+previews, lints and exports it.
+
+```text
+strict content (JSON) ─► validate + lint ─► HTML ─► gordon-doc (Pandoc) ─► DOCX ─► verify
+                                  └─► HTML preview            └─► PDF + PNG pages (Word)
+```
+
+## Quick start
+
+```bash
+npm install -g @gordonkit/docforge
+docforge init document.json
+docforge check document.json
+docforge export document.json --output document.docx
+docforge preview document.json --engine word-com
+```
+
+Requires Node.js 24+, [Pandoc](https://pandoc.org/installing.html) and
+[gordon-doc](https://github.com/gordonkit/gordon-doc-converter) 1.0.0 or later
+(`pip install "gordon-doc-converter[images]"`), or use the [container image](docker/README.md)
+`gordonkit/docforge`, which has all of them. See [`docs/cli.md`](docs/cli.md).
+
+## Principles
+
+- **Constrained input.** AI authors a strict JSON schema, never HTML or CSS.
+- **Real Word structure.** Headings map to Heading 1–4, lists use numbering definitions, TOC is a field. Users can keep editing in Word.
+- **Template driven.** Six built-in templates are design tokens applied to the DOCX styles; restyle without touching content.
+- **Feedback loop.** Lint and preview results are machine-readable so an AI can fix its own output.
+- **Honest limits.** Do not claim pixel-perfect conversion; document what is unsupported.
+
+## Relationship to other repos
+
+- [`gordon-doc-converter`](https://github.com/gordonkit/gordon-doc-converter) — conversion orchestration (Pandoc, LibreOffice, Word COM, page images). DocForge uses it for HTML → DOCX (Phase 1), DOCX → PDF and page-image previews.
+- [`slideforge`](https://github.com/gordonkit/slideforge) — presentations. Shares design-token ideas and the AI workflow; code sharing is deferred until both stabilize.
+
+[繁體中文](README.zh-TW.md)
+
+Docs: [CLI](docs/cli.md) · [schema](docs/schema.md) · [templates](docs/templates.md) · [validation](docs/validation.md) · [AI workflow](docs/ai-workflow.md) · [limitations](docs/limitations.md) · [fidelity study](docs/fidelity.md) · [architecture](docs/architecture.md) · [roadmap](docs/plan.md) · [changelog](CHANGELOG.md).

package/README.zh-TW.md

@@ -0,0 +1,36 @@
+# DocForge
+
+[English](README.md) · 繁體中文
+
+> **狀態：早期版本（v0.1.2）。** CLI、schema、lint 與 DOCX 匯出已可使用，並在 Word 中驗證過。詳見[路線圖](docs/plan.md)與[變更紀錄](CHANGELOG.md)。
+
+DocForge 是一個讓 AI 能穩定產生**可編輯 Word（DOCX）**文件的框架，是 [SlideForge](https://github.com/gordonkit/slideforge)（HTML/CSS → PPTX）的文件版姊妹專案：AI 只撰寫嚴格驗證的 JSON 內容，由 DocForge 負責渲染、預覽、lint 與匯出。
+
+```text
+嚴格 JSON ─► 驗證 + lint ─► HTML ─► gordon-doc (Pandoc) ─► DOCX ─► 結構驗證
+                    └─► HTML 預覽                       └─► PDF + PNG 頁面（Word）
+```
+
+## 快速開始
+
+```bash
+npm install -g @gordonkit/docforge
+docforge init document.json
+docforge check document.json
+docforge export document.json --output document.docx
+docforge preview document.json --engine word-com
+```
+
+需求：Node.js 24+、[Pandoc](https://pandoc.org/installing.html)、[gordon-doc](https://github.com/gordonkit/gordon-doc-converter) 1.0.0 以上（`pip install "gordon-doc-converter[images]"`）；也可以改用已包含這些工具的[容器映像檔](docker/README.md) `gordonkit/docforge`。詳見 [`docs/zh-TW/guide.md`](docs/zh-TW/guide.md)。
+
+## 原則
+
+- **受限輸入**：AI 只寫嚴格的 JSON，不寫 HTML 或 CSS。
+- **真正的 Word 結構**：標題對應 Heading 1–4，清單使用編號定義，目錄是欄位，使用者可繼續在 Word 編輯。
+- **範本驅動**：內建六個範本（`default`、`classic`、`compact`、`minutes`、`proposal`、`letter`），換範本不必改內容。
+- **回饋迴圈**：lint 與預覽結果可由機器讀取，AI 能自行修正。
+- **誠實揭露限制**：不宣稱像素級一致，未支援的項目都有文件說明。
+
+## 文件
+
+[繁體中文指南](docs/zh-TW/guide.md) · [CLI](docs/cli.md) · [schema](docs/schema.md) · [範本](docs/templates.md) · [驗證](docs/validation.md) · [AI 工作流程](docs/ai-workflow.md) · [限制](docs/limitations.md) · [路線圖](docs/plan.md) · [變更紀錄](CHANGELOG.md)（其餘文件為英文）。

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,169 @@
+# Third-party notices
+
+DocForge's own code is licensed under the Apache License 2.0 (see `LICENSE` and `NOTICE`).
+Third-party packages keep their own copyrights and license terms; this document does not
+relicense them.
+
+## Scope
+
+The production inventory is generated from the checked-in `package-lock.json` and the installed
+package manifests. License files are reproduced verbatim. No third-party source is copied into
+this repository, with one exception: the documentation site (`site/build.mjs`) embeds a few
+icon outlines from [Heroicons](https://heroicons.com/) (MIT, Copyright (c) Tailwind Labs, Inc.;
+the MIT terms are the ones reproduced under fflate below). They are not part of the npm package.
+
+## External tools (not bundled)
+
+DocForge runs these as separate processes and does not redistribute them:
+
+- [Pandoc](https://pandoc.org/) (GPL-2.0-or-later), used through gordon-doc-converter.
+- [gordon-doc-converter](https://github.com/gordonkit/gordon-doc-converter) (check its own license).
+- Microsoft Word (optional, for previews on Windows) and LibreOffice (optional).
+
+## Production dependencies
+
+### fflate@0.8.3 (MIT)
+
+https://101arrowz.github.io/fflate
+
+```text
+MIT License
+
+Copyright (c) 2026 Arjun Barrett
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+### zod@4.6.7 (MIT)
+
+https://zod.dev
+
+```text
+MIT License
+
+Copyright (c) 2025 Colin McDonnell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+## Development-only dependencies
+
+Used to build and test; not shipped in the package.
+
+| Package | Version | License |
+| --- | --- | --- |
+| @jridgewell/resolve-uri | 3.1.2 | MIT |
+| @jridgewell/sourcemap-codec | 1.6.0 | MIT |
+| @jridgewell/trace-mapping | 0.3.31 | MIT |
+| @oxc-project/types | 0.156.0 | MIT |
+| @rolldown/binding-android-arm-eabi | 1.2.16 | MIT |
+| @rolldown/binding-android-arm64 | 1.2.16 | MIT |
+| @rolldown/binding-darwin-arm64 | 1.2.16 | MIT |
+| @rolldown/binding-darwin-x64 | 1.2.16 | MIT |
+| @rolldown/binding-freebsd-x64 | 1.2.16 | MIT |
+| @rolldown/binding-linux-arm-gnueabihf | 1.2.16 | MIT |
+| @rolldown/binding-linux-arm64-gnu | 1.2.16 | MIT |
+| @rolldown/binding-linux-arm64-musl | 1.2.16 | MIT |
+| @rolldown/binding-linux-ppc64-gnu | 1.2.16 | MIT |
+| @rolldown/binding-linux-s390x-gnu | 1.2.16 | MIT |
+| @rolldown/binding-linux-x64-gnu | 1.2.16 | MIT |
+| @rolldown/binding-linux-x64-musl | 1.2.16 | MIT |
+| @rolldown/binding-openharmony-arm64 | 1.2.16 | MIT |
+| @rolldown/binding-win32-arm64-msvc | 1.2.16 | MIT |
+| @rolldown/binding-win32-x64-msvc | 1.2.16 | MIT |
+| @rolldown/pluginutils | 1.0.1 | MIT |
+| @types/chai | 5.2.3 | MIT |
+| @types/deep-eql | 4.0.2 | MIT |
+| @types/estree | 1.0.10 | MIT |
+| @types/node | 26.6.6 | MIT |
+| @typescript/typescript-aix-ppc64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-darwin-arm64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-darwin-x64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-freebsd-arm64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-freebsd-x64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-linux-arm | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-linux-arm64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-linux-loong64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-linux-mips64el | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-linux-ppc64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-linux-riscv64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-linux-s390x | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-linux-x64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-netbsd-arm64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-netbsd-x64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-openbsd-arm64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-openbsd-x64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-sunos-x64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-win32-arm64 | 7.0.2 | Apache-2.0 |
+| @typescript/typescript-win32-x64 | 7.0.2 | Apache-2.0 |
+| @vitest/mocker | 5.0.5 | MIT |
+| @vitest/spy | 5.0.5 | MIT |
+| assertion-error | 2.0.1 | MIT |
+| chai | 6.3.0 | MIT |
+| detect-libc | 2.1.2 | Apache-2.0 |
+| es-module-lexer | 2.3.2 | MIT |
+| estree-walker | 3.0.3 | MIT |
+| expect-type | 1.4.0 | Apache-2.0 |
+| fdir | 6.5.0 | MIT |
+| fsevents | 2.3.3 | MIT |
+| lightningcss | 1.33.0 | MPL-2.0 |
+| lightningcss-android-arm64 | 1.33.0 | MPL-2.0 |
+| lightningcss-darwin-arm64 | 1.33.0 | MPL-2.0 |
+| lightningcss-darwin-x64 | 1.33.0 | MPL-2.0 |
+| lightningcss-freebsd-x64 | 1.33.0 | MPL-2.0 |
+| lightningcss-linux-arm-gnueabihf | 1.33.0 | MPL-2.0 |
+| lightningcss-linux-arm64-gnu | 1.33.0 | MPL-2.0 |
+| lightningcss-linux-arm64-musl | 1.33.0 | MPL-2.0 |
+| lightningcss-linux-x64-gnu | 1.33.0 | MPL-2.0 |
+| lightningcss-linux-x64-musl | 1.33.0 | MPL-2.0 |
+| lightningcss-win32-arm64-msvc | 1.33.0 | MPL-2.0 |
+| lightningcss-win32-x64-msvc | 1.33.0 | MPL-2.0 |
+| magic-string | 1.4.5 | MIT |
+| nanoid | 3.3.20 | MIT |
+| obug | 3.0.0 | MIT |
+| picocolors | 1.1.1 | ISC |
+| picomatch | 4.0.7 | MIT |
+| postcss | 8.5.32 | MIT |
+| rolldown | 1.2.16 | MIT |
+| source-map-js | 1.2.2 | BSD-3-Clause |
+| std-env | 4.3.0 | MIT |
+| tinybench | 6.2.3 | MIT |
+| tinyexec | 1.3.1 | MIT |
+| tinyglobby | 0.2.17 | MIT |
+| typescript | 7.0.2 | Apache-2.0 |
+| undici-types | 8.9.0 | MIT |
+| vite | 8.3.6 | MIT |
+| vitest | 5.0.5 | MIT |
+| why-is-node-running | 3.2.1 | MIT |

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { runCli } from './run.js';
+process.exitCode = await runCli(process.argv.slice(2));

package/dist/cli/run.d.ts

@@ -0,0 +1,2 @@
+/** Run the CLI with the given arguments and return the process exit code. */
+export declare function runCli(args: string[]): Promise<number>;

package/dist/cli/run.js

@@ -0,0 +1,182 @@
+import { existsSync } from 'node:fs';
+import { mkdir, writeFile } from 'node:fs/promises';
+import { basename, dirname, extname, join, resolve } from 'node:path';
+import { parseArgs } from 'node:util';
+import { ExportError, exportDocx, previewDocx } from '../exporters/docx.js';
+import { ToolError } from '../exporters/gordon-doc.js';
+import { DocumentError, loadDocument } from '../load.js';
+import { renderHtml } from '../renderers/html.js';
+import { getTemplate } from '../templates/default.js';
+import { hasErrors } from '../validators/lint.js';
+const help = `DocForge — editable Word documents from structured content
+
+Usage:
+  docforge init [document.json]
+  docforge check <document.json> [--json]
+  docforge build <document.json> [--output document.html]
+  docforge export <document.json> --output document.docx [--overwrite]
+  docforge preview <document.json> [--output-dir <directory>] [--engine word-com|libreoffice] [--json]
+
+check validates the schema and lints the content. build writes an HTML preview. export
+writes DOCX through gordon-doc (Pandoc required) and verifies the result. preview exports,
+then renders PDF and PNG pages. Use --engine word-com for authoritative previews: only Word fills
+the table of contents; LibreOffice shows a placeholder.
+Set DOCFORGE_GORDON_DOC to the full path of gordon-doc if it is not on PATH.
+Exit codes: 0 success, 1 operation/validation failure, 2 invalid CLI usage.`;
+class UsageError extends Error {
+}
+const starter = {
+    version: 1,
+    title: 'Untitled document',
+    language: 'en',
+    footer: 'Page {page} of {pages}',
+    blocks: [
+        { type: 'heading', level: 1, text: 'Untitled document' },
+        { type: 'paragraph', text: ['Replace this text. Add ', { text: 'bold', bold: true }, ' words and a footnote.', { footnote: 'Footnotes are numbered automatically.' }] },
+        { type: 'heading', level: 2, text: 'Section' },
+        { type: 'list', ordered: false, items: ['First point', { text: 'Second point', children: ['Nested point'] }] },
+        {
+            type: 'table',
+            columns: [
+                { header: 'Item', width: 60 },
+                { header: 'Value', width: 40 },
+            ],
+            rows: [
+                ['Alpha', '1'],
+                ['Beta', '2'],
+            ],
+        },
+    ],
+};
+function parseCli(args) {
+    try {
+        return parseArgs({
+            args,
+            allowPositionals: true,
+            options: {
+                output: { type: 'string', short: 'o' },
+                'output-dir': { type: 'string' },
+                engine: { type: 'string' },
+                overwrite: { type: 'boolean' },
+                json: { type: 'boolean' },
+                help: { type: 'boolean', short: 'h' },
+            },
+        });
+    }
+    catch (error) {
+        throw new UsageError(error.message);
+    }
+}
+async function main(args) {
+    const parsed = parseCli(args);
+    const { values, positionals } = parsed;
+    const [command, input] = positionals;
+    if (values.help || command === undefined) {
+        console.log(help);
+        return command === undefined && !values.help ? 2 : 0;
+    }
+    if (command === 'init') {
+        const target = resolve(input ?? 'document.json');
+        if (existsSync(target))
+            throw new UsageError(`${target} already exists`);
+        await mkdir(dirname(target), { recursive: true });
+        await writeFile(target, `${JSON.stringify(starter, null, 2)}\n`, 'utf8');
+        console.log(`Created ${target}`);
+        return 0;
+    }
+    if (!['check', 'build', 'export', 'preview'].includes(command))
+        throw new UsageError(`unknown command "${command}"`);
+    if (input === undefined)
+        throw new UsageError(`${command} needs a document JSON file`);
+    const loaded = await loadDocument(input);
+    const errors = hasErrors(loaded.issues);
+    if (command === 'check') {
+        if (values.json) {
+            console.log(JSON.stringify({ ok: !errors, file: loaded.file, issues: loaded.issues }, null, 2));
+        }
+        else if (loaded.issues.length === 0) {
+            console.log(`${loaded.file}: OK`);
+        }
+        else {
+            for (const issue of loaded.issues) {
+                console.log(`${issue.severity.toUpperCase()} ${issue.code} ${issue.path}: ${issue.message}${issue.fix ? ` (${issue.fix})` : ''}`);
+            }
+        }
+        return errors ? 1 : 0;
+    }
+    if (errors) {
+        for (const issue of loaded.issues.filter((item) => item.severity === 'error')) {
+            console.error(`ERROR ${issue.code} ${issue.path}: ${issue.message}`);
+        }
+        console.error('Fix the errors above (run "docforge check") before continuing.');
+        return 1;
+    }
+    for (const issue of loaded.issues)
+        console.error(`${issue.severity.toUpperCase()} ${issue.code} ${issue.path}: ${issue.message}`);
+    const template = getTemplate(loaded.document.template);
+    const stem = basename(loaded.file, extname(loaded.file));
+    if (command === 'build') {
+        const output = resolve(values.output ?? join(dirname(loaded.file), `${stem}.html`));
+        const html = renderHtml(loaded.document, {
+            ...(template ? { template } : {}),
+            mode: 'preview',
+            baseDir: loaded.baseDir,
+            outputDir: dirname(output),
+        });
+        await mkdir(dirname(output), { recursive: true });
+        await writeFile(output, html, 'utf8');
+        console.log(`Wrote ${output}`);
+        return 0;
+    }
+    if (command === 'export') {
+        if (!values.output)
+            throw new UsageError('export needs --output <file>.docx');
+        const result = await exportDocx(loaded.document, {
+            baseDir: loaded.baseDir,
+            output: values.output,
+            overwrite: values.overwrite === true,
+        });
+        console.log(`Wrote ${result.output}`);
+        console.log(`Verified: ${result.verified.length > 0 ? result.verified.join(', ') : 'structure (no optional features used)'}`);
+        return 0;
+    }
+    const result = await previewDocx(loaded.document, {
+        baseDir: loaded.baseDir,
+        outputDir: values['output-dir'] ?? join(dirname(loaded.file), `${stem}-preview`),
+        ...(values.engine ? { engine: values.engine } : {}),
+    });
+    if (values.json) {
+        console.log(JSON.stringify(result, null, 2));
+    }
+    else {
+        console.log(`Rendered ${result.pages.length} page(s) with ${result.engine}`);
+        console.log(`DOCX: ${result.docx}\nPDF:  ${result.pdf}`);
+        for (const page of result.pages)
+            console.log(`Page: ${page}`);
+    }
+    return 0;
+}
+/** Run the CLI with the given arguments and return the process exit code. */
+export async function runCli(args) {
+    try {
+        return await main(args);
+    }
+    catch (error) {
+        if (error instanceof UsageError) {
+            console.error(`${error.message}\n\n${help}`);
+            return 2;
+        }
+        if (error instanceof DocumentError) {
+            console.error(error.message);
+            for (const issue of error.schemaIssues)
+                console.error(`  ${issue.path}: ${issue.message}`);
+        }
+        else if (error instanceof ExportError || error instanceof ToolError) {
+            console.error(error.message);
+        }
+        else {
+            console.error(error);
+        }
+        return 1;
+    }
+}