TypeScript: Migrate `@storybook/docs-tools` to strict TS by efrenaragon96 · Pull Request #22567 · storybookjs/storybook

efrenaragon96 · 2023-05-16T03:15:15Z

Part of #22176

What I did

Migrate @storybook/docs-tools to strict-ts

How to test

Checklist

Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
Make sure to add/update documentation regarding your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Maintainers

If this PR should be tested against many or all sandboxes,
make sure to add the ci:merged or ci:daily GH label to it.
Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

code/lib/docs-tools/src/argTypes/docgen/extractDocgenProps.ts

kasperpeulen

Something seems to wrong in CI.

efrenaragon96 · 2023-06-07T13:13:30Z

Something seems to wrong in CI.

What do you propose? Because the last change isn't rare or complex.

yannbf · 2023-09-19T08:55:57Z

Hey @efrenaragon96 thanks for your contribution! @kasperpeulen would you mind chiming in whenever you have time?

ndelangen · 2023-09-19T15:44:35Z

@efrenaragon96 can you check what's going on with these failures:

> nx run @storybook/react:check

src/docs/propTypes/handleProp.test.tsx:86:18 - error TS18047: 'type' is possibly 'null'.

86           expect(type.summary).toBe('MY_LITERAL');
                    ~~~~
src/docs/propTypes/handleProp.test.tsx:87:18 - error TS18047: 'type' is possibly 'null'.

87           expect(type.detail).toBeUndefined();
                    ~~~~
src/docs/propTypes/handleProp.test.tsx:102:18 - error TS18047: 'type' is possibly 'null'.

102           expect(type.summary.replace(/\s/g, '')).toBe(expectedSummary.replace(/\s/g, ''));
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:102:18 - error TS18048: 'type.summary' is possibly 'undefined'.

102           expect(type.summary.replace(/\s/g, '')).toBe(expectedSummary.replace(/\s/g, ''));
                     ~~~~~~~~~~~~
src/docs/propTypes/handleProp.test.tsx:103:18 - error TS18047: 'type' is possibly 'null'.

103           expect(type.detail).toBeUndefined();
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:116:18 - error TS18047: 'type' is possibly 'null'.

116           expect(type.summary).toBe('object');
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:126:18 - error TS18047: 'type' is possibly 'null'.

126           expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:139:18 - error TS18047: 'type' is possibly 'null'.

139           expect(type.summary).toBe('object');
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:152:18 - error TS18047: 'type' is possibly 'null'.

152           expect(type.summary).toBe('InlinedFunctionalComponent');
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:158:18 - error TS18047: 'type' is possibly 'null'.

158           expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:171:18 - error TS18047: 'type' is possibly 'null'.

171           expect(type.summary).toBe('element');
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:176:18 - error TS18047: 'type' is possibly 'null'.

176           expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:189:18 - error TS18047: 'type' is possibly 'null'.

189           expect(type.summary).toBe('element');
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:195:18 - error TS18047: 'type' is possibly 'null'.

195           expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                     ~~~~
src/docs/propTypes/handleProp.test.tsx:209:20 - error TS18047: 'type' is possibly 'null'.

209             expect(type.summary).toBe('custom');
                       ~~~~
src/docs/propTypes/handleProp.test.tsx:210:20 - error TS18047: 'type' is possibly 'null'.

