From 49a578a218574ddc92a597c7e365b6c21960717e Mon Sep 17 00:00:00 2001
From: webdiscus <6752572+webdiscus@users.noreply.github.com>
Date: Mon, 20 Jun 2022 17:02:10 +0200
Subject: [PATCH] fix: optimize debug message formatting, #1065 (#1066)

---
 README.md                                     | 14 ++++++
 src/utils.js                                  |  4 +-
 test/__snapshots__/loader.test.js.snap        | 16 +++----
 .../warnRuleAsWarning.test.js.snap            | 48 +++++++++----------
 4 files changed, 49 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index 24122235..9bd03af3 100644
--- a/README.md
+++ b/README.md
@@ -778,6 +778,20 @@ module.exports = {
 };
 ```
 
+## How to enable `@debug` output
+
+Defaults, the output of `@debug` messages is disabled.
+To enable it, add to **webpack.config.js** following:
+
+```js
+module.exports = {
+  stats: {
+    loggingDebug: ["sass-loader"],
+  },
+  // ...
+};
+```
+
 ## Examples
 
 ### Extracts CSS into separate files
diff --git a/src/utils.js b/src/utils.js
index fba2af2a..6d8e37c3 100644
--- a/src/utils.js
+++ b/src/utils.js
@@ -157,13 +157,15 @@ async function getSassOptions(
     const logger = loaderContext.getLogger("sass-loader");
     const formatSpan = (span) =>
       `${span.url || "-"}:${span.start.line}:${span.start.column}: `;
+    const formatDebugSpan = (span) =>
+      `[debug:${span.start.line}:${span.start.column}] `;
 
     options.logger = {
       debug(message, loggerOptions) {
         let builtMessage = "";
 
         if (loggerOptions.span) {
-          builtMessage = formatSpan(loggerOptions.span);
+          builtMessage = formatDebugSpan(loggerOptions.span);
         }
 
         builtMessage += message;
diff --git a/test/__snapshots__/loader.test.js.snap b/test/__snapshots__/loader.test.js.snap
index 88d6aeaf..195e08df 100644
--- a/test/__snapshots__/loader.test.js.snap
+++ b/test/__snapshots__/loader.test.js.snap
@@ -2805,7 +2805,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -2833,7 +2833,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -2861,7 +2861,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -2889,7 +2889,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -2917,7 +2917,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -2945,7 +2945,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -2973,7 +2973,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -3001,7 +3001,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
diff --git a/test/__snapshots__/warnRuleAsWarning.test.js.snap b/test/__snapshots__/warnRuleAsWarning.test.js.snap
index d9594668..2f755316 100644
--- a/test/__snapshots__/warnRuleAsWarning.test.js.snap
+++ b/test/__snapshots__/warnRuleAsWarning.test.js.snap
@@ -13,7 +13,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -41,7 +41,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -69,7 +69,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -97,7 +97,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -149,7 +149,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -177,7 +177,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -205,7 +205,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -233,7 +233,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -261,7 +261,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -289,7 +289,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -317,7 +317,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -345,7 +345,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -397,7 +397,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -425,7 +425,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -453,7 +453,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -481,7 +481,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -509,7 +509,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -541,7 +541,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -573,7 +573,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -605,7 +605,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -661,7 +661,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -693,7 +693,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -725,7 +725,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/sass/logging.sass:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },
@@ -757,7 +757,7 @@ Array [
   Array [
     Object {
       "args": Array [
-        "file:///<cwd>/scss/logging.scss:0:0: My debug message",
+        "[debug:0:0] My debug message",
       ],
       "type": "debug",
     },