Closed mjfwebb closed 4 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! 🚀
I can't seem to access your codesandbox
I can't seem to access your codesandbox
Apologies. I've made it public now.
@wolfy1339 I realised I wrote the wrong import, it's updated now to import type { Endpoints } from "@octokit/types";
and shows the issue properly still
This seems like it's an issue with pnpm and TypeScript.
When using npm the types work just fine
it's probably in a subfolder. What do you get when you run npm ls @octokit/types
npm ls @octokit/types
└─┬ octokit@4.0.1
├─┬ @octokit/app@15.0.1
│ ├─┬ @octokit/auth-app@7.0.0
│ │ ├─┬ @octokit/request-error@6.1.1
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ ├─┬ @octokit/request@9.1.1
│ │ │ ├─┬ @octokit/endpoint@10.1.1
│ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ └── @octokit/types@13.5.0
│ ├─┬ @octokit/auth-unauthenticated@6.1.0
│ │ ├─┬ @octokit/request-error@6.1.1
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ └── @octokit/types@13.5.0
│ ├─┬ @octokit/core@6.1.2
│ │ ├─┬ @octokit/graphql@8.1.1
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ ├─┬ @octokit/request-error@6.1.1
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ ├─┬ @octokit/request@9.1.1
│ │ │ ├─┬ @octokit/endpoint@10.1.1
│ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ └── @octokit/types@13.5.0 deduped
│ ├─┬ @octokit/plugin-paginate-rest@11.3.0
│ │ └── @octokit/types@13.5.0 deduped
│ ├── @octokit/types@13.5.0
│ └─┬ @octokit/webhooks@13.2.7
│ └─┬ @octokit/request-error@6.1.1
│ └── @octokit/types@13.5.0
├─┬ @octokit/core@6.1.2
│ ├─┬ @octokit/graphql@8.1.1
│ │ └── @octokit/types@13.5.0 deduped
│ ├─┬ @octokit/request@9.1.1
│ │ ├─┬ @octokit/endpoint@10.1.1
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ └── @octokit/types@13.5.0 deduped
│ └── @octokit/types@13.5.0 deduped
├─┬ @octokit/oauth-app@7.1.2
│ ├─┬ @octokit/auth-oauth-app@8.1.1
│ │ ├─┬ @octokit/auth-oauth-device@7.1.1
│ │ │ ├─┬ @octokit/request@9.1.1
│ │ │ │ ├─┬ @octokit/endpoint@10.1.1
│ │ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ │ ├─┬ @octokit/request-error@6.1.1
│ │ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ └── @octokit/types@13.5.0
│ │ ├─┬ @octokit/request@9.1.1
│ │ │ ├─┬ @octokit/endpoint@10.1.1
│ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ ├─┬ @octokit/request-error@6.1.1
│ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ └── @octokit/types@13.5.0
│ ├─┬ @octokit/auth-oauth-user@5.1.1
│ │ ├─┬ @octokit/request@9.1.1
│ │ │ ├─┬ @octokit/endpoint@10.1.1
│ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ ├─┬ @octokit/request-error@6.1.1
│ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ └── @octokit/types@13.5.0
│ ├─┬ @octokit/core@6.1.2
│ │ ├─┬ @octokit/graphql@8.1.1
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ ├─┬ @octokit/request-error@6.1.1
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ ├─┬ @octokit/request@9.1.1
│ │ │ ├─┬ @octokit/endpoint@10.1.1
│ │ │ │ └── @octokit/types@13.5.0 deduped
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ └── @octokit/types@13.5.0
│ └─┬ @octokit/oauth-methods@5.1.2
│ ├─┬ @octokit/request-error@6.1.1
│ │ └── @octokit/types@13.5.0 deduped
│ ├─┬ @octokit/request@9.1.1
│ │ ├─┬ @octokit/endpoint@10.1.1
│ │ │ └── @octokit/types@13.5.0 deduped
│ │ └── @octokit/types@13.5.0 deduped
│ └── @octokit/types@13.5.0
├─┬ @octokit/plugin-paginate-rest@11.3.0
│ └── @octokit/types@13.5.0 deduped
├─┬ @octokit/plugin-rest-endpoint-methods@13.2.1
│ └── @octokit/types@13.5.0 deduped
├─┬ @octokit/plugin-retry@7.1.1
│ └── @octokit/types@13.5.0 deduped
├─┬ @octokit/plugin-throttling@9.3.0
│ └── @octokit/types@13.5.0 deduped
├─┬ @octokit/request-error@6.1.1
│ └── @octokit/types@13.5.0 deduped
└── @octokit/types@13.5.0
This seems like it's an issue with pnpm and TypeScript.
When using npm the types work just fine
I'm using npm locally. I think that's a red herring because codesandbox defaulted to using pnpm
I don't have much experience with pnpm
, but I don't think the issue you filed is valid. If you want I'd suggest to create a follow up one with reproducible steps using pnpm. But I suggest we close this one
If you want to use @octokit/types
you need to add it as a dependency to your project when using pnpm
https://www.reddit.com/r/typescript/comments/h043pc/comment/ftkekt1/
Anyways, it's always a good idea to have it as a dependency if you are going to interact with it directly in your code
@gr2m @wolfy1339 not sure if you missed my earlier reply, but I'm not using pnpm locally. It was the default of codesandbox.
Edit: I was able to get it working on codesandbox with npm however, so I'm trying to narrow down the differences in tsconfig.
Yes, I saw your comment. My comment explains why it wasn't working with pnpm, and the tidbit i shared is valid for both npm and pnpm
I think that's a perfect solution @wolfy1339. It works fine for me to set @octokit/types
as a dependency.
Thanks very much for your help.
@octokit/types
is no longer available for me after 4.0.0, I get this error:Cannot find module '@octokit' or its corresponding type declarations.
Some relevant information, as it seems the
types
directory is missing in 4.0.0:The
node_modules/@oktokit
contents on 3.1.0:The
node_modules/@octokit
contents after 4.0.0:My package.json entries between upgrading to 4.0.0 (most lines have been removed for the sake of brevity):
Before:
After:
tsconfig.json
is using the node16 for module/moduleResolution.I've made a small reproduction showing this issue: https://codesandbox.io/p/devbox/4wls6z?file=%2Fsrc%2Findex.ts%3A13%2C1
Originally posted by @mjfwebb in https://github.com/octokit/octokit.js/issues/2598#issuecomment-2113251221