Skip to content

feat(language-service): Make MDX nodes typed with JSX.IntrinsicElements #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 16, 2025
Merged

feat(language-service): Make MDX nodes typed with JSX.IntrinsicElements #515

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f88955b
feat(language-service): Make mdx nodes typed with MDX.IntrinsicElements
guyutongxue Aug 31, 2025
f0dc9b8
fix(language-service): use JSX node name map
guyutongxue Sep 7, 2025
fd53792
fix(language-service): close tag bug & tests
guyutongxue Sep 14, 2025
cc9043d
chore(pr): add changeset
guyutongxue Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions packages/language-service/lib/virtual-code.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,25 @@ import {isInjectableComponent, isInjectableEstree} from './jsx-utils.js'
*/
const jsPrefix = (jsxImportSource) => `/* @jsxRuntime automatic
@jsxImportSource ${jsxImportSource} */

/**
* @internal
* @template T
* @typedef {void extends MDX.IntrinsicElements ? any : T extends keyof MDX.IntrinsicElements ? MDX.IntrinsicElements[T] : any} _MDXProps
*/

/**
* @internal
* @typedef {void extends MDX.Element ? JSX.Element : MDX.Element} _MDXElement
*/

/**
* @internal
* @type {{
* [Name in keyof _MDXNodeNames]: (props: _MDXProps<Name>) => _MDXElement
* }}
*/
const _MDXNodes = /** @type {any} */(0);
`

/**
Expand Down Expand Up @@ -247,6 +266,8 @@ function getEmbeddedCodes(
let jsxVariables = ''
let markdown = ''
let nextMarkdownSourceStart = 0
/** @type {Set<string>} */
const foundMdxNodeNames = new Set()

const plugins = virtualCodePlugins.map((plugin) => plugin())
/** @type {CodeMapping[]} */
Expand Down Expand Up @@ -739,7 +760,8 @@ function getEmbeddedCodes(
}

default: {
jsx += jsxIndent + '<>'
foundMdxNodeNames.add(node.type)
jsx += jsxIndent + `<_MDXNodes.${node.type}>`
break
}
}
Expand Down Expand Up @@ -789,7 +811,7 @@ function getEmbeddedCodes(
}

default: {
jsx += jsxIndent + '</>'
jsx += jsxIndent + `</_MDXNodes.${node.type}>`
break
}
}
Expand Down Expand Up @@ -820,6 +842,12 @@ function getEmbeddedCodes(
esmMapping.lengths.unshift(0)
}

esm += `/**
* @typedef {object} _MDXNodeNames
${[...foundMdxNodeNames].map((name) => ` * @property {unknown} ${name}`).join('\n')}
*/
`

updateMarkdownFromOffsets(mdx.length, mdx.length)
esm += componentStart(hasAwait, programScope)

Expand Down
Loading