ESM all the things

README.md

@@ -25,7 +25,7 @@ npm install @mdn/browser-compat-data
 ## Usage
 
 ```js
-const bcd = require('@mdn/browser-compat-data');
+import bcd from '@mdn/browser-compat-data';
 bcd.css.properties.background;
 // returns a compat data object (see schema)
 ```

index.d.ts

@@ -1,9 +1,6 @@
 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
-/// <reference path="./types.d.ts"/>
+
 import { CompatData } from './types';
 
-// This is necessary to have intellisense in projects which
-// import data from this package.
-declare const compatData: CompatData;
-export = compatData;
+export default CompatData;

index.js

@@ -1,6 +1,8 @@
-'use strict';
-const fs = require('fs');
-const path = require('path');
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const dirname = fileURLToPath(new URL('.', import.meta.url));
 
 function load() {
   // Recursively load one or more directories passed as arguments.
@@ -32,7 +34,7 @@ function load() {
   }
 
   for (dir of arguments) {
-    dir = path.resolve(__dirname, dir);
+    dir = path.resolve(dirname, dir);
     fs.readdirSync(dir).forEach(processFilename);
   }
 
@@ -59,7 +61,7 @@ function extend(target, source) {
   }
 }
 
-module.exports = load(
+export default load(
   'api',
   'browsers',
   'css',

package.json

@@ -4,6 +4,7 @@
   "description": "Browser compatibility data provided by MDN Web Docs",
   "main": "index.js",
   "types": "index.d.ts",
+  "type": "module",
   "engines": {
     "node": ">=10.0.0"
   },
@@ -41,15 +42,15 @@
   "scripts": {
     "confluence": "node ./node_modules/mdn-confluence/main/generate.es6.js --output-dir=. --bcd-module=./index.js",
     "mocha": "mocha \"*/**.test.js\"",
-    "lint": "node test/lint",
-    "fix": "node scripts/fix",
-    "mirror": "node scripts/mirror",
-    "stats": "node scripts/statistics",
-    "release-build": "node scripts/release-build",
-    "release-pulls": "node scripts/release-pulls",
-    "release-stats": "node scripts/release-stats",
+    "lint": "node test/lint.js",
+    "fix": "node scripts/fix.js",
+    "mirror": "node scripts/mirror.js",
+    "stats": "node scripts/statistics.js",
+    "release-build": "node scripts/release-build.js",
+    "release-pulls": "node scripts/release-pulls.js",
+    "release-stats": "node scripts/release-stats.js",
     "show-errors": "npm test 1> /dev/null",
     "test": "npm run lint && npm run mocha",
-    "traverse": "node scripts/traverse"
+    "traverse": "node scripts/traverse.js"
   }
 }

schemas/browsers-schema.md

@@ -84,7 +84,7 @@ The release objects consist of the following properties:
 This structure is exported for consumers of `@mdn/browser-compat-data`:
 
 ```js
-> const compat = require('@mdn/browser-compat-data');
-> compat.browsers.firefox.releases['1.5'].status;
+> import bcd from '@mdn/browser-compat-data';
+> bcd.browsers.firefox.releases['1.5'].status;
 // "retired"
 ```

scripts/compare-features.js

@@ -2,8 +2,6 @@
 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
 
-'use strict';
-
 /**
  *
  * Sort a list of features based upon a specific order:
@@ -36,4 +34,4 @@ const compareFeatures = (a, b) => {
   return a.localeCompare(b, 'en');
 };
 
-module.exports = compareFeatures;
+export default compareFeatures;

scripts/diff-features.js

@@ -1,7 +1,8 @@
-const { execSync } = require('child_process');
-const fs = require('fs');
+import { execSync } from 'node:child_process';
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
 
-const yargs = require('yargs');
+import yargs from 'yargs';
 
 function main({ ref1, ref2, format }) {
   let refA, refB;
@@ -73,7 +74,7 @@ function printMarkdown({ added, removed }) {
   }
 }
 
-const { argv } = yargs.command(
+const { argv } = yargs().command(
   '$0 [ref1] [ref2]',
   'Compare the set of features at refA and refB',
   yargs => {
@@ -99,6 +100,7 @@ const { argv } = yargs.command(
   },
 );
 
-if (require.main === module) {
+const self = fileURLToPath(import.meta.url);
+if (process.argv[1] === self) {
   main(argv);
 }

scripts/enumerate-features.js

@@ -1,9 +1,10 @@
-const yargs = require('yargs');
+import yargs from 'yargs';
 
-const fs = require('fs');
-const path = require('path');
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 
-const { walk } = require('../utils');
+import { walk } from '../utils/index.js';
 
 function main({ dest, dataFrom }) {
   fs.writeFileSync(dest, JSON.stringify(enumerateFeatures(dataFrom)));
@@ -13,7 +14,12 @@ function enumerateFeatures(dataFrom) {
   const feats = [];
 
   const walker = dataFrom
-    ? walk(undefined, require(path.join(process.cwd(), dataFrom)))
+    ? walk(
+        undefined,
+        JSON.parse(
+          fs.readFileSync(path.join(process.cwd(), dataFrom), 'utf-8'),
+        ),
+      )
     : walk();
 
   for (const { path, compat } of walker) {
@@ -25,7 +31,7 @@ function enumerateFeatures(dataFrom) {
   return feats;
 }
 
-const { argv } = yargs.command(
+const { argv } = yargs().command(
   '$0 [dest]',
   'Write a JSON-formatted list of feature paths',
   yargs => {
@@ -41,8 +47,9 @@ const { argv } = yargs.command(
   },
 );
 
-if (require.main === module) {
+const self = fileURLToPath(import.meta.url);
+if (process.argv[1] === self) {
   main(argv);
 }
 
-module.exports = enumerateFeatures;
+export default enumerateFeatures;

scripts/fix-browser-order.js

@@ -15,10 +15,12 @@
  * @returns {*} The new value
  */
 
-'use strict';
-const fs = require('fs');
-const path = require('path');
-const { platform } = require('os');
+import fs from 'node:fs';
+import path from 'node:path';
+import { platform } from 'node:os';
+import { fileURLToPath } from 'node:url';
+
+const dirname = fileURLToPath(new URL('.', import.meta.url));
 
 /** Determines if the OS is Windows */
 const IS_WINDOWS = platform() === 'win32';
@@ -53,14 +55,15 @@ const fixBrowserOrder = filename => {
   }
 };
 
