feat: update package.json and create tarball in prepare hook

Author: pvdlg

README.md

@@ -13,9 +13,12 @@ Set of [semantic-release](https://github.com/semantic-release/semantic-release)
 
 Verify the presence of the `NPM_TOKEN` environment variable, create or update the `.npmrc` file with the token and verify the token is valid.
 
-## publish
+## prepare
+
+Update the `package.json` version and [create](https://docs.npmjs.com/cli/pack) the `npm` package tarball.
 
-Update the `package.json` version, [create](https://docs.npmjs.com/cli/pack) the `npm` package tarball and [publish](https://docs.npmjs.com/cli/publish) to the `npm` registry.
+## publish
+[Publish](https://docs.npmjs.com/cli/publish) to the `npm` registry.
 
 ## Configuration
 

index.js

@@ -4,9 +4,11 @@ const setLegacyToken = require('./lib/set-legacy-token');
 const getPkg = require('./lib/get-pkg');
 const verifyNpmConfig = require('./lib/verify-config');
 const verifyNpmAuth = require('./lib/verify-auth');
+const prepareNpm = require('./lib/prepare');
 const publishNpm = require('./lib/publish');
 
 let verified;
+let prepared;
 
 async function verifyConditions(pluginConfig, {options: {publish}, logger}) {
   // If the npm publish plugin is used and has `npmPublish`, `tarballDir` or `pkgRoot` configured, validate them now in order to prevent any release if the configuration is wrong
@@ -38,9 +40,30 @@ async function verifyConditions(pluginConfig, {options: {publish}, logger}) {
   verified = true;
 }
 
+async function prepare(pluginConfig, {nextRelease: {version}, logger}) {
+  let pkg;
+  const errors = verified ? [] : verifyNpmConfig(pluginConfig);
+
+  try {
+    // Reload package.json in case a previous external step updated it
+    pkg = await getPkg(pluginConfig.pkgRoot);
+    if (!verified && pluginConfig.npmPublish !== false) {
+      setLegacyToken();
+      await verifyNpmAuth(pluginConfig, pkg, logger);
+    }
+  } catch (err) {
+    errors.push(...err);
+  }
+  if (errors.length > 0) {
+    throw new AggregateError(errors);
+  }
+  await prepareNpm(pluginConfig, version, logger);
+  prepared = true;
+}
+
 async function publish(pluginConfig, {nextRelease: {version}, logger}) {
   let pkg;
-  const errors = verifyNpmConfig(pluginConfig);
+  const errors = verified ? [] : verifyNpmConfig(pluginConfig);
 
   setLegacyToken();
 
@@ -56,7 +79,10 @@ async function publish(pluginConfig, {nextRelease: {version}, logger}) {
   if (errors.length > 0) {
     throw new AggregateError(errors);
   }
+  if (!prepared) {
+    await prepareNpm(pluginConfig, version, logger);
+  }
   return publishNpm(pluginConfig, pkg, version, logger);
 }
 
-module.exports = {verifyConditions, publish};
+module.exports = {verifyConditions, prepare, publish};

lib/prepare.js

@@ -0,0 +1,15 @@
+const path = require('path');
+const {move} = require('fs-extra');
+const execa = require('execa');
+const updatePackageVersion = require('./update-package-version');
+
+module.exports = async ({tarballDir, pkgRoot}, version, logger) => {
+  const basePath = pkgRoot || '.';
+  await updatePackageVersion(version, basePath, logger);
+
+  if (tarballDir) {
+    logger.log('Creating npm package version %s', version);
+    const tarball = (await execa.stdout('npm', ['pack', `./${basePath}`])).split('\n').pop();
+    await move(tarball, path.join(tarballDir.trim(), tarball));
+  }
+};

lib/publish.js

@@ -1,26 +1,14 @@
-const path = require('path');
-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 || '.';
-  const registry = await getRegistry(publishConfig, name);
-  await updatePackageVersion(version, basePath, logger);
-
-  if (tarballDir) {
-    logger.log('Creating npm package version %s', version);
-    const tarball = (await execa.stdout('npm', ['pack', `./${basePath}`])).split('\n').pop();
-    await move(tarball, path.join(tarballDir.trim(), tarball));
-  }
+const getReleaseInfo = require('./get-release-info');
 
+module.exports = async ({npmPublish, pkgRoot}, {publishConfig, name}, version, logger) => {
   if (npmPublish !== false) {
+    const basePath = pkgRoot || '.';
+    const registry = await getRegistry(publishConfig, name);
     logger.log('Publishing version %s to npm registry', version);
     const shell = await execa('npm', ['publish', `./${basePath}`, '--registry', registry]);
     process.stdout.write(shell.stdout);
+    return getReleaseInfo(name, publishConfig, registry);
   }
-
-  return getReleaseInfo(name, publishConfig, registry);
 };

test/integration.test.js

@@ -205,7 +205,7 @@ test.serial('Create the package and skip publish', async t => {
     {logger: t.context.logger, nextRelease: {version: '1.0.0'}}
   );
 
-  t.deepEqual(result, {name: 'npm package (@latest dist-tag)', url: undefined});
+  t.falsy(result);
   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']));
@@ -221,7 +221,7 @@ test.serial('Create the package and skip publish from a sub-directory', async t
     {logger: t.context.logger, nextRelease: {version: '1.0.0'}}
   );
 
-  t.deepEqual(result, {name: 'npm package (@latest dist-tag)', url: undefined});
+  t.falsy(result);
   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']));
@@ -257,12 +257,78 @@ test.serial('Throw SemanticReleaseError Array if config option are not valid in
   t.is(errors[3].code, 'ENOPKGNAME');
 });
 
-test.serial('Verify token and set up auth only on the fist call', async t => {
+test.serial('Prepare the package', async t => {
+  Object.assign(process.env, npmRegistry.authEnv);
+  const pkg = {name: 'prepare', version: '0.0.0', publishConfig: {registry: npmRegistry.url}};
+  await outputJson('./package.json', pkg);
+
+  await t.context.m.prepare({}, {logger: t.context.logger, nextRelease: {version: '1.0.0'}});
+
+  t.is((await readJson('./package.json')).version, '1.0.0');
+  t.false(await pathExists(`./${pkg.name}-1.0.0.tgz`));
+});
+
+test.serial('Prepare the package from a sub-directory', async t => {
+  Object.assign(process.env, npmRegistry.authEnv);
+  const pkg = {name: 'prepare-sub-dir', version: '0.0.0', publishConfig: {registry: npmRegistry.url}};
+  await outputJson('./dist/package.json', pkg);
+
+  await t.context.m.prepare({pkgRoot: 'dist'}, {logger: t.context.logger, nextRelease: {version: '1.0.0'}});
+
+  t.is((await readJson('./dist/package.json')).version, '1.0.0');
+  t.false(await pathExists(`./${pkg.name}-1.0.0.tgz`));
+});
+
+test.serial('Create the package in prepare step', async t => {
+  const pkg = {name: 'prepare-pkg', version: '0.0.0', publishConfig: {registry: npmRegistry.url}};
+  await outputJson('./package.json', pkg);
+
+  await t.context.m.prepare(
+    {npmPublish: false, tarballDir: 'tarball'},
+    {logger: t.context.logger, nextRelease: {version: '1.0.0'}}
+  );
+
+  t.is((await readJson('./package.json')).version, '1.0.0');
+  t.true(await pathExists(`./tarball/${pkg.name}-1.0.0.tgz`));
+});
+
+test.serial('Throw SemanticReleaseError Array if config option are not valid in prepare', async t => {
+  const pkg = {publishConfig: {registry: npmRegistry.url}};
+  await outputJson('./package.json', pkg);
+  const npmPublish = 42;
+  const tarballDir = 42;
+  const pkgRoot = 42;
+
+  const errors = [
+    ...(await t.throws(
+      t.context.m.prepare(
+        {npmPublish, tarballDir, pkgRoot},
+        {
+          options: {publish: ['@semantic-release/github', '@semantic-release/npm']},
+          nextRelease: {version: '1.0.0'},
+          logger: t.context.logger,
+        }
+      )
+    )),
+  ];
+
+  t.is(errors[0].name, 'SemanticReleaseError');
+  t.is(errors[0].code, 'EINVALIDNPMPUBLISH');
+  t.is(errors[1].name, 'SemanticReleaseError');
+  t.is(errors[1].code, 'EINVALIDTARBALLDIR');
+  t.is(errors[2].name, 'SemanticReleaseError');
+  t.is(errors[2].code, 'EINVALIDPKGROOT');
+  t.is(errors[3].name, 'SemanticReleaseError');
+  t.is(errors[3].code, 'ENOPKGNAME');
+});
+
+test.serial('Verify token and set up auth only on the fist call, then prepare on prepare call only', async t => {
   Object.assign(process.env, npmRegistry.authEnv);
   const pkg = {name: 'test-module', version: '0.0.0-dev', publishConfig: {registry: npmRegistry.url}};
   await outputJson('./package.json', pkg);
 
   await t.notThrows(t.context.m.verifyConditions({}, {options: {}, logger: t.context.logger}));
+  await t.context.m.prepare({}, {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});