feat: return release informations from publish hook

Author: pvdlg

index.js

@@ -44,7 +44,7 @@ async function publish(pluginConfig, {nextRelease: {version}, logger}) {
     }
     verified = true;
   }
-  await publishNpm(pluginConfig, pkg, version, logger);
+  return publishNpm(pluginConfig, pkg, version, logger);
 }
 
 module.exports = {verifyConditions, publish};

lib/get-release-info.js

@@ -0,0 +1,19 @@
+const execa = require('execa');
+const normalizeUrl = require('normalize-url');
+
+const DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org/';
+
+module.exports = async (
+  name,
+  publishConfig,
+  registry,
+  defaultRegistry = process.env.DEFAULT_NPM_REGISTRY || DEFAULT_NPM_REGISTRY
+) => {
+  const distTag =
+    (publishConfig && publishConfig.tag) || (await execa.stdout('npm', ['config', 'get', 'tag'])) || 'latest';
+
+  return {
+    name: `npm package (@${distTag} dist-tag)`,
+    url: normalizeUrl(registry) === normalizeUrl(defaultRegistry) ? `https://www.npmjs.com/package/${name}` : undefined,
+  };
+};

lib/publish.js

@@ -3,6 +3,7 @@ const {move} = require('fs-extra');
 const execa = require('execa');
 const getRegistry = require('./get-registry');
 const updatePackageVersion = require('./update-package-version');
+const getReleaseInfo = require('./get-release-info.js');
 
 module.exports = async ({npmPublish, tarballDir, pkgRoot}, {publishConfig, name}, version, logger) => {
   const basePath = pkgRoot || '.';
@@ -20,4 +21,6 @@ module.exports = async ({npmPublish, tarballDir, pkgRoot}, {publishConfig, name}
     const shell = await execa('npm', ['publish', `./${basePath}`, '--registry', registry]);
     process.stdout.write(shell.stdout);
   }
+
+  return getReleaseInfo(name, publishConfig, registry);
 };

test/get-release-info.test.js

@@ -0,0 +1,72 @@
+import {writeFile} from 'fs-extra';
+import test from 'ava';
+import tempy from 'tempy';
+import getReleaseInfo from '../lib/get-release-info';
+
+// Save the current process.env
+const envBackup = Object.assign({}, process.env);
+// Save the current working diretory
+const cwd = process.cwd();
+
+test.beforeEach(() => {
+  // Change current working directory to a temp directory
+  process.chdir(tempy.directory());
+  // Delete all `npm_config` environment variable set by CI as they take precedence over the `.npmrc` because the process that runs the tests is started before the `.npmrc` is created
+  for (let i = 0, keys = Object.keys(process.env); i < keys.length; i++) {
+    if (keys[i].startsWith('npm_')) {
+      delete process.env[keys[i]];
+    }
+  }
+});
+
+test.afterEach.always(() => {
+  // Restore process.env
+  process.env = envBackup;
+  // Restore the current working directory
+  process.chdir(cwd);
+});
+
+test.serial('Default registry and tag', async t => {
+  t.deepEqual(await getReleaseInfo('module', null, 'https://registry.npmjs.org/'), {
+    name: 'npm package (@latest dist-tag)',
+    url: 'https://www.npmjs.com/package/module',
+  });
+});
+
+test.serial('Default registry, tag and scoped module', async t => {
+  t.deepEqual(await getReleaseInfo('@scope/module', null, 'https://registry.npmjs.org/'), {
+    name: 'npm package (@latest dist-tag)',
+    url: 'https://www.npmjs.com/package/@scope/module',
+  });
+});
+
+test.serial('Custom registry, tag and scoped module', async t => {
+  t.deepEqual(await getReleaseInfo('@scope/module', null, 'https://custom.registry.org/'), {
+    name: 'npm package (@latest dist-tag)',
+    url: undefined,
+  });
+});
+
+test.serial('Default registry and tag from .npmrc', async t => {
+  await writeFile('./.npmrc', 'tag=npmrc');
+  t.deepEqual(await getReleaseInfo('module', {}, 'https://registry.npmjs.org/'), {
+    name: 'npm package (@npmrc dist-tag)',
+    url: 'https://www.npmjs.com/package/module',
+  });
+});
+
+test.serial('Default registry and tag from package.json', async t => {
+  await writeFile('./.npmrc', 'tag=npmrc');
+  t.deepEqual(await getReleaseInfo('module', {tag: 'pkg'}, 'https://registry.npmjs.org/'), {
+    name: 'npm package (@pkg dist-tag)',
+    url: 'https://www.npmjs.com/package/module',
+  });
+});
+
+test.serial('Default tag', async t => {
+  await writeFile('./.npmrc', 'tag=');
+  t.deepEqual(await getReleaseInfo('module', {}, 'https://registry.npmjs.org/'), {
+    name: 'npm package (@latest dist-tag)',
+    url: 'https://www.npmjs.com/package/module',
+  });
+});

