release-it 14.11.8 → 15.0.0-esm.3

package/lib/shell.js

@@ -1,7 +1,9 @@
-const sh = require('shelljs');
-const execa = require('execa');
-const debug = require('debug')('release-it:shell');
-const { format } = require('./util');
+import sh from 'shelljs';
+import { execa } from 'execa';
+import _debug from 'debug';
+import { format } from './util.js';
+
+const debug = _debug('release-it:shell');
 
 sh.config.silent = !debug.enabled;
 
@@ -86,4 +88,4 @@ class Shell {
   }
 }
 
-module.exports = Shell;
+export default Shell;

package/lib/spinner.js

@@ -1,12 +1,12 @@
-const ora = require('ora');
-const { format } = require('./util');
+import { oraPromise } from 'ora';
+import { format } from './util.js';
 
 const noop = Promise.resolve();
 
 class Spinner {
   constructor({ container = {} } = {}) {
     this.config = container.config;
-    this.ora = container.ora || ora;
+    this.ora = container.ora || oraPromise;
   }
   show({ enabled = true, task, label, external = false, context }) {
     if (!enabled) return noop;
@@ -19,11 +19,11 @@ class Spinner {
 
     if (!this.isSpinnerDisabled || (external && this.canForce)) {
       const text = format(label, context);
-      this.ora.promise(awaitTask, text);
+      this.ora(awaitTask, text);
     }
 
     return awaitTask;
   }
 }
 
-module.exports = Spinner;
+export default Spinner;

package/lib/util.js

@@ -1,11 +1,14 @@
-const fs = require('fs');
-const { EOL } = require('os');
-const _ = require('lodash');
-const gitUrlParse = require('git-url-parse');
-const semver = require('semver');
-const osName = require('os-name');
-const pkg = require('../package.json');
-const Log = require('./log');
+import fs from 'fs';
+import { EOL } from 'os';
+import _ from 'lodash';
+import gitUrlParse from 'git-url-parse';
+import semver from 'semver';
+import osName from 'os-name';
+import Log from './log.js';
+
+const readJSON = file => JSON.parse(fs.readFileSync(file, 'utf8'));
+
+const pkg = readJSON(new URL('../package.json', import.meta.url));
 
 const log = new Log();
 
@@ -87,7 +90,7 @@ const parseVersion = raw => {
 
 const e = (message, docs) => new Error(docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message);
 
-module.exports = {
+export {
   getSystemInfo,
   clean,
   format,
@@ -97,5 +100,6 @@ module.exports = {
   parseGitUrl,
   hasAccess,
   parseVersion,
+  readJSON,
   e
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "14.11.8",
+  "version": "15.0.0-esm.3",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -35,7 +35,11 @@
   "bin": {
     "release-it": "bin/release-it.js"
   },
-  "main": "./lib/index.js",
+  "type": "module",
+  "exports": {
+    ".": "./lib/index.js",
+    "./test/util": "./test/util/index.js"
+  },
   "files": [
     "bin",
     "config",
@@ -45,7 +49,7 @@
   "scripts": {
     "lint": "eslint lib test",
     "format": "prettier --write \"{lib,test}/**/*.js\"",
-    "test": "ava",
+    "test": "ava --timeout=20m",
     "coverage": "nyc --reporter=lcov --reporter=html --config=config/.codecov.yml npm test",
     "codecov": "nyc --reporter=json --config=config/.codecov.yml npm test && codecov -f coverage/coverage-final.json",
     "readme": "markdown-toc README.md -i --maxdepth=2 --bullets=-",
@@ -62,22 +66,21 @@
     "async-retry": "1.3.3",
     "chalk": "4.1.2",
     "cosmiconfig": "7.0.1",
-    "debug": "4.3.2",
+    "debug": "4.3.3",
     "deprecated-obj": "2.0.0",
-    "execa": "5.1.1",
+    "execa": "6.0.0",
     "form-data": "4.0.0",
     "git-url-parse": "11.6.0",
-    "globby": "11.0.4",
+    "globby": "12.0.2",
     "got": "11.8.3",
-    "import-cwd": "3.0.0",
     "inquirer": "8.2.0",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.34",
-    "new-github-release-url": "1.0.0",
-    "open": "7.4.2",
-    "ora": "5.4.1",
-    "os-name": "4.0.1",
+    "new-github-release-url": "2.0.0",
+    "open": "8.4.0",
+    "ora": "6.0.1",
+    "os-name": "5.0.1",
     "parse-json": "5.2.0",
     "semver": "7.3.5",
     "shelljs": "0.8.4",
@@ -85,13 +88,13 @@
     "url-join": "4.0.1",
     "uuid": "8.3.2",
     "yaml": "1.10.2",
-    "yargs-parser": "20.2.9"
+    "yargs-parser": "21.0.0"
   },
   "devDependencies": {
     "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
     "codecov": "3.8.3",
-    "eslint": "8.2.0",
+    "eslint": "8.3.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-ava": "13.1.0",
     "eslint-plugin-import": "2.25.3",
@@ -101,12 +104,11 @@
     "mock-stdio": "1.0.3",
     "nock": "13.2.1",
     "nyc": "15.1.0",
-    "prettier": "2.4.1",
-    "proxyquire": "2.1.3",
+    "prettier": "2.5.0",
     "sinon": "12.0.1",
-    "strip-ansi": "6.0.0"
+    "strip-ansi": "7.0.1"
   },
   "engines": {
-    "node": ">=10"
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
   }
 }

package/test/cli.js

@@ -1,7 +1,9 @@
-const test = require('ava');
-const mockStdIo = require('mock-stdio');
-const pkg = require('../package.json');
-const { version, help } = require('../lib/cli');
+import test from 'ava';
+import mockStdIo from 'mock-stdio';
+import { version, help } from '../lib/cli.js';
+import { readJSON } from '../lib/util.js';
+
+const pkg = readJSON(new URL('../package.json', import.meta.url));
 
 test('should print version', t => {
   mockStdIo.start();

package/test/config.js

@@ -1,7 +1,10 @@
-const test = require('ava');
-const mock = require('mock-fs');
-const Config = require('../lib/config');
-const defaultConfig = require('../config/release-it.json');
+import test from 'ava';
+import mock from 'mock-fs';
+import isCI from 'is-ci';
+import Config from '../lib/config.js';
+import { readJSON } from '../lib/util.js';
+
+const defaultConfig = readJSON(new URL('../config/release-it.json', import.meta.url));
 
 const localConfig = { github: { release: true } };
 
@@ -43,7 +46,6 @@ test('should set CI mode', t => {
 });
 
 test('should detect CI mode', t => {
-  const isCI = require('is-ci');
   const config = new Config();
   t.is(config.options.ci, isCI);
   t.is(config.isCI, isCI);

package/test/deprecated.js

@@ -1,7 +1,7 @@
-const test = require('ava');
-const sinon = require('sinon');
-const deprecated = require('../lib/deprecated');
-const Log = require('../lib/log');
+import test from 'ava';
+import sinon from 'sinon';
+import deprecated from '../lib/deprecated.js';
+import Log from '../lib/log.js';
 
 test('should show deprecation warnings and return compliant object', t => {
   const log = sinon.createStubInstance(Log);

package/test/git.init.js

@@ -1,10 +1,12 @@
-const test = require('ava');
-const sh = require('shelljs');
-const Shell = require('../lib/shell');
-const Git = require('../lib/plugin/git/Git');
-const { git } = require('../config/release-it.json');
-const { factory } = require('./util');
-const { mkTmpDir, gitAdd } = require('./util/helpers');
+import test from 'ava';
+import sh from 'shelljs';
+import Shell from '../lib/shell.js';
+import Git from '../lib/plugin/git/Git.js';
+import { readJSON } from '../lib/util.js';
+import { factory } from './util/index.js';
+import { mkTmpDir, gitAdd } from './util/helpers.js';
+
+const { git } = readJSON(new URL('../config/release-it.json', import.meta.url));
 
 test.serial.beforeEach(t => {
   const bare = mkTmpDir();

package/test/git.js

@@ -1,10 +1,10 @@
-const { EOL } = require('os');
-const test = require('ava');
-const sinon = require('sinon');
-const sh = require('shelljs');
-const Git = require('../lib/plugin/git/Git');
-const { mkTmpDir, readFile, gitAdd } = require('./util/helpers');
-const { factory } = require('./util');
+import { EOL } from 'os';
+import test from 'ava';
+import sinon from 'sinon';
+import sh from 'shelljs';
+import Git from '../lib/plugin/git/Git.js';
+import { factory } from './util/index.js';
+import { mkTmpDir, readFile, gitAdd } from './util/helpers.js';
 
 test.beforeEach(() => {
   const tmp = mkTmpDir();

package/test/github.js

@@ -1,16 +1,16 @@
-const test = require('ava');
-const sinon = require('sinon');
-const { RequestError } = require('@octokit/request-error');
-const GitHub = require('../lib/plugin/github/GitHub');
-const { factory, runTasks } = require('./util');
-const {
+import test from 'ava';
+import sinon from 'sinon';
+import { RequestError } from '@octokit/request-error';
+import GitHub from '../lib/plugin/github/GitHub.js';
+import { factory, runTasks } from './util/index.js';
+import {
   interceptAuthentication,
   interceptCollaborator,
   interceptListReleases,
   interceptCreate,
   interceptUpdate,
   interceptAsset
-} = require('./stub/github');
+} from './stub/github.js';
 
 const tokenRef = 'GITHUB_TOKEN';
 const pushRepo = 'git://github.com:user/repo';
@@ -56,6 +56,7 @@ test('should release and upload assets', async t => {
   };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
 
   interceptAuthentication();
@@ -85,6 +86,7 @@ test('should create a pre-release and draft release notes', async t => {
   };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
 
   interceptAuthentication();
@@ -116,6 +118,7 @@ test('should update release and upload assets', async t => {
   };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
   exec.withArgs('git rev-list 2.0.1 --tags --max-count=1').resolves('a123456');
   exec.withArgs('git describe --tags --abbrev=0 "a123456^"').resolves('2.0.1');
@@ -149,6 +152,7 @@ test('should create new release for unreleased tag', async t => {
   };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
   exec.withArgs('git rev-list 2.0.1 --tags --max-count=1').resolves('b123456');
   exec.withArgs('git describe --tags --abbrev=0 "b123456^"').resolves('2.0.1');
@@ -202,6 +206,7 @@ test('should release to alternative host and proxy', async t => {
   };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('1.0.0');
 
   await runTasks(github);
@@ -218,6 +223,7 @@ test('should release to git.pushRepo', async t => {
   const options = { git: { pushRepo: 'upstream', changelog: null }, github: { tokenRef, skipChecks: true } };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('1.0.0');
   exec.withArgs('git remote get-url upstream').resolves('https://my-custom-host.org/user/repo');
 
@@ -229,7 +235,9 @@ test('should release to git.pushRepo', async t => {
   exec.restore();
 });
 
-test('should throw for unauthenticated user', async t => {
+const testSkipOnActions = process.env.GITHUB_ACTIONS ? test.skip : test;
+
+testSkipOnActions('should throw for unauthenticated user', async t => {
   const options = { github: { tokenRef, pushRepo, host } };
   const github = factory(GitHub, { options });
   const stub = sinon.stub(github.client.users, 'getAuthenticated');
@@ -243,7 +251,7 @@ test('should throw for unauthenticated user', async t => {
   stub.restore();
 });
 
-test('should throw for non-collaborator', async t => {
+testSkipOnActions('should throw for non-collaborator', async t => {
   interceptAuthentication({ username: 'john' });
   const options = { github: { tokenRef, pushRepo, host } };
   const github = factory(GitHub, { options });
@@ -256,8 +264,11 @@ test('should throw for non-collaborator', async t => {
 });
 
 test.serial('should skip authentication and collaborator checks when running on GitHub Actions', async t => {
-  process.env.GITHUB_ACTIONS = 1;
-  process.env.GITHUB_ACTOR = 'release-it';
+  const { GITHUB_ACTIONS, GITHUB_ACTOR } = process.env;
+  if (!GITHUB_ACTIONS) {
+    process.env.GITHUB_ACTIONS = 1;
+    process.env.GITHUB_ACTOR = 'webpro';
+  }
 
   const options = { github: { tokenRef } };
   const github = factory(GitHub, { options });
@@ -268,12 +279,15 @@ test.serial('should skip authentication and collaborator checks when running on
 
   t.is(authStub.callCount, 0);
   t.is(collaboratorStub.callCount, 0);
-  t.is(github.getContext('username'), 'release-it');
+  t.is(github.getContext('username'), 'webpro');
 
   authStub.restore();
   collaboratorStub.restore();
-  delete process.env.GITHUB_ACTIONS;
-  delete process.env.GITHUB_ACTOR;
+
+  if (!GITHUB_ACTIONS) {
+    process.env.GITHUB_ACTIONS = GITHUB_ACTIONS || '';
+    process.env.GITHUB_ACTOR = GITHUB_ACTOR || '';
+  }
 });
 
 test('should handle octokit client error (without retries)', async t => {
@@ -308,6 +322,7 @@ test('should not call octokit client in dry run', async t => {
   const github = factory(GitHub, { options });
   const spy = sinon.spy(github, 'client', ['get']);
   const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('v1.0.0');
 
   await runTasks(github);
@@ -330,7 +345,6 @@ test('should skip checks', async t => {
 
 test('should generate GitHub web release url', async t => {
   const options = {
-    git,
     github: {
       pushRepo,
       release: true,
@@ -341,6 +355,7 @@ test('should generate GitHub web release url', async t => {
   };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
 
   await runTasks(github);
@@ -353,3 +368,30 @@ test('should generate GitHub web release url', async t => {
   );
   exec.restore();
 });
+
+test('should generate GitHub web release url for enterprise host', async t => {
+  const options = {
+    github: {
+      pushRepo: 'git://my-custom-host.org:user/repo',
+      release: true,
+      web: true,
+      host: 'my-custom-host.org',
+      releaseName: 'The Launch',
+      releaseNotes: 'echo It happened'
+    }
+  };
+  const github = factory(GitHub, { options });
+  const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
+  exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
+
+  await runTasks(github);
+
+  const { isReleased, releaseUrl } = github.getContext();
+  t.true(isReleased);
+  t.is(
+    releaseUrl,
+    'https://my-custom-host.org/user/repo/releases/new?tag=2.0.2&title=The+Launch&body=It+happened&prerelease=false'
+  );
+  exec.restore();
+});

package/test/gitlab.js

@@ -1,15 +1,15 @@
-const test = require('ava');
-const sinon = require('sinon');
-const nock = require('nock');
-const GitLab = require('../lib/plugin/gitlab/GitLab');
-const {
+import test from 'ava';
+import sinon from 'sinon';
+import nock from 'nock';
+import GitLab from '../lib/plugin/gitlab/GitLab.js';
+import { factory, runTasks } from './util/index.js';
+import {
   interceptUser,
   interceptCollaborator,
   interceptCollaboratorFallback,
   interceptPublish,
   interceptAsset
-} = require('./stub/gitlab');
-const { factory, runTasks } = require('./util');
+} from './stub/gitlab.js';
 
 const tokenHeader = 'Private-Token';
 const tokenRef = 'GITLAB_TOKEN';

package/test/log.js

@@ -1,8 +1,8 @@
-const { EOL } = require('os');
-const test = require('ava');
-const mockStdIo = require('mock-stdio');
-const stripAnsi = require('strip-ansi');
-const Log = require('../lib/log');
+import { EOL } from 'os';
+import test from 'ava';
+import mockStdIo from 'mock-stdio';
+import stripAnsi from 'strip-ansi';
+import Log from '../lib/log.js';
 
 test('should write to stdout', t => {
   const log = new Log();

package/test/metrics.js

@@ -1,6 +1,6 @@
-const test = require('ava');
-const sinon = require('sinon');
-const Metrics = require('../lib/metrics');
+import test from 'ava';
+import sinon from 'sinon';
+import Metrics from '../lib/metrics.js';
 
 test('should send metrics', async t => {
   const stub = sinon.stub().resolves();

package/test/npm.js

@@ -1,10 +1,10 @@
-const path = require('path');
-const test = require('ava');
-const sinon = require('sinon');
-const mock = require('mock-fs');
-const npm = require('../lib/plugin/npm/npm');
-const { factory, runTasks } = require('./util');
-const { getArgs } = require('./util/helpers');
+import path from 'path';
+import test from 'ava';
+import sinon from 'sinon';
+import mock from 'mock-fs';
+import npm from '../lib/plugin/npm/npm.js';
+import { factory, runTasks } from './util/index.js';
+import { getArgs } from './util/helpers.js';
 
 test('should return npm package url', t => {
   const options = { npm: { name: 'my-cool-package' } };
@@ -279,7 +279,6 @@ test('should skip checks', async t => {
 });
 
 test('should publish to a different/scoped registry', async t => {
-  delete require.cache[require.resolve('../package.json')];
   mock({
     [path.resolve('package.json')]: JSON.stringify({
       name: '@my-scope/my-pkg',
@@ -317,7 +316,6 @@ test('should publish to a different/scoped registry', async t => {
 });
 
 test('should not publish when `npm version` fails', async t => {
-  delete require.cache[require.resolve('../package.json')];
   mock({
     [path.resolve('package.json')]: JSON.stringify({
       name: '@my-scope/my-pkg',