chore(v2): tighten up the TypeScript onboarding #3244
Conversation
|
Deploy preview for docusaurus-2 ready! Built with commit cb37c7a |
| @@ -53,6 +53,28 @@ declare module '@theme-original/*'; | |||
|
|
|||
| declare module '@docusaurus/*'; | |||
There was a problem hiding this comment.
This globally applies an any to all @docusaurus/* stuff, but because the following are more specific, then they get picked up as the module definition. This means as you add new things to the module TS users just get any, but then it can get filled in here.
| declare module '@docusaurus/useBaseUrl' { | ||
| export default function(relativePath: string): string | ||
| } | ||
|
|
There was a problem hiding this comment.
I use the import("x") syntax, which means recommending people add the @types/x for them ahead of time
| "noEmit": true, | ||
| "noImplicitAny": false | ||
| }, | ||
| "extends": "@tsconfig/docusaurus/tsconfig.json", |
There was a problem hiding this comment.
Moves all these config options to tsconfig/bases#27 - then it's obvious what is framework vs project
| ```ts title="src/types.d.ts" | ||
| /// <reference types="@docusaurus/module-type-aliases" /> | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Removed with https://github.com/tsconfig/bases/pull/28/files
This has one side-effect of encouraging people to be explicit in their global types, so for example if they wanted to add Jest tests, it would need to look like:
{
"extends": "@tsconfig/docusaurus",
"types": ["node", "jest", "@docusaurus/module-type-aliases"],
"include": ["src"]
}
But I imagine that this is the minority of folks, so I've left it off
| ``` | ||
|
|
||
| This file makes TypeScript recognize various Docusaurus specific webpack aliases like `@theme`, `@docusaurus`, `@generated`. | ||
| Docusaurus doesn't use this `tsconfig.json` to compile your project. It is added just for a nicer Editor experience, although you can choose to run `tsc` to type check your code for yourself or on CI. |
There was a problem hiding this comment.
The config specifies noEmit - so no need to include it here
|
Ah, good, TypeScript runs across this repo too - that should help make this more accurate. |
|
This ended up a bit bigger than I had anticipated, but as I tightened the types for consumers it also tightened the types used internally - will comment |
| @@ -127,4 +127,4 @@ class PendingNavigation extends React.Component<Props, State> { | |||
| } | |||
| } | |||
|
|
|||
| export default withRouter(PendingNavigation); | |||
| export default withRouter(PendingNavigation as any) as any; | |||
There was a problem hiding this comment.
introducing @types/react-router-dom gave a fail here because the objects don't all match up - this is a known issue in the types for withRouter - it expects to be used as a decorator. I tried using a disable next error for this, but it still propagated into a bunch of places, so I just as any'd it
It previously was an any
| @@ -142,7 +142,7 @@ function Link({ | |||
| {...props} | |||
| onMouseEnter={onMouseEnter} | |||
| innerRef={handleRef} | |||
| to={targetLink} | |||
| to={targetLink || ''} | |||
There was a problem hiding this comment.
to has always been a string | undefined and if it goes through the undefined path then it ends up a <a and not down this branch, as the linter doesn't allow a ! then I opted for the 'should never occur' || ""
| @@ -5,6 +5,7 @@ | |||
| "lib": ["es2017","es2019.array", "DOM"], | |||
| "declaration": true, | |||
| "declarationMap": true, | |||
| "jsx": "react", | |||
There was a problem hiding this comment.
optional and doesn't affect the output to my knowledge, but I get errors everywhere in vscode without it
|
Thanks for this, we definitively need to improve the TS story :) Quite busy this week but will check it in detail at the end of the week. Also think it would be nice if we migrated our own website to TS to dogfood |
|
thanks :) |
slorber
changed the title
slorber
changed the title
slorber
added
pr: maintenance
Motivation
Improve the TypeScript experience for an out of the box classic template
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
I have a new v2 0.61 project, and this builds the template OOTB with no errors (assuming you merge with master's
packages/docusaurus-module-type-aliases/src/index.d.tsanyway) - I'll leave notes inline.