-if (require.main === module) {
+const self = fileURLToPath(import.meta.url);
+if (process.argv[1] === self) {
   /**
    * @param {string[]} files
    */
   function load(...files) {
     for (let file of files) {
-      if (file.indexOf(__dirname) !== 0) {
-        file = path.resolve(__dirname, '..', file);
+      if (file.indexOf(dirname) !== 0) {
+        file = path.resolve(dirname, '..', file);
       }
 
       if (!fs.existsSync(file)) {
@@ -101,4 +104,4 @@ if (require.main === module) {
   }
 }
 
-module.exports = fixBrowserOrder;
+export default fixBrowserOrder;

scripts/fix-feature-order.js

@@ -15,16 +15,18 @@
  * @returns {*} The new value
  */
 
-'use strict';
-const fs = require('fs');
-const path = require('path');
-const { platform } = require('os');
+import fs from 'node:fs';
+import path from 'node:path';
+import { platform } from 'node:os';
+import { fileURLToPath } from 'node:url';
+
+import compareFeatures from './compare-features.js';
+
+const dirname = fileURLToPath(new URL('.', import.meta.url));
 
 /** Determines if the OS is Windows */
 const IS_WINDOWS = platform() === 'win32';
 
-const compareFeatures = require('./compare-features');
-
 function orderFeatures(key, value) {
   if (value instanceof Object && '__compat' in value) {
     value = Object.keys(value)
@@ -55,14 +57,15 @@ const fixFeatureOrder = filename => {
   }
 };
 
-if (require.main === module) {
+const self = fileURLToPath(import.meta.url);
+if (process.argv[1] === self) {
   /**
    * @param {string[]} files
    */
   function load(...files) {
     for (let file of files) {
-      if (file.indexOf(__dirname) !== 0) {
-        file = path.resolve(__dirname, '..', file);
+      if (file.indexOf(dirname) !== 0) {
+        file = path.resolve(dirname, '..', file);
       }
 
       if (!fs.existsSync(file)) {
@@ -103,4 +106,4 @@ if (require.main === module) {
   }
 }
 
-module.exports = fixFeatureOrder;
+export default fixFeatureOrder;

scripts/fix-format.js

@@ -2,12 +2,10 @@
 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
 
-'use strict';
-
-const { exec } = require('child_process');
+import { exec } from 'node:child_process';
 
 const format = () => {
   exec('npx prettier --write "**/*.js" "**/*.ts" "**/*.md"');
 };
 
-module.exports = format;
+export default format;

scripts/fix.js

@@ -1,17 +1,19 @@
-'use strict';
-const fs = require('fs');
-const path = require('path');
-const fixBrowserOrder = require('./fix-browser-order');
-const fixFeatureOrder = require('./fix-feature-order');
-const format = require('./fix-format');
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import fixBrowserOrder from './fix-browser-order.js';
+import fixFeatureOrder from './fix-feature-order.js';
+import format from './fix-format.js';
+
+const dirname = fileURLToPath(new URL('.', import.meta.url));
 
 /**
  * @param {string[]} files
  */
 function load(...files) {
   for (let file of files) {
-    if (file.indexOf(__dirname) !== 0) {
-      file = path.resolve(__dirname, '..', file);
+    if (file.indexOf(dirname) !== 0) {
+      file = path.resolve(dirname, '..', file);
     }
 
     if (!fs.existsSync(file)) {

scripts/migrations/001-sort-features.js

@@ -2,8 +2,6 @@
 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
 
-'use strict';
-
-const { exec } = require('child_process');
+import { exec } from 'node:child_process';
 
 exec('node scripts/fix-feature-order.js');

scripts/migrations/002-remove-webview-flags.js

@@ -2,10 +2,12 @@
 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
 
-'use strict';
-const fs = require('fs');
-const path = require('path');
-const { platform } = require('os');
+import fs from 'node:fs';
+import path from 'node:path';
+import { platform } from 'node:os';
+import { fileURLToPath } from 'node:url';
+
+const dirname = fileURLToPath(new URL('.', import.meta.url));
 
 /** Determines if the OS is Windows */
 const IS_WINDOWS = platform() === 'win32';
@@ -58,14 +60,15 @@ const fixWebViewFlags = filename => {
   }
 };
 
-if (require.main === module) {
+const self = fileURLToPath(import.meta.url);
+if (process.argv[1] === self) {
   /**
    * @param {string[]} files
    */
   function load(...files) {
     for (let file of files) {
-      if (file.indexOf(__dirname) !== 0) {
-        file = path.resolve(__dirname, '..', '..', file);
+      if (file.indexOf(dirname) !== 0) {
+        file = path.resolve(dirname, '..', '..', file);
       }
 
       if (!fs.existsSync(file)) {
@@ -106,4 +109,4 @@ if (require.main === module) {
   }
 }
 
-module.exports = { removeWebViewFlags, fixWebViewFlags };
+export { fixWebViewFlags, removeWebViewFlags };