Skip to content

Commit 49a578a

Browse files
webdiscuswebdiscus
authored
fix: optimize debug message formatting, #1065 (#1066)
1 parent cb98ad5 commit 49a578a

File tree

4 files changed

+49
-33
lines changed

4 files changed

+49
-33
lines changed

‎README.md

+14
Original file line numberDiff line numberDiff line change
@@ -778,6 +778,20 @@ module.exports = {
778778
};
779779
```
780780

781+
## How to enable `@debug` output
782+
783+
Defaults, the output of `@debug` messages is disabled.
784+
To enable it, add to **webpack.config.js** following:
785+
786+
```js
787+
module.exports = {
788+
stats: {
789+
loggingDebug: ["sass-loader"],
790+
},
791+
// ...
792+
};
793+
```
794+
781795
## Examples
782796

783797
### Extracts CSS into separate files

‎src/utils.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -157,13 +157,15 @@ async function getSassOptions(
157157
const logger = loaderContext.getLogger("sass-loader");
158158
const formatSpan = (span) =>
159159
`${span.url || "-"}:${span.start.line}:${span.start.column}: `;
160+
const formatDebugSpan = (span) =>
161+
`[debug:${span.start.line}:${span.start.column}] `;
160162

161163
options.logger = {
162164
debug(message, loggerOptions) {
163165
let builtMessage = "";
164166

165167
if (loggerOptions.span) {
166-
builtMessage = formatSpan(loggerOptions.span);
168+
builtMessage = formatDebugSpan(loggerOptions.span);
167169
}
168170

169171
builtMessage += message;

‎test/__snapshots__/loader.test.js.snap

+8-8
Original file line numberDiff line numberDiff line change
@@ -2805,7 +2805,7 @@ Array [
28052805
Array [
28062806
Object {
28072807
"args": Array [
2808-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
2808+
"[debug:0:0] My debug message",
28092809
],
28102810
"type": "debug",
28112811
},
@@ -2833,7 +2833,7 @@ Array [
28332833
Array [
28342834
Object {
28352835
"args": Array [
2836-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
2836+
"[debug:0:0] My debug message",
28372837
],
28382838
"type": "debug",
28392839
},
@@ -2861,7 +2861,7 @@ Array [
28612861
Array [
28622862
Object {
28632863
"args": Array [
2864-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
2864+
"[debug:0:0] My debug message",
28652865
],
28662866
"type": "debug",
28672867
},
@@ -2889,7 +2889,7 @@ Array [
28892889
Array [
28902890
Object {
28912891
"args": Array [
2892-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
2892+
"[debug:0:0] My debug message",
28932893
],
28942894
"type": "debug",
28952895
},
@@ -2917,7 +2917,7 @@ Array [
29172917
Array [
29182918
Object {
29192919
"args": Array [
2920-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
2920+
"[debug:0:0] My debug message",
29212921
],
29222922
"type": "debug",
29232923
},
@@ -2945,7 +2945,7 @@ Array [
29452945
Array [
29462946
Object {
29472947
"args": Array [
2948-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
2948+
"[debug:0:0] My debug message",
29492949
],
29502950
"type": "debug",
29512951
},
@@ -2973,7 +2973,7 @@ Array [
29732973
Array [
29742974
Object {
29752975
"args": Array [
2976-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
2976+
"[debug:0:0] My debug message",
29772977
],
29782978
"type": "debug",
29792979
},
@@ -3001,7 +3001,7 @@ Array [
30013001
Array [
30023002
Object {
30033003
"args": Array [
3004-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
3004+
"[debug:0:0] My debug message",
30053005
],
30063006
"type": "debug",
30073007
},

‎test/__snapshots__/warnRuleAsWarning.test.js.snap

+24-24
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Array [
1313
Array [
1414
Object {
1515
"args": Array [
16-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
16+
"[debug:0:0] My debug message",
1717
],
1818
"type": "debug",
1919
},
@@ -41,7 +41,7 @@ Array [
4141
Array [
4242
Object {
4343
"args": Array [
44-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
44+
"[debug:0:0] My debug message",
4545
],
4646
"type": "debug",
4747
},
@@ -69,7 +69,7 @@ Array [
6969
Array [
7070
Object {
7171
"args": Array [
72-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
72+
"[debug:0:0] My debug message",
7373
],
7474
"type": "debug",
7575
},
@@ -97,7 +97,7 @@ Array [
9797
Array [
9898
Object {
9999
"args": Array [
100-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
100+
"[debug:0:0] My debug message",
101101
],
102102
"type": "debug",
103103
},
@@ -149,7 +149,7 @@ Array [
149149
Array [
150150
Object {
151151
"args": Array [
152-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
152+
"[debug:0:0] My debug message",
153153
],
154154
"type": "debug",
155155
},
@@ -177,7 +177,7 @@ Array [
177177
Array [
178178
Object {
179179
"args": Array [
180-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
180+
"[debug:0:0] My debug message",
181181
],
182182
"type": "debug",
183183
},
@@ -205,7 +205,7 @@ Array [
205205
Array [
206206
Object {
207207
"args": Array [
208-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
208+
"[debug:0:0] My debug message",
209209
],
210210
"type": "debug",
211211
},
@@ -233,7 +233,7 @@ Array [
233233
Array [
234234
Object {
235235
"args": Array [
236-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
236+
"[debug:0:0] My debug message",
237237
],
238238
"type": "debug",
239239
},
@@ -261,7 +261,7 @@ Array [
261261
Array [
262262
Object {
263263
"args": Array [
264-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
264+
"[debug:0:0] My debug message",
265265
],
266266
"type": "debug",
267267
},
@@ -289,7 +289,7 @@ Array [
289289
Array [
290290
Object {
291291
"args": Array [
292-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
292+
"[debug:0:0] My debug message",
293293
],
294294
"type": "debug",
295295
},
@@ -317,7 +317,7 @@ Array [
317317
Array [
318318
Object {
319319
"args": Array [
320-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
320+
"[debug:0:0] My debug message",
321321
],
322322
"type": "debug",
323323
},
@@ -345,7 +345,7 @@ Array [
345345
Array [
346346
Object {
347347
"args": Array [
348-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
348+
"[debug:0:0] My debug message",
349349
],
350350
"type": "debug",
351351
},
@@ -397,7 +397,7 @@ Array [
397397
Array [
398398
Object {
399399
"args": Array [
400-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
400+
"[debug:0:0] My debug message",
401401
],
402402
"type": "debug",
403403
},
@@ -425,7 +425,7 @@ Array [
425425
Array [
426426
Object {
427427
"args": Array [
428-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
428+
"[debug:0:0] My debug message",
429429
],
430430
"type": "debug",
431431
},
@@ -453,7 +453,7 @@ Array [
453453
Array [
454454
Object {
455455
"args": Array [
456-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
456+
"[debug:0:0] My debug message",
457457
],
458458
"type": "debug",
459459
},
@@ -481,7 +481,7 @@ Array [
481481
Array [
482482
Object {
483483
"args": Array [
484-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
484+
"[debug:0:0] My debug message",
485485
],
486486
"type": "debug",
487487
},
@@ -509,7 +509,7 @@ Array [
509509
Array [
510510
Object {
511511
"args": Array [
512-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
512+
"[debug:0:0] My debug message",
513513
],
514514
"type": "debug",
515515
},
@@ -541,7 +541,7 @@ Array [
541541
Array [
542542
Object {
543543
"args": Array [
544-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
544+
"[debug:0:0] My debug message",
545545
],
546546
"type": "debug",
547547
},
@@ -573,7 +573,7 @@ Array [
573573
Array [
574574
Object {
575575
"args": Array [
576-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
576+
"[debug:0:0] My debug message",
577577
],
578578
"type": "debug",
579579
},
@@ -605,7 +605,7 @@ Array [
605605
Array [
606606
Object {
607607
"args": Array [
608-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
608+
"[debug:0:0] My debug message",
609609
],
610610
"type": "debug",
611611
},
@@ -661,7 +661,7 @@ Array [
661661
Array [
662662
Object {
663663
"args": Array [
664-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
664+
"[debug:0:0] My debug message",
665665
],
666666
"type": "debug",
667667
},
@@ -693,7 +693,7 @@ Array [
693693
Array [
694694
Object {
695695
"args": Array [
696-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
696+
"[debug:0:0] My debug message",
697697
],
698698
"type": "debug",
699699
},
@@ -725,7 +725,7 @@ Array [
725725
Array [
726726
Object {
727727
"args": Array [
728-
"file:///<cwd>/sass/logging.sass:0:0: My debug message",
728+
"[debug:0:0] My debug message",
729729
],
730730
"type": "debug",
731731
},
@@ -757,7 +757,7 @@ Array [
757757
Array [
758758
Object {
759759
"args": Array [
760-
"file:///<cwd>/scss/logging.scss:0:0: My debug message",
760+
"[debug:0:0] My debug message",
761761
],
762762
"type": "debug",
763763
},

0 commit comments

Comments
 (0)