7.9 KiB
Agent Note: TSC-first build and one compiler ownership
Status: implemented
English | 中文
Root project topology (which tsconfig owns which graph) has since moved to a solution root over two aggregate programs; see the solution-root note. The tsc-first pipeline decided here is unchanged.
Problem
The current TypeScript build and typecheck setup had these issues:
buildusedtscto transform.tsto.d.tsfiles for packages underpackages/<group>/<pkg>andvendor/*, and then usedtsdownto transform.tsto bundled.jsfiles. This made two tools do TypeScript transform.typechecktended to validate packages, vendor source, examples, tests, and scripts through one root typecheck config.
The goal is to make build and typecheck use matching tsconfig boundaries and TypeScript resolution/transform behavior. Build should generate .js, .d.ts, .js.map, and .d.ts.map through one compiler and config, so publish output and type validation stay consistent.
Validation found several concrete technical issues and possible routes:
tsdownusesoxcto transform TypeScript, which is not the same behavior astsc.- Bundled
.d.tsemitted bytsdownconflicts with Cordis' internal relative module augmentation shape. - The tsc output is affected by
allowImportingTsExtensions, so we need to ensure that generated.jsfiles do not import.tsfiles and generated.d.tsfiles keep explicit relative specifiers that NodeNext/Node16 accepts. Therefore, in-package relative imports use explicit.tsspecifiers in TypeScript source andrewriteRelativeImportExtensionsrewrites those specifiers to.jsin emitted JS. - Bundled
.jsemitted bytsdownis not the same behavior as per-file.jsemitted bytsc -b, such as decorator transform behavior.
- Bundled
vendor/*/src, examples, tests, and scripts cannot all be plain-included in one root strict program.- Directly typechecking
vendor/*/srcunder the root strict config triggers many type errors outside this project's ownership. - Package dependencies under
packages/*/*onvendorare resolved to thevendor/*/libfor different tsconfig strictness.
- Directly typechecking
Decision
In-package relative imports use explicit .ts specifiers.
pnpm run build is a two-stage build:
- Stage 1:
tsc -bover the root solution emits per-module.js, declarations.d.ts, JS sourcemaps.js.map, and declaration sourcemaps.d.ts.mapinto each package'slib/types. This is the authoritative TypeScript compilation result. For publish we keep.d.ts/.d.ts.mapand ignore.js/.js.map.- The graph is the project-reference graph reachable from the root solution
tsconfig.jsonthrough the two aggregates (topology). It validates and emits package/vendor build results.
- The graph is the project-reference graph reachable from the root solution
- Stage 2: a bundler reads the emitted JS under
lib/typesand writes the bundled runtime entry aslib/index.jsorlib/index.mjs(follow current behavior). This stage is bundling only. It must not read TypeScript source or emit declarations.
tsdown is no longer the owner of TypeScript compilation or declaration output.
pnpm run typecheck runs the same tsc -b graph.
- The aggregates (
tsconfig.host.json,tsconfig.client.json) typecheck examples, tests, and scripts withnoEmit, and validate package/vendor source through references. - Referenced package/vendor projects keep the same emit behavior as build, so typecheck refreshes their
lib/typesoutputs instead of using a separate no-emit graph. Project-specific strictness changes live in the owningpackages/*/*/tsconfig.jsonorvendor/*/tsconfig.json. - The no-emit aggregates disable
rewriteRelativeImportExtensions; they emit nothing and include tests that import helpers across project-reference boundaries. Package/vendor emit projects keep the rewrite enabled.
Composite projects keep their incremental build information inside their project-local lib/ output. pnpm run clean derives live output directories from the root TypeScript project-reference graph, removes legacy root build information, and removes deleted packages/*/* directories that contain only known generated residue. Before removing an existing target, it resolves the target's parent and refuses it if that resolved parent is outside the repository, so a symlinked project reference cannot redirect cleanup outside the checkout. It preserves node_modules for every package that still has a package.json, and refuses to remove a manifest-less directory containing unknown files. Build does not invoke clean automatically, so ordinary builds retain incremental state.
The command orchestration shape is:
pnpm run build:
tsc -b
tsdown
pnpm run verify-node-next-types:
tsx scripts/verify-node-next-types.ts
pnpm run typecheck:
tsc -b
pnpm run clean:
tsx scripts/clean.ts
The source-mode demos run through their declared TypeScript launchers and the root paths map. The dsh TUI chain uses Node's native transform plus its app-owned paths loader, the Web demo builds its required artifacts before entering that same CLI source chain, and the other source demos continue to use tsx.
Alternatives considered
- Keep
tsdown/oxc as the TypeScript transformer — oxc's transform is nottscbehavior (decorator transform differs, bundled JS differs from per-file emit), and its bundled.d.tsconflicts with Cordis' internal relative module augmentation shape. - One root strict program over packages, vendor, examples, tests, and scripts — vendor source triggers type errors outside this project's ownership under the root strict flags; project references with per-project strictness are the boundary that works.
- Clean before every build — this would discard the incremental state owned by
tscand the bundler even when the workspace layout is unchanged. - Remove every package-level
node_modules— valid package dependency links do not cause the workspace-discovery failure, and deleting them would turn build cleanup into dependency reinstallation.
Consequences
Build responsibilities are clearer:
- Each module under
packages/<group>/<pkg>andvendor/*has one local tsconfig for build, typecheck, and tools that run source directly, such as thedshsource loader,tsx, andvitest. - The
buildcommand drives the root solution graph.tsc -bowns the publishable per-module.jsand.d.tsoutput, and the bundler owns onlylib/index.*.lib/types/*.d.tsand.d.ts.mapare the publish declaration output.lib/types/*.d.tsuses explicit.tsrelative specifiers, which TypeScript's NodeNext/Node16 resolver maps to sibling.d.tsfiles.lib/types/*.jsis only a bundler input and must not be used as a runtime entry or public import target.lib/index.*is the publish runtime output and is generated by the bundler, currentlytsdown.
pnpm run verify-node-next-typesscans built declarations for relative specifiers without file extensions, then typechecks a temporary external ESM consumer withmoduleResolution: "NodeNext"against the builttypes/exportssurface, so declaration specifier regressions fail before publish.- The
typecheckcommand usestsconfig.json. Examples, tests, and scripts are checked by the root no-emit project, while packages and vendor modules keep the same emit behavior asbuild. Package and vendor source stays behind project-reference boundaries. - After changing branches or updating a checkout that deleted packages, contributors can run
pnpm run cleanto remove stale package directories before rebuilding. Unknown files in a manifest-less package directory require manual classification instead of being deleted.
The Cordis vendor copy now has one more type-structure divergence from upstream. During upstream sync, that divergence must be reapplied or explicitly retired.