build(packages): ship SPEC.md and sources in the published tarball - #36
Merged
Conversation
The tarball carried dist and README.md only, so the two things you want when a behavior surprises you — the spec that defines the contract and the code that implements it — were reachable only by finding the repo and guessing which tag matches the installed version. Add src and SPEC.md to files across every publishable package and both scaffold templates, so new primitives inherit it. Resolution is untouched: publishConfig still points main, types, and exports at dist, and the sources are inert payload. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why/What
A published package carried
distandREADME.mdonly. The two things youactually want when a behavior surprises you — the
SPEC.mdthat defines thecontract and the code that implements it — were reachable only by finding the
repo and guessing which tag matches the version you installed. Both now sit in
node_modules/<pkg>/, pinned to the exact version resolved.Resolution is untouched:
publishConfigstill pointsmain,types, andexportsatdist, so the sources are inert payload — read them, don't importthem.
Changes
files: ["dist", "src", "SPEC.md"]across all 10 publishable packages.pnpm scaffoldstamps it into newprimitives.
ARCHITECTURE.mdrecording what a tarball carries and why.Verified with
pnpm packon a package with a spec and one without (npm skips amissing
filesentry, so the entry is already in place for the specs landing ondocs/util-package-specs):The packed
package.jsonstill resolves to./dist/….pnpm build(publintclean), 137 tests, lint, typecheck, and format all pass.
Issues
🤖 Generated with Claude Code