fix(conventional-commits): Improve logging during preset resolution

lerna · Feb 14, 2019 · d4a16a5 · d4a16a5
1 parent 237d1c5
commit d4a16a5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/core/conventional-commits/__tests__/conventional-commits.test.js b/core/conventional-commits/__tests__/conventional-commits.test.js
@@ -134,7 +134,7 @@ describe("conventional-commits", () => {
         await recommendVersion(pkg1, "fixed", { changelogPreset: "garbage" });
       } catch (err) {
         expect(err.message).toBe(
-          "Unable to load conventional-commits preset 'garbage' (conventional-changelog-garbage)"
+          "Unable to load conventional-changelog preset 'garbage' (conventional-changelog-garbage)"
         );
       }
 
@@ -177,7 +177,7 @@ describe("conventional-commits", () => {
         await recommendVersion(pkg1, "fixed", { changelogPreset: "conventional-changelog-garbage" });
       } catch (err) {
         expect(err.message).toBe(
-          "Unable to load conventional-commits preset 'conventional-changelog-garbage'"
+          "Unable to load conventional-changelog preset 'conventional-changelog-garbage'"
         );
       }
 
@@ -192,7 +192,7 @@ describe("conventional-commits", () => {
         await recommendVersion(pkg1, "fixed", { changelogPreset: "conventional-changelog-garbage/pail" });
       } catch (err) {
         expect(err.message).toMatch(
-          "Unable to load conventional-commits preset 'conventional-changelog-garbage/pail'"
+          "Unable to load conventional-changelog preset 'conventional-changelog-garbage/pail'"
         );
       }
 

diff --git a/core/conventional-commits/lib/get-changelog-config.js b/core/conventional-commits/lib/get-changelog-config.js
@@ -14,9 +14,13 @@ function isFunction(config) {
 }
 
 function resolveConfigPromise(presetPackageName) {
+  log.verbose("getChangelogConfig", "Attempting to resolve preset %j", presetPackageName);
+
   // eslint-disable-next-line global-require, import/no-dynamic-require
   let config = require(presetPackageName);
 
+  log.info("getChangelogConfig", "Successfully resolved preset %j", presetPackageName);
+
   // legacy presets export an errback function instead of Q.all()
   if (isFunction(config)) {
     config = pify(config)();
@@ -34,6 +38,9 @@ function getChangelogConfig(changelogPreset = "conventional-changelog-angular",
     // https://github.com/npm/npm-package-arg#result-object
     const parsed = npa(presetPackageName, rootPath);
 
+    log.verbose("getChangelogConfig", "using preset %j", presetPackageName);
+    log.silly("npa", parsed);
+
     if (parsed.type === "directory") {
       if (parsed.raw[0] === "@") {
         // npa parses scoped subpath reference as a directory
@@ -58,7 +65,7 @@ function getChangelogConfig(changelogPreset = "conventional-changelog-angular",
       return Promise.resolve(config);
     } catch (err) {
       log.verbose("getChangelogConfig", err.message);
-      log.info("getChangelogConfig", `Auto-prefixing conventional-commits preset '${changelogPreset}'`);
+      log.info("getChangelogConfig", "Auto-prefixing conventional-changelog preset %j", changelogPreset);
 
       // probably a deep shorthand subpath :P
       parsed.name = parsed.raw;
@@ -86,7 +93,7 @@ function getChangelogConfig(changelogPreset = "conventional-changelog-angular",
 
       throw new ValidationError(
         "EPRESET",
-        `Unable to load conventional-commits preset '${changelogPreset}'${
+        `Unable to load conventional-changelog preset '${changelogPreset}'${
           changelogPreset !== presetPackageName ? ` (${presetPackageName})` : ""
         }`
       );