feat: use cwd and env options passed by core

pvdlg · pvdlg · commit f2e30c71e059 · 2018-07-17T00:15:03.000-04:00
BREAKING CHANGE: require `semantic-release` &gt;= `15.8.0`
diff --git a/index.js b/index.js
@@ -24,11 +24,11 @@ async function verifyConditions(pluginConfig, context) {
   const errors = verifyNpmConfig(pluginConfig);
 
   try {
-    const pkg = await getPkg(pluginConfig.pkgRoot);
+    const pkg = await getPkg(pluginConfig, context);
 
     // Verify the npm authentication only if `npmPublish` is not false and `pkg.private` is not `true`
     if (pluginConfig.npmPublish !== false && pkg.private !== true) {
-      setLegacyToken();
+      setLegacyToken(context);
       await verifyNpmAuth(pluginConfig, pkg, context);
     }
   } catch (err) {
@@ -46,9 +46,9 @@ async function prepare(pluginConfig, context) {
 
   try {
     // Reload package.json in case a previous external step updated it
-    pkg = await getPkg(pluginConfig.pkgRoot);
+    pkg = await getPkg(pluginConfig, context);
     if (!verified && pluginConfig.npmPublish !== false && pkg.private !== true) {
-      setLegacyToken();
+      setLegacyToken(context);
       await verifyNpmAuth(pluginConfig, pkg, context);
     }
   } catch (err) {
@@ -65,11 +65,11 @@ async function publish(pluginConfig, context) {
   let pkg;
   const errors = verified ? [] : verifyNpmConfig(pluginConfig);
 
-  setLegacyToken();
+  setLegacyToken(context);
 
   try {
     // Reload package.json in case a previous external step updated it
-    pkg = await getPkg(pluginConfig.pkgRoot);
+    pkg = await getPkg(pluginConfig, context);
     if (!verified && pluginConfig.npmPublish !== false && pkg.private !== true) {
       await verifyNpmAuth(pluginConfig, pkg, context);
     }
diff --git a/lib/get-pkg.js b/lib/get-pkg.js
@@ -1,13 +1,14 @@
+const path = require('path');
 const readPkg = require('read-pkg');
 const AggregateError = require('aggregate-error');
 const getError = require('./get-error');
 
-module.exports = async pkgRoot => {
+module.exports = async ({pkgRoot}, {cwd}) => {
   const errors = [];
   let pkg;
 
   try {
-    pkg = await readPkg({cwd: pkgRoot ? String(pkgRoot) : process.cwd()});
+    pkg = await readPkg({cwd: pkgRoot ? path.resolve(cwd, String(pkgRoot)) : cwd});
 
     if (!pkg.name) {
       errors.push(getError('ENOPKGNAME'));
diff --git a/lib/get-registry.js b/lib/get-registry.js
@@ -1,3 +1,11 @@
+const path = require('path');
+const rc = require('rc');
 const getRegistryUrl = require('registry-auth-token/registry-url');
 
-module.exports = async ({registry} = {}, name) => (registry ? registry : getRegistryUrl(name.split('/')[0]));
+module.exports = ({publishConfig: {registry} = {}, name}, {cwd}) =>
+  registry
+    ? registry
+    : getRegistryUrl(
+        name.split('/')[0],
+        rc('npm', {registry: 'https://registry.npmjs.org/'}, {config: path.resolve(cwd, '.npmrc')})
+      );
diff --git a/lib/get-release-info.js b/lib/get-release-info.js
@@ -1,19 +1,18 @@
 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
+  {name, publishConfig: {tag} = {}},
+  {cwd, env: {DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org/', ...env}},
+  registry
 ) => {
-  const distTag =
-    (publishConfig && publishConfig.tag) || (await execa.stdout('npm', ['config', 'get', 'tag'])) || 'latest';
+  const distTag = tag || (await execa.stdout('npm', ['config', 'get', 'tag'], {cwd, env})) || 'latest';
 
   return {
     name: `npm package (@${distTag} dist-tag)`,
-    url: normalizeUrl(registry) === normalizeUrl(defaultRegistry) ? `https://www.npmjs.com/package/${name}` : undefined,
+    url:
+      normalizeUrl(registry) === normalizeUrl(DEFAULT_NPM_REGISTRY)
+        ? `https://www.npmjs.com/package/${name}`
+        : undefined,
   };
 };
diff --git a/lib/prepare.js b/lib/prepare.js
@@ -3,13 +3,13 @@ const {move} = require('fs-extra');
 const execa = require('execa');
 const updatePackageVersion = require('./update-package-version');
 
-module.exports = async ({tarballDir, pkgRoot}, {nextRelease: {version}, logger}) => {
-  const basePath = pkgRoot || '.';
+module.exports = async ({tarballDir, pkgRoot}, {cwd, nextRelease: {version}, logger}) => {
+  const basePath = pkgRoot ? path.resolve(cwd, pkgRoot) : cwd;
   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 tarball = (await execa.stdout('npm', ['pack', basePath], {cwd})).split('\n').pop();
+    await move(path.resolve(cwd, tarball), path.resolve(cwd, tarballDir.trim(), tarball));
   }
 };
diff --git a/lib/publish.js b/lib/publish.js
@@ -1,21 +1,25 @@
+const path = require('path');
 const execa = require('execa');
 const getRegistry = require('./get-registry');
 const getReleaseInfo = require('./get-release-info');
 
-module.exports = async (
-  {npmPublish, pkgRoot},
-  {publishConfig, name, private: priv},
-  {nextRelease: {version}, logger}
-) => {
-  if (npmPublish !== false && priv !== true) {
-    const basePath = pkgRoot || '.';
-    const registry = await getRegistry(publishConfig, name);
+module.exports = async ({npmPublish, pkgRoot}, pkg, context) => {
+  const {
+    cwd,
+    env,
+    nextRelease: {version},
+    logger,
+  } = context;
+
+  if (npmPublish !== false && pkg.private !== true) {
+    const basePath = pkgRoot ? path.resolve(cwd, pkgRoot) : cwd;
+    const registry = getRegistry(pkg, context);
 
     logger.log('Publishing version %s to npm registry', version);
-    const shell = await execa('npm', ['publish', `./${basePath}`, '--registry', registry]);
+    const shell = await execa('npm', ['publish', basePath, '--registry', registry], {cwd, env});
 
-    process.stdout.write(shell.stdout);
-    return getReleaseInfo(name, publishConfig, registry);
+    logger.stdout(shell.stdout);
+    return getReleaseInfo(pkg, context, registry);
   }
   logger.log(
     'Skip publishing to npm registry as %s is %s',
diff --git a/lib/set-legacy-token.js b/lib/set-legacy-token.js
@@ -1,8 +1,6 @@
-module.exports = () => {
+module.exports = ({env}) => {
   // Set the environment variable `LEGACY_TOKEN` when user use the legacy auth, so it can be resolved by npm CLI
-  if (process.env.NPM_USERNAME && process.env.NPM_PASSWORD && process.env.NPM_EMAIL) {
-    process.env.LEGACY_TOKEN = Buffer.from(`${process.env.NPM_USERNAME}:${process.env.NPM_PASSWORD}`, 'utf8').toString(
-      'base64'
-    );
+  if (env.NPM_USERNAME && env.NPM_PASSWORD && env.NPM_EMAIL) {
+    env.LEGACY_TOKEN = Buffer.from(`${env.NPM_USERNAME}:${env.NPM_PASSWORD}`, 'utf8').toString('base64');
   }
 };
diff --git a/lib/set-npmrc-auth.js b/lib/set-npmrc-auth.js
@@ -1,22 +1,23 @@
+const path = require('path');
+const rc = require('rc');
 const {appendFile} = require('fs-extra');
 const getAuthToken = require('registry-auth-token');
 const nerfDart = require('nerf-dart');
 const AggregateError = require('aggregate-error');
 const getError = require('./get-error');
 
-module.exports = async (registry, logger) => {
+module.exports = async (registry, {cwd, env: {NPM_TOKEN, NPM_USERNAME, NPM_PASSWORD, NPM_EMAIL}, logger}) => {
   logger.log('Verify authentication for registry %s', registry);
-  const {NPM_TOKEN, NPM_USERNAME, NPM_PASSWORD, NPM_EMAIL} = process.env;
-
-  if (getAuthToken(registry)) {
+  const config = path.resolve(cwd, '.npmrc');
+  if (getAuthToken(registry, {npmrc: rc('npm', {registry: 'https://registry.npmjs.org/'}, {config})})) {
     return;
   }
   if (NPM_USERNAME && NPM_PASSWORD && NPM_EMAIL) {
-    await appendFile('./.npmrc', `\n_auth = ${Buffer.from(`\${LEGACY_TOKEN}\nemail = \${NPM_EMAIL}`)}`);
-    logger.log('Wrote NPM_USERNAME, NPM_PASSWORD and NPM_EMAIL to .npmrc.');
+    await appendFile(config, `\n_auth = ${Buffer.from(`\${LEGACY_TOKEN}\nemail = \${NPM_EMAIL}`)}`);
+    logger.log(`Wrote NPM_USERNAME, NPM_PASSWORD and NPM_EMAIL to ${config}`);
   } else if (NPM_TOKEN) {
-    await appendFile('./.npmrc', `\n${nerfDart(registry)}:_authToken = \${NPM_TOKEN}`);
-    logger.log('Wrote NPM_TOKEN to .npmrc.');
+    await appendFile(config, `\n${nerfDart(registry)}:_authToken = \${NPM_TOKEN}`);
+    logger.log(`Wrote NPM_TOKEN to ${config}`);
   } else {
     throw new AggregateError([getError('ENONPMTOKEN', {registry})]);
   }
diff --git a/lib/update-package-version.js b/lib/update-package-version.js
@@ -8,9 +8,9 @@ const DEFAULT_INDENT = 2;
 const DEFAULT_NEWLINE = '\n';
 
 module.exports = async (version, basePath, logger) => {
-  const packagePath = path.join(basePath, 'package.json');
-  const shrinkwrapPath = path.join(basePath, 'npm-shrinkwrap.json');
-  const packageLockPath = path.join(basePath, 'package-lock.json');
+  const packagePath = path.resolve(basePath, 'package.json');
+  const shrinkwrapPath = path.resolve(basePath, 'npm-shrinkwrap.json');
+  const packageLockPath = path.resolve(basePath, 'package-lock.json');
   const pkg = await readFile(packagePath, 'utf8');
 
   await writeJson(packagePath, {...parseJson(pkg), ...{version}}, getWriteOptions(pkg));
diff --git a/lib/verify-auth.js b/lib/verify-auth.js
@@ -5,20 +5,18 @@ const getError = require('./get-error');
 const getRegistry = require('./get-registry');
 const setNpmrcAuth = require('./set-npmrc-auth');
 
-const DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org/';
+module.exports = async (pluginConfig, pkg, context) => {
+  const {
+    cwd,
+    env: {DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org/', ...env},
+  } = context;
+  const registry = getRegistry(pkg, context);
 
-module.exports = async (
-  pluginConfig,
-  {publishConfig, name},
-  {logger},
-  defaultRegistry = process.env.DEFAULT_NPM_REGISTRY || DEFAULT_NPM_REGISTRY
-) => {
-  const registry = await getRegistry(publishConfig, name);
-  await setNpmrcAuth(registry, logger);
+  await setNpmrcAuth(registry, context);
 
-  if (normalizeUrl(registry) === normalizeUrl(defaultRegistry)) {
+  if (normalizeUrl(registry) === normalizeUrl(DEFAULT_NPM_REGISTRY)) {
     try {
-      await execa('npm', ['whoami', '--registry', registry]);
+      await execa('npm', ['whoami', '--registry', registry], {cwd, env});
     } catch (err) {
       throw new AggregateError([getError('EINVALIDNPMTOKEN', {registry})]);
     }
diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
     "nerf-dart": "^1.0.0",
     "normalize-url": "^3.0.0",
     "parse-json": "^4.0.0",
+    "rc": "^1.2.8",
     "read-pkg": "^4.0.0",
     "registry-auth-token": "^3.3.1"
   },
@@ -77,6 +78,9 @@
     ],
     "all": true
   },
+  "peerDependencies": {
+    "semantic-release": ">=15.8.0 <16.0.0"
+  },
   "prettier": {
     "printWidth": 120,
     "trailingComma": "es5"
diff --git a/test/get-pkg.test.js b/test/get-pkg.test.js
@@ -1,59 +1,53 @@
+import path from 'path';
 import test from 'ava';
 import {outputJson, writeFile} from 'fs-extra';
 import tempy from 'tempy';
 import getPkg from '../lib/get-pkg';
 
-// Save the current working diretory
-const cwd = process.cwd();
-
-test.beforeEach(() => {
-  // Change current working directory to a temp directory
-  process.chdir(tempy.directory());
-});
-
-test.afterEach.always(() => {
-  // Restore the current working directory
-  process.chdir(cwd);
-});
-
-test.serial('Verify name and version then return parsed package.json', async t => {
+test('Verify name and version then return parsed package.json', async t => {
+  const cwd = tempy.directory();
   const pkg = {name: 'package', version: '0.0.0'};
-  await outputJson('./package.json', pkg);
+  await outputJson(path.resolve(cwd, 'package.json'), pkg);
 
-  const result = await getPkg();
+  const result = await getPkg({}, {cwd});
   t.is(pkg.name, result.name);
   t.is(pkg.version, result.version);
 });
 
-test.serial('Verify name and version then return parsed package.json from a sub-directory', async t => {
+test('Verify name and version then return parsed package.json from a sub-directory', async t => {
+  const cwd = tempy.directory();
+  const pkgRoot = 'dist';
   const pkg = {name: 'package', version: '0.0.0'};
-  await outputJson('./dist/package.json', pkg);
+  await outputJson(path.resolve(cwd, pkgRoot, 'package.json'), pkg);
 
-  const result = await getPkg('dist');
+  const result = await getPkg({pkgRoot}, {cwd});
   t.is(pkg.name, result.name);
   t.is(pkg.version, result.version);
 });
 
-test.serial('Throw error if missing package.json', async t => {
-  const [error] = await t.throws(getPkg());
+test('Throw error if missing package.json', async t => {
+  const cwd = tempy.directory();
+  const [error] = await t.throws(getPkg({}, {cwd}));
 
   t.is(error.name, 'SemanticReleaseError');
   t.is(error.code, 'ENOPKG');
 });
 
-test.serial('Throw error if missing package name', async t => {
-  await outputJson('./package.json', {version: '0.0.0'});
+test('Throw error if missing package name', async t => {
+  const cwd = tempy.directory();
+  await outputJson(path.resolve(cwd, 'package.json'), {version: '0.0.0'});
 
-  const [error] = await t.throws(getPkg());
+  const [error] = await t.throws(getPkg({}, {cwd}));
 
   t.is(error.name, 'SemanticReleaseError');
   t.is(error.code, 'ENOPKGNAME');
 });
 
-test.serial('Throw error if package.json is malformed', async t => {
-  await writeFile('./package.json', "{name: 'package',}");
+test('Throw error if package.json is malformed', async t => {
+  const cwd = tempy.directory();
+  await writeFile(path.resolve(cwd, 'package.json'), "{name: 'package',}");
 
-  const [error] = await t.throws(getPkg());
+  const [error] = await t.throws(getPkg({}, {cwd}));
 
   t.is(error.name, 'JSONError');
 });
diff --git a/test/get-registry.test.js b/test/get-registry.test.js
@@ -1,38 +1,35 @@
+import path from 'path';
 import test from 'ava';
 import {appendFile} from 'fs-extra';
 import tempy from 'tempy';
 import getRegistry from '../lib/get-registry';
 
-// Save the current working diretory
-const cwd = process.cwd();
-
-test.beforeEach(() => {
-  // Change current working directory to a temp directory
-  process.chdir(tempy.directory());
+test('Get default registry', t => {
+  const cwd = tempy.directory();
+  t.is(getRegistry({name: 'package-name'}, {cwd}), 'https://registry.npmjs.org/');
+  t.is(getRegistry({name: 'package-name', publishConfig: {}}, {cwd}), 'https://registry.npmjs.org/');
 });
 
-test.afterEach.always(() => {
-  // Restore the current working directory
-  process.chdir(cwd);
-});
+test('Get the registry configured in ".npmrc" and normalize trailing slash', async t => {
+  const cwd = tempy.directory();
+  await appendFile(path.resolve(cwd, '.npmrc'), 'registry = https://custom1.registry.com');
 
-test.serial('Get default registry', async t => {
-  t.is(await getRegistry(undefined, 'package-name'), 'https://registry.npmjs.org/');
-  t.is(await getRegistry({}, 'package-name'), 'https://registry.npmjs.org/');
+  t.is(getRegistry({name: 'package-name'}, {cwd}), 'https://custom1.registry.com/');
 });
 
-test.serial('Get the registry configured in ".npmrc" and normalize trailing slash', async t => {
-  await appendFile('./.npmrc', 'registry = https://custom1.registry.com');
-
-  t.is(await getRegistry({}, 'package-name'), 'https://custom1.registry.com/');
-});
+test('Get the registry configured from "publishConfig"', async t => {
+  const cwd = tempy.directory();
+  await appendFile(path.resolve(cwd, '.npmrc'), 'registry = https://custom2.registry.com');
 
-test.serial('Get the registry configured from "publishConfig"', async t => {
-  t.is(await getRegistry({registry: 'https://custom2.registry.com/'}, 'package-name'), 'https://custom2.registry.com/');
+  t.is(
+    getRegistry({name: 'package-name', publishConfig: {registry: 'https://custom3.registry.com/'}}, {cwd}),
+    'https://custom3.registry.com/'
+  );
 });
 
-test.serial('Get the registry configured in ".npmrc" for scoped package', async t => {
-  await appendFile('./.npmrc', '@scope:registry = https://custom3.registry.com');
+test('Get the registry configured in ".npmrc" for scoped package', async t => {
+  const cwd = tempy.directory();
+  await appendFile(path.resolve(cwd, '.npmrc'), '@scope:registry = https://custom3.registry.com');
 
-  t.is(await getRegistry({}, '@scope/package-name'), 'https://custom3.registry.com/');
+  t.is(getRegistry({name: '@scope/package-name'}, {cwd}), 'https://custom3.registry.com/');
 });
diff --git a/test/get-release-info.test.js b/test/get-release-info.test.js
diff --git a/test/integration.test.js b/test/integration.test.js
diff --git a/test/set-npmrc-auth.test.js b/test/set-npmrc-auth.test.js
diff --git a/test/update-package-version.test.js b/test/update-package-version.test.js
