release-it 19.0.5 → 19.1.0

package/README.md

@@ -315,6 +315,7 @@ Since v11, release-it can be extended in many, many ways. Here are some plugins:
 | [release-it-pnpm][16]                     | Add basic support for pnpm workspaces, integrates with [bumpp][50] and [changelogithub][51] |
 | [changesets-release-it-plugin][52]        | Combine [Changesets][53] changelog management with release-it                               |
 | [release-it-gitea][54]                    | Gitea plugin to create Gitea releases and upload attachments                                |
+| [release-it-beautiful-changelog][84]      | Generate beautiful changelogs using conventional commits by [@unjs/changelogen][45]         |
 
 Internally, release-it uses its own plugin architecture (for Git, GitHub, GitLab, npm).
 
@@ -459,3 +460,4 @@ Are you using release-it at work? Please consider [sponsoring me][14]!
 [81]: ./.github/CONTRIBUTING.md
 [82]: https://github.com/release-it/release-it/issues/new
 [83]: ./LICENSE
+[84]: https://github.com/mohammadGh/release-it-beautiful-changelog

package/lib/plugin/npm/npm.js

@@ -2,12 +2,12 @@ import path from 'node:path';
 import semver from 'semver';
 import urlJoin from 'url-join';
 import Plugin from '../Plugin.js';
-import { hasAccess, rejectAfter, parseVersion, readJSON, e, fixArgs } from '../../util.js';
+import { hasAccess, rejectAfter, parseVersion, readJSON, e, fixArgs, getNpmEnv } from '../../util.js';
 import prompts from './prompts.js';
 
 const docs = 'https://git.io/release-it-npm';
 
-const options = { write: false };
+const getOptions = () => ({ write: false, env: getNpmEnv() });
 
 const MANIFEST_PATH = './package.json';
 const DEFAULT_TAG = 'latest';
@@ -84,8 +84,14 @@ class npm extends Plugin {
     if (!this.config.isIncrement) return false;
 
     const { versionArgs, allowSameVersion } = this.options;
-    const args = [version, '--no-git-tag-version', allowSameVersion && '--allow-same-version', ...fixArgs(versionArgs)];
-    const task = () => this.exec(`npm version ${args.filter(Boolean).join(' ')}`);
+    const args = [
+      version,
+      '--no-git-tag-version',
+      '--workspaces=false',
+      allowSameVersion && '--allow-same-version',
+      ...fixArgs(versionArgs)
+    ];
+    const task = () => this.exec(`npm version ${args.filter(Boolean).join(' ')}`, { options: getOptions() });
     return this.spinner.show({ task, label: 'npm version' });
   }
 
