types: create jsdoc based typescript typings

[ChristianMurphy]

No description provided.

[ChristianMurphy]

more definition around what these could/should be could be helpfup

[wooorm]

I guess there are no types for Fragment, jsx (which is missing here), and jsxs https://github.com/DefinitelyTyped/DefinitelyTyped/blob/a05cc538a42243c632f054e42eab483ebf1560ab/types/react/index.d.ts, perhaps because they are normally injected instead of supposed to be imported

[wooorm]

I guess there are no types for Fragment, jsx (which is missing here), and jsxs https://github.com/DefinitelyTyped/DefinitelyTyped/blob/a05cc538a42243c632f054e42eab483ebf1560ab/types/react/index.d.ts, perhaps because they are normally injected instead of supposed to be imported

[wooorm]

Maybe MDXContentProps instead? To me that explains more that they’re for the content component

[wooorm]

Maybe MDXContent can also be defined as a function, which always returns a call to jsx / jsxs / pragma

[ChristianMurphy]

applied the first, can you expand what you mean by the second?

[wooorm]

The result of evaluate() at .default is a component: a function that takes MDXContentProps and returns a call to jsx: in React, I’m sure there’s a type for that.

Now, assuming jsx had types in React, then there’d be a type for its return value, right? Then I’m guessing that you could take that value and define it as .defaults return value too?

Illustrated in another way: jsx is a function: f() = x. So the return value of .default is also always x

(and for my comment I forgot that pragma is not an option for evaluate, and the return value of jsxs and jsx are the same)

[ChristianMurphy]

The result of evaluate() at .default is a component: a function that takes MDXContentProps

Right, and that is the ExportMap type on line 19

Now, assuming jsx had types in React, then there’d be a type for its return value, right?

For react yes,
one that is consistent across React, Preact, and Vue, I'm not so sure.
I think there are differences (it would take some experimentation to check), and if there are differences, it would be difficult to capture even with conditional types watching what was passed to pragma.

[wooorm]

There would be difference but the result of that f() = x should be accessible though?

If someone does evaluateSync({jsx: f}).default() the output type is still x, and jsx is a required option.

I understand that all the things passed as jsx will be different, but they’re required to be functions, so that might help?

[wooorm]

Preact’s runtime does have types: https://github.com/preactjs/preact/blob/9250ac91891d19ec988938971b6767697bcb028e/jsx-runtime/src/index.d.ts#L11-L17

[wooorm]

One extra thing is that TS is probably not reading webpack.cjs in the root, due to its extension? That might be useful for webpack folks wanting types

[ChristianMurphy]

I can add jsdocs to webpack.cjs, but the extension will conflict with

error TS6054: File 'xdm/webpack.cjs' has an unsupported extension. The only supported extensions are '.ts', '.tsx', '.d.ts', '.js', '.jsx'.

adding cjs extension support in typescript is an open item at microsoft/TypeScript#38784

[wooorm]

find . -maxdepth 3 -type f -name "*.d.ts" was removing a ton of stuff from node_modules btw, which was hiding https://github.com/wooorm/xdm/runs/1878119750?check_suite_focus=true#step:5:157