test/integration.test.js

@@ -181,8 +181,23 @@ test.serial('Publish the package', async t => {
   const pkg = {name: 'publish', version: '0.0.0', publishConfig: {registry: npmRegistry.url}};
   await outputJson('./package.json', pkg);
 
-  await t.context.m.publish({}, {logger: t.context.logger, nextRelease: {version: '1.0.0'}});
+  const result = await t.context.m.publish({}, {logger: t.context.logger, nextRelease: {version: '1.0.0'}});
 
+  t.deepEqual(result, {name: 'npm package (@latest dist-tag)', url: undefined});
+  t.is((await readJson('./package.json')).version, '1.0.0');
+  t.false(await pathExists(`./${pkg.name}-1.0.0.tgz`));
+  t.is((await execa('npm', ['view', pkg.name, 'version'])).stdout, '1.0.0');
+});
+
+test.serial('Publish the package on a dist-tag', async t => {
+  Object.assign(process.env, npmRegistry.authEnv);
+  process.env.DEFAULT_NPM_REGISTRY = npmRegistry.url;
+  const pkg = {name: 'publish-tag', version: '0.0.0', publishConfig: {registry: npmRegistry.url, tag: 'next'}};
+  await outputJson('./package.json', pkg);
+
+  const result = await t.context.m.publish({}, {logger: t.context.logger, nextRelease: {version: '1.0.0'}});
+
+  t.deepEqual(result, {name: 'npm package (@next dist-tag)', url: 'https://www.npmjs.com/package/publish-tag'});
   t.is((await readJson('./package.json')).version, '1.0.0');
   t.false(await pathExists(`./${pkg.name}-1.0.0.tgz`));
   t.is((await execa('npm', ['view', pkg.name, 'version'])).stdout, '1.0.0');
@@ -193,8 +208,12 @@ test.serial('Publish the package from a sub-directory', async t => {
   const pkg = {name: 'publish-sub-dir', version: '0.0.0', publishConfig: {registry: npmRegistry.url}};
   await outputJson('./dist/package.json', pkg);
 
-  await t.context.m.publish({pkgRoot: 'dist'}, {logger: t.context.logger, nextRelease: {version: '1.0.0'}});
+  const result = await t.context.m.publish(
+    {pkgRoot: 'dist'},
+    {logger: t.context.logger, nextRelease: {version: '1.0.0'}}
+  );
 
+  t.deepEqual(result, {name: 'npm package (@latest dist-tag)', url: undefined});
   t.is((await readJson('./dist/package.json')).version, '1.0.0');
   t.false(await pathExists(`./${pkg.name}-1.0.0.tgz`));
   t.is((await execa('npm', ['view', pkg.name, 'version'])).stdout, '1.0.0');
@@ -211,11 +230,12 @@ test.serial('Create the package and skip publish', async t => {
   const pkg = {name: 'skip-publish', version: '0.0.0', publishConfig: {registry: npmRegistry.url}};
   await outputJson('./package.json', pkg);
 
-  await t.context.m.publish(
+  const result = await t.context.m.publish(
     {npmPublish: false, tarballDir: 'tarball'},
     {logger: t.context.logger, nextRelease: {version: '1.0.0'}}
   );
 
+  t.deepEqual(result, {name: 'npm package (@latest dist-tag)', url: undefined});
   t.is((await readJson('./package.json')).version, '1.0.0');
   t.true(await pathExists(`./tarball/${pkg.name}-1.0.0.tgz`));
   await t.throws(execa('npm', ['view', pkg.name, 'version']));
@@ -226,11 +246,12 @@ test.serial('Create the package and skip publish from a sub-directory', async t
   const pkg = {name: 'skip-publish-sub-dir', version: '0.0.0', publishConfig: {registry: npmRegistry.url}};
   await outputJson('./dist/package.json', pkg);
 
-  await t.context.m.publish(
+  const result = await t.context.m.publish(
     {npmPublish: false, tarballDir: './tarball', pkgRoot: './dist'},
     {logger: t.context.logger, nextRelease: {version: '1.0.0'}}
   );
 
+  t.deepEqual(result, {name: 'npm package (@latest dist-tag)', url: undefined});
   t.is((await readJson('./dist/package.json')).version, '1.0.0');
   t.true(await pathExists(`./tarball/${pkg.name}-1.0.0.tgz`));
   await t.throws(execa('npm', ['view', pkg.name, 'version']));
@@ -243,5 +264,6 @@ test.serial('Verify token and set up auth only on the fist call', async t => {
 
   await t.notThrows(t.context.m.verifyConditions({}, {options: {}, logger: t.context.logger}));
 
-  await t.context.m.publish({}, {logger: t.context.logger, nextRelease: {version: '1.0.0'}});
+  const result = await t.context.m.publish({}, {logger: t.context.logger, nextRelease: {version: '1.0.0'}});
+  t.deepEqual(result, {name: 'npm package (@latest dist-tag)', url: undefined});
 });