feat: log with signale and allow to customize stdin and stdout

lib/get-commits.js

@@ -24,7 +24,7 @@ module.exports = async ({cwd, env, lastRelease: {gitHead}, logger}) => {
     commit.gitTags = commit.gitTags.trim();
     return commit;
   });
-  logger.log('Found %s commits since last release', commits.length);
+  logger.log(`Found ${commits.length} commits since last release`);
   debug('Parsed commits: %o', commits);
   return commits;
 };

lib/get-last-release.js

@@ -42,7 +42,7 @@ module.exports = async ({cwd, env, options: {tagFormat}, logger}) => {
   const tag = await pLocate(tags, tag => isRefInHistory(tag.gitTag, {cwd, env}), {preserveOrder: true});
 
   if (tag) {
-    logger.log('Found git tag %s associated with version %s', tag.gitTag, tag.version);
+    logger.log(`Found git tag ${tag.gitTag} associated with version ${tag.version}`);
     return {gitHead: await gitTagHead(tag.gitTag, {cwd, env}), ...tag};
   }
 

lib/get-logger.js

@@ -0,0 +1,16 @@
+const {Signale} = require('signale');
+const figures = require('figures');
+
+module.exports = ({stdout, stderr}) =>
+  new Signale({
+    config: {displayTimestamp: true, underlineMessage: true, displayLabel: false},
+    disabled: false,
+    interactive: false,
+    scope: 'semantic-release',
+    stream: [stdout],
+    types: {
+      error: {badge: figures.cross, color: 'red', label: '', stream: [stderr]},
+      log: {badge: figures.info, color: 'magenta', label: '', stream: [stdout]},
+      success: {badge: figures.tick, color: 'green', label: '', stream: [stdout]},
+    },
+  });

lib/get-next-version.js

@@ -5,10 +5,10 @@ module.exports = ({nextRelease: {type}, lastRelease, logger}) => {
   let version;
   if (lastRelease.version) {
     version = semver.inc(lastRelease.version, type);
-    logger.log('The next release version is %s', version);
+    logger.log(`The next release version is ${version}`);
   } else {
     version = FIRST_RELEASE;
-    logger.log('There is no previous release, the next release version is %s', version);
+    logger.log(`There is no previous release, the next release version is ${version}`);
   }
 
   return version;

lib/logger.js

@@ -1,29 +0,0 @@
-const chalk = require('chalk');
-
-/**
- * Logger with `log` and `error` function.
- */
-module.exports = {
-  log(...args) {
-    const [format, ...rest] = args;
-    console.log(
-      `${chalk.grey('[Semantic release]:')}${
-        typeof format === 'string' ? ` ${format.replace(/%[^%]/g, seq => chalk.magenta(seq))}` : ''
-      }`,
-      ...(typeof format === 'string' ? [] : [format]).concat(rest)
-    );
-  },
-  error(...args) {
-    const [format, ...rest] = args;
-    console.error(
-      `${chalk.grey('[Semantic release]:')}${typeof format === 'string' ? ` ${chalk.red(format)}` : ''}`,
-      ...(typeof format === 'string' ? [] : [format]).concat(rest)
-    );
-  },
-  stdout(...args) {
-    console.log(args);
-  },
-  stderr(...args) {
-    console.error(args);
-  },
-};

lib/plugins/normalize.js

@@ -13,14 +13,6 @@ module.exports = ({cwd, options, logger}, type, pluginOpt, pluginsPath) => {
   const {path, ...config} = isString(pluginOpt) || isFunction(pluginOpt) ? {path: pluginOpt} : pluginOpt;
   const pluginName = isFunction(path) ? `[Function: ${path.name}]` : path;
 
-  if (!isFunction(pluginOpt)) {
-    if (pluginsPath[path]) {
-      logger.log('Load plugin "%s" from %s in shareable config %s', type, path, pluginsPath[path]);
-    } else {
-      logger.log('Load plugin "%s" from %s', type, path);
-    }
-  }
-
   const basePath = pluginsPath[path]
     ? dirname(resolveFrom.silent(__dirname, pluginsPath[path]) || resolveFrom(cwd, pluginsPath[path]))
     : __dirname;
@@ -38,18 +30,29 @@ module.exports = ({cwd, options, logger}, type, pluginOpt, pluginsPath) => {
   const validator = async input => {
     const {outputValidator} = PLUGINS_DEFINITIONS[type] || {};
     try {
-      logger.log('Call plugin "%s"', type);
-      const result = await func(cloneDeep(input));
+      logger.log(`Start step "${type}" of plugin "${pluginName}"`);
+      const result = await func({...cloneDeep(input), logger: logger.scope(logger.scopeName, pluginName)});
       if (outputValidator && !outputValidator(result)) {
         throw getError(`E${type.toUpperCase()}OUTPUT`, {result, pluginName});
       }
+      logger.success(`Completed step "${type}" of plugin "${pluginName}"`);
       return result;
     } catch (err) {
+      logger.error(`Failed step "${type}" of plugin "${pluginName}"`);
       extractErrors(err).forEach(err => Object.assign(err, {pluginName}));
       throw err;
     }
   };
 
   Reflect.defineProperty(validator, 'pluginName', {value: pluginName, writable: false, enumerable: true});
+
+  if (!isFunction(pluginOpt)) {
+    if (pluginsPath[path]) {
+      logger.success(`Loaded plugin "${type}" from "${path}" in shareable config "${pluginsPath[path]}"`);
+    } else {
+      logger.success(`Loaded plugin "${type}" from "${path}"`);
+    }
+  }
+
   return validator;
 };