-
Notifications
You must be signed in to change notification settings - Fork 45
/
index.js
416 lines (366 loc) · 15.2 KB
/
index.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
const fs = require("fs-extra");
const chalk = require("chalk");
const partialUtils = require("./utils/partials");
const helperUtils = require("./utils/helpers");
const _Handlebars = require("handlebars");
const glob = require("glob");
const path = require("path");
const log = require("./utils/log");
const getTargetFilepath = require("./utils/getTargetFilepath");
const sanitizePath = require("./utils/sanitizePath.js");
const getRootFolder = require("./utils/getRootFolder");
const _HtmlWebpackPlugin = require("safe-require")("html-webpack-plugin");
class HandlebarsPlugin {
constructor(options = {}) {
this.HB = HandlebarsPlugin.Handlebars.create();
this.options = Object.assign({
entry: null,
output: null,
data: {},
helpers: {},
htmlWebpackPlugin: null,
// make filepath retrieval customizable
getTargetFilepath,
// make partial-id generator customizable
getPartialId: partialUtils.getDefaultId,
// lifecycle hooks
onBeforeSetup: Function.prototype,
onBeforeAddPartials: Function.prototype,
onBeforeCompile: Function.prototype,
onBeforeRender: Function.prototype,
onBeforeSave: Function.prototype,
onDone: Function.prototype
}, options);
// setup htmlWebpackPlugin default options and merge user configuration
let htmlWebpackPluginOptions = options.htmlWebpackPlugin;
if (htmlWebpackPluginOptions && htmlWebpackPluginOptions.toString() === "true") {
htmlWebpackPluginOptions = { enabled: true };
}
this.options.htmlWebpackPlugin = Object.assign({
enabled: false,
prefix: "html",
HtmlWebpackPlugin: _HtmlWebpackPlugin
}, htmlWebpackPluginOptions);
this.firstCompilation = true;
this.options.onBeforeSetup(this.HB);
this.fileDependencies = [];
this.assetsToEmit = {};
this.updateData();
this.prevTimestamps = {};
this.startTime = Date.now();
}
loadHelpers() {
const helperMap = helperUtils.resolve(this.options.helpers);
// remove helper, before adding them again
helperUtils.unregister(this.HB, ...helperMap.map(helper => helper.id));
helperMap.forEach(helper => {
helperUtils.register(this.HB, helper.id, helper.helperFunction);
if (helper.filepath) {
this.addDependency(helper.filepath);
}
});
}
/**
* Register all partials to Handlebars
*/
loadPartials() {
// register partials
const partials = partialUtils.resolve(this.HB, this.options.partials, this.options.getPartialId);
this.options.onBeforeAddPartials(this.HB, partials);
partialUtils.addMap(this.HB, partials);
// watch all partials for changes
this.addDependency.apply(this, Object.keys(partials).map(key => partials[key]));
}
/**
* Webpack plugin hook - main entry point
* @param {Compiler} compiler
*/
apply(compiler) {
// COMPILE TEMPLATES
const compile = (compilation, done) => {
try {
// wp >= v5
if (compilation.fileTimestamps == null) {
if (this.dependenciesUpdated(compiler) === false) {
return done();
}
// @legacy wp < v5
} else if (this.dependenciesUpdatedLegacy(compilation) === false) {
return done();
}
this.loadPartials(); // Refresh partials
this.loadHelpers(); // Refresh helpers
this.compileAllEntryFiles(compilation, done); // build all html pages
} catch (error) {
compilation.errors.push(error);
}
return undefined; // done();?
};
// REGISTER FILE DEPENDENCIES TO WEBPACK
const emitDependencies = (compilation, done) => {
try {
// resolve file paths for webpack-dev-server
const resolvedDependencies = this.fileDependencies.map(file => path.resolve(file));
// register dependencies at webpack
if (compilation.fileDependencies.add) {
// webpack@4
resolvedDependencies.forEach(compilation.fileDependencies.add, compilation.fileDependencies);
} else {
compilation.fileDependencies = compilation.fileDependencies.concat(resolvedDependencies);
}
// emit generated html pages (webpack-dev-server)
this.emitGeneratedFiles(compilation);
return done();
} catch (error) {
compilation.errors.push(error);
}
return undefined; // done();?
};
// @wp >= 4
if (compiler.hooks) {
const { enabled, HtmlWebpackPlugin } = this.options.htmlWebpackPlugin;
// @feature html-webpack-plugin
if (enabled && HtmlWebpackPlugin) {
compiler.hooks.compilation.tap("HtmlWebpackPluginHooks", compilation => {
// html-webpack-plugin < 4
if (compilation.hooks.htmlWebpackPluginAfterHtmlProcessing) {
compilation.hooks.htmlWebpackPluginAfterHtmlProcessing.tap(
"HandlebarsRenderPlugin",
this.processHtml.bind(this)
);
// html-webpack-plugin >= 4
} else if (HtmlWebpackPlugin.getHooks) {
HtmlWebpackPlugin.getHooks(compilation).beforeEmit
.tapAsync("HandlebarsRenderPlugin", (data, cb) => cb(null, this.processHtml(data)));
}
});
compiler.hooks.emit.tapAsync("HandlebarsRenderPlugin", (compilation, done) => {
compile(compilation, () => emitDependencies(compilation, done));
});
} else {
// use standard compiler hooks
compiler.hooks.make.tapAsync("HandlebarsRenderPlugin", compile);
compiler.hooks.emit.tapAsync("HandlebarsRenderPlugin", emitDependencies);
}
} else {
// @legacy wp < v4
compiler.plugin("make", compile);
compiler.plugin("emit", emitDependencies);
}
}
processHtml(data) {
const { prefix } = this.options.htmlWebpackPlugin;
// @todo used a new partial helper to check for an existing partial
// @todo use generate id for consistent name replacements
this.HB.registerPartial(
`${prefix}/${sanitizePath(data.outputName.replace(/\.[^.]*$/, ""))}`,
data.html
);
try {
// @improve hacky filepath retrieval
// add source file to file dependencies, to watch for changes in webpack-dev-server
const sourceFile = data.plugin.options.template.split("!").pop();
this.addDependency(sourceFile);
} catch (e) {
log(chalk.red(e));
}
return data;
}
/**
* Returns contents of a dependent file
* @param {String} filepath
* @return {String} filecontents
*/
readFile(filepath) {
this.addDependency(filepath);
return fs.readFileSync(filepath, "utf-8");
}
/**
* Registers a file as a dependency
* @param {...[String]} args - list of filepaths
*/
addDependency(...args) {
if (!args) {
return;
}
args.forEach(filename => {
filename = sanitizePath(filename);
if (filename && !this.fileDependencies.includes(filename)) {
this.fileDependencies.push(filename);
}
});
}
/**
* Check if dependencies have been modified (webpack < 5)
* @param {Object} compilation - webpack compilation
* @return {Boolean} true, if a handlebars file or helper has been updated
*/
dependenciesUpdatedLegacy(compilation) {
// NOTE: fileTimestamps will be an `object` or `Map` depending on the webpack version
const fileTimestamps = compilation.fileTimestamps;
const fileNames = fileTimestamps.has ? Array.from(fileTimestamps.keys()) : Object.keys(fileTimestamps);
const changedFiles = fileNames.filter(watchfile => {
const prevTimestamp = this.prevTimestamps[watchfile];
const nextTimestamp = fileTimestamps.has ? fileTimestamps.get(watchfile) : fileTimestamps[watchfile];
this.prevTimestamps[watchfile] = nextTimestamp;
return (prevTimestamp || this.startTime) < (nextTimestamp || Infinity);
});
// diff may be zero on initial build, thus also rebuild if there are no changes
return changedFiles.length === 0 || this.containsOwnDependency(changedFiles);
}
/**
* Check if dependencies have been modified
* @param {Object} compiler
* @return {Boolean} true, if a handlebars file or helper has been updated
*/
dependenciesUpdated(compiler) {
const modifiedFiles = compiler.modifiedFiles; // Set containing paths of modified files
if (modifiedFiles == null) { // First run
return true;
}
const fileDependencies = this.fileDependencies;
for (let i = 0; i < fileDependencies.length; i++) {
// path.resolve because paths in fileDependencies have '/' separators while paths
// in modifiedFiles have '\' separators (on windows)
if (modifiedFiles.has(path.resolve(fileDependencies[i]))) {
return true;
}
}
return false;
}
/**
* @param {Array} list - list of changed files as absolute paths
* @return {Boolean} true, if a file is a dependency of this handlebars build
*/
containsOwnDependency(list) {
for (let i = 0; i < list.length; i += 1) {
const filepath = sanitizePath(list[i]);
if (this.fileDependencies.includes(filepath)) {
return true;
}
}
return false;
}
/**
* Register generated html files to support serving file with webpack-dev-server
* @param {String} filepath - target filepath, where the file is created
* @param {String} content - file contents
*/
registerGeneratedFile(filepath, content) {
this.assetsToEmit[path.basename(filepath)] = {
source: () => content,
size: () => content.length
};
}
/**
* Resets list of generated files
*/
clearGeneratedFiles() {
this.assetsToEmit = {};
}
/**
* Notifies webpack-dev-server of generated files
* @param {Object} compilation
*/
emitGeneratedFiles(compilation) {
Object.keys(this.assetsToEmit).forEach(filename => {
compilation.assets[filename] = this.assetsToEmit[filename];
});
}
/**
* (Re)load input data for hbs rendering
*/
updateData() {
if (this.options.data && typeof this.options.data === "string") {
try {
const dataFromFile = JSON.parse(this.readFile(this.options.data));
this.addDependency(this.options.data);
this.data = dataFromFile;
} catch (e) {
console.error(`Tried to read ${this.options.data} as json-file and failed. Using it as data source...`);
this.data = this.options.data;
}
} else {
this.data = this.options.data;
}
}
/**
* @async
* Generates all given handlebars templates
* @param {Object} compilation - webpack compilation
* @param {Function} done
*/
compileAllEntryFiles(compilation, done) {
this.updateData();
glob(this.options.entry, (globError, entryFilesArray) => {
if (globError) {
compilation.errors.push(globError);
done();
return;
}
try {
if (entryFilesArray.length === 0) {
log(chalk.yellow(`no valid entry files found for ${this.options.entry} -- aborting`));
return;
}
entryFilesArray.forEach(sourcePath => {
try {
this.compileEntryFile(sourcePath, compilation.compiler.outputPath, compilation);
} catch (error) {
compilation.errors.push(new Error(`${sourcePath}: ${error.message}\n${error.stack}`));
}
});
} catch (error) {
compilation.errors.push(error);
}
// enforce new line after plugin has finished
console.log();
done();
});
}
/**
* Generates the html file for the given filepath
* @param {String} sourcePath - filepath to handelebars template
* @param {String} outputPath - webpack output path for build results
* @param {Object} compilation - webpack compilation instance
*/
compileEntryFile(sourcePath, outputPath, compilation) {
outputPath = sanitizePath(outputPath);
let rootFolderName = path.dirname(sourcePath);
if (this.options.output.includes("[path]")) {
rootFolderName = getRootFolder(sourcePath, this.options.entry);
}
if (rootFolderName === false) {
compilation.errors.push(new Error(`${sourcePath}: is ignored`));
return;
}
let targetFilepath = this.options.getTargetFilepath(sourcePath, this.options.output, rootFolderName);
targetFilepath = sanitizePath(targetFilepath);
// fetch template content
let templateContent = this.readFile(sourcePath, "utf-8");
templateContent = this.options.onBeforeCompile(this.HB, templateContent) || templateContent;
// create template
const template = this.HB.compile(templateContent);
const data = this.options.onBeforeRender(this.HB, this.data, sourcePath) || this.data;
// compile template
let result = template(data);
result = this.options.onBeforeSave(this.HB, result, targetFilepath) || result;
if (targetFilepath.includes(outputPath)) {
// change the destination path relative to webpacks output folder and emit it via webpack
targetFilepath = targetFilepath.replace(outputPath, "").replace(/^\/*/, "");
this.assetsToEmit[targetFilepath] = {
source: () => result,
size: () => result.length
};
} else {
// @legacy: if the filepath lies outside the actual webpack destination folder, simply write that file.
// There is no wds-support here, because of watched assets being emitted again
fs.outputFileSync(targetFilepath, result, "utf-8");
}
this.options.onDone(this.HB, targetFilepath);
log(chalk.grey(`created output '${targetFilepath.replace(`${process.cwd()}/`, "")}'`));
}
}
// export Handlebars for easy access in helpers
HandlebarsPlugin.Handlebars = _Handlebars;
module.exports = HandlebarsPlugin;