Merge pull request #23 from blutorange/update-to-esm

Switch from CommonJS to ESM for support for TypeDoc 0.27.x

package.json

@@ -2,6 +2,7 @@
   "name": "typedoc-plugin-mdn-links",
   "version": "4.0.1",
   "main": "dist/index.js",
+  "type": "module",
   "license": "MIT",
   "devDependencies": {
     "@webgpu/types": "^0.1.43",

scripts/generateWebApiIndex.js

@@ -1,6 +1,9 @@
-const bcd = require("@mdn/browser-compat-data");
-const { writeFileSync } = require("fs");
-const { join } = require("path");
+import bcd from "@mdn/browser-compat-data" assert { type: "json" };
+import { writeFileSync } from "node:fs";
+import { join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const dirname = resolve(fileURLToPath(import.meta.url), "..");
 
 /** @typedef {import("../src/webApi").WebApiData} WebApiData */
 
@@ -61,6 +64,6 @@ for (const key in bcd.javascript.builtins) {
 
 console.log("There are", Object.keys(results).length, "root entries.");
 writeFileSync(
-    join(__dirname, "../data/web-api.json"),
+    join(dirname, "../data/web-api.json"),
     JSON.stringify(results, null, "\t"),
 );

src/index.ts

@@ -1,17 +1,17 @@
 import {
     Application,
-    CommentDisplayPart,
-    ComponentPath,
+    type CommentDisplayPart,
+    type ComponentPath,
     Converter,
-    DeclarationReference,
+    type DeclarationReference,
     ParameterType,
     Reflection,
     ReflectionSymbolId,
     splitUnquotedString,
-    SymbolReference,
+    type SymbolReference,
 } from "typedoc";
-import { resolveTsType } from "./typescript";
-import { resolveWebApiPath } from "./webApi";
+import { resolveTsType } from "./typescript.js";
+import { resolveWebApiPath } from "./webApi.js";
 
 declare module "typedoc" {
     export interface TypeDocOptionMap {

src/test/plugin.test.ts

@@ -1,7 +1,7 @@
 import {
     Application,
     DeclarationReflection,
-    InlineTagDisplayPart,
+    type InlineTagDisplayPart,
     ProjectReflection,
     QueryType,
     ReferenceType,

src/typescript.ts

@@ -1,4 +1,4 @@
-import { ComponentPath } from "typedoc";
+import type { ComponentPath } from "typedoc";
 
 const utilityTypes = new Map([
     ["Awaited", "awaitedtype"],

src/webApi.ts

@@ -1,12 +1,12 @@
-import { ComponentPath } from "typedoc";
+import type { ComponentPath } from "typedoc";
 
 export interface WebApiData {
     url: string;
     inst?: Record<string, WebApiData | string>;
     stat?: Record<string, WebApiData | string>;
 }
 
-import _webApi from "#data";
+import _webApi from "#data" assert { type: "json" };
 const webApi = _webApi as Record<string, WebApiData | string>;
 
 function resolvePath(

tsconfig.json

@@ -1,7 +1,7 @@
 {
     "compilerOptions": {
         "target": "es2020",
-        "module": "Node16",
+        "module": "NodeNext",
         "lib": ["ESNext", "DOM"],
         "rootDir": "src",
         "strict": true,
@@ -10,7 +10,8 @@
         "resolveJsonModule": true,
         "outDir": "dist",
         "types": [],
-        "skipLibCheck": true
+        "skipLibCheck": true,
+        "verbatimModuleSyntax": true
     },
     "include": ["."]
 }