Downgrade TypeScript to ~3.6.0 #9826
Conversation
lychyi
requested review from
alterx,
igor-dv and
thomasbertet
as code owners
| @@ -17,7 +17,8 @@ export const axeTest = (customConfig: Partial<CommonConfig> = {}) => | |||
| ...customConfig, | |||
| async testBody(page, options) { | |||
| const parameters = options.context.parameters.a11y; | |||
| const include = parameters?.element ?? '#root'; | |||
| const element = (parameters === null || parameters === undefined) ? undefined : parameters.element; | |||
There was a problem hiding this comment.
This was the only place in the codebase that I could find that took advantage of the optional chaining and nullish coalescing operator introduced in 3.7.
I replaced it with the equivalent code here.
| @@ -33,6 +33,8 @@ | |||
| "prepare": "node ../../scripts/prepare.js" | |||
| }, | |||
| "dependencies": { | |||
| "@angular/compiler-cli": "^8.2.8", | |||
There was a problem hiding this comment.
These two dependencies @angular/compiler-cli and @angular-devkit/build-angular are required for this package but hoisted from a different location (examples/angular-cli here and here).
These two additions to dependencies guarantees that they're here in this package. If these are missing, the build and tests will fail since yarn install nests them in example/angular-cli after changing TypeScript to ~3.6.0 for some reason.
🤷♂
| @@ -161,7 +161,7 @@ export function applyAngularCliWebpackConfig(baseConfig: any, cliWebpackConfigOp | |||
| // todo add type for acc | |||
| const entry = [ | |||
| ...baseConfig.entry, | |||
| ...Object.values(cliStyleConfig.entry).reduce((acc: any, item) => acc.concat(item), []), | |||
| ...Object.values<any>(cliStyleConfig.entry).reduce((acc: any, item) => acc.concat(item), []), | |||
There was a problem hiding this comment.
After installing TypeScript ~3.6.0, this line errors out: TS2461: Type 'unknown' is not an array type.
This is because unknown is the type for cliStyleConfig.entry if you don't specify so I just went ahead and updated the generic to match the type (which is any according to my editor).
lychyi
force-pushed
the
ts-change-9463
branch
from
74ab4a4
to
1083476
Compare
lychyi
requested review from
aaronmcadam,
alexandrebodin,
CodeByAlex,
dangreenisrael,
danielduan,
Gongreg,
jbovenschen,
kazupon,
leonrodenburg,
thani-sh,
naipath,
ndelangen,
renaudtertrais,
rmevans9,
saponifi3d,
shilman,
stijnkoopal and
theinterned
as code owners
| @@ -49,6 +49,7 @@ const linked = ( | |||
| }: { onClick: Function; onKeyUp: Function; Link: ComponentType; prefix: string } | |||
| ) => { | |||
| const Linked = React.memo(p => ( | |||
| // @ts-ignore | |||
There was a problem hiding this comment.
For some reason, compiling TS doesn't quite ignore the onKeyUp, it references line 52 instead so I had to add a // @ts-ignore here. I'm not sure if this is different in TS3.7 vs TS3.6.
There was a problem hiding this comment.
Thanks @lychyi, really great work!!! Per discussion in the issue, I'm not sure whether this should target next or master. Hope one of the typescript guys can comment cc @kroeder @gaetanmaisse
|
Superseeded by #9847 |
Possibly closing in favor of #9847
Issue: Fixes #9463
Storybook version 5.3.x should be on TypeScript 3.6 and not on 3.7.
The "minor" bump in TS versions caused a breaking change. A class of type declarations generated with TS3.7 would not be compatible with TS3.6 and below. This causes users of Storybook 5.3 to either upgrade TS to 3.7 or stay on an older version of Storybook.
For library maintainers, if they upgrade TS to 3.7, they would force their consumers to do so as well to avoid this issue. Given that the leap from TS 3.6 to 3.7 is technically a breaking change, it would make sense for the Storybook 5.3 version line to just hold at
~3.6.0and wait to upgrade to 3.7 when Storybook 6 gets released (or held until future major versions). This PR does that.What I did
I specified the workspace
package.jsondependency to"typescript": '~3.6.0'. This generates declaration files usingtscusing 3.6.5 and should play nice with Storybook consumers still using TypeScript 3.6 and below.A few other changes were made to accommodate this and I've notated it as comments in the file diffs themselves.