Skip to content

fix(openapi-typescript-helpers): keep index.d.cts in npm distribution #1788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 30, 2024

Conversation

yukukotani
Copy link
Contributor

@yukukotani yukukotani commented Jul 30, 2024

Changes

Fix #1749

By default, npm publish respects .gitignore so that the npm distribution doesn't include index.d.cts.

package.ison points to it even though it's missing, and this results in fallback to index.cjs. This causes that types from openapi-typescript-helpers to be treated as any.

This PR adds files field in package.json to explicitly declare index.d.cts to be included in the distribution.

How to Review

The output of npm pack includes package.d.cts.

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

@yukukotani yukukotani requested a review from a team as a code owner July 30, 2024 09:40
Copy link

changeset-bot bot commented Jul 30, 2024

🦋 Changeset detected

Latest commit: 250fb43

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
openapi-typescript-helpers Patch
openapi-fetch Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thank you! I hadn’t considered the .gitignore impact on publishing. Thank you for fixing it!

@drwpow drwpow merged commit bcc9222 into openapi-ts:main Jul 30, 2024
7 checks passed
@github-actions github-actions bot mentioned this pull request Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Types are not enforced with typescript 5.5.3
2 participants