{"id":26463761,"url":"https://github.com/syntax-tree/mdast-util-mdxjs-esm","last_synced_at":"2025-03-19T07:16:16.272Z","repository":{"id":44541892,"uuid":"317183918","full_name":"syntax-tree/mdast-util-mdxjs-esm","owner":"syntax-tree","description":"mdast extension to parse and serialize MDX.js ESM (import/exports)","archived":false,"fork":false,"pushed_at":"2024-09-13T10:00:51.000Z","size":134,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-02-16T21:06:44.005Z","etag":null,"topics":["esm","mdast","mdast-util","mdx","mdxjs"],"latest_commit_sha":null,"homepage":"https://unifiedjs.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/syntax-tree.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"unifiedjs","open_collective":"unified"}},"created_at":"2020-11-30T10:11:57.000Z","updated_at":"2024-09-13T10:00:55.000Z","dependencies_parsed_at":"2023-02-16T08:46:12.475Z","dependency_job_id":"b60f1304-d98a-4cf0-944d-8beba27a554f","html_url":"https://github.com/syntax-tree/mdast-util-mdxjs-esm","commit_stats":{"total_commits":50,"total_committers":2,"mean_commits":25.0,"dds":"0.040000000000000036","last_synced_commit":"b2ade9b49592a1a7cd7917f6f81535fd065d6e20"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntax-tree%2Fmdast-util-mdxjs-esm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntax-tree%2Fmdast-util-mdxjs-esm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntax-tree%2Fmdast-util-mdxjs-esm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntax-tree%2Fmdast-util-mdxjs-esm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/syntax-tree","download_url":"https://codeload.github.com/syntax-tree/mdast-util-mdxjs-esm/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244082787,"owners_count":20395330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esm","mdast","mdast-util","mdx","mdxjs"],"created_at":"2025-03-19T07:16:15.699Z","updated_at":"2025-03-19T07:16:16.263Z","avatar_url":"https://github.com/syntax-tree.png","language":"JavaScript","funding_links":["https://github.com/sponsors/unifiedjs","https://opencollective.com/unified"],"categories":[],"sub_categories":[],"readme":"# mdast-util-mdxjs-esm\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n[![Sponsors][sponsors-badge]][collective]\n[![Backers][backers-badge]][collective]\n[![Chat][chat-badge]][chat]\n\n[mdast][] extensions to parse and serialize [MDX][] ESM (import/exports).\n\n## Contents\n\n* [What is this?](#what-is-this)\n* [When to use this](#when-to-use-this)\n* [Install](#install)\n* [Use](#use)\n* [API](#api)\n  * [`mdxjsEsmFromMarkdown()`](#mdxjsesmfrommarkdown)\n  * [`mdxjsEsmToMarkdown()`](#mdxjsesmtomarkdown)\n  * [`MdxjsEsm`](#mdxjsesm)\n  * [`MdxjsEsmHast`](#mdxjsesmhast)\n* [HTML](#html)\n* [Syntax](#syntax)\n* [Syntax tree](#syntax-tree)\n  * [Nodes](#nodes)\n  * [Content model](#content-model)\n* [Types](#types)\n* [Compatibility](#compatibility)\n* [Related](#related)\n* [Contribute](#contribute)\n* [License](#license)\n\n## What is this?\n\nThis package contains two extensions that add support for MDX ESM syntax in\nmarkdown to [mdast][].\nThese extensions plug into\n[`mdast-util-from-markdown`][mdast-util-from-markdown] (to support parsing\nESM in markdown into a syntax tree) and\n[`mdast-util-to-markdown`][mdast-util-to-markdown] (to support serializing\nESM in syntax trees to markdown).\n\n## When to use this\n\nYou can use these extensions when you are working with\n`mdast-util-from-markdown` and `mdast-util-to-markdown` already.\n\nWhen working with `mdast-util-from-markdown`, you must combine this package\nwith [`micromark-extension-mdxjs-esm`][extension].\n\nWhen you are working with syntax trees and want all of MDX, use\n[`mdast-util-mdx`][mdast-util-mdx] instead.\n\nAll these packages are used in [`remark-mdx`][remark-mdx], which\nfocusses on making it easier to transform content by abstracting these\ninternals away.\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 16+), install with [npm][]:\n\n```sh\nnpm install mdast-util-mdxjs-esm\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'https://esm.sh/mdast-util-mdxjs-esm@2'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'https://esm.sh/mdast-util-mdxjs-esm@2?bundle'\n\u003c/script\u003e\n```\n\n## Use\n\nSay our document `example.mdx` contains:\n\n```mdx\nimport a from 'b'\nexport const c = ''\n\nd\n```\n\n…and our module `example.js` looks as follows:\n\n```js\nimport fs from 'node:fs/promises'\nimport * as acorn from 'acorn'\nimport {fromMarkdown} from 'mdast-util-from-markdown'\nimport {toMarkdown} from 'mdast-util-to-markdown'\nimport {mdxjsEsm} from 'micromark-extension-mdxjs-esm'\nimport {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'mdast-util-mdxjs-esm'\n\nconst doc = await fs.readFile('example.mdx')\n\nconst tree = fromMarkdown(doc, {\n  extensions: [mdxjsEsm({acorn, addResult: true})],\n  mdastExtensions: [mdxjsEsmFromMarkdown()]\n})\n\nconsole.log(tree)\n\nconst out = toMarkdown(tree, {extensions: [mdxjsEsmToMarkdown()]})\n\nconsole.log(out)\n```\n\n…now running `node example.js` yields (positional info removed for brevity):\n\n```js\n{\n  type: 'root',\n  children: [\n    {\n      type: 'mdxjsEsm',\n      value: \"import a from 'b'\\nexport const c = ''\",\n      data: {\n        estree: {\n          type: 'Program',\n          body: [\n            {\n              type: 'ImportDeclaration',\n              specifiers: [\n                {\n                  type: 'ImportDefaultSpecifier',\n                  local: {type: 'Identifier', name: 'a'}\n                }\n              ],\n              source: {type: 'Literal', value: 'b', raw: \"'b'\"}\n            },\n            {\n              type: 'ExportNamedDeclaration',\n              declaration: {\n                type: 'VariableDeclaration',\n                declarations: [\n                  {\n                    type: 'VariableDeclarator',\n                    id: {type: 'Identifier', name: 'c'},\n                    init: {type: 'Literal', value: '', raw: \"''\"}\n                  }\n                ],\n                kind: 'const'\n              },\n              specifiers: [],\n              source: null\n            }\n          ],\n          sourceType: 'module'\n        }\n      }\n    },\n    {type: 'paragraph', children: [{type: 'text', value: 'd'}]}\n  ]\n}\n```\n\n```markdown\nimport a from 'b'\nexport const c = ''\n\nd\n```\n\n## API\n\nThis package exports the identifiers\n[`mdxjsEsmFromMarkdown`][api-mdxjs-esm-from-markdown] and\n[`mdxjsEsmToMarkdown`][api-mdxjs-esm-to-markdown].\nThere is no default export.\n\n### `mdxjsEsmFromMarkdown()`\n\nCreate an extension for [`mdast-util-from-markdown`][mdast-util-from-markdown]\nto enable MDX.js ESM in markdown.\n\nWhen using the [micromark syntax extension][extension] with `addResult`, nodes\nwill have a `data.estree` field set to an ESTree [`Program`][program] node.\n\n###### Returns\n\nExtension for `mdast-util-from-markdown` to enable MDX.js ESM\n([`FromMarkdownExtension`][from-markdown-extension]).\n\n### `mdxjsEsmToMarkdown()`\n\nCreate an extension for [`mdast-util-to-markdown`][mdast-util-to-markdown]\nto enable MDX.js ESM in markdown.\n\n###### Returns\n\nExtension for `mdast-util-to-markdown` to enable MDX.js ESM\n([`ToMarkdownExtension`][to-markdown-extension]).\n\n### `MdxjsEsm`\n\nMDX ESM (import/export) node (TypeScript type).\n\n###### Type\n\n```ts\nimport type {Program} from 'estree-jsx'\nimport type {Data, Literal} from 'mdast'\n\ninterface MdxjsEsm extends Literal {\n  type: 'mdxjsEsm'\n  data?: MdxjsEsmData | undefined\n}\n\nexport interface MdxjsEsmData extends Data {\n  estree?: Program | null | undefined\n}\n```\n\n### `MdxjsEsmHast`\n\nSame as [`MdxjsEsm`][api-mdxjs-esm], but registered with `@types/hast`\n(TypeScript type).\n\n###### Type\n\n```ts\nimport type {Program} from 'estree-jsx'\nimport type {Data, Literal} from 'hast'\n\ninterface MdxjsEsmHast extends Literal {\n  type: 'mdxjsEsm'\n  data?: MdxjsEsmHastData | undefined\n}\n\nexport interface MdxjsEsmHastData extends Data {\n  estree?: Program | null | undefined\n}\n```\n\n## HTML\n\nMDX ESM has no representation in HTML.\nThough, when you are dealing with MDX, you will likely go *through* hast.\nYou can enable passing MDX ESM through to hast by configuring\n[`mdast-util-to-hast`][mdast-util-to-hast] with `passThrough: ['mdxjsEsm']`.\n\n## Syntax\n\nSee [Syntax in `micromark-extension-mdxjs-esm`][syntax].\n\n## Syntax tree\n\nThe following interfaces are added to **[mdast][]** by this utility.\n\n### Nodes\n\n#### `MdxjsEsm`\n\n```idl\ninterface MdxjsEsm \u003c: Literal {\n  type: 'mdxjsEsm'\n}\n```\n\n**MdxjsEsm** (**[Literal][dfn-literal]**) represents ESM import/exports\nembedded in MDX.\nIt can be used where **[flow][dfn-flow-content]** content is expected.\nIts content is represented by its `value` field.\n\nFor example, the following Markdown:\n\n```markdown\nimport a from 'b'\n```\n\nYields:\n\n```js\n{\n  type: 'mdxjsEsm',\n  value: 'import a from \\'b\\''\n}\n```\n\n### Content model\n\n#### `FlowContent` (MDX.js ESM)\n\n```idl\ntype FlowContentMdxjsEsm = MdxjsEsm | FlowContent\n```\n\nNote that when ESM is present, it can only exist as top-level content: if it has\na *[parent][dfn-parent]*, that parent must be **[Root][dfn-root]**.\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports the additional types [`MdxjsEsm`][api-mdxjs-esm] and\n[`MdxjsEsmHast`][api-mdxjs-esm-hast].\n\nIt also registers the node type with `@types/mdast` and `@types/hast`.\nIf you’re working with the syntax tree, make sure to import this utility\nsomewhere in your types, as that registers the new node types in the tree.\n\n```js\n/**\n * @typedef {import('mdast-util-mdxjs-esm')}\n */\n\nimport {visit} from 'unist-util-visit'\n\n/** @type {import('mdast').Root} */\nconst tree = getMdastNodeSomeHow()\n\nvisit(tree, function (node) {\n  // `node` can now be an ESM node.\n})\n```\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line, `mdast-util-mdxjs-esm@^2`,\ncompatible with Node.js 16.\n\nThis utility works with `mdast-util-from-markdown` version 2+ and\n`mdast-util-to-markdown` version 2+.\n\n## Related\n\n* [`remarkjs/remark-mdx`][remark-mdx]\n  — remark plugin to support MDX\n* [`syntax-tree/mdast-util-mdx`][mdast-util-mdx]\n  — mdast utility to support MDX\n* [`micromark/micromark-extension-mdxjs-esm`][extension]\n  — micromark extension to parse MDX.js ESM\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for\nways to get started.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/syntax-tree/mdast-util-mdxjs-esm/workflows/main/badge.svg\n\n[build]: https://github.com/syntax-tree/mdast-util-mdxjs-esm/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-mdxjs-esm.svg\n\n[coverage]: https://codecov.io/github/syntax-tree/mdast-util-mdxjs-esm\n\n[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-mdxjs-esm.svg\n\n[downloads]: https://www.npmjs.com/package/mdast-util-mdxjs-esm\n\n[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size\u0026query=$.size.compressedSize\u0026url=https://deno.bundlejs.com/?q=mdast-util-mdxjs-esm\n\n[size]: https://bundlejs.com/?q=mdast-util-mdxjs-esm\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/syntax-tree/unist/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[esmsh]: https://esm.sh\n\n[typescript]: https://www.typescriptlang.org\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[health]: https://github.com/syntax-tree/.github\n\n[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md\n\n[support]: https://github.com/syntax-tree/.github/blob/main/support.md\n\n[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md\n\n[mdast]: https://github.com/syntax-tree/mdast\n\n[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast\n\n[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown\n\n[mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown\n\n[mdast-util-mdx]: https://github.com/syntax-tree/mdast-util-mdx\n\n[extension]: https://github.com/micromark/micromark-extension-mdxjs-esm\n\n[syntax]: https://github.com/micromark/micromark-extension-mdxjs-esm#syntax\n\n[program]: https://github.com/estree/estree/blob/master/es2015.md#programs\n\n[dfn-literal]: https://github.com/syntax-tree/mdast#literal\n\n[dfn-parent]: https://github.com/syntax-tree/unist#parent-1\n\n[dfn-root]: https://github.com/syntax-tree/mdast#root\n\n[remark-mdx]: https://mdxjs.com/packages/remark-mdx/\n\n[mdx]: https://mdxjs.com\n\n[from-markdown-extension]: https://github.com/syntax-tree/mdast-util-from-markdown#extension\n\n[to-markdown-extension]: https://github.com/syntax-tree/mdast-util-to-markdown#options\n\n[dfn-flow-content]: #flowcontent-mdxjs-esm\n\n[api-mdxjs-esm-from-markdown]: #mdxjsesmfrommarkdown\n\n[api-mdxjs-esm-to-markdown]: #mdxjsesmtomarkdown\n\n[api-mdxjs-esm]: #mdxjsesm\n\n[api-mdxjs-esm-hast]: #mdxjsesmhast\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyntax-tree%2Fmdast-util-mdxjs-esm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyntax-tree%2Fmdast-util-mdxjs-esm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyntax-tree%2Fmdast-util-mdxjs-esm/lists"}