mirror of https://github.com/deepseek-ai/deepseek-harness.git synced 2026-08-29 04:26:38 +00:00

Files

T

Tianyi Cui e6fad266a6 docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus

Define the in-file RFC contract in docs/rfc/README.md § The file format:
the header block (`# RFC: <title>` plus a dateless Status enum
cross-checked against the lifecycle folder), the per-lifecycle body
skeleton (a Problem opener everywhere; Proposal/Alternatives considered/
Acceptance criteria/Risks in proposed/; present-tense Decision/
Consequences with proposal-era headings banned in implemented/; the
frozen proposal shape in rejected/), and a mandatory Alternatives
considered section with a date-fenced grandfather comment for pre-format
RFCs whose alternatives are not reconstructible from the record.

Enforce it with a new doc-sync gate, scripts/verify-rfc-format.ts, and
normalize all 112 RFCs to it: ~15 Status-line spellings collapse to the
enum, 29 Context openers become Problem, the 39 legacy-format XXX debt
markers are resolved and banned from reappearing, proposal-era sections
in implemented RFCs are rewritten to shipped reality (including the
web/fs/subagent seam RFCs' migration plans and test checklists, closing
the doc-tiers deferred-work item on the web seam), every RFC gains an
Alternatives considered section or the grandfather comment, and the
bilingual pair is re-mirrored and re-recorded.

Move the generated index tables out of README.md into a fully generated
docs/rfc/INDEX.md — gen-rfc-index now writes the whole file, and
verify-rfc-classification checks its freshness and rejects index-shaped
rows in the curated README — which makes room for the format contract to
live in the README front door instead of a separate FORMAT.md.

The decision record, and the first RFC written in the new format, is
docs/rfc/implemented/process/2026-07-05-uniform-rfc-format.md.

2026-07-05 22:58:25 +08:00

3.1 KiB

Raw Blame History

RFC: tsdown for JS bundling instead of dumble

Status: implemented

Problem

The initial build used dumble, the cordiverse zero-config esbuild wrapper that upstream Cordis itself builds with — maximum alignment with the vendored packages' conventions (it reads each package.json and infers entries/formats from the exports field). But dumble is a liability as a load-bearing tool in this repo: v0.2.x, ~530 npm downloads/week, effectively one maintainer, and we were invoking it through a custom orchestration script (scripts/build.ts) because it has no workspace mode.

Build output currently matters only for pnpm run build + publint (nothing publishes yet; dev/test/demo run unbuilt via tsx), so the switching cost is at its lowest now and only grows once packages publish.

Decision

Replace dumble with tsdown (rolldown-based, ~2.5M downloads/week, VoidZero-backed, actively released):

Root tsdown.config.ts with workspace: ['vendor/*', 'packages/*'] (explicit globs, not workspace: true, which would also pick up examples/* — they have package.json files but are not pnpm workspaces).
Shared shape: entry lib/types/index.js, outDir: 'lib', ESM, platform: node, target: es2024, fixedExtension: false (keeps .js for "type": "module" packages), dts: false (tsc -b owns declarations), clean: false (lib/ also holds TSC's lib/types intermediate tree). The entry was originally src/index.ts; the TSC-first build RFC later moved tsdown to bundling TSC-emitted JS so TypeScript transform behavior comes from one compiler.
Two per-package overrides in vendor/ (ours, like the regenerated tsconfigs; logged in vendor/README.md): schemastery (dual .mjs/.cjs via outExtensions), logger-console (two single-entry passes so the shared base class is inlined into each entry instead of a hash-named chunk, matching upstream's published shape).
scripts/build.ts deleted; pnpm run build = tsc -b tsconfig.build.json && tsdown.

Alternatives considered

A direct esbuild script — the most established engine and zero wrapper risk, but hand-maintains the per-package spec table tsdown's workspace mode gives us.
pkgroll — the closest drop-in philosophically, but 78k downloads/week and Rollup-based: strictly weaker maintenance story than tsdown.
Keep dumble — perfect upstream alignment, unacceptable bus factor.

Consequences

Runtime bundle outputs still follow the dumble-era public entry shape (lib/index.js, plus package-specific variants such as schemastery's lib/index.mjs/lib/index.cjs and logger-console's lib/browser.js); declarations now live under lib/types per the TSC-first build RFC. Externals still come from each package's dependencies/peerDependencies. We give up dumble's exports-field inference — new packages with non-default shapes need a per-package tsdown.config.ts instead of just package.json fields. Future option: tsdown could also absorb declaration bundling (isolatedDeclarations) if tsc -b ever becomes the bottleneck; that would be a new RFC.

3.1 KiB Raw Blame History