release-it 15.0.0-esm.3 → 15.0.0-esm.6

package/test/plugins.js

@@ -1,3 +1,4 @@
+import { join } from 'node:path';
 import test from 'ava';
 import sh from 'shelljs';
 import sinon from 'sinon';
@@ -12,16 +13,13 @@ import ContextPlugin from './stub/plugin-context.js';
 import { mkTmpDir } from './util/helpers.js';
 import ShellStub from './stub/shell.js';
 
-const rootDir = new URL('..', import.meta.url);
-
 const noop = Promise.resolve();
 
 const sandbox = sinon.createSandbox();
 
 const testConfig = {
   ci: true,
-  config: false,
-  'disable-metrics': true
+  config: false
 };
 
 const log = sandbox.createStubInstance(Log);
@@ -39,6 +37,11 @@ const getContainer = options => {
   };
 };
 
+test.serial.before(t => {
+  t.timeout(60 * 1000);
+  sh.exec('npm link');
+});
+
 test.serial.beforeEach(t => {
   const dir = mkTmpDir();
   sh.pushd('-q', dir);
@@ -50,23 +53,28 @@ test.serial.afterEach(() => {
 });
 
 test.serial('should instantiate plugins and execute all release-cycle methods', async t => {
-  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' })).toEnd('package.json');
-  sh.exec(`npm install ${rootDir}`);
+  const { dir } = t.context;
 
   const pluginDir = mkTmpDir();
   sh.pushd('-q', pluginDir);
-  sh.ShellString(JSON.stringify({ name: 'my-plugin', version: '1.0.0', type: 'module' })).toEnd('package.json');
-  sh.exec(`npm install ${rootDir}`);
+  sh.ShellString(JSON.stringify({ name: 'my-plugin', version: '1.0.0', type: 'module' })).toEnd(
+    join(pluginDir, 'package.json')
+  );
+  sh.exec(`npm link release-it`);
   const content = "import { Plugin } from 'release-it'; " + MyPlugin.toString() + '; export default MyPlugin;';
-  sh.ShellString(content).toEnd('index.js');
-  sh.popd();
+  sh.ShellString(content).toEnd(join(pluginDir, 'index.js'));
 
+  sh.pushd('-q', dir);
   sh.mkdir('-p', 'my/plugin');
   sh.pushd('-q', 'my/plugin');
-  sh.ShellString(content).toEnd('index.js');
-  sh.popd();
+  sh.ShellString(content).toEnd(join(dir, 'my', 'plugin', 'index.js'));
 
+  sh.pushd('-q', dir);
+  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' })).toEnd(
+    join(dir, 'package.json')
+  );
   sh.exec(`npm install ${pluginDir}`);
+  sh.exec(`npm link release-it`);
 
   const config = {
     plugins: {
@@ -114,14 +122,16 @@ test.serial('should instantiate plugins and execute all release-cycle methods',
 });
 
 test.serial('should disable core plugins', async t => {
-  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0' })).toEnd('package.json');
-  sh.exec(`npm install release-it@^14`);
-  const content = "const { Plugin } = require('release-it'); module.exports = " + ReplacePlugin.toString();
-  sh.ShellString(content).toEnd('replace-plugin.js');
+  const { dir } = t.context;
+  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0' })).toEnd(join(dir, 'package.json'));
+  const content =
+    "import { Plugin } from 'release-it'; " + ReplacePlugin.toString() + '; export default ReplacePlugin;';
+  sh.ShellString(content).toEnd(join(dir, 'replace-plugin.mjs'));
+  sh.exec(`npm link release-it`);
 
   const config = {
     plugins: {
-      './replace-plugin.js': {}
+      './replace-plugin.mjs': {}
     }
   };
   const container = getContainer(config);
@@ -137,12 +147,14 @@ test.serial('should disable core plugins', async t => {
 });
 
 test.serial('should expose context to execute commands', async t => {
-  sh.ShellString(JSON.stringify({ name: 'pkg-name', version: '1.0.0', type: 'module' })).toEnd('package.json');
-  sh.exec(`npm install ${rootDir}`);
-
+  const { dir } = t.context;
+  sh.ShellString(JSON.stringify({ name: 'pkg-name', version: '1.0.0', type: 'module' })).toEnd(
+    join(dir, 'package.json')
+  );
   const content =
     "import { Plugin } from 'release-it'; " + ContextPlugin.toString() + '; export default ContextPlugin;';
-  sh.ShellString(content).toEnd('context-plugin.js');
+  sh.ShellString(content).toEnd(join(dir, 'context-plugin.js'));
+  sh.exec(`npm link release-it`);
 
   const repo = parseGitUrl('https://github.com/user/pkg');
 

package/test/spinner.js

@@ -10,8 +10,7 @@ test.beforeEach(t => {
 const getConfig = options => {
   const testConfig = {
     ci: false,
-    config: false,
-    'disable-metrics': true
+    config: false
   };
   return new Config(Object.assign({}, testConfig, options));
 };

package/test/stub/config/default/.release-it.json

@@ -0,0 +1,5 @@
+{
+  "github": {
+    "release": true
+  }
+}

package/test/stub/config/invalid-config-rc

@@ -0,0 +1 @@
+foo=bar

package/test/stub/config/invalid-config-txt

@@ -0,0 +1,2 @@
+foo
+bar\baz

package/test/stub/config/merge/.release-it.json

@@ -0,0 +1,5 @@
+{
+  "github": {
+    "release": true
+  }
+}

package/test/stub/config/merge/package.json

@@ -0,0 +1,7 @@
+{
+  "release-it": {
+    "git": {
+      "push": false
+    }
+  }
+}

package/test/stub/config/toml/.release-it.toml

@@ -0,0 +1,2 @@
+[foo]
+bar=1

package/test/stub/config/yaml/.release-it.yaml

@@ -0,0 +1,2 @@
+foo:
+  bar: 1

package/test/stub/config/yml/.release-it.yml

@@ -0,0 +1,2 @@
+foo:
+  bar: 1

package/test/stub/github.js

@@ -1,16 +1,19 @@
 import nock from 'nock';
 
-const interceptAuthentication = ({ api = 'https://api.github.com', username = 'john' } = {}) =>
+const interceptAuthentication = ({ api = 'https://api.github.com', username = 'john' } = {}) => {
   nock(api).get('/user').reply(200, {
     login: username
   });
+};
 
 const interceptCollaborator = ({
   api = 'https://api.github.com',
   owner = 'user',
   project = 'repo',
   username = 'john'
-} = {}) => nock(api).get(`/repos/${owner}/${project}/collaborators/${username}`).reply(204);
+} = {}) => {
+  nock(api).get(`/repos/${owner}/${project}/collaborators/${username}`).reply(204);
+};
 
 const interceptListReleases = ({
   host = 'github.com',
@@ -18,7 +21,7 @@ const interceptListReleases = ({
   owner = 'user',
   project = 'repo',
   tag_name
-} = {}) =>
+} = {}) => {
   nock(api)
     .get(`/repos/${owner}/${project}/releases?per_page=1&page=1`)
     .reply(200, [
@@ -34,16 +37,24 @@ const interceptListReleases = ({
         prerelease: false
       }
     ]);
+};
 
 const interceptCreate = ({
   api = 'https://api.github.com',
   host = 'github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = null, prerelease = false, draft = false }
-} = {}) =>
+  body: { tag_name, name = '', generate_release_notes = false, body = null, prerelease = false, draft = false }
+} = {}) => {
   nock(api)
-    .post(`/repos/${owner}/${project}/releases`, { tag_name, name, body, prerelease, draft })
+    .post(`/repos/${owner}/${project}/releases`, {
+      tag_name,
+      name,
+      body,
+      prerelease,
+      draft,
+      generate_release_notes
+    })
     .reply(() => {
       const id = 1;
       const responseBody = {
@@ -53,21 +64,23 @@ const interceptCreate = ({
         body,
         prerelease,
         draft,
+        generate_release_notes,
         upload_url: `https://uploads.${host}/repos/${owner}/${project}/releases/${id}/assets{?name,label}`,
         html_url: `https://${host}/${owner}/${project}/releases/tag/${tag_name}`
       };
       return [200, responseBody, { location: `${api}/repos/${owner}/${project}/releases/${id}` }];
     });
+};
 
 const interceptUpdate = ({
   host = 'github.com',
   api = 'https://api.github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = null, prerelease = false, draft = false }
-} = {}) =>
+  body: { tag_name, name = '', body = null, prerelease = false, draft = false, generate_release_notes = false }
+} = {}) => {
   nock(api)
-    .patch(`/repos/${owner}/${project}/releases/1`, { tag_name, name, body, draft, prerelease })
+    .patch(`/repos/${owner}/${project}/releases/1`, { tag_name, name, body, draft, prerelease, generate_release_notes })
     .reply(200, {
       id: 1,
       tag_name,
@@ -75,9 +88,11 @@ const interceptUpdate = ({
       body,
       prerelease,
       draft,
+      generate_release_notes,
       upload_url: `https://uploads.${host}/repos/${owner}/${project}/releases/1/assets{?name,label}`,
       html_url: `https://${host}/${owner}/${project}/releases/tag/${tag_name}`
     });
+};
 
 const interceptAsset = ({
   api = 'https://api.github.com',
@@ -86,7 +101,7 @@ const interceptAsset = ({
   project = 'repo',
   tagName,
   body = {}
-} = {}) =>
+} = {}) => {
   nock(`https://uploads.${host}`)
     .post(`/repos/${owner}/${project}/releases/1/assets`, body)
     .query(true)
@@ -103,6 +118,7 @@ const interceptAsset = ({
         browser_download_url: `https://${host}/${owner}/${project}/releases/download/${tagName}/${name}`
       };
     });
+};
 
 export {
   interceptAuthentication,

package/test/stub/gitlab.js

@@ -11,16 +11,24 @@ export let interceptCollaborator = (
     .get(`/api/v4/projects/${group ? `${group}%2F` : ''}${owner}%2F${project}/members/all/${userId}`)
     .reply(200, { id: userId, username: owner, access_level: 30 });
 
-export let interceptCollaboratorFallback = (
-  { host = 'https://gitlab.com', owner = 'user', project = 'repo', group, userId = 1 } = {},
+export let interceptPublish = ({ host = 'https://gitlab.com', owner = 'user', project = 'repo', body } = {}, options) =>
+  nock(host, options).post(`/api/v4/projects/${owner}%2F${project}/releases`, body).reply(200, {});
+
+export let interceptMilestones = (
+  { host = 'https://gitlab.com', owner = 'user', project = 'repo', query = {}, milestones = [] } = {},
   options
 ) =>
   nock(host, options)
-    .get(`/api/v4/projects/${group ? `${group}%2F` : ''}${owner}%2F${project}/members/${userId}`)
-    .reply(200, { id: userId, username: owner, access_level: 30 });
-
-export let interceptPublish = ({ host = 'https://gitlab.com', owner = 'user', project = 'repo', body } = {}, options) =>
-  nock(host, options).post(`/api/v4/projects/${owner}%2F${project}/releases`, body).reply(200, {});
+    .get(`/api/v4/projects/${owner}%2F${project}/milestones`)
+    .query(
+      Object.assign(
+        {
+          include_parent_milestones: true
+        },
+        query
+      )
+    )
+    .reply(200, JSON.stringify(milestones));
 
 export let interceptAsset = ({ host = 'https://gitlab.com', owner = 'user', project = 'repo' } = {}) =>
   nock(host)

package/test/stub/shell.js

@@ -1,7 +1,7 @@
-import _debug from 'debug';
+import util from 'node:util';
 import Shell from '../../lib/shell.js';
 
-const debug = _debug('release-it:shell-stub');
+const debug = util.debug('release-it:shell-stub');
 
 class ShellStub extends Shell {
   exec(command) {

package/test/tasks.interactive.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import test from 'ava';
 import sh from 'shelljs';
 import _ from 'lodash';
@@ -19,8 +19,7 @@ const sandbox = sinon.createSandbox();
 
 const testConfig = {
   ci: false,
-  config: false,
-  'disable-metrics': true
+  config: false
 };
 
 const log = sandbox.createStubInstance(Log);

package/test/tasks.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import test from 'ava';
 import sh from 'shelljs';
 import _ from 'lodash';
@@ -30,8 +30,7 @@ const sandbox = sinon.createSandbox();
 
 const testConfig = {
   ci: true,
-  config: false,
-  'disable-metrics': true
+  config: false
 };
 
 const log = sandbox.createStubInstance(Log);
@@ -358,7 +357,7 @@ test.serial('should initially publish non-private scoped npm package privately',
 test.serial('should use pkg.publishConfig.registry', async t => {
   const { target } = t.context;
   const pkgName = path.basename(target);
-  const registry = 'https://my-registry.com';
+  const registry = 'https://my-registry.example.org';
 
   gitAdd(
     JSON.stringify({

package/test/util/helpers.js

@@ -1,14 +1,14 @@
-import { promises as fs } from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
 import sh from 'shelljs';
-import tmp from 'tmp';
 
 const mkTmpDir = () => {
-  const dir = tmp.dirSync({ prefix: 'release-it-' });
-  return dir.name;
+  const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'release-it-'));
+  return dir;
 };
 
-const readFile = file => fs.readFile(path.resolve(file), 'utf8');
+const readFile = file => fs.promises.readFile(path.resolve(file), 'utf8');
 
 const gitAdd = (content, file, message) => {
   sh.ShellString(content).toEnd(file);

package/test/util/index.js

@@ -30,23 +30,14 @@ export let factory = (Definition, { namespace, options = {}, container = {} } =
   });
 };
 
-const getIncrement = (plugin, { latestVersion }) => {
-  return (
-    plugin.getIncrement({
-      latestVersion,
-      increment: plugin.options.increment,
-      isPreRelease: false,
-      preReleaseId: null
-    }) ||
-    plugin.getContext('increment') ||
-    plugin.config.getContext('increment')
-  );
-};
+const getIncrement = plugin =>
+  plugin.getIncrement(plugin.options) || plugin.getContext('increment') || plugin.config.getContext('increment');
 
-const getVersion = async (plugin, { latestVersion, increment }) => {
+const getVersion = async (plugin, options) => {
+  const { latestVersion, increment } = options;
   return (
-    (await plugin.getIncrementedVersionCI({ latestVersion, increment })) ||
-    (await plugin.getIncrementedVersion({ latestVersion, increment })) ||
+    (await plugin.getIncrementedVersionCI(options)) ||
+    (await plugin.getIncrementedVersion(options)) ||
     (increment !== false ? semver.inc(latestVersion, increment || 'patch') : latestVersion)
   );
 };
@@ -56,12 +47,16 @@ export let runTasks = async plugin => {
 
   const name = (await plugin.getName()) || '__test__';
   const latestVersion = (await plugin.getLatestVersion()) || '1.0.0';
-  const changelog = (await plugin.getChangelog()) || null;
-  const increment = getIncrement(plugin, { latestVersion });
+  const latestTag = plugin.config.getContext('latestTag');
+  const changelog = (await plugin.getChangelog(latestVersion)) || null;
+  const increment = getIncrement(plugin);
 
-  plugin.config.setContext({ name, latestVersion, latestTag: latestVersion, changelog });
+  plugin.config.setContext({ name, latestVersion, latestTag, changelog });
 
-  const version = await getVersion(plugin, { latestVersion, increment });
+  const { preRelease } = plugin.config.options;
+  const isPreRelease = Boolean(preRelease);
+  const preReleaseId = typeof preRelease === 'string' ? preRelease : null;
+  const version = await getVersion(plugin, { latestVersion, increment, isPreRelease, preReleaseId });
 
   plugin.config.setContext(parseVersion(version));
 

package/test/utils.js

@@ -1,4 +1,4 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import test from 'ava';
 import mockStdIo from 'mock-stdio';
 import stripAnsi from 'strip-ansi';

package/test/version.js

@@ -148,17 +148,22 @@ test('should run tasks without errors', async t => {
   await runTasks(v);
 
   t.is(getIncrement.callCount, 1);
-  t.deepEqual(getIncrement.firstCall.args[0], {
+  t.deepEqual(getIncrement.firstCall.args[0], { increment: 'minor' });
+  t.is(getIncrementedVersionCI.callCount, 1);
+  t.deepEqual(getIncrementedVersionCI.firstCall.args[0], {
     latestVersion: '1.0.0',
     increment: 'minor',
     isPreRelease: false,
     preReleaseId: null
   });
-  t.is(getIncrementedVersionCI.callCount, 1);
-  t.deepEqual(getIncrementedVersionCI.firstCall.args[0], { latestVersion: '1.0.0', increment: 'minor' });
   t.is(await incrementVersion.firstCall.returnValue, '1.1.0');
   t.is(incrementVersion.callCount, 1);
-  t.deepEqual(incrementVersion.firstCall.args[0], { latestVersion: '1.0.0', increment: 'minor' });
+  t.deepEqual(incrementVersion.firstCall.args[0], {
+    latestVersion: '1.0.0',
+    increment: 'minor',
+    isPreRelease: false,
+    preReleaseId: null
+  });
   t.is(incrementVersion.firstCall.returnValue, '1.1.0');
   const { latestVersion, version, isPreRelease, preReleaseId } = v.config.getContext();
   t.is(latestVersion, '1.0.0');

package/config/.codecov.yml

@@ -1,5 +0,0 @@
-coverage:
-  parsers:
-    javascript:
-      enable_partials: yes
-comment: false

package/config/deprecated.json

@@ -1 +0,0 @@
-{}

package/lib/deprecated.js

@@ -1,22 +0,0 @@
-import Deprecated from 'deprecated-obj';
-import { readJSON } from './util.js';
-import Log from './log.js';
-
-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();
-  if (Object.keys(violations).length > 0) {
-    log.warn(`Deprecated configuration options found. Please migrate before the next major release.`);
-  }
-  for (const d in violations) {
-    log.warn(
-      `The "${d}" option is deprecated. ${
-        violations[d] ? (/^[A-Z]/.test(violations[d]) ? violations[d] : `Please use "${violations[d]}" instead.`) : ''
-      }`
-    );
-  }
-  return compliant;
-};

package/lib/metrics.js

@@ -1,76 +0,0 @@
-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();
-
-const cast = value => (value ? 1 : 0);
-
-const cid = uuidv4();
-
-const payload = config => ({
-  v: 1,
-  tid: 'UA-108828841-1',
-  cid,
-  cd1: pkg.version,
-  cd2: process.version,
-  cd3: osName(),
-  cd4: cast(!config.isCI),
-  cd5: cast(config.isDryRun),
-  cd6: cast(config.isVerbose),
-  cd7: cast(config.isDebug),
-  cd8: null,
-  cd9: config.preReleaseId,
-  cd11: cast(isCi),
-  cd12: cast(config.git.tag),
-  cd13: cast(config.npm.publish),
-  cd14: cast(config.github.release),
-  cd15: config.increment,
-  cd16: cast(config.gitlab.release)
-});
-
-class Metrics {
-  constructor({ isEnabled = true, request = got } = {}) {
-    this.isEnabled = isEnabled;
-    this.request = request;
-  }
-  send(payload) {
-    return !this.isEnabled
-      ? noop
-      : this.request('http://www.google-analytics.com/collect', {
-          timeout: 300,
-          retries: 0,
-          method: 'POST',
-          form: payload
-        })
-          .then(res => {
-            const { url, statusCode, statusMessage } = res;
-            debug({ url, statusCode, statusMessage, payload: new URLSearchParams(payload).toString() });
-          })
-          .catch(debug);
-  }
-  trackEvent(action, config) {
-    return this.send(
-      Object.assign(config ? payload(config) : {}, {
-        t: 'event',
-        ec: 'session',
-        ea: action
-      })
-    );
-  }
-  trackException(err) {
-    return this.send({
-      t: 'exception',
-      exd: err.toString().split(EOL)[0]
-    });
-  }
-}
-
-export default Metrics;

package/test/deprecated.js

@@ -1,11 +0,0 @@
-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);
-  const config = deprecated({ keep: 1 }, log);
-  t.is(log.warn.callCount, 0);
-  t.deepEqual(config, { keep: 1 });
-});

package/test/metrics.js

@@ -1,17 +0,0 @@
-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();
-  const metrics = new Metrics({ request: stub });
-  await metrics.trackEvent('test');
-  t.true(stub.calledWithMatch(/google-analytics.com\/collect/, sinon.match.object));
-});
-
-test('should not send metrics when disabled', async t => {
-  const stub = sinon.stub().resolves();
-  const metrics = new Metrics({ isEnabled: false, request: stub });
-  await metrics.trackEvent('test');
-  t.true(stub.notCalled);
-});