mirror of
https://github.com/garrytan/gstack.git
synced 2026-05-05 13:15:24 +02:00
d0782c4c4d
* feat(browse): full $B pdf flag contract + tab-scoped load-html/js/pdf
Grow $B pdf from a 2-line wrapper (hard-coded A4) into a real PDF engine
frontend so make-pdf can shell out to it without duplicating Playwright:
- pdf: --format, --width/--height, --margins, --margin-*, --header-template,
--footer-template, --page-numbers, --tagged, --outline, --print-background,
--prefer-css-page-size, --toc. Mutex rules enforced. --from-file <json>
dodges Windows argv limits (8191 char CreateProcess cap).
- load-html: add --from-file <json> mode for large inline HTML. Size + magic
byte checks still apply to the inline content, not the payload file path.
- newtab: add --json returning {"tabId":N,"url":...} for programmatic use.
- cli: extract --tab-id flag and route as body.tabId to the HTTP layer so
parallel callers can target specific tabs without racing on the active
tab (makes make-pdf's per-render tab isolation possible).
- --toc: non-fatal 3s wait for window.__pagedjsAfterFired. Paged.js ships
later; v1 renders TOC statically via the markdown renderer.
Codex round 2 flagged these P0 issues during plan review. All resolved.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* feat(resolvers): add MAKE_PDF_SETUP + makePdfDir host paths
Skill templates can now embed {{MAKE_PDF_SETUP}} to resolve $P to the
make-pdf binary via the same discovery order as $B / $D: env override
(MAKE_PDF_BIN), local skill root, global install, or PATH.
Mirrors the pattern established by generateBrowseSetup() and
generateDesignSetup() in scripts/resolvers/design.ts.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* feat(make-pdf): new /make-pdf skill + orchestrator binary
Turn markdown into publication-quality PDFs. $P generate input.md out.pdf
produces a PDF with 1in margins, intelligent page breaks, page numbers,
running header, CONFIDENTIAL footer, and curly quotes/em dashes — all on
Helvetica so copy-paste extraction works ("S ai li ng" bug avoided).
Architecture (per Codex round 2):
markdown → render.ts (marked + sanitize + smartypants) → orchestrator
→ $B newtab --json → $B load-html --tab-id → $B js (poll Paged.js)
→ $B pdf --tab-id → $B closetab
browseClient.ts shells out to the compiled browse CLI rather than
duplicating Playwright. --tab-id isolation per render means parallel
$P generate calls don't race on the active tab. try/finally tab cleanup
survives Paged.js timeouts, browser crashes, and output-path failures.
Features in v1:
--cover left-aligned cover page (eyebrow + title + hairline rule)
--toc clickable static TOC (Paged.js page numbers deferred)
--watermark <text> diagonal DRAFT/CONFIDENTIAL layer
--no-chapter-breaks opt out of H1-starts-new-page
--page-numbers "N of M" footer (default on)
--tagged --outline accessible PDF + bookmark outline (default on)
--allow-network opt in to external image loading (default off for privacy)
--quiet --verbose stderr control
Design decisions locked from the /plan-design-review pass:
- Helvetica everywhere (Chromium emits single-word Tj operators for
system fonts; bundled webfonts emit per-glyph and break extraction).
- Left-aligned body, flush-left paragraphs, no text-indent, 12pt gap.
- Cover shares 1in margins with body pages; no flexbox-center, no
inset padding.
- The reference HTMLs at .context/designs/*.html are the implementation
source of truth for print-css.ts.
Tests (56 unit + 1 E2E combined-features gate):
- smartypants: code/URL-safe, verified against 10 fixtures
- sanitizer: strips <script>/<iframe>/on*/javascript: URLs
- render: HTML assembly, CJK fallback, cover/TOC/chapter wrap
- print-css: all @page rules, margin variants, watermark
- pdftotext: normalize()+copyPasteGate() cross-OS tolerance
- browseClient: binary resolution + typed error propagation
- combined-features gate (P0): 2-chapter fixture with smartypants +
hyphens + ligatures + bold/italic + inline code + lists + blockquote
passes through PDF → pdftotext → expected.txt diff
Deferred to Phase 4 (future PR): Paged.js vendored for accurate TOC page
numbers, highlight.js for syntax highlighting, drop caps, pull quotes,
two-column, CMYK, watermark visual-diff acceptance.
Plan: .context/ceo-plans/2026-04-19-perfect-pdf-generator.md
References: .context/designs/make-pdf-*.html
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* chore(build): wire make-pdf into build/test/setup/bin + add marked dep
- package.json: compile make-pdf/dist/pdf as part of bun run build; add
"make-pdf" to bin entry; include make-pdf/test/ in the free test pass;
add marked@18.0.2 as a dep (markdown parser, ~40KB).
- setup: add make-pdf/dist/pdf to the Apple Silicon codesign loop.
- .gitignore: add make-pdf/dist/ (matches browse/dist/ and design/dist/).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* ci(make-pdf): matrix copy-paste gate on Ubuntu + macOS
Runs the combined-features P0 gate on pull requests that touch make-pdf/
or browse's PDF surface. Installs poppler (macOS) / poppler-utils (Ubuntu)
per OS. Windows deferred to tolerant mode (Xpdf / Poppler-Windows
extraction variance not yet calibrated against the normalized comparator —
Codex round 2 #18).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(skills): regenerate SKILL.md for make-pdf addition + browse pdf flags
bun run gen:skill-docs picks up:
- the new /make-pdf skill (make-pdf/SKILL.md)
- updated browse command descriptions for 'pdf', 'load-html', 'newtab'
reflecting the new flag contract and --from-file mode
Source of truth stays the .tmpl files + COMMAND_DESCRIPTIONS;
these are regenerated artifacts.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix(tests): repair stale test expectations + emit _EXPLAIN_LEVEL / _QUESTION_TUNING from preamble
Three pre-existing test failures on main were blocking /ship:
- test/skill-validation.test.ts "Step 3.4 test coverage audit" expected the
literal strings "CODE PATH COVERAGE" and "USER FLOW COVERAGE" which were
removed when the Step 7 coverage diagram was compressed. Updated assertions
to check the stable `Code paths:` / `User flows:` labels that still ship.
- test/skill-validation.test.ts "ship step numbering" allowed-substeps list
didn't include 15.0 (WIP squash) and 15.1 (bisectable commits) which were
added for continuous checkpoint mode. Extended the allowlist.
- test/writing-style-resolver.test.ts and test/plan-tune.test.ts expected
`_EXPLAIN_LEVEL` and `_QUESTION_TUNING` bash variables in the preamble but
generate-preamble-bash.ts had been refactored and those lines were dropped.
Without them, downstream skills can't read `explain_level` or
`question_tuning` config at runtime — terse mode and /plan-tune features
were silently broken.
Added the two bash echo blocks back to generatePreambleBash and refreshed
the golden-file fixtures to match. All three preamble-related golden
baselines (claude/codex/factory) are synchronized with the new output.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* chore: bump version and changelog (v1.4.0.0)
New /make-pdf skill + $P binary.
Turn any markdown file into a publication-quality PDF. Default output is
a 1in-margin Helvetica letter with page numbers in the footer. `--cover`
adds a left-aligned cover page, `--toc` generates a clickable table of
contents, `--watermark DRAFT` overlays a diagonal watermark. Copy-paste
extraction from the PDF produces clean words, not "S a i l i n g"
spaced out letter by letter. CI gate (macOS + Ubuntu) runs a combined-
features fixture through pdftotext on every PR.
make-pdf shells out to browse rather than duplicating Playwright.
$B pdf grew into a real PDF engine with full flag contract (--format,
--margins, --header-template, --footer-template, --page-numbers,
--tagged, --outline, --toc, --tab-id, --from-file). $B load-html and
$B js gained --tab-id. $B newtab --json returns structured output.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(changelog): rewrite v1.4.0.0 headline — positive voice, no VC framing
The original headline led with "a PDF you wouldn't be embarrassed to send
to a VC": double-negative voice and audience-too-narrow. /make-pdf works
for essays, letters, memos, reports, proposals, and briefs. Framing the
whole release around founders-to-investors misses the wider audience.
New headline: "Turn any markdown file into a PDF that looks finished."
New tagline: "This one reads like a real essay or a real letter."
Positive voice. Broader aperture. Same energy.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
111 lines
3.9 KiB
TypeScript
111 lines
3.9 KiB
TypeScript
/**
|
|
* `$P setup` — guided smoke test.
|
|
*
|
|
* Flow (per the CEO plan CLI UX spec):
|
|
* 1. Verify browse binary exists and responds
|
|
* 2. Verify Chromium launches via $B goto about:blank
|
|
* 3. Verify pdftotext is installed (warn, don't fail)
|
|
* 4. Generate a smoke-test PDF from an inline 2-paragraph fixture
|
|
* 5. Open it
|
|
* 6. Print a 3-command cheatsheet
|
|
*/
|
|
|
|
import * as os from "node:os";
|
|
import * as path from "node:path";
|
|
import * as fs from "node:fs";
|
|
|
|
import * as browseClient from "./browseClient";
|
|
import { resolvePdftotext, PdftotextUnavailableError } from "./pdftotext";
|
|
import { generate } from "./orchestrator";
|
|
|
|
export async function runSetup(): Promise<void> {
|
|
process.stderr.write("make-pdf setup — verifying install\n\n");
|
|
|
|
// 1. Resolve browse binary
|
|
process.stderr.write(" [1/5] Checking browse binary...");
|
|
try {
|
|
const bin = browseClient.resolveBrowseBin();
|
|
process.stderr.write(` OK (${bin})\n`);
|
|
} catch (err: any) {
|
|
process.stderr.write(" FAIL\n");
|
|
process.stderr.write(`\n${err.message}\n`);
|
|
process.exit(4);
|
|
}
|
|
|
|
// 2. Chromium smoke (navigate a dedicated tab to about:blank)
|
|
process.stderr.write(" [2/5] Launching Chromium...");
|
|
let chromiumTab: number | null = null;
|
|
try {
|
|
chromiumTab = browseClient.newtab("about:blank");
|
|
process.stderr.write(` OK (tab ${chromiumTab})\n`);
|
|
} catch (err: any) {
|
|
process.stderr.write(" FAIL\n");
|
|
process.stderr.write(`\nChromium failed to launch: ${err.message}\n`);
|
|
process.stderr.write("\nTo fix: run gstack setup from the gstack repo:\n");
|
|
process.stderr.write(" cd ~/.claude/skills/gstack && ./setup\n");
|
|
process.exit(4);
|
|
} finally {
|
|
if (chromiumTab !== null) {
|
|
try { browseClient.closetab(chromiumTab); } catch { /* ignore */ }
|
|
}
|
|
}
|
|
|
|
// 3. pdftotext (optional — CI gate only)
|
|
process.stderr.write(" [3/5] Checking pdftotext (optional)...");
|
|
try {
|
|
const info = resolvePdftotext();
|
|
process.stderr.write(` OK (${info.flavor}, ${info.version.split(" ").slice(-1)[0] || "version unknown"})\n`);
|
|
} catch (err) {
|
|
process.stderr.write(" SKIP\n");
|
|
if (err instanceof PdftotextUnavailableError) {
|
|
process.stderr.write(
|
|
" pdftotext not installed. This is optional — only the CI\n" +
|
|
" copy-paste gate needs it. To enable:\n" +
|
|
" macOS: brew install poppler\n" +
|
|
" Ubuntu: sudo apt-get install poppler-utils\n",
|
|
);
|
|
}
|
|
}
|
|
|
|
// 4. Render smoke-test PDF
|
|
process.stderr.write(" [4/5] Generating smoke-test PDF...\n");
|
|
const fixture = [
|
|
"# Hello from make-pdf",
|
|
"",
|
|
"This is a two-paragraph smoke test. If you can read this sentence in the PDF that just opened, the pipeline works end-to-end.",
|
|
"",
|
|
"The second paragraph contains curly quotes (\"hello\"), an em dash -- like this, and an ellipsis... all of which should render correctly.",
|
|
"",
|
|
].join("\n");
|
|
const fixturePath = path.join(os.tmpdir(), `make-pdf-smoke-${process.pid}.md`);
|
|
const outPath = path.join(os.tmpdir(), `make-pdf-smoke-${process.pid}.pdf`);
|
|
fs.writeFileSync(fixturePath, fixture, "utf8");
|
|
|
|
try {
|
|
await generate({
|
|
input: fixturePath,
|
|
output: outPath,
|
|
quiet: true,
|
|
pageNumbers: true,
|
|
});
|
|
process.stderr.write(` PASSED. Smoke test saved to ${outPath}\n`);
|
|
} catch (err: any) {
|
|
process.stderr.write(` FAILED: ${err.message}\n`);
|
|
process.exit(2);
|
|
} finally {
|
|
try { fs.unlinkSync(fixturePath); } catch { /* ignore */ }
|
|
}
|
|
|
|
// 5. Cheatsheet
|
|
process.stderr.write(" [5/5] All checks passed.\n\n");
|
|
process.stderr.write([
|
|
"make-pdf is ready. Try:",
|
|
" $P generate letter.md # default memo mode",
|
|
" $P generate --cover --toc essay.md # full publication",
|
|
" $P generate --watermark DRAFT memo.md # diagonal watermark",
|
|
"",
|
|
`Smoke-test PDF: ${outPath}`,
|
|
"",
|
|
].join("\n"));
|
|
}
|