210             expect(type.detail).toBe(
                       ~~~~
src/docs/propTypes/handleProp.test.tsx:225:20 - error TS18047: 'type' is possibly 'null'.

225             expect(type.summary).toBe('Symbol("Hey!")');
                       ~~~~
src/docs/propTypes/handleProp.test.tsx:226:20 - error TS18047: 'type' is possibly 'null'.

226             expect(type.detail).toBeUndefined();
                       ~~~~
src/docs/propTypes/handleProp.test.tsx:240:16 - error TS18047: 'type' is possibly 'null'.

240         expect(type.summary).toBe('custom');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:264:16 - error TS18047: 'type' is possibly 'null'.

264         expect(type.summary).toBe(x);
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:285:14 - error TS18047: 'type' is possibly 'null'.

285       expect(type.summary.replace(/\s/g, '')).toBe(expectedSummary.replace(/\s/g, ''));
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:285:14 - error TS18048: 'type.summary' is possibly 'undefined'.

285       expect(type.summary.replace(/\s/g, '')).toBe(expectedSummary.replace(/\s/g, ''));
                 ~~~~~~~~~~~~
src/docs/propTypes/handleProp.test.tsx:286:14 - error TS18047: 'type' is possibly 'null'.

286       expect(type.detail).toBeUndefined();
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:324:14 - error TS18047: 'type' is possibly 'null'.

324       expect(type.summary).toBe('object');
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:335:14 - error TS18047: 'type' is possibly 'null'.

335       expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:359:14 - error TS18047: 'type' is possibly 'null'.

359       expect(type.summary).toBe('object');
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:381:14 - error TS18047: 'type' is possibly 'null'.

381       expect(type.summary).toBe("'News' | 'Photos'");
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:405:14 - error TS18047: 'type' is possibly 'null'.

405       expect(type.summary).toBe('object | object');
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:417:14 - error TS18047: 'type' is possibly 'null'.

417       expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:439:14 - error TS18047: 'type' is possibly 'null'.

439       expect(type.summary).toBe('{ text: string } | { foo: string }');
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:461:14 - error TS18047: 'type' is possibly 'null'.

461       expect(type.summary).toBe('object | object');
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:484:14 - error TS18047: 'type' is possibly 'null'.

484       expect(type.summary).toBe('element | ClassComponent');
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:494:14 - error TS18047: 'type' is possibly 'null'.

494       expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:507:16 - error TS18047: 'type' is possibly 'null'.

507         expect(type.summary).toBe('func');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:520:16 - error TS18047: 'type' is possibly 'null'.

520         expect(type.summary).toBe('func');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:533:16 - error TS18047: 'type' is possibly 'null'.

533         expect(type.summary).toBe('(event, data) => string');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:547:14 - error TS18047: 'type' is possibly 'null'.

547       expect(type.summary).toBe('Set');
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:563:16 - error TS18047: 'type' is possibly 'null'.

563         expect(type.summary).toBe('objectOf(number)');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:564:16 - error TS18047: 'type' is possibly 'null'.

564         expect(type.detail).toBeUndefined();
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:580:16 - error TS18047: 'type' is possibly 'null'.

580         expect(type.summary).toBe('objectOf(NAMED_OBJECT)');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:581:16 - error TS18047: 'type' is possibly 'null'.

581         expect(type.detail).toBeUndefined();
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:597:16 - error TS18047: 'type' is possibly 'null'.

597         expect(type.summary).toBe('objectOf({ foo: string })');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:598:16 - error TS18047: 'type' is possibly 'null'.

598         expect(type.detail).toBeUndefined();
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:614:16 - error TS18047: 'type' is possibly 'null'.

614         expect(type.summary).toBe('objectOf(object)');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:623:16 - error TS18047: 'type' is possibly 'null'.

623         expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:639:16 - error TS18047: 'type' is possibly 'null'.

639         expect(type.summary).toBe('objectOf(object)');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:660:16 - error TS18047: 'type' is possibly 'null'.

660         expect(type.summary).toBe('objectOf({ foo: string })');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:661:16 - error TS18047: 'type' is possibly 'null'.

661         expect(type.detail).toBeUndefined();
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:694:16 - error TS18047: 'type' is possibly 'null'.

694         expect(type.summary).toBe('objectOf(object)');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:703:16 - error TS18047: 'type' is possibly 'null'.

703         expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:730:16 - error TS18047: 'type' is possibly 'null'.

730         expect(type.summary).toBe('objectOf(object)');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:752:14 - error TS18047: 'type' is possibly 'null'.

752       expect(type.summary).toBe('string | Set');
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:753:14 - error TS18047: 'type' is possibly 'null'.

753       expect(type.detail).toBeUndefined();
                 ~~~~
src/docs/propTypes/handleProp.test.tsx:769:16 - error TS18047: 'type' is possibly 'null'.

769         expect(type.summary).toBe('number[]');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:770:16 - error TS18047: 'type' is possibly 'null'.

770         expect(type.detail).toBeUndefined();
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:786:16 - error TS18047: 'type' is possibly 'null'.

786         expect(type.summary).toBe('NAMED_OBJECT[]');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:787:16 - error TS18047: 'type' is possibly 'null'.

787         expect(type.detail).toBeUndefined();
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:803:16 - error TS18047: 'type' is possibly 'null'.

803         expect(type.summary).toBe('[{ foo: string }]');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:804:16 - error TS18047: 'type' is possibly 'null'.

804         expect(type.detail).toBeUndefined();
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:820:16 - error TS18047: 'type' is possibly 'null'.

820         expect(type.summary).toBe('object[]');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:831:16 - error TS18047: 'type' is possibly 'null'.

831         expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:847:16 - error TS18047: 'type' is possibly 'null'.

847         expect(type.summary).toBe('object[]');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:868:16 - error TS18047: 'type' is possibly 'null'.

868         expect(type.summary).toBe('[{ foo: string }]');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:869:16 - error TS18047: 'type' is possibly 'null'.

869         expect(type.detail).toBeUndefined();
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:910:16 - error TS18047: 'type' is possibly 'null'.

910         expect(type.summary).toBe('object[]');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:921:16 - error TS18047: 'type' is possibly 'null'.

921         expect(type.detail?.replace(/\s/g, '')).toBe(expectedDetail.replace(/\s/g, ''));
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:948:16 - error TS18047: 'type' is possibly 'null'.

948         expect(type.summary).toBe('object[]');
                   ~~~~
src/docs/propTypes/handleProp.test.tsx:976:14 - error TS18048: 'defaultValue.summary' is possibly 'undefined'.

976       expect(defaultValue?.summary.replace(/\s/g, '')).toBe(expectedSummary.replace(/\s/g, ''));
                 ~~~~~~~~~~~~~~~~~~~~~
src/docs/propTypes/rawDefaultPropResolvers.ts:13:21 - error TS18047: 'type' is possibly 'null'.

13   const isElement = type.summary === 'element' || type.summary === 'elementType';
                       ~~~~
src/docs/propTypes/rawDefaultPropResolvers.ts:13:51 - error TS18047: 'type' is possibly 'null'.

13   const isElement = type.summary === 'element' || type.summary === 'elementType';
                                                     ~~~~
src/docs/typeScript/handleProp.test.tsx:88:14 - error TS18048: 'defaultValue.summary' is possibly 'undefined'.

88       expect(defaultValue?.summary.replace(/\s/g, '')).toBe(expectedSummary.replace(/\s/g, ''));
                ~~~~~~~~~~~~~~~~~~~~~


> nx run @storybook/vue:check

src/docs/extractArgTypes.ts(21,9): error TS2339: Property 'summary' does not exist on type 'PropSummaryValue | null'.
src/docs/extractArgTypes.ts(24,17): error TS2769: No overload matches this call.
  Overload 1 of 4, '(target: {}, source: { name: string; value: any[]; summary: any; detail?: string | undefined; }): { name: string; value: any[]; summary: any; detail?: string | undefined; }', gave the following error.
    Argument of type 'PropSummaryValue | null' is not assignable to parameter of type '{}'.
      Type 'null' is not assignable to type '{}'.
  Overload 2 of 4, '(target: object, ...sources: any[]): any', gave the following error.
    Argument of type 'PropSummaryValue | null' is not assignable to parameter of type 'object'.
      Type 'null' is not assignable to type 'object'.

🙏

socket-security · 2023-11-28T21:51:45Z

Updated and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@rollup/pluginutils	5.0.5...5.1.0	None	`+0/-0`	57.1 kB	shellscape

🚮 Removed packages: @angular-devkit/core@16.2.4, @storybook/client-logger@7.5.3, @storybook/theming@7.5.3

done

JReinhold assigned kasperpeulen May 22, 2023

kasperpeulen self-requested a review May 31, 2023 09:21

kasperpeulen previously requested changes May 31, 2023

View reviewed changes

code/lib/docs-tools/src/argTypes/docgen/extractDocgenProps.ts Show resolved Hide resolved

kasperpeulen mentioned this pull request May 31, 2023

Migrate monorepo to strict TS #22176

Closed

efrenaragon96 added 8 commits June 1, 2023 15:43

feat: activate strict option in ts config

fa90910

fix: jsdocParser errors

b35de57

fix: ts error in argTypes converter

7b1be45

fix: ts error on src/argTypes/docgen folder

39404a0

fix: ts error on src/argTypes/docgen/flow folder

d95b4c3

fix: ts error on src/argTypes/docgen/typeScript folder

6498a92

fix: ts error in utils files

e49d5fd

fix: call parseJsDoc without second param

3f791b5

efrenaragon96 force-pushed the ts-migrate/lib-docs-tools branch from 642a42f to 3f791b5 Compare June 1, 2023 19:46

kasperpeulen and others added 2 commits June 2, 2023 09:37

Prefer satisfies over as

0dff3fe

fix: change satisfies by static type

e12279a

efrenaragon96 requested a review from a team as a code owner June 5, 2023 19:16

fix: use only the fields for the JsDocTags type

305d5da

kasperpeulen reviewed Jun 6, 2023

View reviewed changes

ndelangen and others added 5 commits June 7, 2023 15:41

Merge branch 'next' into ts-migrate/lib-docs-tools

61ce834

Merge branch 'next' into ts-migrate/lib-docs-tools

8382350

Merge branch 'next' into ts-migrate/lib-docs-tools

3b54eac

Merge branch 'next' into ts-migrate/lib-docs-tools

96afbdc

fix: doc tools types

d78e200

efrenaragon96 force-pushed the ts-migrate/lib-docs-tools branch from d5e4b0f to d78e200 Compare July 3, 2023 19:44

Merge branch 'next' into ts-migrate/lib-docs-tools

f0d68a3

efrenaragon96 requested review from JReinhold and shilman as code owners August 2, 2023 17:32

kasperpeulen added maintenance User-facing maintenance tasks ci:normal labels Aug 3, 2023

Merge branch 'next' into ts-migrate/lib-docs-tools

2356aad

kasperpeulen removed their assignment Aug 4, 2023

ndelangen assigned kasperpeulen Aug 7, 2023

ndelangen added the patch:no label Aug 7, 2023

kasperpeulen removed the patch:no label Aug 9, 2023

yannbf and others added 2 commits September 19, 2023 10:56

Merge branch 'next' into ts-migrate/lib-docs-tools

325b0d7

Merge branch 'next' into ts-migrate/lib-docs-tools

f40ec49

fix: check possible undefined or null values

9ade666

efrenaragon96 requested a review from valentinpalkovic as a code owner October 9, 2023 21:26

efrenaragon96 and others added 2 commits October 9, 2023 17:31

fix: use tiny-invariant in vue docs

cf83e3f

Merge branch 'next' into ts-migrate/lib-docs-tools

fc0b847

valentinpalkovic removed their request for review November 28, 2023 09:02

ndelangen added 2 commits November 28, 2023 22:24

Merge branch 'next' into pr/efrenaragon96/22567

804cb50

regen lockfile

f8b3d2b

ndelangen requested a review from kasperpeulen November 28, 2023 21:31

fix

5a74d6e

ndelangen changed the title ~~Migrate @storybook/docs-tools to strict TS~~ Maintenence: Migrate @storybook/docs-tools to strict TS Nov 28, 2023

ndelangen approved these changes Nov 29, 2023

View reviewed changes

ndelangen merged commit 9fecce2 into storybookjs:next Nov 29, 2023

github-actions bot mentioned this pull request Nov 29, 2023

Release: Prerelease 8.0.0-alpha.1 #25017

Merged

36 tasks

shilman changed the title ~~Maintenence: Migrate @storybook/docs-tools to strict TS~~ TypeScript: Migrate @storybook/docs-tools to strict TS Dec 5, 2023

github-actions bot mentioned this pull request Dec 7, 2023

Release: Prerelease 8.0.0-alpha.1 #25140

Closed

44 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

TypeScript: Migrate `@storybook/docs-tools` to strict TS#22567

TypeScript: Migrate `@storybook/docs-tools` to strict TS#22567
ndelangen merged 26 commits intostorybookjs:nextfrom
efrenaragon96:ts-migrate/lib-docs-tools

efrenaragon96 commented May 16, 2023

Uh oh!

Uh oh!

kasperpeulen left a comment

Uh oh!

efrenaragon96 commented Jun 7, 2023

Uh oh!

yannbf commented Sep 19, 2023

Uh oh!

ndelangen commented Sep 19, 2023

Uh oh!

socket-security bot commented Nov 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

efrenaragon96 commented May 16, 2023

What I did

How to test

Checklist

Maintainers

Uh oh!

Uh oh!

kasperpeulen left a comment

Choose a reason for hiding this comment

Uh oh!

efrenaragon96 commented Jun 7, 2023

Uh oh!

yannbf commented Sep 19, 2023

Uh oh!

ndelangen commented Sep 19, 2023

Uh oh!

socket-security bot commented Nov 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants