Skip to content

fix(pkg): add default fallback and types export#612

Merged
wolfy1339 merged 5 commits intomainfrom
fix-esm-exports
Apr 16, 2024
Merged

fix(pkg): add default fallback and types export#612
wolfy1339 merged 5 commits intomainfrom
fix-esm-exports

Conversation

@wolfy1339
Copy link
Copy Markdown
Member

@wolfy1339 wolfy1339 commented Apr 15, 2024

Resolves octokit/core.js#667
Resolves octokit/core.js#665

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 15, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 15, 2024

👋 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! 🚀

gr2m
gr2m previously approved these changes Apr 16, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@gr2m gr2m left a comment

Choose a reason for hiding this comment

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

man I really hoped that with the ESM standard we would put all this nonsense behind us 😭 thank you for seeing the transition through and addressing the follow ups ❤️

@wolfy1339
Copy link
Copy Markdown
Member Author

wolfy1339 commented Apr 16, 2024

It seems nobody has the same idea of how to interpret the standard

@wolfy1339 wolfy1339 merged commit 069235f into main Apr 16, 2024
@wolfy1339 wolfy1339 deleted the fix-esm-exports branch April 16, 2024 00:09
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 16, 2024

🎉 This PR is included in version 11.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

wolfy1339 added a commit that referenced this pull request May 2, 2024
@wolfy1339
Revert "fix(pkg): add default fallback and types export (#612)"
27a8552 
This reverts commit 069235f.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gr2m gr2m gr2m approved these changes

Assignees

No one assigned

Labels

released Type: Bug Something isn't working as documented

Projects

🧰 Octokit Active
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[BUG]: Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: No "exports" main defined in [BUG]: No "exports" main defined in version 6.0.1

2 participants

@wolfy1339 @gr2m