fix: improve build logs related to plugin event handlers (#3721)

netlify · Oct 14, 2021 · e1a33fe · e1a33fe
1 parent 3105842
commit e1a33fe
Show file tree

Hide file tree

Showing 15 changed files with 413 additions and 415 deletions.
diff --git a/packages/build/src/log/messages/steps.js b/packages/build/src/log/messages/steps.js
@@ -12,9 +12,7 @@ const logStepStart = function ({ logs, event, packageName, coreStepDescription,
 }
 
 const getDescription = function ({ coreStepDescription, netlifyConfig, packageName, event }) {
-  return coreStepDescription === undefined
-    ? `${event} step from ${packageName}`
-    : coreStepDescription({ netlifyConfig })
+  return coreStepDescription === undefined ? `${packageName} (${event} event)` : coreStepDescription({ netlifyConfig })
 }
 
 const logBuildCommandStart = function (logs, buildCommand) {

diff --git a/packages/build/tests/core/snapshots/tests.js.md b/packages/build/tests/core/snapshots/tests.js.md
@@ -1065,7 +1065,7 @@ Generated by [AVA](https://avajs.dev).
        - ./plugin.js@1.0.0 from netlify.toml␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onPreBuild step from ./plugin.js                           ␊
+      1. ./plugin.js (onPreBuild event)                             ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     expect execPath to NOT equal TEST_NODE_PATH. Got 'true'␊
@@ -1120,7 +1120,7 @@ Generated by [AVA](https://avajs.dev).
        - netlify-plugin-test@1.0.0 from netlify.toml and package.json␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onPreBuild step from netlify-plugin-test                   ␊
+      1. netlify-plugin-test (onPreBuild event)                     ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     expect execPath to NOT equal TEST_NODE_PATH. Got 'true'␊
@@ -1345,7 +1345,7 @@ Generated by [AVA](https://avajs.dev).
        - ./plugin.js@1.0.0 from netlify.toml␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onBuild step from ./plugin.js                              ␊
+      1. ./plugin.js (onBuild event)                                ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     ␊

diff --git a/packages/build/tests/core/snapshots/tests.js.snap b/packages/build/tests/core/snapshots/tests.js.snap
diff --git a/packages/build/tests/env/snapshots/tests.js.md b/packages/build/tests/env/snapshots/tests.js.md
@@ -45,7 +45,7 @@ Generated by [AVA](https://avajs.dev).
        - ./plugin@1.0.0 from netlify.toml␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onPreBuild step from ./plugin                              ␊
+      1. ./plugin (onPreBuild event)                                ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     en_US.UTF-8␊
@@ -151,7 +151,7 @@ Generated by [AVA](https://avajs.dev).
        - ./plugin@1.0.0 from netlify.toml␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onPreBuild step from ./plugin                              ␊
+      1. ./plugin (onPreBuild event)                                ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     test␊
@@ -258,7 +258,7 @@ Generated by [AVA](https://avajs.dev).
        - ./plugin@1.0.0 from netlify.toml␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onPreBuild step from ./plugin                              ␊
+      1. ./plugin (onPreBuild event)                                ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     test␊
@@ -315,7 +315,7 @@ Generated by [AVA](https://avajs.dev).
        - ./plugin@1.0.0 from netlify.toml␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onPreBuild step from ./plugin                              ␊
+      1. ./plugin (onPreBuild event)                                ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     test␊
@@ -372,7 +372,7 @@ Generated by [AVA](https://avajs.dev).
        - ./plugin@1.0.0 from netlify.toml␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onPreBuild step from ./plugin                              ␊
+      1. ./plugin (onPreBuild event)                                ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     test-build␊
@@ -429,7 +429,7 @@ Generated by [AVA](https://avajs.dev).
        - ./plugin@1.0.0 from netlify.toml␊
     ␊
     ────────────────────────────────────────────────────────────────␊
-      1. onPreBuild step from ./plugin                              ␊
+      1. ./plugin (onPreBuild event)                                ␊
     ────────────────────────────────────────────────────────────────␊
     ␊
     test␊

diff --git a/packages/build/tests/env/snapshots/tests.js.snap b/packages/build/tests/env/snapshots/tests.js.snap