release-it 12.3.6 → 12.4.3

package/README.md

@@ -287,7 +287,7 @@ overridden. To customize the release notes for the GitHub or GitLab release, use
 `gitlab.releaseNotes`. Make sure any of these commands output the changelog to `stdout`.
 
 Instead of executing a shell command, a (Handlebars) template can be used to generate the changelog. See
-[auto-changelog](./docs/changelogs#auto-changelog) for more details. If your project follows conventions, such as the
+[auto-changelog](./docs/changelog.md#auto-changelog) for more details. If your project follows conventions, such as the
 [Angular commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits), the
 [@release-it/conventional-changelog](https://github.com/release-it/conventional-changelog) plugin is useful.
 
@@ -355,6 +355,8 @@ repo.remote, repo.protocol, repo.host, repo.owner, repo.repository, repo.project
 All variables are available in all hooks. The only exception is that the additional variables listed above are not
 available in the `init` hook.
 
+Use `--verbose` to also log the output of the commands.
+
 ## Scripts (deprecated)
 
 Please use [hooks](#hooks) instead, as hooks are more flexible. The `scripts` will stay for a while, but will be removed
@@ -389,7 +391,8 @@ Use `--disable-metrics` to opt-out of sending some anonymous statistical data to
 
 ## Troubleshooting & debugging
 
-- With `release-it --verbose`, release-it prints every command and its output.
+- With `release-it --verbose` (or `-V`), release-it prints every custom script/hook and its output.
+- With `release-it -VV`, release-it prints every command (also internal) and its output.
 - Prepend `DEBUG=release-it:* release-it [...]` to print configuration and more error details.
 - Use `DEBUG=* release-it [...]` to include debug output for dependencies, such as
   [@octokit/rest](https://github.com/octokit/rest.js).
@@ -403,6 +406,7 @@ While mostly used as a CLI tool, release-it can be used as a dependency to ingra
 
 - [react-navigation/react-navigation](https://github.com/react-navigation/react-navigation)
 - [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui)
+- [js-cookie/js-cookie](https://github.com/js-cookie/js-cookie)
 - [StevenBlack/hosts](https://github.com/StevenBlack/hosts)
 - [react-native-community/react-native-tab-view](https://github.com/react-native-community/react-native-tab-view)
 - [callstack/linaria](https://github.com/callstack/linaria)

package/bin/release-it.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 const updater = require('update-notifier');
-const pkg = require('../package.json');
 const parseArgs = require('yargs-parser');
+const pkg = require('../package.json');
 const release = require('../lib');
 
 const aliases = {
@@ -17,12 +17,13 @@ const aliases = {
 
 const parseCliArguments = args => {
   const options = parseArgs(args, {
-    boolean: ['dry-run', 'ci', 'non-interactive', 'verbose'],
+    boolean: ['dry-run', 'ci', 'non-interactive'],
     alias: aliases,
     default: {
       'dry-run': false,
-      verbose: false
+      verbose: 0
     },
+    count: ['verbose'],
     configuration: {
       'parse-numbers': false
     }

package/lib/config.js

@@ -86,6 +86,10 @@ class Config {
     return Boolean(this.options.verbose);
   }
 
+  get verbosityLevel() {
+    return this.options.verbose;
+  }
+
   get isDebug() {
     return debug.enabled;
   }

package/lib/log.js

@@ -1,11 +1,12 @@
 const { EOL } = require('os');
 const chalk = require('chalk');
-const _ = require('lodash');
+const { isObject, last, filter, isString, lowerCase, upperFirst } = require('lodash');
 
 class Logger {
-  constructor({ isCI = true, isVerbose = false, isDryRun = false } = {}) {
+  constructor({ isCI = true, isVerbose = false, verbosityLevel = 0, isDryRun = false } = {}) {
     this.isCI = isCI;
     this.isVerbose = isVerbose;
+    this.verbosityLevel = verbosityLevel;
     this.isDryRun = isDryRun;
   }
   log(...args) {
@@ -21,13 +22,16 @@ class Logger {
     this.log(chalk.yellow('WARNING'), ...args);
   }
   verbose(...args) {
-    this.isVerbose && this.log(...args);
+    const { isExternal } = isObject(last(args)) ? last(args) : {};
+    if (this.verbosityLevel === 2 || (this.isVerbose && (isExternal || this.isDryRun))) {
+      this.log(...filter(args, isString));
+    }
   }
   exec(...args) {
-    if (this.isVerbose || this.isDryRun) {
-      const isNotExecuted = typeof _.last(args) === 'boolean' && _.last(args) === true;
-      const prefix = isNotExecuted ? '!' : '$';
-      this.log(prefix, ..._.filter(args, _.isString));
+    const { isDryRun: isExecutedInDryRun, isExternal } = isObject(last(args)) ? last(args) : {};
+    if (this.verbosityLevel === 2 || this.isDryRun || (this.isVerbose && isExternal)) {
+      const prefix = isExecutedInDryRun == null ? '$' : '!';
+      this.log(prefix, ...filter(args, isString));
     }
   }
   obtrusive(...args) {
@@ -37,11 +41,11 @@ class Logger {
   }
   preview({ title, text }) {
     if (text) {
-      const header = chalk.bold(_.upperFirst(title));
+      const header = chalk.bold(upperFirst(title));
       const body = text.replace(new RegExp(EOL + EOL, 'g'), EOL);
       this.obtrusive(`${header}:${EOL}${body}`);
     } else {
-      this.obtrusive(`Empty ${_.lowerCase(title)}`);
+      this.obtrusive(`Empty ${lowerCase(title)}`);
     }
   }
 }

package/lib/plugin/git/Git.js

@@ -74,7 +74,7 @@ class Git extends GitBase {
 
   async getCommitsSinceLatestTag() {
     const latestTagName = await this.getLatestTagName();
-    return this.exec(`git rev-list ${latestTagName}..HEAD --count`, { options }).then(Number);
+    return this.exec(`git rev-list ${latestTagName ? `${latestTagName}..` : ''}HEAD --count`, { options }).then(Number);
   }
 
   stage(file) {

package/lib/plugin/github/GitHub.js

@@ -92,7 +92,7 @@ class GitHub extends Release {
     const name = format(releaseName, { version });
     const body = releaseNotes;
 
-    this.log.exec(`octokit releases#draftRelease "${name}" (${tagName})`, isDryRun);
+    this.log.exec(`octokit releases#draftRelease "${name}" (${tagName})`, { isDryRun });
 
     if (isDryRun) {
       this.releaseUrl = this.getReleaseUrlFallback(tagName);
@@ -161,7 +161,7 @@ class GitHub extends Release {
     const { assets } = this.options;
     const { isDryRun } = this.global;
 
-    this.log.exec('octokit releases#uploadAssets', assets, isDryRun);
+    this.log.exec('octokit releases#uploadAssets', assets, { isDryRun });
 
     if (!assets || !this.isReleased || isDryRun) {
       return noop;
@@ -187,7 +187,7 @@ class GitHub extends Release {
     const { isDryRun } = this.global;
     const tag_name = format(tagName, { version });
 
-    this.log.exec(`octokit releases#publishRelease (${tagName})`, isDryRun);
+    this.log.exec(`octokit releases#publishRelease (${tagName})`, { isDryRun });
 
     if (isDryRun || draft) return;
 

package/lib/plugin/gitlab/GitLab.js

@@ -71,7 +71,7 @@ class GitLab extends Release {
     const name = format(releaseName, { version });
     const description = releaseNotes || '-';
 
-    this.log.exec(`gitlab releases#createRelease "${name}" (${tagName})`, isDryRun);
+    this.log.exec(`gitlab releases#createRelease "${name}" (${tagName})`, { isDryRun });
 
     if (isDryRun) {
       this.releaseUrl = `${this.origin}/${repo.repository}/releases`;
@@ -148,7 +148,7 @@ class GitLab extends Release {
     const { assets } = this.options;
     const { isDryRun } = this.global;
 
-    this.log.exec('gitlab releases#uploadAssets', assets, isDryRun);
+    this.log.exec('gitlab releases#uploadAssets', assets, { isDryRun });
 
     if (!assets || isDryRun) {
       return noop;

package/lib/plugin/npm/npm.js

@@ -118,10 +118,12 @@ class npm extends Plugin {
   }
 
   async getLatestRegistryVersion() {
+    const registry = this.getRegistry();
+    const registryArg = registry !== NPM_DEFAULT_REGISTRY ? ` --registry ${registry}` : '';
     const name = this.getName();
     const latestVersion = this.getLatestVersion();
     const tag = await this.resolveTag(latestVersion);
-    return this.exec(`npm show ${name}@${tag} version`, { options }).catch(() => null);
+    return this.exec(`npm show ${name}@${tag} version${registryArg}`, { options }).catch(() => null);
   }
 
   getRegistryPreReleaseTags() {

package/lib/shell.js

@@ -20,11 +20,13 @@ class Shell {
     const normalizedCmd = command.replace(forcedCmdRe, '').trim();
     const program = normalizedCmd.split(' ')[0];
     const programArgs = normalizedCmd.split(' ').slice(1);
+    const isDryRun = this.global.isDryRun;
     const isWrite = options.write !== false;
     const cacheable = options.cache === true;
+    const isExternal = options.external === true;
 
-    if (this.global.isDryRun && isWrite) {
-      this.log.exec(normalizedCmd, this.global.isDryRun);
+    if (isDryRun && isWrite) {
+      this.log.exec(normalizedCmd, { isDryRun });
       return noop;
     }
 
@@ -33,10 +35,10 @@ class Shell {
     }
 
     const awaitExec = new Promise((resolve, reject) => {
+      this.log.exec(normalizedCmd, { isExternal });
       const cb = (code, stdout, stderr) => {
         stdout = stdout.toString().trim();
-        this.log.exec(normalizedCmd);
-        this.log.verbose(stdout);
+        this.log.verbose(stdout, { isExternal });
         debug({ command, options, code, stdout, stderr });
         if (code === 0) {
           resolve(stdout);

package/lib/spinner.js

@@ -9,10 +9,10 @@ class Spinner {
     this.canForce = !global.isCI && !global.isVerbose && !global.isDryRun && !global.isDebug;
     this.ora = container.ora || ora;
   }
-  show({ enabled = true, task, label, forced = false, context }) {
+  show({ enabled = true, task, label, external = false, context }) {
     if (!enabled) return noop;
     const awaitTask = task();
-    if (!this.isSpinnerDisabled || (forced && this.canForce)) {
+    if (!this.isSpinnerDisabled || (external && this.canForce)) {
       const text = format(label, context);
       this.ora.promise(awaitTask, text);
     }

package/lib/tasks.js

@@ -18,8 +18,8 @@ const runTasks = async (opts, di) => {
     container.config = container.config || new Config(opts);
 
     const { config } = container;
-    const { isCI, isVerbose, isDryRun, isDebug } = config;
-    const global = { isCI, isVerbose, isDryRun, isDebug };
+    const { isCI, isVerbose, verbosityLevel, isDryRun, isDebug } = config;
+    const global = { isCI, isVerbose, verbosityLevel, isDryRun, isDebug };
 
     container.log = container.log || new Logger(global);
     container.spinner = container.spinner || new Spinner({ global, container, config });
@@ -41,9 +41,10 @@ const runTasks = async (opts, di) => {
     const runScript = async scripts => {
       if (!scripts || !scripts.length) return;
       const context = config.getContext();
+      const external = true;
       for (const script of _.castArray(scripts)) {
-        const task = () => shell.exec(script, {}, context);
-        await spinner.show({ task, label: script, context, forced: true });
+        const task = () => shell.exec(script, { external }, context);
+        await spinner.show({ task, label: script, context, external });
       }
     };
 

package/lib/util.js

@@ -3,13 +3,22 @@ const { EOL } = require('os');
 const _ = require('lodash');
 const gitUrlParse = require('git-url-parse');
 const semver = require('semver');
+const Log = require('./log');
 const { TimeoutError } = require('./errors');
 
+const log = new Log();
+
 const format = (template = '', context = {}) => {
-  template = template.startsWith('git log')
-    ? template.replace('[REV_RANGE]', '${latestTag}...HEAD')
-    : template.replace(/%s/g, '${version}');
-  return _.template(template)(context);
+  try {
+    template = template.startsWith('git log')
+      ? template.replace('[REV_RANGE]', '${latestTag}...HEAD')
+      : template.replace(/%s/g, '${version}');
+    return _.template(template)(context);
+  } catch (error) {
+    log.error(`Unable to render template with context:\n${template}\n${JSON.stringify(context)}`);
+    log.error(error);
+    throw error;
+  }
 };
 
 const truncateLines = (input, maxLines = 10, surplusText = null) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "12.3.6",
+  "version": "12.4.3",
   "description": "CLI release tool for Git repos and npm packages.",
   "keywords": [
     "build",
@@ -56,7 +56,7 @@
   "license": "MIT",
   "dependencies": {
     "@iarna/toml": "2.2.3",
-    "@octokit/rest": "16.28.7",
+    "@octokit/rest": "16.33.0",
     "async-retry": "1.2.3",
     "chalk": "2.4.2",
     "cosmiconfig": "5.2.1",
@@ -64,7 +64,7 @@
     "deprecated-obj": "1.0.1",
     "detect-repo-changelog": "1.0.1",
     "find-up": "4.1.0",
-    "form-data": "2.5.0",
+    "form-data": "2.5.1",
     "git-url-parse": "11.1.2",
     "globby": "10.0.1",
     "got": "9.6.0",
@@ -73,34 +73,34 @@
     "is-ci": "2.0.0",
     "lodash": "4.17.15",
     "mime-types": "2.1.24",
-    "ora": "3.4.0",
+    "ora": "4.0.2",
     "os-name": "3.1.0",
     "semver": "6.3.0",
     "shelljs": "0.8.3",
-    "supports-color": "7.0.0",
+    "supports-color": "7.1.0",
     "update-notifier": "3.0.1",
     "url-join": "4.0.1",
     "uuid": "3.3.3",
     "window-size": "1.1.1",
-    "yargs-parser": "13.1.1"
+    "yargs-parser": "15.0.0"
   },
   "devDependencies": {
     "@octokit/request-error": "1.0.4",
-    "ava": "2.3.0",
-    "codecov": "3.5.0",
-    "eslint": "6.2.2",
-    "eslint-config-prettier": "6.1.0",
-    "eslint-plugin-ava": "8.0.0",
+    "ava": "2.4.0",
+    "codecov": "3.6.1",
+    "eslint": "6.5.1",
+    "eslint-config-prettier": "6.4.0",
+    "eslint-plugin-ava": "9.0.0",
     "eslint-plugin-import": "2.18.2",
-    "eslint-plugin-prettier": "3.1.0",
+    "eslint-plugin-prettier": "3.1.1",
     "markdown-toc": "1.2.0",
     "mock-fs": "4.10.1",
     "mock-stdio": "1.0.3",
-    "nock": "10.0.6",
+    "nock": "11.4.0",
     "nyc": "14.1.1",
     "prettier": "1.18.2",
     "proxyquire": "2.1.3",
-    "sinon": "7.4.1",
+    "sinon": "7.5.0",
     "strip-ansi": "5.2.0"
   },
   "engines": {

package/test/util/helpers.js

@@ -20,7 +20,8 @@ const gitAdd = (content, file, message) => {
   sh.ShellString(content).toEnd(file);
   sh.exec(`git add ${file}`);
   const { stdout } = sh.exec(`git commit -m "${message}"`);
-  return stdout.match(/\[.+([a-z0-9]{7})\]/)[1];
+  const match = stdout.match(/\[.+([a-z0-9]{7})\]/);
+  return match ? match[1] : null;
 };
 
 module.exports = {