Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
Closed
Assignees
Labels
accepting prsGo ahead, send a pull request that resolves this issuelocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.package: websiteIssues related to the @typescript-eslint websiterepo maintenancethings to do with maintenance of the repo, and not with code/docs
Description
Suggestion
Right now ourgenerated-rule-docs.ts file manually inserts POJO objects for the MDAST. It'd be great if we could use a package likehttps://github.com/syntax-tree/mdast-util-from-markdown to clean up that code.
However, that package is written in ESM, which Docusaurus doesn't support yet. Adding this inside a plugin:
import{fromMarkdown}from'mdast-util-from-markdown';
...gives a loading failure:
[INFO] Starting the development server...[ERROR] Error [ERR_REQUIRE_ESM]: require() of ES Module /Users/josh/repos/typescript-eslint/node_modules/mdast-util-from-markdown/index.js from /Users/josh/repos/typescript-eslint/packages/website/plugins/generated-rule-docs.ts not supported.Instead change the require of index.js in /Users/josh/repos/typescript-eslint/packages/website/plugins/generated-rule-docs.ts to a dynamic import() which is available in all CommonJS modules. at Object.require.extensions.<computed> [as .js] (/Users/josh/repos/typescript-eslint/node_modules/ts-node/dist/index.js:785:20) at Object.<anonymous> (/Users/josh/repos/typescript-eslint/packages/website/plugins/generated-rule-docs.ts:8:30) at Module.m._compile (/Users/josh/repos/typescript-eslint/node_modules/ts-node/dist/index.js:791:29) at Object.require.extensions.<computed> [as .ts] (/Users/josh/repos/typescript-eslint/node_modules/ts-node/dist/index.js:793:16) at Object.<anonymous> (/Users/josh/repos/typescript-eslint/packages/website/docusaurusConfig.ts:5:26) at Module.m._compile (/Users/josh/repos/typescript-eslint/node_modules/ts-node/dist/index.js:791:29) at Object.require.extensions.<computed> [as .ts] (/Users/josh/repos/typescript-eslint/node_modules/ts-node/dist/index.js:793:16) at Object.<anonymous> (/Users/josh/repos/typescript-eslint/packages/website/docusaurus.config.js:10:18) at module.exports (/Users/josh/repos/typescript-eslint/node_modules/import-fresh/index.js:32:59) at loadSiteConfig (/Users/josh/repos/typescript-eslint/node_modules/@docusaurus/core/lib/server/config.js:36:55) at async loadContext (/Users/josh/repos/typescript-eslint/node_modules/@docusaurus/core/lib/server/index.js:31:63) at async load (/Users/josh/repos/typescript-eslint/node_modules/@docusaurus/core/lib/server/index.js:75:21) at async start (/Users/josh/repos/typescript-eslint/node_modules/@docusaurus/core/lib/commands/start.js:41:19)Switching to an async import:
const{ fromMarkdown}=awaitimport('mdast-util-from-markdown');
Delays the failure until each rule docs page's generation:
[INFO] Starting the development server...[SUCCESS] Docusaurus website is running at: http://localhost:3000/ℹ Compiling Client✔ Client: Compiled with some errors in 5.85sError [ERR_REQUIRE_ESM]: require() of ES Module /Users/josh/repos/typescript-eslint/node_modules/mdast-util-from-markdown/index.js from /Users/josh/repos/typescript-eslint/packages/website/plugins/generated-rule-docs.ts not supported.Instead change the require of index.js in /Users/josh/repos/typescript-eslint/packages/website/plugins/generated-rule-docs.ts to a dynamic import() which is available in all CommonJS modules....client (webpack 5.73.0) compiled with 127 errorscc@Josh-Cena, our resident Docusaurus expert! 😄
Metadata
Metadata
Assignees
Labels
accepting prsGo ahead, send a pull request that resolves this issuelocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.package: websiteIssues related to the @typescript-eslint websiterepo maintenancethings to do with maintenance of the repo, and not with code/docs