-
Notifications
You must be signed in to change notification settings - Fork 0
/
browserDevelopmentConfiguration.js
290 lines (285 loc) · 10.8 KB
/
browserDevelopmentConfiguration.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
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
const path = require('path');
const extend = require('extend');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const ScriptExtHtmlWebpackPlugin = require('script-ext-html-webpack-plugin');
const ExtractTextPlugin = require('extract-text-webpack-plugin');
const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin');
const {
NoEmitOnErrorsPlugin,
DefinePlugin,
HotModuleReplacementPlugin,
NamedModulesPlugin,
} = require('webpack');
const { provider } = require('jimple');
const ConfigurationFile = require('../../abstracts/configurationFile');
/**
* Creates the specifics of a Webpack configuration for a browser target development build.
* @extends {ConfigurationFile}
*/
class WebpackBrowserDevelopmentConfiguration extends ConfigurationFile {
/**
* Class constructor.
* @param {Logger} appLogger To inform the user when the
* build is running on the dev
* server.
* @param {Events} events To reduce the configuration.
* @param {PathUtils} pathUtils Required by `ConfigurationFile`
* in order to build the path to
* the overwrite file.
* @param {WebpackBaseConfiguration} webpackBaseConfiguration The configuration this one will
* extend.
*/
constructor(
appLogger,
events,
pathUtils,
webpackBaseConfiguration
) {
super(
pathUtils,
'webpack/browser.development.config.js',
true,
webpackBaseConfiguration
);
/**
* A local reference for the `appLogger` service.
* @type {Logger}
*/
this.appLogger = appLogger;
/**
* A local reference for the `events` service.
* @type {Events}
*/
this.events = events;
}
/**
* Create the configuration with the `entry`, the `output` and the plugins specifics for a
* browser target development build. It also checks if it should enable source map and the
* dev server based on the target information.
* This method uses the reducer event `webpack-browser-development-configuration`, which sends
* the configuration, the received `params` and expects a configuration on return.
* @param {WebpackConfigurationParams} params A dictionary generated by the top service building
* the configuration and that includes things like the
* target information, its entry settings, output
* paths, etc.
* @return {object}
*/
createConfig(params) {
const {
definitions,
entry,
target,
output,
} = params;
// Define the basic stuff: entry and output.
const config = {
entry: extend(true, {}, entry),
output: {
path: `./${target.folders.build}`,
filename: output.js,
publicPath: '/',
},
};
// If the target has source maps enabled...
if (target.sourceMap.development) {
// ...configure the devtool
config.devtool = 'source-map';
}
// Setup the plugins.
config.plugins = [
// To push all the styles into one single file.
new ExtractTextPlugin(output.css),
// To automatically inject the `script` tag on the target `html` file.
new HtmlWebpackPlugin(Object.assign({}, target.html, {
template: path.join(target.paths.source, target.html.template),
inject: 'body',
})),
// To add the `async` attribute to the `script` tag.
new ScriptExtHtmlWebpackPlugin({
defaultAttribute: 'async',
}),
// If the target uses hot replacement, add the plugin.
...(target.hot ? [new NamedModulesPlugin(), new HotModuleReplacementPlugin()] : []),
// To avoid pushing assets with errors.
new NoEmitOnErrorsPlugin(),
// To add the _'browser env variables'_.
new DefinePlugin(definitions),
// To optimize the SCSS and remove repeated declarations.
new OptimizeCssAssetsPlugin(),
];
// Define a list of extra entries that may be need depending on the target HMR configuration.
const hotEntries = [];
// If the target needs to run on development...
if (target.runOnDevelopment) {
const devServerConfig = this._normalizeTargetDevServerSettings(target);
// Add the dev server information to the configuration.
config.devServer = {
port: devServerConfig.port,
inline: !!devServerConfig.reload,
open: true,
openPage: '/',
};
// If the configuration has a custom host, set it.
if (devServerConfig.host !== 'localhost') {
config.devServer.host = devServerConfig.host;
}
// If there are SSL files, set them on the server.
if (devServerConfig.ssl) {
config.devServer.https = {
key: devServerConfig.ssl.key,
cert: devServerConfig.ssl.cert,
ca: devServerConfig.ssl.ca,
};
}
// If the server is being proxied, add the public host.
if (devServerConfig.proxied) {
config.devServer.public = devServerConfig.proxied.host;
}
// If the target will run with the dev server and it requires HMR...
if (target.hot) {
// Disable the `inline` mode.
config.devServer.inline = false;
// Set the public path to `/`, as required by HMR.
config.devServer.publicPath = '/';
// Enable the dev server `hot` setting.
config.devServer.hot = true;
// Push the required entries to enable HMR on the dev server.
hotEntries.push(...[
`webpack-dev-server/client?${devServerConfig.url}`,
'webpack/hot/only-dev-server',
]);
}
// Push the fake plugin that logs the dev server statuses.
config.plugins.push(this._getDevServerLogger(config.devServer));
} else if (target.hot) {
/**
* If the target requires HMR but is not running with the dev server, it means that there's
* an Express or Jimpex target that implements the `webpack-hot-middleware`, so we push it
* required entry to the list.
*/
hotEntries.push('webpack-hot-middleware/client?reload=true');
}
// If there are entries for HMR...
if (hotEntries.length) {
// Get target entry name.
const [entryName] = Object.keys(entry);
// Get the list of entries for the target.
const entries = config.entry[entryName];
// Check if the `babel-polyfill` is present, since it always needs to be first.
const polyfillIndex = entries.indexOf('babel-polyfill');
// If the `babel-polyfill` is present...
if (polyfillIndex > -1) {
// ...push all the _"hot entries"_ after it.
entries.splice(polyfillIndex + 1, 0, ...hotEntries);
} else {
// ...push all the _"hot entries"_ on top of the existing entries.
entries.unshift(...hotEntries);
}
}
// Reduce the configuration
return this.events.reduce(
'webpack-browser-development-configuration',
config,
params
);
}
/**
* Check a target dev server settings in order to validate those that needs to be removed or
* completed with their default values.
* @param {Target} target The target information.
* @return {TargetDevServerSettings}
*/
_normalizeTargetDevServerSettings(target) {
// Get a new copy of the config to work with.
const config = extend(true, {}, target.devServer);
/**
* Set a flag to know if at least one SSL file was sent.
* This flag is also used when reading the `proxied` settings to determine the default
* behaviour of `proxied.https`.
*/
let hasASSLFile = false;
// Loop all the SSL files...
Object.keys(config.ssl).forEach((name) => {
const file = config.ssl[name];
// If there's an actual path...
if (typeof file === 'string') {
// ...set the flag to `true`.
hasASSLFile = true;
// Generate the path to the file.
config.ssl[name] = this.pathUtils.join(file);
}
});
// If no SSL file was sent, just remove the settings.
if (!hasASSLFile) {
delete config.ssl;
}
// If the server is being proxied...
if (config.proxied.enabled) {
// ...if no `host` was specified, use the one defined for the server.
if (config.proxied.host === null) {
config.proxied.host = config.host;
}
// If no `https` option was specified, set it to `true` if at least one SSL file was sent.
if (config.proxied.https === null) {
config.proxied.https = hasASSLFile;
}
} else {
// ...otherwise, just remove the setting.
delete config.proxied;
}
const protocol = config.ssl ? 'https' : 'http';
config.url = `${protocol}://${config.host}:${config.port}`;
return config;
}
/**
* Creates a _'fake Webpack plugin'_ that detects when the bundle is being compiled in order to
* log messages with the dev server information.
* @param {object} devServer The target dev server configuration.
* @param {number} devServer.port The port in which the dev server is running.
* @return {object} A webpack plugin.
* @ignore
* @access protected
*/
_getDevServerLogger(devServer) {
const { port } = devServer;
return {
apply: (compiler) => {
compiler.plugin('compile', () => {
this.appLogger.success(`Starting on port ${port}`);
this.appLogger.warning('waiting for Webpack...');
});
compiler.plugin('done', () => {
// Awful hack, but the webpack output gets on the same line
setTimeout(() => {
this.appLogger.success(`Your app is running on the port ${port}`);
}, 0);
});
},
};
}
}
/**
* The service provider that once registered on the app container will set an instance of
* `WebpackBrowserDevelopmentConfiguration` as the `webpackBrowserDevelopmentConfiguration` service.
* @example
* // Register it on the container
* container.register(webpackBrowserDevelopmentConfiguration);
* // Getting access to the service instance
* const webpackBrowserDevConfig = container.get('webpackBrowserDevelopmentConfiguration');
* @type {Provider}
*/
const webpackBrowserDevelopmentConfiguration = provider((app) => {
app.set(
'webpackBrowserDevelopmentConfiguration',
() => new WebpackBrowserDevelopmentConfiguration(
app.get('appLogger'),
app.get('events'),
app.get('pathUtils'),
app.get('webpackBaseConfiguration')
)
);
});
module.exports = {
WebpackBrowserDevelopmentConfiguration,
webpackBrowserDevelopmentConfiguration,
};