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));
 
 class DuplicateCompatError extends Error {
   constructor(message) {
@@ -39,7 +41,7 @@ function load() {
   }
 
   for (dir of arguments) {
-    dir = path.resolve(__dirname, dir);
+    dir = path.resolve(dirname, dir);
     fs.readdirSync(dir).forEach(processFilename);
   }
 
@@ -70,7 +72,7 @@ function extend(target, source, feature = '') {
   }
 }
 
-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": ">=16.0.0"
   },
@@ -34,6 +35,7 @@
     "browser-specs": "~3.10.0",
     "chalk": "~4.1.0",
     "compare-versions": "~4.1.1",
+    "es-main": "~1.0.2",
     "mdn-confluence": "~2.2.2",
     "mocha": "~10.0.0",
     "ora": "~5.4.0",

schemas/browsers-schema.md

@@ -80,7 +80,12 @@ 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"
+```
+
+```js
+> const bcd = require('@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/compare-features.test.js

@@ -2,10 +2,9 @@
 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
 
-'use strict';
-const assert = require('assert').strict;
+import assert from 'node:assert/strict';
 
-const compareFeatures = require('./compare-features');
+import compareFeatures from './compare-features.js';
 
 describe('compare-features script', () => {
   it('`compareFeatures()` works correctly', () => {

scripts/diff-features.js

@@ -1,19 +1,12 @@
-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 esMain from 'es-main';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
 
-function main({ ref1, ref2, format, github }) {
-  const results = diff({ ref1, ref2, github });
-
-  if (format === 'markdown') {
-    printMarkdown(results);
-  } else {
-    console.log(JSON.stringify(results, undefined, 2));
-  }
-}
-
-function diff({ ref1, ref2, github }) {
+export default function diff({ ref1, ref2, github }) {
   let refA, refB;
 
   if (ref1 === undefined && ref2 === undefined) {
@@ -133,8 +126,18 @@ function printMarkdown({ added, removed }) {
   }
 }
 
-if (require.main === module) {
-  const { argv } = yargs.command(
+function main({ ref1, ref2, format, github }) {
+  const results = diff({ ref1, ref2, github });
+
+  if (format === 'markdown') {
+    printMarkdown(results);
+  } else {
+    console.log(JSON.stringify(results, undefined, 2));
+  }
+}
+
+if (esMain(import.meta)) {
+  const { argv } = yargs(hideBin(process.argv)).command(
     '$0 [ref1] [ref2]',
     'Compare the set of features at refA and refB',
     (yargs) => {
@@ -166,5 +169,3 @@ if (require.main === module) {
 
   main(argv);
 }
-
-module.exports = diff;

scripts/enumerate-features.js

@@ -1,9 +1,12 @@
-const yargs = require('yargs');
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 
-const fs = require('fs');
-const path = require('path');
+import esMain from 'es-main';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
 
-const { walk } = require('../utils');
+import { walk } from '../utils/index.js';
 
 function main({ dest, dataFrom }) {
   fs.writeFileSync(dest, JSON.stringify(enumerateFeatures(dataFrom)));
@@ -13,7 +16,7 @@ function enumerateFeatures(dataFrom) {
   const feats = [];
 
   const walker = dataFrom
-    ? walk(undefined, require(path.join(process.cwd(), dataFrom)))
+    ? walk(undefined, import(path.join(process.cwd(), dataFrom, 'index.js')))
     : walk();
 
   for (const { path, compat } of walker) {
@@ -25,24 +28,24 @@ function enumerateFeatures(dataFrom) {
   return feats;
 }
 
-const { argv } = yargs.command(
-  '$0 [dest]',
-  'Write a JSON-formatted list of feature paths',
-  (yargs) => {
-    yargs
-      .positional('dest', {
-        default: '.features.json',
-        description: 'File destination',
-      })
-      .option('data-from', {
-        nargs: 1,
-        description: 'Require compat data from an alternate path',
-      });
-  },
-);
-
-if (require.main === module) {
+if (esMain(import.meta)) {
+  const { argv } = yargs(hideBin(process.argv)).command(
+    '$0 [dest]',
+    'Write a JSON-formatted list of feature paths',
+    (yargs) => {
+      yargs
+        .positional('dest', {
+          default: '.features.json',
+          description: 'File destination',
+        })
+        .option('data-from', {
+          nargs: 1,
+          description: 'Require compat data from an alternate path',
+        });
+    },
+  );
+
   main(argv);
 }
 
-module.exports = enumerateFeatures;
+export default enumerateFeatures;

scripts/fix-browser-order.js

@@ -15,13 +15,16 @@
  * @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';
 
-/** Determines if the OS is Windows */
-const IS_WINDOWS = platform() === 'win32';
+import esMain from 'es-main';
+
+import { IS_WINDOWS } from '../test/utils.js';
+
+const dirname = fileURLToPath(new URL('.', import.meta.url));
 
 const orderSupportBlock = (key, value) => {
   if (key === '__compat') {
@@ -53,14 +56,14 @@ const fixBrowserOrder = (filename) => {
   }
 };
 
-if (require.main === module) {
+if (esMain(import.meta)) {
   /**
    * @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,15 +15,17 @@
  * @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';
 
-/** Determines if the OS is Windows */
-const IS_WINDOWS = platform() === 'win32';
+import esMain from 'es-main';
 
-const compareFeatures = require('./compare-features');
+import compareFeatures from './compare-features.js';
+import { IS_WINDOWS } from '../test/utils.js';
+
+const dirname = fileURLToPath(new URL('.', import.meta.url));
 
 function orderFeatures(key, value) {
   if (value instanceof Object && '__compat' in value) {
@@ -55,14 +57,14 @@ const fixFeatureOrder = (filename) => {
   }
 };
 
-if (require.main === module) {
+if (esMain(import.meta)) {
   /**
    * @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 +105,4 @@ if (require.main === module) {
   }
 }
 
-module.exports = fixFeatureOrder;
+export default fixFeatureOrder;