fix(pkg): add `default` fallback and `types` export

octokit / core.js

Extendable client for GitHub's REST & GraphQL APIs

MIT License

1.19k stars 310 forks source link

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

Closed wolfy1339 closed 7 months ago

wolfy1339 commented 7 months ago

Resolves #667 Resolves #665 Partly reverts #662

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)
[x] 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
[x] No

github-actions[bot] commented 7 months ago

👋 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 commented 7 months ago

I have tested this locally with eslint, and the problem seems to be fixed

github-actions[bot] commented 7 months ago

:tada: This PR is included in version 6.1.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

marekdedic commented 6 months ago

Hi, thanks, but I am running into the same error in dependencies, namely in my case:

@octokit/request
@octokit/endpoint
@octokit/request-error
@octokit/graphql
@octokit/auth-token
@octokit/plugin-rest-endpoint-methods

I can open PRs for all of these, but I don't know if this isn't something you'd rather solve for the whole org...

wolfy1339 commented 6 months ago

Yes, that is expected, as they haven't received the same update yet.

Yes, I would love PRs!

marekdedic commented 6 months ago

Sorry, you got to it faster than I could :) Thanks!

wolfy1339 commented 6 months ago

No worries 🙂