release-it 14.11.8 → 15.0.0-esm.3

package/bin/release-it.js

@@ -1,9 +1,11 @@
 #!/usr/bin/env node
 
-const updater = require('update-notifier');
-const parseArgs = require('yargs-parser');
-const pkg = require('../package.json');
-const release = require('../lib');
+import updater from 'update-notifier';
+import parseArgs from 'yargs-parser';
+import release from '../lib/cli.js';
+import { readJSON } from '../lib/util.js';
+
+const pkg = readJSON(new URL('../package.json', import.meta.url));
 
 const aliases = {
   c: 'config',

package/lib/cli.js

@@ -1,5 +1,8 @@
-const pkg = require('../package.json');
-const Log = require('./log');
+import { readJSON } from './util.js';
+import Log from './log.js';
+import runTasks from './index.js';
+
+const pkg = readJSON(new URL('../package.json', import.meta.url));
 
 const log = new Log();
 
@@ -22,6 +25,17 @@ const helpText = `Release It! v${pkg.version}
 
 For more details, please see https://github.com/release-it/release-it`;
 
-module.exports.version = () => log.log(`v${pkg.version}`);
+export let version = () => log.log(`v${pkg.version}`);
+
+export let help = () => log.log(helpText);
 
-module.exports.help = () => log.log(helpText);
+export default async options => {
+  if (options.version) {
+    version();
+  } else if (options.help) {
+    help();
+  } else {
+    return runTasks(options);
+  }
+  return Promise.resolve();
+};

package/lib/config.js

@@ -1,12 +1,14 @@
-const { cosmiconfigSync } = require('cosmiconfig');
-const parseJson = require('parse-json');
-const parseToml = require('@iarna/toml/parse-string');
-const yaml = require('yaml');
-const _ = require('lodash');
-const isCI = require('is-ci');
-const debug = require('debug')('release-it:config');
-const defaultConfig = require('../config/release-it.json');
-const { getSystemInfo } = require('./util');
+import { cosmiconfigSync } from 'cosmiconfig';
+import parseJson from 'parse-json';
+import parseToml from '@iarna/toml/parse-string.js';
+import yaml from 'yaml';
+import _ from 'lodash';
+import isCI from 'is-ci';
+import _debug from 'debug';
+import { readJSON, getSystemInfo } from './util.js';
+
+const debug = _debug('release-it:config');
+const defaultConfig = readJSON(new URL('../config/release-it.json', import.meta.url));
 
 const searchPlaces = [
   'package.json',
@@ -52,10 +54,6 @@ class Config {
 
   expandPreReleaseShorthand(options) {
     const { increment, preRelease, preReleaseId } = options;
-    if (options.github.release && increment === false) {
-      console.warn('Using --no-increment with --github.release is deprecated. Add --github.update in release-it v15.');
-      options.github.update = increment === false;
-    }
     options.version = {
       increment,
       isPreRelease: Boolean(preRelease),
@@ -131,4 +129,4 @@ class Config {
   }
 }
 
-module.exports = Config;
+export default Config;

package/lib/deprecated.js

@@ -1,8 +1,10 @@
-const Deprecated = require('deprecated-obj');
-const deprecated = require('../config/deprecated.json');
-const Log = require('./log');
+import Deprecated from 'deprecated-obj';
+import { readJSON } from './util.js';
+import Log from './log.js';
 
-module.exports = (config, log = new Log()) => {
+const deprecated = readJSON(new URL('../config/deprecated.json', import.meta.url));
+
+export default (config, log = new Log()) => {
   const deprecations = new Deprecated(deprecated, config);
   const compliant = deprecations.getCompliant();
   const violations = deprecations.getViolations();

package/lib/index.js

@@ -1,16 +1,142 @@
-const { version, help } = require('./cli');
-const runTasks = require('./tasks');
-const Plugin = require('./plugin/Plugin');
-
-module.exports = async options => {
-  if (options.version) {
-    version();
-  } else if (options.help) {
-    help();
-  } else {
-    return runTasks(options);
+import _ from 'lodash';
+import { getPlugins } from './plugin/factory.js';
+import Logger from './log.js';
+import Config from './config.js';
+import Shell from './shell.js';
+import Prompt from './prompt.js';
+import Spinner from './spinner.js';
+import Metrics from './metrics.js';
+import { reduceUntil, parseVersion } from './util.js';
+import handleDeprecated from './deprecated.js';
+import Plugin from './plugin/Plugin.js';
+
+const runTasks = async (opts, di) => {
+  let container = {};
+
+  try {
+    Object.assign(container, di);
+    container.config = container.config || new Config(opts);
+
+    const { config } = container;
+    const { isCI, isVerbose, verbosityLevel, isDryRun } = config;
+
+    container.log = container.log || new Logger({ isCI, isVerbose, verbosityLevel, isDryRun });
+    container.spinner = container.spinner || new Spinner({ container, config });
+    container.prompt = container.prompt || new Prompt({ container: { config } });
+    container.metrics = new Metrics({ isEnabled: config.isCollectMetrics });
+    container.shell = container.shell || new Shell({ container });
+
+    const { log, metrics, shell, spinner } = container;
+
+    const options = handleDeprecated(config.getContext(), log);
+
+    metrics.trackEvent('start', options);
+
+    const { hooks } = options;
+
+    const runHook = async (...name) => {
+      const scripts = hooks[name.join(':')];
+      if (!scripts || !scripts.length) return;
+      const context = config.getContext();
+      const external = true;
+      for (const script of _.castArray(scripts)) {
+        const task = () => shell.exec(script, { external }, context);
+        await spinner.show({ task, label: script, context, external });
+      }
+    };
+
+    const runLifeCycleHook = async (plugin, name, ...args) => {
+      if (plugin === _.first(plugins)) await runHook('before', name);
+      await runHook('before', plugin.namespace, name);
+      const willHookRun = (await plugin[name](...args)) !== false;
+      if (willHookRun) {
+        await runHook('after', plugin.namespace, name);
+      }
+      if (plugin === _.last(plugins)) await runHook('after', name);
+    };
+
+    const [internal, external] = await getPlugins(config, container);
+    let plugins = [...external, ...internal];
+
+    for (const plugin of plugins) {
+      await runLifeCycleHook(plugin, 'init');
+    }
+
+    const { increment, isPreRelease, preReleaseId } = options.version;
+
+    const name = await reduceUntil(plugins, plugin => plugin.getName());
+    const latestVersion = (await reduceUntil(plugins, plugin => plugin.getLatestVersion())) || '0.0.0';
+    const changelog = await reduceUntil(plugins, plugin => plugin.getChangelog(latestVersion));
+
+    const incrementBase = { latestVersion, increment, isPreRelease, preReleaseId };
+
+    let version;
+    if (config.isIncrement) {
+      incrementBase.increment = await reduceUntil(plugins, plugin => plugin.getIncrement(incrementBase));
+      version = await reduceUntil(plugins, plugin => plugin.getIncrementedVersionCI(incrementBase));
+    } else {
+      version = latestVersion;
+    }
+
+    if (config.isReleaseVersion) {
+      log.log(version);
+      process.exit(0);
+    }
+
+    config.setContext({ name, latestVersion, version, changelog });
+
+    const action = config.isIncrement ? 'release' : 'update';
+    const suffix = version && config.isIncrement ? `${latestVersion}...${version}` : `currently at ${latestVersion}`;
+
+    log.obtrusive(`🚀 Let's ${action} ${name} (${suffix})`);
+
+    log.preview({ title: 'changelog', text: changelog });
+
+    if (config.isIncrement) {
+      version = version || (await reduceUntil(plugins, plugin => plugin.getIncrementedVersion(incrementBase)));
+    }
+
+    config.setContext(parseVersion(version));
+
+    if (config.isPromptOnlyVersion) {
+      config.setCI(true);
+    }
+
+    for (const hook of ['beforeBump', 'bump', 'beforeRelease']) {
+      for (const plugin of plugins) {
+        const args = hook === 'bump' ? [version] : [];
+        await runLifeCycleHook(plugin, hook, ...args);
+      }
+    }
+
+    plugins = [...internal, ...external];
+
+    for (const hook of ['release', 'afterRelease']) {
+      for (const plugin of plugins) {
+        await runLifeCycleHook(plugin, hook);
+      }
+    }
+
+    await metrics.trackEvent('end');
+
+    log.log(`🏁 Done (in ${Math.floor(process.uptime())}s.)`);
+
+    return {
+      name,
+      changelog,
+      latestVersion,
+      version
+    };
+  } catch (err) {
+    const { log, metrics } = container;
+    if (metrics) {
+      await metrics.trackException(err);
+    }
+    log ? log.error(err.message || err) : console.error(err); // eslint-disable-line no-console
+    throw err;
   }
-  return Promise.resolve();
 };
 
-module.exports.Plugin = Plugin;
+export default runTasks;
+
+export { Plugin };

package/lib/log.js

@@ -1,6 +1,8 @@
-const { EOL } = require('os');
-const chalk = require('chalk');
-const { isObject, last, filter, isString, lowerCase, upperFirst, isArray } = require('lodash');
+import { EOL } from 'os';
+import chalk from 'chalk';
+import _ from 'lodash';
+
+const { isObject, last, filter, isString, lowerCase, upperFirst, isArray } = _;
 
 class Logger {
   constructor({ isCI = true, isVerbose = false, verbosityLevel = 0, isDryRun = false } = {}) {
@@ -64,4 +66,4 @@ class Logger {
   }
 }
 
-module.exports = Logger;
+export default Logger;

package/lib/metrics.js

@@ -1,10 +1,13 @@
-const { EOL } = require('os');
-const got = require('got');
-const { v4: uuidv4 } = require('uuid');
-const osName = require('os-name');
-const isCi = require('is-ci');
-const debug = require('debug')('release-it:metrics');
-const pkg = require('../package.json');
+import { EOL } from 'os';
+import got from 'got';
+import { v4 as uuidv4 } from 'uuid';
+import osName from 'os-name';
+import isCi from 'is-ci';
+import _debug from 'debug';
+import { readJSON } from './util.js';
+
+const debug = _debug('release-it:metrics');
+const pkg = readJSON(new URL('../package.json', import.meta.url));
 
 const noop = Promise.resolve();
 
@@ -70,4 +73,4 @@ class Metrics {
   }
 }
 
-module.exports = Metrics;
+export default Metrics;

package/lib/plugin/GitBase.js

@@ -1,6 +1,6 @@
-const { EOL } = require('os');
-const { format, parseGitUrl } = require('../util');
-const Plugin = require('./Plugin');
+import { EOL } from 'os';
+import { format, parseGitUrl } from '../util.js';
+import Plugin from './Plugin.js';
 
 const options = { write: false };
 const changelogFallback = 'git log --pretty=format:"* %s (%h)"';
@@ -103,4 +103,4 @@ class GitBase extends Plugin {
   }
 }
 
-module.exports = GitBase;
+export default GitBase;

package/lib/plugin/GitRelease.js

@@ -1,6 +1,8 @@
-const _ = require('lodash');
-const defaultConfig = require('../../config/release-it.json');
-const GitBase = require('./GitBase');
+import _ from 'lodash';
+import { readJSON } from '../util.js';
+import GitBase from './GitBase.js';
+
+const defaultConfig = readJSON(new URL('../../config/release-it.json', import.meta.url));
 
 class GitRelease extends GitBase {
   static isEnabled(options) {
@@ -37,4 +39,4 @@ class GitRelease extends GitBase {
   }
 }
 
-module.exports = GitRelease;
+export default GitRelease;

package/lib/plugin/Plugin.js

@@ -1,5 +1,5 @@
-const debug = require('debug');
-const _ = require('lodash');
+import debug from 'debug';
+import _ from 'lodash';
 
 class Plugin {
   static isEnabled() {
@@ -69,4 +69,4 @@ class Plugin {
   }
 }
 
-module.exports = Plugin;
+export default Plugin;

package/lib/plugin/factory.js

@@ -1,12 +1,15 @@
-const path = require('path');
-const _ = require('lodash');
-const requireCwd = require('import-cwd');
-const debug = require('debug')('release-it:plugins');
-const Version = require('./version/Version');
-const Git = require('./git/Git');
-const GitLab = require('./gitlab/GitLab');
-const GitHub = require('./github/GitHub');
-const npm = require('./npm/npm');
+import url from 'url';
+import path from 'path';
+import { createRequire } from 'module';
+import _ from 'lodash';
+import _debug from 'debug';
+import Version from './version/Version.js';
+import Git from './git/Git.js';
+import GitLab from './gitlab/GitLab.js';
+import GitHub from './github/GitHub.js';
+import npm from './npm/npm.js';
+
+const debug = _debug('release-it:plugins');
 
 const pluginNames = ['npm', 'git', 'github', 'gitlab', 'version'];
 
@@ -18,24 +21,33 @@ const plugins = {
   npm: npm
 };
 
-const load = pluginName => {
+const load = async pluginName => {
   let plugin = null;
   try {
-    plugin = require(pluginName);
+    const module = await import(pluginName);
+    plugin = module.default;
   } catch (err) {
-    plugin = requireCwd(pluginName);
+    try {
+      const module = await import(path.join(process.cwd(), pluginName));
+      plugin = module.default;
+    } catch (err) {
+      // In some cases or tests we might need to support legacy `require.resolve`
+      const require = createRequire(process.cwd());
+      const module = await import(url.pathToFileURL(require.resolve(pluginName, { paths: [process.cwd()] })));
+      plugin = module.default;
+    }
   }
   return [path.parse(pluginName).name, plugin];
 };
 
-module.exports.getPlugins = async (config, container) => {
+export let getPlugins = async (config, container) => {
   const context = config.getContext();
   const disabledPlugins = [];
 
   const enabledExternalPlugins = await _.reduce(
     context.plugins,
     async (result, pluginConfig, pluginName) => {
-      const [name, Plugin] = load(pluginName);
+      const [name, Plugin] = await load(pluginName);
       const [namespace, options] = pluginConfig.length === 2 ? pluginConfig : [name, pluginConfig];
       config.setContext({ [namespace]: options });
       if (await Plugin.isEnabled(options)) {

package/lib/plugin/git/Git.js

@@ -1,9 +1,9 @@
-const { EOL } = require('os');
-const _ = require('lodash');
-const execa = require('execa');
-const { format, e } = require('../../util');
-const GitBase = require('../GitBase');
-const prompts = require('./prompts');
+import { EOL } from 'os';
+import _ from 'lodash';
+import { execa } from 'execa';
+import { format, e } from '../../util.js';
+import GitBase from '../GitBase.js';
+import prompts from './prompts.js';
 
 const noop = Promise.resolve();
 const invalidPushRepoRe = /^\S+@/;
@@ -208,4 +208,4 @@ class Git extends GitBase {
   }
 }
 
-module.exports = Git;
+export default Git;

package/lib/plugin/git/prompts.js

@@ -1,6 +1,6 @@
-const { format, truncateLines } = require('../../util');
+import { format, truncateLines } from '../../util.js';
 
-module.exports = {
+export default {
   commit: {
     type: 'confirm',
     message: context => `Commit (${truncateLines(format(context.git.commitMessage, context), 1, ' [...]')})?`,

package/lib/plugin/github/GitHub.js

@@ -1,16 +1,17 @@
-const fs = require('fs');
-const path = require('path');
-const { Octokit } = require('@octokit/rest');
-const globby = require('globby');
-const mime = require('mime-types');
-const _ = require('lodash');
-const retry = require('async-retry');
-const newGithubReleaseUrl = require('new-github-release-url');
-const open = require('open');
-const pkg = require('../../../package.json');
-const { format, parseVersion, e } = require('../../util');
-const Release = require('../GitRelease');
-const prompts = require('./prompts');
+import fs from 'fs';
+import path from 'path';
+import open from 'open';
+import { Octokit } from '@octokit/rest';
+import { globby } from 'globby';
+import mime from 'mime-types';
+import _ from 'lodash';
+import retry from 'async-retry';
+import newGithubReleaseUrl from 'new-github-release-url';
+import { format, parseVersion, readJSON, e } from '../../util.js';
+import Release from '../GitRelease.js';
+import prompts from './prompts.js';
+
+const pkg = readJSON(new URL('../../../package.json', import.meta.url));
 
 const docs = 'https://git.io/release-it-github';
 
@@ -295,8 +296,11 @@ class GitHub extends Release {
   }
 
   generateWebUrl() {
+    const host = this.options.host || this.getContext('repo.host');
+    const isGitHub = host === 'github.com';
+
     const options = this.getOctokitReleaseOptions();
-    return newGithubReleaseUrl({
+    const url = newGithubReleaseUrl({
       user: options.owner,
       repo: options.repo,
       tag: options.tag_name,
@@ -304,6 +308,7 @@ class GitHub extends Release {
       title: options.name,
       body: options.body
     });
+    return isGitHub ? url : url.replace('github.com', host);
   }
 
   async createWebRelease() {
@@ -342,4 +347,4 @@ class GitHub extends Release {
   }
 }
 
-module.exports = GitHub;
+export default GitHub;

package/lib/plugin/github/prompts.js

@@ -1,4 +1,4 @@
-const { format } = require('../../util');
+import { format } from '../../util.js';
 
 const message = context => {
   const { isPreRelease, github } = context;
@@ -7,7 +7,7 @@ const message = context => {
   return `${update ? 'Update' : 'Create a'} ${isPreRelease ? 'pre-' : ''}release on GitHub (${name})?`;
 };
 
-module.exports = {
+export default {
   release: {
     type: 'confirm',
     message,

package/lib/plugin/gitlab/GitLab.js

@@ -1,12 +1,12 @@
-const fs = require('fs');
-const path = require('path');
-const got = require('got');
-const globby = require('globby');
-const FormData = require('form-data');
-const _ = require('lodash');
-const Release = require('../GitRelease');
-const { format, e } = require('../../util');
-const prompts = require('./prompts');
+import fs from 'fs';
+import path from 'path';
+import got from 'got';
+import { globby } from 'globby';
+import FormData from 'form-data';
+import _ from 'lodash';
+import Release from '../GitRelease.js';
+import { format, e } from '../../util.js';
+import prompts from './prompts.js';
 
 const docs = 'https://git.io/release-it-gitlab';
 
@@ -216,4 +216,4 @@ class GitLab extends Release {
   }
 }
 
-module.exports = GitLab;
+export default GitLab;

package/lib/plugin/gitlab/prompts.js

@@ -1,6 +1,6 @@
-const { format } = require('../../util');
+import { format } from '../../util.js';
 
-module.exports = {
+export default {
   release: {
     type: 'confirm',
     message: context => `Create a release on GitLab (${format(context.gitlab.releaseName, context)})?`,

package/lib/plugin/npm/npm.js

@@ -1,9 +1,9 @@
-const path = require('path');
-const semver = require('semver');
-const urlJoin = require('url-join');
-const Plugin = require('../Plugin');
-const { hasAccess, rejectAfter, parseVersion, e } = require('../../util');
-const prompts = require('./prompts');
+import path from 'path';
+import semver from 'semver';
+import urlJoin from 'url-join';
+import Plugin from '../Plugin.js';
+import { hasAccess, rejectAfter, parseVersion, readJSON, e } from '../../util.js';
+import prompts from './prompts.js';
 
 const docs = 'https://git.io/release-it-npm';
 
@@ -27,7 +27,7 @@ class npm extends Plugin {
   }
 
   async init() {
-    const { name, version: latestVersion, private: isPrivate, publishConfig } = require(path.resolve(MANIFEST_PATH));
+    const { name, version: latestVersion, private: isPrivate, publishConfig } = readJSON(path.resolve(MANIFEST_PATH));
     this.setContext({ name, latestVersion, private: isPrivate, publishConfig });
 
     const { publish, skipChecks } = this.options;
@@ -255,4 +255,4 @@ class npm extends Plugin {
   }
 }
 
-module.exports = npm;
+export default npm;

package/lib/plugin/npm/prompts.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   publish: {
     type: 'confirm',
     message: context =>

package/lib/plugin/version/Version.js

@@ -1,6 +1,6 @@
-const semver = require('semver');
-const chalk = require('chalk');
-const Plugin = require('../Plugin');
+import semver from 'semver';
+import chalk from 'chalk';
+import Plugin from '../Plugin.js';
 
 const { green, red, redBright } = chalk;
 
@@ -122,4 +122,4 @@ class Version extends Plugin {
   }
 }
 
-module.exports = Version;
+export default Version;

package/lib/prompt.js

@@ -1,4 +1,4 @@
-const inquirer = require('inquirer');
+import inquirer from 'inquirer';
 
 class Prompt {
   constructor({ container }) {
@@ -30,4 +30,4 @@ class Prompt {
   }
 }
 
-module.exports = Prompt;
+export default Prompt;