@@ -101,7 +107,7 @@ class npm extends Plugin {
   isRegistryUp() {
     const registry = this.getRegistry();
     const registryArg = registry ? ` --registry ${registry}` : '';
-    return this.exec(`npm ping${registryArg}`, { options }).then(
+    return this.exec(`npm ping${registryArg}`, { options: getOptions() }).then(
       () => true,
       err => {
         if (/code E40[04]|404.*(ping not found|No content for path)/.test(err)) {
@@ -116,7 +122,7 @@ class npm extends Plugin {
   isAuthenticated() {
     const registry = this.getRegistry();
     const registryArg = registry ? ` --registry ${registry}` : '';
-    return this.exec(`npm whoami${registryArg}`, { options }).then(
+    return this.exec(`npm whoami${registryArg}`, { options: getOptions() }).then(
       output => {
         const username = output ? output.trim() : null;
         this.setContext({ username });
@@ -142,7 +148,7 @@ class npm extends Plugin {
     if (username === null) return false;
 
     try {
-      let npmVersion = await this.exec('npm --version', { options });
+      let npmVersion = await this.exec('npm --version', { options: getOptions() });
 
       let accessCommand;
       if (semver.gt(npmVersion, '9.0.0')) {
@@ -151,7 +157,7 @@ class npm extends Plugin {
         accessCommand = 'npm access ls-collaborators';
       }
 
-      const output = await this.exec(`${accessCommand} ${name}${registryArg}`, { options });
+      const output = await this.exec(`${accessCommand} ${name}${registryArg}`, { options: getOptions() });
 
       try {
         const collaborators = JSON.parse(output);
@@ -178,11 +184,11 @@ class npm extends Plugin {
     const name = this.getName();
     const latestVersion = this.getLatestVersion();
     const tag = await this.resolveTag(latestVersion);
-    return this.exec(`npm show ${name}@${tag} version${registryArg}`, { options }).catch(() => null);
+    return this.exec(`npm show ${name}@${tag} version${registryArg}`, { options: getOptions() }).catch(() => null);
   }
 
   getRegistryPreReleaseTags() {
-    return this.exec(`npm view ${this.getName()} dist-tags --json`, { options }).then(
+    return this.exec(`npm view ${this.getName()} dist-tags --json`, { options: getOptions() }).then(
       output => {
         try {
           const tags = JSON.parse(output);
@@ -242,7 +248,7 @@ class npm extends Plugin {
   async publish({ otp = this.options.otp, otpCallback } = {}) {
     const { publishPath = '.', publishArgs } = this.options;
     const { private: isPrivate, tag = DEFAULT_TAG } = this.getContext();
-    const otpArg = otp ? `--otp ${otp}` : '';
+    const otpArgs = otp ? ['--otp', otp] : [];
     const dryRunArg = this.config.isDryRun ? '--dry-run' : '';
     const registry = this.getRegistry();
     const registryArg = registry ? `--registry ${registry}` : '';
@@ -250,8 +256,18 @@ class npm extends Plugin {
       this.log.warn('Skip publish: package is private.');
       return false;
     }
-    const args = [publishPath, `--tag ${tag}`, otpArg, dryRunArg, registryArg, ...fixArgs(publishArgs)].filter(Boolean);
-    return this.exec(`npm publish ${args.join(' ')}`, { options })
+    const args = [
+      publishPath,
+      '--tag',
+      tag,
+      '--workspaces=false',
+      ...otpArgs,
+      dryRunArg,
+      registryArg,
+      ...fixArgs(publishArgs)
+    ].filter(Boolean);
+    const isInteractive = !this.config.isCI;
+    return this.exec(['npm', 'publish', ...args], { options: { ...getOptions(), interactive: isInteractive } })
       .then(() => {
         this.setContext({ isReleased: true });
       })

package/lib/shell.js

@@ -52,7 +52,8 @@ class Shell {
 
   execStringCommand(command, options, { isExternal }) {
     return new Promise((resolve, reject) => {
-      const proc = exec(command, (err, stdout, stderr) => {
+      const execOptions = options.env ? { env: options.env } : {};
+      const proc = exec(command, execOptions, (err, stdout, stderr) => {
         stdout = stdout.toString().trimEnd();
         const code = !err ? 0 : err === 'undefined' ? 1 : err.code;
         debug({ command, options, code, stdout, stderr });
@@ -69,35 +70,41 @@ class Shell {
 
   async execWithArguments(command, options = {}, { isExternal } = {}) {
     const [program, ...programArgs] = command;
+    const isInteractive = options.interactive === true;
 
     try {
       return await new Promise((resolve, reject) => {
-        const proc = spawn(program, programArgs, {
-          // we want to capture all output from the process so the extra 2 pipe
-          stdio: ['inherit', 'pipe', 'pipe'],
+        const spawnOptions = {
+          stdio: isInteractive ? 'inherit' : ['inherit', 'pipe', 'pipe'],
+          env: options.env,
           ...options
-        });
+        };
+        delete spawnOptions.interactive;
+
+        const proc = spawn(program, programArgs, spawnOptions);
 
         let stdout = '';
         let stderr = '';
 
-        proc.stdout.on('data', data => {
-          stdout += data.toString();
-        });
+        if (!isInteractive) {
+          proc.stdout.on('data', data => {
+            stdout += data.toString();
+          });
 
-        proc.stderr.on('data', data => {
-          stderr += data.toString();
-        });
+          proc.stderr.on('data', data => {
+            stderr += data.toString();
+          });
+        }
 
         proc.on('close', code => {
           stdout = stdout === '""' ? '' : stdout;
-          this.log.verbose(stdout, { isExternal });
+          if (!isInteractive) this.log.verbose(stdout, { isExternal });
           debug({ command, options, stdout, stderr });
 
           if (code === 0) {
             resolve((stdout || stderr).trim());
           } else {
-            if (stdout) {
+            if (stdout && !isInteractive) {
               this.log.log(`\n${stdout}`);
             }
             debug({ code, command, options, stdout, stderr });

package/lib/util.js

@@ -159,6 +159,19 @@ export const touch = (path, callback) => {
 
 export const fixArgs = args => (args ? (typeof args === 'string' ? args.split(' ') : args) : []);
 
+// Remove npm_config_* variables set by others (e.g. pnpm) that npm warns about
+export const getNpmEnv = () => {
+  const env = { ...process.env };
+  const removeVars = new Set([
+    'npm_config_npm_globalconfig',
+    'npm_config_verify_deps_before_run',
+    'npm_config_overrides',
+    'npm_config__jsr_registry'
+  ]);
+  for (const key of Object.keys(env)) if (removeVars.has(key.toLowerCase())) delete env[key];
+  return env;
+};
+
 export const upperFirst = string => {
   return string ? string.charAt(0).toUpperCase() + string.slice(1) : '';
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "19.0.5",
+  "version": "19.1.0",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -82,7 +82,7 @@
     "@octokit/rest": "22.0.0",
     "@phun-ky/typeof": "2.0.3",
     "async-retry": "1.3.3",
-    "c12": "3.3.0",
+    "c12": "3.3.1",
     "ci-info": "^4.3.0",
     "eta": "4.0.1",
     "git-url-parse": "16.1.0",

package/test/npm.js

@@ -155,7 +155,14 @@ describe('npm', async () => {
     exec.mock.mockImplementationOnce(() => Promise.reject(new Error(whoamiError)), 1);
     exec.mock.mockImplementationOnce(() => Promise.reject(new Error(accessError)), 2);
     await runTasks(npmClient);
-    assert.equal(exec.mock.calls.at(-1).arguments[0].trim(), 'npm publish . --tag latest');
+    assert.deepEqual(exec.mock.calls.at(-1).arguments[0], [
+      'npm',
+      'publish',
+      '.',
+      '--tag',
+      'latest',
+      '--workspaces=false'
+    ]);
   });
 
   test('should not throw if npm returns 400 for unsupported ping/whoami/access', async t => {
@@ -168,7 +175,14 @@ describe('npm', async () => {
     exec.mock.mockImplementationOnce(() => Promise.reject(new Error(whoamiError)), 1);
     exec.mock.mockImplementationOnce(() => Promise.reject(new Error(accessError)), 2);
     await runTasks(npmClient);
-    assert.equal(exec.mock.calls.at(-1).arguments[0].trim(), 'npm publish . --tag latest');
+    assert.deepEqual(exec.mock.calls.at(-1).arguments[0], [
+      'npm',
+      'publish',
+      '.',
+      '--tag',
+      'latest',
+      '--workspaces=false'
+    ]);
   });
 
   test('should throw if user is not authenticated', async t => {
@@ -238,9 +252,27 @@ describe('npm', async () => {
     });
 
     assert.equal(exec.mock.callCount(), 3);
-    assert.equal(exec.mock.calls[0].arguments[0].trim(), 'npm publish . --tag latest');
-    assert.equal(exec.mock.calls[1].arguments[0].trim(), 'npm publish . --tag latest --otp 123');
-    assert.equal(exec.mock.calls[2].arguments[0].trim(), 'npm publish . --tag latest --otp 123456');
+    assert.deepEqual(exec.mock.calls[0].arguments[0], ['npm', 'publish', '.', '--tag', 'latest', '--workspaces=false']);
+    assert.deepEqual(exec.mock.calls[1].arguments[0], [
+      'npm',
+      'publish',
+      '.',
+      '--tag',
+      'latest',
+      '--workspaces=false',
+      '--otp',
+      '123'
+    ]);
+    assert.deepEqual(exec.mock.calls[2].arguments[0], [
+      'npm',
+      'publish',
+      '.',
+      '--tag',
+      'latest',
+      '--workspaces=false',
+      '--otp',
+      '123456'
+    ]);
 
     assert.equal(npmClient.log.warn.mock.callCount(), 1);
     assert.equal(npmClient.log.warn.mock.calls[0].arguments[0], 'The provided OTP is incorrect or has expired.');
@@ -255,7 +287,14 @@ describe('npm', async () => {
       return Promise.resolve();
     });
     await runTasks(npmClient);
-    assert.equal(exec.mock.calls.at(-1).arguments[0].trim(), 'npm publish . --tag latest');
+    assert.deepEqual(exec.mock.calls.at(-1).arguments[0], [
+      'npm',
+      'publish',
+      '.',
+      '--tag',
+      'latest',
+      '--workspaces=false'
+    ]);
   });
 
   test('should use extra publish arguments', async t => {
@@ -263,10 +302,15 @@ describe('npm', async () => {
     const npmClient = await factory(npm, { options });
     const exec = t.mock.method(npmClient.shell, 'exec', () => Promise.resolve());
     await runTasks(npmClient);
-    assert.equal(
-      exec.mock.calls.at(-1).arguments[0].trim(),
-      'npm publish . --tag latest --registry=http://my-internal-registry.local'
-    );
+    assert.deepEqual(exec.mock.calls.at(-1).arguments[0], [
+      'npm',
+      'publish',
+      '.',
+      '--tag',
+      'latest',
+      '--workspaces=false',
+      '--registry=http://my-internal-registry.local'
+    ]);
   });
 
   test('should skip checks', async () => {
@@ -306,8 +350,8 @@ describe('npm', async () => {
       'npm whoami --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/',
       'npm show @my-scope/my-pkg@latest version --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/',
       'npm --version',
-      'npm version 1.0.1 --no-git-tag-version',
-      'npm publish . --tag latest --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/'
+      'npm version 1.0.1 --no-git-tag-version --workspaces=false',
+      'npm publish . --tag latest --workspaces=false --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/'
     ]);
   });
 
@@ -322,7 +366,7 @@ describe('npm', async () => {
       if (command === 'npm whoami') return Promise.resolve('john');
       const re = /npm access (list collaborators --json|ls-collaborators) @my-scope\/my-pkg/;
       if (re.test(command)) return Promise.resolve(JSON.stringify({ john: ['write'] }));
-      if (command === 'npm version 1.0.1 --no-git-tag-version')
+      if (command === 'npm version 1.0.1 --no-git-tag-version --workspaces=false')
         return Promise.reject('npm ERR! Version not changed, might want --allow-same-version');
       return Promise.resolve();
     });
@@ -334,7 +378,7 @@ describe('npm', async () => {
       'npm whoami',
       'npm show @my-scope/my-pkg@latest version',
       'npm --version',
-      'npm version 1.0.1 --no-git-tag-version'
+      'npm version 1.0.1 --no-git-tag-version --workspaces=false'
     ]);
   });
 

package/test/stub/shell.js

@@ -5,16 +5,17 @@ const debug = util.debug('release-it:shell-stub');
 
 class ShellStub extends Shell {
   exec(command) {
-    if (/^(npm (ping|publish|show)|git fetch)/.test(command)) {
-      debug(command);
+    const cmd = Array.isArray(command) ? command.join(' ') : command;
+    if (/^(npm (ping|publish|show)|git fetch)/.test(cmd)) {
+      debug(cmd);
       return Promise.resolve();
     }
-    if (/^npm whoami/.test(command)) {
-      debug(command);
+    if (/^npm whoami/.test(cmd)) {
+      debug(cmd);
       return Promise.resolve('john');
     }
-    if (/^npm access/.test(command)) {
-      debug(command);
+    if (/^npm access/.test(cmd)) {
+      debug(cmd);
       return Promise.resolve(JSON.stringify({ john: ['write'] }));
     }
     return super.exec(...arguments);

package/test/tasks.js

@@ -140,7 +140,7 @@ describe('tasks', () => {
     const stdout = childProcess.execSync('git describe --tags --match=* --abbrev=0', { encoding: 'utf-8' });
     assert.equal(stdout.trim(), '1.0.0');
     const npmArgs = getArgs(exec, 'npm');
-    assert.equal(npmArgs[5], 'npm version 1.3.0 --no-git-tag-version');
+    assert.equal(npmArgs[5], 'npm version 1.3.0 --no-git-tag-version --workspaces=false');
   });
 
   test('should ignore version in pkg.version and use git tag instead', async () => {
@@ -187,8 +187,8 @@ describe('tasks', () => {
       `npm show ${pkgName}@latest version`,
       'npm --version',
       `npm access ${npmMajorVersion >= 9 ? 'list collaborators --json' : 'ls-collaborators'} ${pkgName}`,
-      'npm version 1.0.1 --no-git-tag-version',
-      'npm publish . --tag latest'
+      'npm version 1.0.1 --no-git-tag-version --workspaces=false',
+      'npm publish . --tag latest --workspaces=false'
     ]);
 
     assert(log.obtrusive.mock.calls[0].arguments[0].endsWith(`release ${pkgName} (1.0.0...1.0.1)`));
@@ -320,8 +320,8 @@ describe('tasks', () => {
       `npm show ${pkgName}@latest version`,
       'npm --version',
       `npm access ${npmMajorVersion >= 9 ? 'list collaborators --json' : 'ls-collaborators'} ${pkgName}`,
-      'npm version 1.1.0-alpha.0 --no-git-tag-version',
-      'npm publish . --tag alpha'
+      'npm version 1.1.0-alpha.0 --no-git-tag-version --workspaces=false',
+      'npm publish . --tag alpha --workspaces=false'
     ]);
 
     const commitMessage = childProcess.execSync('git log --oneline --format=%B -n 1 HEAD', {
@@ -361,8 +361,8 @@ describe('tasks', () => {
       `npm show ${pkgName}@latest version`,
       'npm --version',
       `npm access ${npmMajorVersion >= 9 ? 'list collaborators --json' : 'ls-collaborators'} ${pkgName}`,
-      'npm version 2.0.0-0 --no-git-tag-version',
-      'npm publish . --tag next'
+      'npm version 2.0.0-0 --no-git-tag-version --workspaces=false',
+      'npm publish . --tag next --workspaces=false'
     ]);
 
     const stdout = childProcess.execSync('git describe --tags --match=* --abbrev=0', { encoding: 'utf-8' });
@@ -383,7 +383,7 @@ describe('tasks', () => {
     await runTasks({}, container);
 
     const npmArgs = getArgs(exec, 'npm');
-    assert.deepEqual(npmArgs, ['npm version 1.0.1 --no-git-tag-version']);
+    assert.deepEqual(npmArgs, ['npm version 1.0.1 --no-git-tag-version --workspaces=false']);
     assert(log.obtrusive.mock.calls[0].arguments[0].endsWith(`release ${pkgName} (1.0.0...1.0.1)`));
     assert.equal(log.warn.length, 0);
     assert.match(log.log.mock.calls[0].arguments[0], /Done \(in [0-9]+s\.\)/);
@@ -404,7 +404,7 @@ describe('tasks', () => {
     await runTasks({}, container);
 
     const npmArgs = getArgs(exec, 'npm');
-    assert.equal(npmArgs[6], 'npm publish . --tag latest');
+    assert.equal(npmArgs[6], 'npm publish . --tag latest --workspaces=false');
   });
 
   test('should use pkg.publishConfig.registry', async t => {