fixup!;

Author: avivkeller

package-lock.json

@@ -37,7 +37,7 @@
     "eslint-plugin-import-x": "^4.16.1",
     "eslint-plugin-jsdoc": "^62.4.1",
     "eslint-plugin-react-x": "^2.8.1",
-    "globals": "^17.3.0",
+    "globals": "~17.3.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.2.7",
     "prettier": "3.8.1"

package.json

@@ -18,34 +18,9 @@ const creatingMapping = obj =>
 const map = {
   ...creatingMapping(compat.api),
   ...creatingMapping(compat.javascript.builtins),
-
-  //   TSC39 objects
-  asynciterable: 'https://tc39.github.io/ecma262/#sec-asynciterable-interface',
-  'module namespace object':
-    'https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects',
-
-  // Data structures
-  ...Object.fromEntries(
-    [
-      'null',
-      'undefined',
-      'boolean',
-      'number',
-      'bigint',
-      'string',
-      'symbol',
-    ].map(k => [
-      k,
-      `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/${k}`,
-    ])
-  ),
-  integer:
-    'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/number',
-  any: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/#Data_types',
-  this: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this',
 };
 
 writeFile(
-  './src/generators/metadata/typeMap.json',
+  './src/generators/metadata/maps/mdn.json',
   JSON.stringify(map, null, 2) + '\n'
 );

scripts/update-type-map.mjs

@@ -17,7 +17,7 @@ export default createLazyGenerator({
   dependsOn: 'ast',
 
   defaultConfiguration: {
-    typeMap: import.meta.resolve('./typeMap.json'),
+    typeMap: import.meta.resolve('./maps/hardcoded.json'),
   },
 
   hasParallelProcessor: true,

src/generators/metadata/index.mjs

@@ -0,0 +1,14 @@
+{
+  "asynciterable": "https://tc39.github.io/ecma262/#sec-asynciterable-interface",
+  "module namespace object": "https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects",
+  "null": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/null",
+  "undefined": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/undefined",
+  "boolean": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/boolean",
+  "number": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/number",
+  "bigint": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/bigint",
+  "string": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/string",
+  "symbol": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/symbol",
+  "integer": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/number",
+  "any": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/#Data_types",
+  "this": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this"
+}

src/generators/metadata/maps/hardcoded.json

@@ -1040,10 +1040,10 @@
   "asyncgeneratorfunction": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGeneratorFunction",
   "asynciterator": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator",
   "atomics": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Atomics",
-  "bigint": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/bigint",
+  "bigint": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/BigInt",
   "bigint64array": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/BigInt64Array",
   "biguint64array": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/BigUint64Array",
-  "boolean": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/boolean",
+  "boolean": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean",
   "dataview": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DataView",
   "date": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date",
   "disposablestack": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DisposableStack",
@@ -1067,7 +1067,7 @@
   "map": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map",
   "math": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Math",
   "nan": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/NaN",
-  "number": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/number",
+  "number": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number",
   "object": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",
   "promise": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise",
   "proxy": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Proxy",
@@ -1077,9 +1077,9 @@
   "regexp": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp",
   "set": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set",
   "sharedarraybuffer": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer",
-  "string": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/string",
+  "string": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",
   "suppressederror": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/SuppressedError",
-  "symbol": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/symbol",
+  "symbol": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol",
   "syntaxerror": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError",
   "temporal": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Temporal",
   "typeerror": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypeError",
@@ -1103,12 +1103,6 @@
   "isnan": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/isNaN",
   "parsefloat": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/parseFloat",
   "parseint": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/parseInt",
-  "undefined": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/undefined",
-  "unescape": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/unescape",
-  "asynciterable": "https://tc39.github.io/ecma262/#sec-asynciterable-interface",
-  "module namespace object": "https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects",
-  "null": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/null",
-  "integer": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/number",
-  "any": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures/#Data_types",
-  "this": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this"
+  "undefined": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined",
+  "unescape": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/unescape"
 }

src/generators/metadata/typeMap.json src/generators/metadata/maps/mdn.jsonsrc/generators/metadata/typeMap.json renamed to src/generators/metadata/maps/mdn.json

@@ -5,7 +5,8 @@ import {
 } from '../constants.mjs';
 import { slug } from './slugger.mjs';
 import { transformNodesToString } from '../../../utils/unist.mjs';
-import MDN_TYPE_MAP from '../typeMap.json' with { type: 'json' };
+import HARDCODED_TYPE_MAP from '../maps/hardcoded.json' with { type: 'json' };
+import MDN_TYPE_MAP from '../maps/mdn.json' with { type: 'json' };
 
 /**
  * @param {string} text The inner text
@@ -123,9 +124,16 @@ export const transformTypeToReferenceLink = (type, record) => {
       return record[lookupPiece];
     }
 
-    // Transform from MDN
-    if (lookupPiece.toLowerCase() in MDN_TYPE_MAP) {
-      return MDN_TYPE_MAP[lookupPiece.toLowerCase()];
+    const key = lookupPiece.toLowerCase();
+
+    // Check in our hardcoded map (i.e. TC39 objects)
+    if (key in HARDCODED_TYPE_MAP) {
+      return HARDCODED_TYPE_MAP[key];
+    }
+
+    // Check in MDN
+    if (key in MDN_TYPE_MAP) {
+      return MDN_TYPE_MAP[key];
     }
 
     // Transform Node.js types like 'vm.Something'.