swap to esm only - drop support for require() to load this package pre node v20.19

.eslintrc.js

@@ -1,11 +1,9 @@
-'use strict';
-
 module.exports = {
   root: true,
 
   parserOptions: {
-    ecmaVersion: 2018,
-    sourceType: 'script',
+    ecmaVersion: 2021,
+    sourceType: 'module',
   },
   plugins: ['prettier'],
   extends: ['plugin:prettier/recommended'],

.github/workflows/ci.yml

@@ -66,6 +66,8 @@ jobs:
         cache: yarn
     - run: yarn install --frozen-lockfile --ignore-engines
     - run: yarn add broccoli@${{matrix.broccoli-version}} --ignore-engines
+    - run: node -v
+    - run: yarn tsc -v
     - run: yarn test
 
   windows-test:

package.json

@@ -5,6 +5,7 @@
   "keywords": [
     "broccoli-plugin"
   ],
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "https://github.com/broccolijs/broccoli-plugin"
@@ -39,7 +40,7 @@
     "@types/chai": "^4.2.15",
     "@types/glob": "^8.0.0",
     "@types/mocha": "^8.2.1",
-    "@types/node": "^14.14.33",
+    "@types/node": "^20.0.0",
     "@types/symlink-or-copy": "^1.2.0",
     "@typescript-eslint/eslint-plugin": "^4.17.0",
     "@typescript-eslint/parser": "^4.17.0",
@@ -56,7 +57,7 @@
     "mocha": "^8.3.1",
     "prettier": "^2.2.1",
     "release-plan": "^0.17.4",
-    "typescript": "^4.2.3"
+    "typescript": "^5.9.3"
   },
   "packageManager": "pnpm@10.30.1+sha256.bc8bb877378eab6a8a83114eeb6a31ef88528db4ab5570299baba8fa54da2375",
   "engines": {

prettier.config.js

@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   singleQuote: true,
   trailingComma: 'es5',

src/index.ts

@@ -6,12 +6,15 @@ import {
   CallbackObject,
 } from 'broccoli-node-api';
 
-import { MapSeriesIterator, PluginOptions } from './interfaces';
+import type { MapSeriesIterator, PluginOptions } from './interfaces';
 
-import ReadCompat from './read_compat';
+import ReadCompat from './read_compat.js';
 import { FSOutput } from 'broccoli-output-wrapper';
-import buildOutputWrapper = require('broccoli-output-wrapper');
-import FSMerger = require('fs-merger');
+
+// @ts-expect-error the types are declared wrong upstream here
+import buildOutputWrapper from 'broccoli-output-wrapper';
+// @ts-expect-error the types are declared wrong upstream here
+import FSMerger from 'fs-merger';
 
 const BROCCOLI_FEATURES = Object.freeze({
   persistentOutputFlag: true,
@@ -54,7 +57,7 @@ function _checkBuilderFeatures(builderFeatures: FeatureSet) {
   }
 }
 
-class Plugin implements TransformNode {
+export default class Plugin implements TransformNode {
   private _name: string;
   private _annotation?: string;
   private _baseConstructorCalled: boolean;
@@ -317,5 +320,3 @@ class Plugin implements TransformNode {
     this._readCompat = new ReadCompat(this);
   }
 }
-
-export = Plugin;

src/read_compat.ts

@@ -1,15 +1,15 @@
-import Plugin = require('./index');
-import fs = require('fs');
-import path = require('path');
-import quickTemp = require('quick-temp');
-import mapSeries = require('promise-map-series');
-import symlinkOrCopy = require('symlink-or-copy');
+import Plugin from './index';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as quickTemp from 'quick-temp';
+import mapSeries from 'promise-map-series';
+import * as symlinkOrCopy from 'symlink-or-copy';
 const symlinkOrCopySync = symlinkOrCopy.sync;
 
 import { InputNode, TransformNodeInfo, CallbackObject } from 'broccoli-node-api';
 import { MapSeriesIterator } from './interfaces';
 
-interface PluginWithDescription extends Plugin {
+export interface PluginWithDescription extends Omit<Plugin, 'description'> {
   description?: string;
 }
 

test/integration_test.js

@@ -1,18 +1,22 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const fixturify = require('fixturify');
-const Fixturify = require('broccoli-fixturify');
-const Plugin = require('../dist/index');
-const chai = require('chai'),
-  expect = chai.expect;
-const chaiAsPromised = require('chai-as-promised');
-chai.use(chaiAsPromised);
-const broccoli = require('broccoli');
+import fs from 'fs';
+import path from 'path';
+import fixturify from 'fixturify';
+import Fixturify from 'broccoli-fixturify';
+import chai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+import broccoli from 'broccoli';
+import quickTemp from 'quick-temp';
+import symlinkOrCopy from 'symlink-or-copy';
+
+import Plugin from '../dist/index.js';
+
+// this is to avoid having to update eslint to support import attributes to import a json file
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
 const broccoliPkg = require('broccoli/package.json');
-const quickTemp = require('quick-temp');
-const symlinkOrCopy = require('symlink-or-copy');
+
+const expect = chai.expect;
+chai.use(chaiAsPromised);
 
 const broccoliVersion = broccoliPkg.version;
 

test/unit_test.js

@@ -1,9 +1,9 @@
-'use strict';
+import chai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
 
-const Plugin = require('../dist/index');
-const chai = require('chai'),
-  expect = chai.expect;
-const chaiAsPromised = require('chai-as-promised');
+import Plugin from '../dist/index.js';
+
+const expect = chai.expect;
 chai.use(chaiAsPromised);
 
 class NoopPlugin extends Plugin {

tsconfig.json

@@ -5,7 +5,7 @@
     "declaration": true,
     "strict": true,
     "moduleResolution": "node",
-    "module": "commonjs",
+    "module": "es2022",
     "sourceMap": true,
     "target": "es2017",
     "baseUrl": ".",

types/promise-map-series.d.ts

@@ -1,9 +1,7 @@
 import { MapSeriesIterator } from '../src/interfaces';
 
-declare function mapSeries<T>(
+export default function mapSeries<T>(
   array: T[],
   interator: MapSeriesIterator<T>,
   thisArg?: unknown
 ): Promise<T[]>;
-
-export = mapSeries;