Refactor to support release-it@15 (ESM)

.eslintrc.js → .eslintrc.cjs

@@ -3,12 +3,21 @@ module.exports = {
   extends: ['eslint:recommended', 'plugin:node/recommended', 'plugin:prettier/recommended'],
   plugins: ['prettier', 'node'],
   parserOptions: {
-    ecmaVersion: 2017,
-    sourceType: 'script',
+    ecmaVersion: 2022,
+    sourceType: 'module',
   },
   env: {
     node: true,
   },
+  rules: {
+    'node/no-missing-import': [
+      'error',
+      {
+        // ignoring `release-it` as a devDep since there's an expectation that it's installed in the host package
+        allowModules: ['release-it'],
+      },
+    ],
+  },
   overrides: [
     {
       files: ['jest.setup.js', '__tests__/**/*.js'],

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [14.x, 16.x]
 
     steps:
     - uses: actions/checkout@v1
@@ -34,7 +34,7 @@ jobs:
 
     strategy:
       matrix:
-        release-it-version: ["14.0.0", "14.1.0", "14.2.0"]
+        release-it-version: ["14.0.0", "14.1.0", "14.2.0", "15.0.0", "15.1.1"]
 
     steps:
     - uses: actions/checkout@v1

__tests__/plugin-test.js

@@ -1,8 +1,8 @@
-const fs = require('fs');
-const { createTempDir } = require('broccoli-test-helper');
-const { factory, runTasks } = require('release-it/test/util');
-const Shell = require('release-it/lib/shell');
-const Plugin = require('../index');
+import fs from 'fs';
+import _ from 'lodash';
+import { createTempDir } from 'broccoli-test-helper';
+import { factory, runTasks } from 'release-it/test/util';
+import Plugin from '../index.js';
 
 const namespace = 'release-it-yarn-workspaces';
 
@@ -78,7 +78,12 @@ function buildPlugin(config = {}, _Plugin = TestPlugin) {
   // we work around the same relative issue by storing the commands executed,
   // and intercepting them to return replacement values (this is done in
   // execFormattedCommand just below)
-  container.shell.exec = Shell.prototype.exec;
+  container.shell.exec = (command, options, context) => {
+    if (!command || !command.length) return;
+    return typeof command === 'string'
+      ? container.shell.execFormattedCommand(_.template(command)(context), options)
+      : container.shell.execFormattedCommand(command, options);
+  };
   container.shell.execFormattedCommand = async (command, options) => {
     const operation = {
       operationType: 'command',
@@ -195,12 +200,12 @@ describe('release-it-yarn-workspaces', () => {
           Object {
             "command": "npm ping --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm whoami --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm publish ./packages/bar --tag latest",
@@ -387,12 +392,12 @@ describe('release-it-yarn-workspaces', () => {
           Object {
             "command": "npm ping --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm whoami --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm publish ./packages/@scope-name/bar --tag latest",
@@ -465,12 +470,12 @@ describe('release-it-yarn-workspaces', () => {
           Object {
             "command": "npm ping --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm whoami --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm publish ./dist/packages/qux --tag latest",
@@ -512,12 +517,12 @@ describe('release-it-yarn-workspaces', () => {
           Object {
             "command": "npm ping --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm whoami --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm publish ./packages/bar --tag foo",
@@ -598,12 +603,12 @@ describe('release-it-yarn-workspaces', () => {
           Object {
             "command": "npm ping --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm whoami --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm publish ./packages/bar --tag beta",
@@ -658,12 +663,12 @@ describe('release-it-yarn-workspaces', () => {
           Object {
             "command": "npm ping --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm whoami --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm publish ./packages/bar --tag latest",
@@ -765,12 +770,12 @@ describe('release-it-yarn-workspaces', () => {
           Object {
             "command": "npm ping --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm whoami --registry https://registry.npmjs.org",
             "operationType": "command",
-            "options": Object {},
+            "options": undefined,
           },
           Object {
             "command": "npm publish ./dist/@glimmer/interfaces --tag latest",

index.js

@@ -1,13 +1,17 @@
-const fs = require('fs');
-const path = require('path');
-const semver = require('semver');
-const urlJoin = require('url-join');
-const walkSync = require('walk-sync');
-const detectNewline = require('detect-newline');
-const detectIndent = require('detect-indent');
-const { Plugin } = require('release-it');
-
-require('validate-peer-dependencies')(__dirname);
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import semver from 'semver';
+import urlJoin from 'url-join';
+import walkSync from 'walk-sync';
+import detectNewline from 'detect-newline';
+import detectIndent from 'detect-indent';
+import { Plugin } from 'release-it';
+import validatePeerDependencies from 'validate-peer-dependencies';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+validatePeerDependencies(__dirname);
 
 const options = { write: false };
 
@@ -114,7 +118,7 @@ class JSONFile {
   }
 }
 
-module.exports = class YarnWorkspacesPlugin extends Plugin {
+export default class YarnWorkspacesPlugin extends Plugin {
   static isEnabled(options) {
     return fs.existsSync(ROOT_MANIFEST_PATH) && options !== false;
   }
@@ -146,7 +150,9 @@ module.exports = class YarnWorkspacesPlugin extends Plugin {
       },
     });
 
-    const { publishConfig, workspaces } = require(path.resolve(ROOT_MANIFEST_PATH));
+    const { publishConfig, workspaces } = JSON.parse(
+      fs.readFileSync(path.resolve(ROOT_MANIFEST_PATH))
+    );
 
     this.setContext({
       publishConfig,
@@ -522,4 +528,4 @@ module.exports = class YarnWorkspacesPlugin extends Plugin {
 
     return this._workspaces;
   }
-};
+}

jest.config.js

@@ -1,3 +1,10 @@
-module.exports = {
+export default {
   setupFilesAfterEnv: ['./jest.setup.js'],
+  moduleFileExtensions: ['js', 'ts', 'mjs'],
+  transform: {
+    '^.+\\.[t|j]sx?$': 'babel-jest',
+  },
+  moduleNameMapper: {
+    '#(.*)': '<rootDir>/node_modules/$1',
+  },
 };

jest.setup.js

@@ -1 +1,3 @@
+import { jest } from '@jest/globals';
+
 jest.setTimeout(30000);

package.json

@@ -11,14 +11,15 @@
   "repository": "https://github.com/rwjblue/release-it-yarn-workspaces",
   "license": "MIT",
   "author": "Robert Jackson <me@rwjblue.com>",
+  "type": "module",
   "main": "index.js",
   "files": [
     "index.js"
   ],
   "scripts": {
     "lint:js": "eslint .",
     "test": "npm-run-all lint:js test:jest",
-    "test:jest": "jest"
+    "test:jest": "NODE_OPTIONS=--experimental-vm-modules yarn jest"
   },
   "husky": {
     "hooks": {
@@ -37,26 +38,29 @@
     "walk-sync": "^2.0.2"
   },
   "devDependencies": {
+    "@jest/globals": "^28.1.2",
     "broccoli-test-helper": "^2.0.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.1",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^3.1.2",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "husky": "^4.2.3",
-    "jest": "^25.2.3",
+    "jest": "^28.1.2",
+    "jest-environment-node": "^28.1.2",
     "lint-staged": "^10.1.1",
+    "lodash": "^4.17.21",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.2",
-    "release-it": "^14.0.0",
-    "release-it-lerna-changelog": "^3.0.0",
+    "release-it": "^15.1.1",
+    "release-it-lerna-changelog": "^4.0.1",
     "sinon": "^9.0.1",
     "tmp": "^0.1.0"
   },
   "peerDependencies": {
-    "release-it": "^14.0.0"
+    "release-it": "^14.0.0 || ^15.0.0"
   },
   "engines": {
-    "node": "10.* || 12.* || >= 14"
+    "node": ">= 14"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"