fix: publish correct esm and cjs type declarations#224
Merged
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0600c6e8b8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
MylesBorins
force-pushed
the
fix/types-publish-layout
branch
from
0600c6e to
2a4dbd5
Compare
Fix the published type layout for dual ESM/CommonJS consumers. Generate ESM declarations from lib/ into types/ and generate CommonJS declarations from the Rollup CJS output in dist/lib/ into dist/types/. Update package exports so import resolves to types/index.d.mts and require resolves to dist/types/index.d.ts. Also update the type fixtures to validate both module systems, document the type generation and publish layout in README.md and AGENTS.md, and add a files whitelist so npm only publishes the runtime, declarations, docs, and examples.
MylesBorins
force-pushed
the
fix/types-publish-layout
branch
from
2a4dbd5 to
2fa9f8a
Compare
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
1 participant
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.
Summary
fixes: #220
This fixes the package’s published type layout for dual ESM/CommonJS consumers.
Previously, the package only published a single ESM-flavored declaration entry, which could lead to incorrect or incomplete type resolution for CommonJS consumers and was flagged by external tooling.
What changed
lib/intotypes/dist/lib/intodist/types/package.jsonconditional exports so:importresolves totypes/index.d.mtsrequireresolves todist/types/index.d.tsREADME.mdandAGENTS.mdfileswhitelist so npm only publishes the runtime, declarations, docs, and examplesWhy
This package ships separate ESM and CommonJS runtime entry points, so the published type metadata should match that layout as well. Generating CJS declarations from the Rollup-produced CJS tree keeps the declaration output aligned with the actual CommonJS runtime shape while avoiding hand-maintained type wrappers.
Validation
npm testnpm pack --dry-runNotes
This keeps JSDoc in the ESM source as the single source of truth. The CJS declarations are generated from the built CommonJS output rather than maintained separately by hand.