-
Notifications
You must be signed in to change notification settings - Fork 5
/
formatWebpackMessages.js
123 lines (107 loc) · 3.99 KB
/
formatWebpackMessages.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
const chalk = require("chalk");
const friendlySyntaxErrorLabel = "Syntax error:";
function isLikelyASyntaxError(message) {
return message.indexOf(friendlySyntaxErrorLabel) !== -1;
}
// Cleans up webpack error messages.
function formatMessage(stats) {
let { message } = stats;
if (message === undefined) {
message = stats;
}
let lines = message.split("\n");
// Strip webpack-added headers off errors/warnings
// https://github.com/webpack/webpack/blob/master/lib/ModuleError.js
lines = lines.filter((line) => {
return !/Module [A-z ]+\(from/.test(line);
});
// Transform parsing error into syntax error
// @TODO: move this to our ESLint formatter?
lines = lines.map((line) => {
const parsingError = /Line (\d+):(?:(\d+):)?\s*Parsing error: (.+)$/.exec(
line
);
if (!parsingError) {
return line;
}
const [, errorLine, errorColumn, errorMessage] = parsingError;
return `${friendlySyntaxErrorLabel} ${errorMessage} (${errorLine}:${errorColumn})`;
});
message = lines.join("\n");
// Smoosh syntax errors (commonly found in CSS)
message = message.replace(
/SyntaxError\s+\((\d+):(\d+)\)\s*(.+?)\n/g,
`${friendlySyntaxErrorLabel} $3 ($1:$2)\n`
);
// Clean up export errors
message = message.replace(
/^.*export '(.+?)' was not found in '(.+?)'.*$/gm,
"Attempted import error: '$1' is not exported from '$2'."
);
message = message.replace(
/^.*export 'default' \(imported as '(.+?)'\) was not found in '(.+?)'.*$/gm,
"Attempted import error: '$2' does not contain a default export (imported as '$1')."
);
message = message.replace(
/^.*export '(.+?)' \(imported as '(.+?)'\) was not found in '(.+?)'.*$/gm,
"Attempted import error: '$1' is not exported from '$3' (imported as '$2')."
);
lines = message.split("\n");
// Remove leading newline
if (lines.length > 2 && lines[1].trim() === "") {
lines.splice(1, 1);
}
// Clean up file name
lines[0] = lines[0].replace(/^(.*) \d+:\d+-\d+$/, "$1");
// Cleans up verbose "module not found" messages for files and packages.
if (lines[1] && lines[1].indexOf("Module not found: ") === 0) {
lines = [
lines[0],
lines[1]
.replace("Error: ", "")
.replace("Module not found: Cannot find file:", "Cannot find file:"),
];
}
// Add helpful message for users trying to use Sass for the first time
if (lines[1] && lines[1].match(/Cannot find module.+node-sass/)) {
lines[1] = "To import Sass files, you first need to install node-sass.\n";
lines[1] +=
"Run `npm install node-sass` or `yarn add node-sass` inside your workspace.";
}
lines[0] = chalk.inverse(lines[0]);
message = lines.join("\n");
// Internal stacks are generally useless so we strip them... with the
// exception of stacks containing `webpack:` because they're normally
// from user code generated by webpack. For more information see
// https://github.com/facebook/create-react-app/pull/1050
message = message.replace(
/^\s*at\s((?!webpack:).)*:\d+:\d+[\s)]*(\n|$)/gm,
""
); // at ... ...:x:y
message = message.replace(/^\s*at\s<anonymous>(\n|$)/gm, ""); // at <anonymous>
lines = message.split("\n");
// Remove duplicated newlines
lines = lines.filter((line, index, arr) => {
return (
index === 0 || line.trim() !== "" || line.trim() !== arr[index - 1].trim()
);
});
// Reassemble the message
message = lines.join("\n");
return message.trim();
}
function formatWebpackMessages(jsonStats) {
const formattedErrors = jsonStats.errors.map((message) => {
return formatMessage(message, true);
});
const formattedWarnings = jsonStats.warnings.map((message) => {
return formatMessage(message, false);
});
const result = { errors: formattedErrors, warnings: formattedWarnings };
if (result.errors.some(isLikelyASyntaxError)) {
// If there are any syntax errors, show just them.
result.errors = result.errors.filter(isLikelyASyntaxError);
}
return result;
}
module.exports = formatWebpackMessages;