friendly-errors-plugin.js
4.29 KB
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
'use strict';
const path = require('path');
const chalk = require('chalk');
const os = require('os');
const transformErrors = require('./core/transformErrors');
const formatErrors = require('./core/formatErrors');
const output = require('./output');
const utils = require('./utils');
const concat = utils.concat;
const uniqueBy = utils.uniqueBy;
const defaultTransformers = [
require('./transformers/babelSyntax'),
require('./transformers/moduleNotFound'),
require('./transformers/esLintError'),
];
const defaultFormatters = [
require('./formatters/moduleNotFound'),
require('./formatters/eslintError'),
require('./formatters/defaultError'),
];
class FriendlyErrorsWebpackPlugin {
constructor(options) {
options = options || {};
this.compilationSuccessInfo = options.compilationSuccessInfo || {};
this.onErrors = options.onErrors;
this.shouldClearConsole = options.clearConsole == null ? true : Boolean(options.clearConsole);
this.formatters = concat(defaultFormatters, options.additionalFormatters);
this.transformers = concat(defaultTransformers, options.additionalTransformers);
}
apply(compiler) {
const doneFn = stats => {
this.clearConsole();
const hasErrors = stats.hasErrors();
const hasWarnings = stats.hasWarnings();
if (!hasErrors && !hasWarnings) {
this.displaySuccess(stats);
return;
}
if (hasErrors) {
this.displayErrors(extractErrorsFromStats(stats, 'errors'), 'error');
return;
}
if (hasWarnings) {
this.displayErrors(extractErrorsFromStats(stats, 'warnings'), 'warning');
}
};
const invalidFn = () => {
this.clearConsole();
output.title('info', 'WAIT', 'Compiling...');
};
if (compiler.hooks) {
const plugin = { name: 'FriendlyErrorsWebpackPlugin' };
compiler.hooks.done.tap(plugin, doneFn);
compiler.hooks.invalid.tap(plugin, invalidFn);
} else {
compiler.plugin('done', doneFn);
compiler.plugin('invalid', invalidFn);
}
}
clearConsole() {
if (this.shouldClearConsole) {
output.clearConsole();
}
}
displaySuccess(stats) {
const time = getCompileTime(stats);
output.title('success', 'DONE', 'Compiled successfully in ' + time + 'ms');
if (this.compilationSuccessInfo.messages) {
this.compilationSuccessInfo.messages.forEach(message => output.info(message));
}
if (this.compilationSuccessInfo.notes) {
output.log();
this.compilationSuccessInfo.notes.forEach(note => output.note(note));
}
}
displayErrors(errors, severity) {
const processedErrors = transformErrors(errors, this.transformers);
const topErrors = getMaxSeverityErrors(processedErrors);
const nbErrors = topErrors.length;
const subtitle = severity === 'error' ?
`Failed to compile with ${nbErrors} ${severity}s` :
`Compiled with ${nbErrors} ${severity}s`;
output.title(severity, severity.toUpperCase(), subtitle);
if (this.onErrors) {
this.onErrors(severity, topErrors);
}
formatErrors(topErrors, this.formatters, severity)
.forEach(chunk => output.log(chunk));
}
}
function extractErrorsFromStats(stats, type) {
if (isMultiStats(stats)) {
const errors = stats.stats
.reduce((errors, stats) => errors.concat(extractErrorsFromStats(stats, type)), []);
// Dedupe to avoid showing the same error many times when multiple
// compilers depend on the same module.
return uniqueBy(errors, error => error.message);
}
return stats.compilation[type];
}
function getCompileTime(stats) {
if (isMultiStats(stats)) {
// Webpack multi compilations run in parallel so using the longest duration.
// https://webpack.github.io/docs/configuration.html#multiple-configurations
return stats.stats
.reduce((time, stats) => Math.max(time, getCompileTime(stats)), 0);
}
return stats.endTime - stats.startTime;
}
function isMultiStats(stats) {
return stats.stats;
}
function getMaxSeverityErrors(errors) {
const maxSeverity = getMaxInt(errors, 'severity');
return errors.filter(e => e.severity === maxSeverity);
}
function getMaxInt(collection, propertyName) {
return collection.reduce((res, curr) => {
return curr[propertyName] > res ? curr[propertyName] : res;
}, 0)
}
module.exports = FriendlyErrorsWebpackPlugin;