fix(v2): fix bad @docusaurus/types Plugin type generics #5058
Conversation
`LoadedPlugin` referenced line 201 is not generic, causing typescript errors on end-user builds.
Contributors will no longer inadvertently dump type errors since any IDE should check types now.
|
✔️ [V2] 🔨 Explore the source changes: 9c08bb6 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/60d5928573140700075e62e9 😎 Browse the preview: https://deploy-preview-5058--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5058--docusaurus-2.netlify.app/ |
| @@ -13,11 +13,17 @@ | |||
| "directory": "packages/docusaurus-types" | |||
| }, | |||
| "license": "MIT", | |||
| "scripts": { | |||
| "test": "tsc -p ." | |||
There was a problem hiding this comment.
Is this supposed to catch the error? Because I tried locally and it doesn't.
Actually trying to find a solution to catch such mistakes 🤪 let me know if you find one
There was a problem hiding this comment.
Oh I see what happened. I tested a custom tsconfig.json file, then I realized there was a shared config and used extends. But the TS server didn't reboot and kept the former config, thus I thought the new config would still catch those errors.
And the new config brought "skipLibCheck": true which caused declaration files to be ignored. But if I revert that, all those @types/webpack error spawn.
There was a problem hiding this comment.
Those webpack errors come from conflicting tapable definitions. @types/webpack@4.41.29 depends on @types/tapable@^1" while webpack@5.40.0depends ontapable@^2` which provides its own definitions.
Not sure what is meant by "@types/webpack and webpack/types.d.ts are not the same thing" 😓 (in root tsconfig); but either upgrading @types/webpack to ^5 or sticking with TS types provided by webpack might fix the issue...
Those TS errors in node_modules are maddening!
There was a problem hiding this comment.
Previously Webpack used definitively typed (4.x); but it started to ship official typedefs in 5.x. The initial 5.x typedefs were missing a lot of things, I think they completed support more recently so we can probably try again to remove @types/webpack once for all
| @@ -283,12 +283,14 @@ export interface Plugin<Content> { | |||
| }): ThemeConfig; | |||
| } | |||
|
|
|||
| export type InitializedPlugin = Plugin<unknown> & { | |||
| export type InitializedPlugin<Content = unknown> = Plugin<Content> & { | |||
There was a problem hiding this comment.
Also adding the missing plugin content generic to these derived types
slorber
changed the title
Motivation
When building a Typescript project depending on
@docusaurus/types, this error is raised:Have you read the Contributing Guidelines on pull requests?
Yes.
Test Plan
I have added a
tsconfig.jsonfile to@docusaurus/typesand typescript as a dev dep. One can check those types now withyarn workspace @docusaurus/types testThe test now passes: