release-it 19.0.0-next.0 → 19.0.0-next.2

package/test/plugin-name.js

@@ -1,9 +1,10 @@
-import test from 'ava';
+import test from 'node:test';
+import assert from 'node:assert/strict';
 import { getPluginName } from '../lib/plugin/factory.js';
 
-test('pluginName can return correct name for variants', t => {
-  t.is(getPluginName('plain-plugin'), 'plain-plugin');
-  t.is(getPluginName('@some/scoped-plugin'), '@some/scoped-plugin');
-  t.is(getPluginName('@some/nested/scoped-plugin'), '@some/nested/scoped-plugin');
-  t.is(getPluginName('./relative-plugin.cjs'), 'relative-plugin');
+test('pluginName can return correct name for variants', async () => {
+  assert.equal(getPluginName('plain-plugin'), 'plain-plugin');
+  assert.equal(getPluginName('@some/scoped-plugin'), '@some/scoped-plugin');
+  assert.equal(getPluginName('@some/nested/scoped-plugin'), '@some/nested/scoped-plugin');
+  assert.equal(getPluginName('./relative-plugin.cjs'), 'relative-plugin');
 });

package/test/plugins.js

@@ -1,243 +1,232 @@
 import { resolve, join } from 'node:path';
 import childProcess from 'node:child_process';
 import fs, { appendFileSync, mkdirSync } from 'node:fs';
-import test from 'ava';
-import sinon from 'sinon';
-import Log from '../lib/log.js';
-import Spinner from '../lib/spinner.js';
+import test, { afterEach, describe } from 'node:test';
+import assert from 'node:assert/strict';
 import Config from '../lib/config.js';
 import { execOpts, parseGitUrl } from '../lib/util.js';
 import runTasks from '../lib/index.js';
 import MyPlugin from './stub/plugin.js';
 import ReplacePlugin from './stub/plugin-replace.js';
 import ContextPlugin from './stub/plugin-context.js';
-import { mkTmpDir } from './util/helpers.js';
+import { getArgs, mkTmpDir } from './util/helpers.js';
 import ShellStub from './stub/shell.js';
+import { LogStub, SpinnerStub } from './util/index.js';
 
-const noop = Promise.resolve();
-
-const sandbox = sinon.createSandbox();
-
-const testConfig = {
-  ci: true,
-  config: false
-};
+describe('plugins', () => {
+  const testConfig = {
+    ci: true,
+    config: false
+  };
 
-const log = sandbox.createStubInstance(Log);
-const spinner = sandbox.createStubInstance(Spinner);
-spinner.show.callsFake(({ enabled = true, task }) => (enabled ? task() : noop));
+  const log = new LogStub();
+  const spinner = new SpinnerStub();
 
-const getContainer = options => {
-  const config = new Config(Object.assign({}, testConfig, options));
-  const shell = new ShellStub({ container: { log, config } });
-  return {
-    log,
-    spinner,
-    config,
-    shell
+  const getContainer = options => {
+    const config = new Config(Object.assign({}, testConfig, options));
+    const shell = new ShellStub({ container: { log, config } });
+    return { log, spinner, config, shell };
   };
-};
 
-test.before(t => {
-  t.timeout(60 * 1000);
   childProcess.execSync('npm link', execOpts);
-});
 
-test.serial.beforeEach(t => {
-  const dir = mkTmpDir();
-  process.chdir(dir);
-  t.context = { dir };
-});
-
-test.serial.afterEach(() => {
-  sandbox.resetHistory();
-});
+  afterEach(() => {
+    log.resetCalls();
+  });
 
-test.serial('should instantiate plugins and execute all release-cycle methods', async t => {
-  const { dir } = t.context;
-
-  const pluginDir = mkTmpDir();
-  process.chdir(pluginDir);
-
-  appendFileSync(
-    join(pluginDir, 'package.json'),
-    JSON.stringify({ name: 'my-plugin', version: '1.0.0', type: 'module' })
-  );
-  childProcess.execSync(`npm link release-it`, execOpts);
-  const content = "import { Plugin } from 'release-it'; " + MyPlugin.toString() + '; export default MyPlugin;';
-
-  appendFileSync(join(pluginDir, 'index.js'), content);
-  process.chdir(dir);
-  mkdirSync(resolve('my/plugin'), { recursive: true });
-  process.chdir('my/plugin');
-
-  appendFileSync(join(dir, 'my', 'plugin', 'index.js'), content);
-  process.chdir(dir);
-
-  appendFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' }));
-  childProcess.execSync(`npm install ${pluginDir}`, execOpts);
-  childProcess.execSync(`npm link release-it`, execOpts);
-
-  const config = {
-    plugins: {
-      'my-plugin': {
-        name: 'foo'
-      },
-      './my/plugin/index.js': [
-        'named-plugin',
-        {
-          name: 'bar'
-        }
+  test('should instantiate plugins and execute all release-cycle methods', async () => {
+    const pluginDir = mkTmpDir();
+    const dir = mkTmpDir();
+    process.chdir(pluginDir);
+
+    appendFileSync(
+      join(pluginDir, 'package.json'),
+      JSON.stringify({ name: 'my-plugin', version: '1.0.0', type: 'module' })
+    );
+    childProcess.execSync(`npm link release-it`, execOpts);
+    const content = "import { Plugin } from 'release-it'; " + MyPlugin.toString() + '; export default MyPlugin;';
+
+    appendFileSync(join(pluginDir, 'index.js'), content);
+    process.chdir(dir);
+    mkdirSync(resolve('my/plugin'), { recursive: true });
+    process.chdir('my/plugin');
+
+    appendFileSync(join(dir, 'my', 'plugin', 'index.js'), content);
+    process.chdir(dir);
+
+    appendFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' }));
+    childProcess.execSync(`npm install ${pluginDir}`, execOpts);
+    childProcess.execSync(`npm link release-it`, execOpts);
+
+    const config = {
+      plugins: {
+        'my-plugin': {
+          name: 'foo'
+        },
+        './my/plugin/index.js': [
+          'named-plugin',
+          {
+            name: 'bar'
+          }
+        ]
+      }
+    };
+    const container = getContainer(config);
+
+    const result = await runTasks({}, container);
+
+    assert.deepEqual(
+      container.log.info.mock.calls.map(call => call.arguments),
+      [
+        ['my-plugin:foo:init'],
+        ['named-plugin:bar:init'],
+        ['my-plugin:foo:getName'],
+        ['my-plugin:foo:getLatestVersion'],
+        ['my-plugin:foo:getIncrement'],
+        ['my-plugin:foo:getIncrementedVersionCI'],
+        ['named-plugin:bar:getIncrementedVersionCI'],
+        ['my-plugin:foo:beforeBump'],
+        ['named-plugin:bar:beforeBump'],
+        ['my-plugin:foo:bump:1.3.0'],
+        ['named-plugin:bar:bump:1.3.0'],
+        ['my-plugin:foo:beforeRelease'],
+        ['named-plugin:bar:beforeRelease'],
+        ['my-plugin:foo:release'],
+        ['named-plugin:bar:release'],
+        ['my-plugin:foo:afterRelease'],
+        ['named-plugin:bar:afterRelease']
       ]
-    }
-  };
-  const container = getContainer(config);
-
-  const result = await runTasks({}, container);
-
-  t.deepEqual(container.log.info.args, [
-    ['my-plugin:foo:init'],
-    ['named-plugin:bar:init'],
-    ['my-plugin:foo:getName'],
-    ['my-plugin:foo:getLatestVersion'],
-    ['my-plugin:foo:getIncrement'],
-    ['my-plugin:foo:getIncrementedVersionCI'],
-    ['named-plugin:bar:getIncrementedVersionCI'],
-    ['my-plugin:foo:beforeBump'],
-    ['named-plugin:bar:beforeBump'],
-    ['my-plugin:foo:bump:1.3.0'],
-    ['named-plugin:bar:bump:1.3.0'],
-    ['my-plugin:foo:beforeRelease'],
-    ['named-plugin:bar:beforeRelease'],
-    ['my-plugin:foo:release'],
-    ['named-plugin:bar:release'],
-    ['my-plugin:foo:afterRelease'],
-    ['named-plugin:bar:afterRelease']
-  ]);
-
-  t.deepEqual(result, {
-    changelog: undefined,
-    name: 'new-project-name',
-    latestVersion: '1.2.3',
-    version: '1.3.0'
+    );
+
+    assert.deepEqual(result, {
+      changelog: undefined,
+      name: 'new-project-name',
+      latestVersion: '1.2.3',
+      version: '1.3.0'
+    });
   });
-});
-
-test.serial('should instantiate plugins and execute all release-cycle methods for scoped plugins', async t => {
-  const { dir } = t.context;
-
-  const pluginDir = mkTmpDir();
-  process.chdir(pluginDir);
-
-  fs.writeFileSync(
-    join(pluginDir, 'package.json'),
-    JSON.stringify({ name: '@scoped/my-plugin', version: '1.0.0', type: 'module' })
-  );
-  childProcess.execSync(`npm link release-it`, execOpts);
-  const content = "import { Plugin } from 'release-it'; " + MyPlugin.toString() + '; export default MyPlugin;';
-
-  fs.writeFileSync(join(pluginDir, 'index.js'), content);
-  process.chdir(dir);
-
-  fs.writeFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' }));
-  childProcess.execSync(`npm install ${pluginDir}`, execOpts);
-  childProcess.execSync(`npm link release-it`, execOpts);
 
-  const config = {
-    plugins: {
-      '@scoped/my-plugin': {
-        name: 'foo'
+  test('should instantiate plugins and execute all release-cycle methods for scoped plugins', async () => {
+    const pluginDir = mkTmpDir();
+    const dir = mkTmpDir();
+    process.chdir(pluginDir);
+
+    fs.writeFileSync(
+      join(pluginDir, 'package.json'),
+      JSON.stringify({ name: '@scoped/my-plugin', version: '1.0.0', type: 'module' })
+    );
+    childProcess.execSync(`npm link release-it`, execOpts);
+    const content = "import { Plugin } from 'release-it'; " + MyPlugin.toString() + '; export default MyPlugin;';
+
+    fs.writeFileSync(join(pluginDir, 'index.js'), content);
+    process.chdir(dir);
+
+    fs.writeFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' }));
+    childProcess.execSync(`npm install ${pluginDir}`, execOpts);
+    childProcess.execSync(`npm link release-it`, execOpts);
+
+    const config = {
+      plugins: {
+        '@scoped/my-plugin': {
+          name: 'foo'
+        }
       }
-    }
-  };
-  const container = getContainer(config);
-
-  const result = await runTasks({}, container);
-
-  t.deepEqual(container.log.info.args, [
-    ['@scoped/my-plugin:foo:init'],
-    ['@scoped/my-plugin:foo:getName'],
-    ['@scoped/my-plugin:foo:getLatestVersion'],
-    ['@scoped/my-plugin:foo:getIncrement'],
-    ['@scoped/my-plugin:foo:getIncrementedVersionCI'],
-    ['@scoped/my-plugin:foo:beforeBump'],
-    ['@scoped/my-plugin:foo:bump:1.3.0'],
-    ['@scoped/my-plugin:foo:beforeRelease'],
-    ['@scoped/my-plugin:foo:release'],
-    ['@scoped/my-plugin:foo:afterRelease']
-  ]);
-
-  t.deepEqual(result, {
-    changelog: undefined,
-    name: 'new-project-name',
-    latestVersion: '1.2.3',
-    version: '1.3.0'
+    };
+    const container = getContainer(config);
+
+    const result = await runTasks({}, container);
+
+    assert.deepEqual(
+      container.log.info.mock.calls.map(call => call.arguments),
+      [
+        ['@scoped/my-plugin:foo:init'],
+        ['@scoped/my-plugin:foo:getName'],
+        ['@scoped/my-plugin:foo:getLatestVersion'],
+        ['@scoped/my-plugin:foo:getIncrement'],
+        ['@scoped/my-plugin:foo:getIncrementedVersionCI'],
+        ['@scoped/my-plugin:foo:beforeBump'],
+        ['@scoped/my-plugin:foo:bump:1.3.0'],
+        ['@scoped/my-plugin:foo:beforeRelease'],
+        ['@scoped/my-plugin:foo:release'],
+        ['@scoped/my-plugin:foo:afterRelease']
+      ]
+    );
+
+    assert.deepEqual(result, {
+      changelog: undefined,
+      name: 'new-project-name',
+      latestVersion: '1.2.3',
+      version: '1.3.0'
+    });
   });
-});
 
-test.serial('should disable core plugins', async t => {
-  const { dir } = t.context;
+  test('should disable core plugins', async () => {
+    const dir = mkTmpDir();
+    process.chdir(dir);
 
-  fs.appendFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'project', version: '1.0.0' }));
-  const content =
-    "import { Plugin } from 'release-it'; " + ReplacePlugin.toString() + '; export default ReplacePlugin;';
+    fs.appendFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'project', version: '1.0.0' }));
+    const content =
+      "import { Plugin } from 'release-it'; " + ReplacePlugin.toString() + '; export default ReplacePlugin;';
 
-  fs.appendFileSync(join(dir, 'replace-plugin.mjs'), content);
-  childProcess.execSync(`npm link release-it`, execOpts);
+    fs.appendFileSync(join(dir, 'replace-plugin.mjs'), content);
+    childProcess.execSync(`npm link release-it`, execOpts);
 
-  const config = {
-    plugins: {
-      './replace-plugin.mjs': {}
-    }
-  };
-  const container = getContainer(config);
+    const config = {
+      plugins: {
+        './replace-plugin.mjs': {}
+      }
+    };
+    const container = getContainer(config);
 
-  const result = await runTasks({}, container);
+    const result = await runTasks({}, container);
 
-  t.deepEqual(result, {
-    changelog: undefined,
-    name: undefined,
-    latestVersion: '0.0.0',
-    version: undefined
+    assert.deepEqual(result, {
+      changelog: undefined,
+      name: undefined,
+      latestVersion: '0.0.0',
+      version: undefined
+    });
   });
-});
-
-test.serial('should expose context to execute commands', async t => {
-  const { dir } = t.context;
 
-  fs.appendFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'pkg-name', version: '1.0.0', type: 'module' }));
-  const content =
-    "import { Plugin } from 'release-it'; " + ContextPlugin.toString() + '; export default ContextPlugin;';
-
-  fs.appendFileSync(join(dir, 'context-plugin.js'), content);
-  childProcess.execSync(`npm link release-it`, execOpts);
-
-  const repo = parseGitUrl('https://github.com/user/pkg');
-
-  const container = getContainer({ plugins: { './context-plugin.js': {} } });
-  const exec = sinon.spy(container.shell, 'execFormattedCommand');
-
-  container.config.setContext({ repo });
-  container.config.setContext({ tagName: '1.0.1' });
-
-  await runTasks({}, container);
-
-  const pluginExecArgs = exec.args
-    .map(args => args[0])
-    .filter(arg => typeof arg === 'string' && arg.startsWith('echo'));
-
-  t.deepEqual(pluginExecArgs, [
-    'echo false',
-    'echo false',
-    `echo pkg-name user 1.0.0 1.0.1`,
-    `echo pkg-name user 1.0.0 1.0.1`,
-    `echo user pkg user/pkg 1.0.1`,
-    `echo user pkg user/pkg 1.0.1`,
-    `echo user pkg user/pkg 1.0.1`,
-    `echo user pkg user/pkg 1.0.1`,
-    `echo pkg 1.0.0 1.0.1 1.0.1`,
-    `echo pkg 1.0.0 1.0.1 1.0.1`,
-    `echo pkg 1.0.0 1.0.1 1.0.1`,
-    `echo pkg 1.0.0 1.0.1 1.0.1`
-  ]);
+  test('should expose context to execute commands', async t => {
+    const dir = mkTmpDir();
+    process.chdir(dir);
+
+    fs.appendFileSync(
+      join(dir, 'package.json'),
+      JSON.stringify({ name: 'pkg-name', version: '1.0.0', type: 'module' })
+    );
+    const content =
+      "import { Plugin } from 'release-it'; " + ContextPlugin.toString() + '; export default ContextPlugin;';
+
+    fs.appendFileSync(join(dir, 'context-plugin.js'), content);
+    childProcess.execSync(`npm link release-it`, execOpts);
+
+    const repo = parseGitUrl('https://github.com/user/pkg');
+
+    const container = getContainer({ plugins: { './context-plugin.js': {} } });
+    const exec = t.mock.method(container.shell, 'execFormattedCommand');
+
+    container.config.setContext({ repo });
+    container.config.setContext({ tagName: '1.0.1' });
+
+    await runTasks({}, container);
+
+    const pluginExecArgs = getArgs(exec, 'echo');
+
+    assert.deepEqual(pluginExecArgs, [
+      'echo false',
+      'echo false',
+      `echo pkg-name user 1.0.0 1.0.1`,
+      `echo pkg-name user 1.0.0 1.0.1`,
+      `echo user pkg user/pkg 1.0.1`,
+      `echo user pkg user/pkg 1.0.1`,
+      `echo user pkg user/pkg 1.0.1`,
+      `echo user pkg user/pkg 1.0.1`,
+      `echo pkg 1.0.0 1.0.1 1.0.1`,
+      `echo pkg 1.0.0 1.0.1 1.0.1`,
+      `echo pkg 1.0.0 1.0.1 1.0.1`,
+      `echo pkg 1.0.0 1.0.1 1.0.1`
+    ]);
+  });
 });

package/test/prompt.js

@@ -1,5 +1,5 @@
-import test from 'ava';
-import sinon from 'sinon';
+import test from 'node:test';
+import assert from 'node:assert/strict';
 import Prompt from '../lib/prompt.js';
 import Config from '../lib/config.js';
 import git from '../lib/plugin/git/prompts.js';
@@ -13,31 +13,25 @@ const prompts = { git, github, gitlab, npm };
 const yes = ([options]) => Promise.resolve({ [options.name]: true });
 const no = ([options]) => Promise.resolve({ [options.name]: false });
 
-test.beforeEach(t => {
-  t.context.getInquirer = stub => ({
-    prompt: stub
-  });
-});
-
 test('should not create prompt if disabled', async t => {
-  const task = sinon.spy();
-  const stub = sinon.stub().callsFake(yes);
-  const inquirer = t.context.getInquirer(stub);
+  const task = t.mock.fn();
+  const promptMock = t.mock.fn(yes);
+  const inquirer = { prompt: promptMock };
   const prompt = factory(Prompt, { container: { inquirer } });
   prompt.register(prompts.git);
   await prompt.show({ enabled: false, prompt: 'push', task });
-  t.is(stub.callCount, 0);
-  t.is(task.callCount, 0);
+  assert.equal(promptMock.mock.callCount(), 0);
+  assert.equal(task.mock.callCount(), 0);
 });
 
 test('should create prompt', async t => {
-  const stub = sinon.stub().callsFake(yes);
-  const inquirer = t.context.getInquirer(stub);
+  const promptMock = t.mock.fn(yes);
+  const inquirer = { prompt: promptMock };
   const prompt = factory(Prompt, { container: { inquirer } });
   prompt.register(prompts.git);
   await prompt.show({ prompt: 'push' });
-  t.is(stub.callCount, 1);
-  t.deepEqual(stub.firstCall.args[0][0], {
+  assert.equal(promptMock.mock.callCount(), 1);
+  assert.deepEqual(promptMock.mock.calls[0].arguments[0][0], {
     type: 'confirm',
     message: 'Push?',
     name: 'push',
@@ -57,41 +51,41 @@ test('should create prompt', async t => {
   ['npm', 'otp', 'Please enter OTP for npm:']
 ].map(async ([namespace, prompt, message]) => {
   test(`should create prompt and render template message (${namespace}.${prompt})`, async t => {
-    const stub = sinon.stub().callsFake(yes);
+    const promptMock = t.mock.fn(yes);
     const config = new Config({
       isPreRelease: true,
       git: { tagName: 'v${version}' },
       npm: { name: 'my-pkg', tag: 'next' }
     });
     config.setContext({ version: '1.0.0', tagName: '1.0.0' });
-    const inquirer = t.context.getInquirer(stub);
+    const inquirer = { prompt: promptMock };
     const p = factory(Prompt, { container: { inquirer } });
     p.register(prompts[namespace], namespace);
     await p.show({ namespace, prompt, context: config.getContext() });
-    t.is(stub.callCount, 1);
-    t.is(stub.firstCall.args[0][0].message, message);
+    assert.equal(promptMock.mock.callCount(), 1);
+    assert.equal(promptMock.mock.calls[0].arguments[0][0].message, message);
   });
 });
 
 test('should execute task after positive answer', async t => {
-  const task = sinon.spy();
-  const stub = sinon.stub().callsFake(yes);
-  const inquirer = t.context.getInquirer(stub);
+  const task = t.mock.fn();
+  const promptMock = t.mock.fn(yes);
+  const inquirer = { prompt: promptMock };
   const prompt = factory(Prompt, { container: { inquirer } });
   prompt.register(prompts.git);
   await prompt.show({ prompt: 'push', task });
-  t.is(stub.callCount, 1);
-  t.is(task.callCount, 1);
-  t.is(task.firstCall.args[0], true);
+  assert.equal(promptMock.mock.callCount(), 1);
+  assert.equal(task.mock.callCount(), 1);
+  assert.equal(task.mock.calls[0].arguments[0], true);
 });
 
 test('should not execute task after negative answer', async t => {
-  const task = sinon.spy();
-  const stub = sinon.stub().callsFake(no);
-  const inquirer = t.context.getInquirer(stub);
+  const task = t.mock.fn();
+  const promptMock = t.mock.fn(no);
+  const inquirer = { prompt: promptMock };
   const prompt = factory(Prompt, { container: { inquirer } });
   prompt.register(prompts.git);
   await prompt.show({ prompt: 'push', task });
-  t.is(stub.callCount, 1);
-  t.is(task.callCount, 0);
+  assert.equal(promptMock.mock.callCount(), 1);
+  assert.equal(task.mock.callCount(), 0);
 });