Skip to content
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

fix(pkg): add a default fallback export #523

Merged
merged 2 commits into from
Apr 16, 2024
Merged

fix(pkg): add a default fallback export #523

merged 2 commits into from
Apr 16, 2024

Conversation

wolfy1339
Copy link
Member

See octokit/core.js#667
See octokit/core.js#665
Partly reverts #508


Before the change?

  • Some consumers of this package could not resolve it properly (ex: jest, ts-node, tsx)
  • CJS consumers would be getting errors even though the package is ESM
  • Consumers cannot import paths from the package like in CJS

After the change?

  • Clients should be able to import the module without any errors with the fallback
  • CJS consumers will generate a better error with the new fallback
  • Consumers are able to import types from the dist-types/types.d.ts file in the package

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

@wolfy1339 wolfy1339 added the Type: Bug Something isn't working as documented label Apr 16, 2024
Copy link

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@wolfy1339 wolfy1339 merged commit cf1468d into main Apr 16, 2024
8 checks passed
@wolfy1339 wolfy1339 deleted the fix-esm-exports branch April 16, 2024 22:29
Copy link

🎉 This PR is included in version 7.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Type: Bug Something isn't working as documented
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants