This repository has been archived by the owner on Nov 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
mod.ts
548 lines (497 loc) · 14 KB
/
mod.ts
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
// deno-lint-ignore-file no-explicit-any
// Allow any as long as not all types are defined
/*!
* Pug
* Copyright(c) 2010 TJ Holowaychuk <tj@vision-media.ca>
* MIT Licensed
*/
/**
* Module dependencies.
*/
import { extname } from "./deps.js";
import lex from "./lexer.js";
import stripComments from "./strip-comments.js";
import parse from "./parser.js";
import load from "./load.js";
import handleFilters from "./lib/handle-filters.js";
import link from "./linker.js";
import generateCode from "./code-gen.js";
import * as runtime from "./runtime.js";
import runtimeWrap from "./runtime-wrap.js";
/**
* Types, interfaces, enums, etc
*/
import type {
Cache,
Callback,
CompileTemplate,
DebugSources,
Filter,
LexerOptions,
LocalsObject,
Options,
ParserOptions,
Plugin,
PluginFunction,
PluginFunctionOptions,
PluginResolve,
PluginType,
Token,
} from "./types/index.ts";
// Export types
export type {
Cache,
Callback,
CompileTemplate,
DebugSources,
Filter,
LexerOptions,
LocalsObject,
Options,
ParserOptions,
Plugin,
PluginFunction,
PluginFunctionOptions,
PluginResolve,
PluginType,
Token,
};
/**
* Name for detection
*/
export const name = "Pug";
/**
* Pug runtime helpers.
*/
export { runtime };
/**
* Template function cache.
*/
export const cache: Cache = {};
function applyPlugins(
value: any,
options: any,
plugins: Plugin[],
name: PluginType,
) {
return plugins.reduce(function (value, plugin) {
return typeof plugin[name] === "function"
? (plugin[name] as PluginFunction)(value, options)
: value;
}, value);
}
function findReplacementFunc(plugins: Plugin[], name: PluginType): any {
const eligiblePlugins = plugins.filter(function (plugin) {
return plugin[name] as PluginFunction;
});
if (eligiblePlugins.length > 1) {
throw new Error("Two or more plugins all implement " + name + " method.");
} else if (eligiblePlugins.length) {
return (eligiblePlugins[0][name] as PluginFunction).bind(
eligiblePlugins[0],
);
}
return null;
}
/**
* Object for global custom filters. Note that you can also just pass a `filters`
* option to any other method.
*/
export const filters: Record<string, Filter> = {};
/**
* Compile the given `str` of pug and return a function body.
*
* @param {String} str
* @param {Object} options
* @return {Object}
* @api private
*/
function compileBody(str: string, options: Options) {
const debugSources: DebugSources = {};
debugSources[options.filename!] = str;
const dependencies: string[] = [];
const plugins = options.plugins || [];
let ast = load.string(str, {
filename: options.filename,
basedir: options.basedir,
lex: function (str: string, options: PluginFunctionOptions) {
const lexOptions: LexerOptions = {
plugins: [],
};
Object.keys(options).forEach(function (key) {
(lexOptions as any)[key] = (options as any)[key];
});
lexOptions.plugins.push(
...plugins
.filter(function (plugin) {
return !!plugin.lex;
})
.map(function (plugin) {
return plugin.lex as PluginFunction;
}),
);
const contents = applyPlugins(
str,
{ filename: options.filename },
plugins,
"preLex",
);
return applyPlugins(
lex(contents, lexOptions),
options,
plugins,
"postLex",
);
},
parse: function (tokens: Token[], options: ParserOptions) {
tokens = tokens.map(function (token) {
if (token.type === "path" && extname(token.val) === "") {
return {
type: "path",
loc: token.loc,
val: token.val + ".pug",
};
}
return token;
});
tokens = stripComments(tokens, options);
tokens = applyPlugins(tokens, options, plugins, "preParse");
const parseOptions: ParserOptions = {
plugins: [],
};
Object.keys(options).forEach(function (key) {
(parseOptions as any)[key] = (options as any)[key];
});
parseOptions.plugins.push(
...plugins
.filter(function (plugin) {
return !!plugin.parse;
})
.map(function (plugin) {
return plugin.parse as PluginFunction;
}),
);
return applyPlugins(
applyPlugins(
parse(tokens, parseOptions),
options,
plugins,
"postParse",
),
options,
plugins,
"preLoad",
);
},
resolve: function (
filename: string,
source: string,
loadOptions: PluginFunctionOptions,
) {
const replacementFunc = findReplacementFunc(plugins, "resolve") as
| PluginResolve
| null;
if (replacementFunc) {
return replacementFunc(filename, source, options);
}
return load.resolve(filename, source, loadOptions);
},
read: function (filename: string, loadOptions: PluginFunctionOptions) {
dependencies.push(filename);
let contents: string;
const replacementFunc = findReplacementFunc(plugins, "read");
if (replacementFunc) {
contents = replacementFunc(filename, options) as string;
} else {
contents = load.read(filename, loadOptions);
}
debugSources[filename] = contents;
return contents;
},
});
ast = applyPlugins(ast, options, plugins, "postLoad");
ast = applyPlugins(ast, options, plugins, "preFilters");
const filtersSet: Record<string, Filter> = {};
Object.keys(filters).forEach(function (key) {
filtersSet[key] = filters[key];
});
if (options.filters) {
Object.keys(options.filters).forEach(function (key) {
if (options.filters) {
filtersSet[key] = options.filters[key];
}
});
}
ast = handleFilters(
ast,
filtersSet,
options.filterOptions,
options.filterAliases,
);
ast = applyPlugins(ast, options, plugins, "postFilters");
ast = applyPlugins(ast, options, plugins, "preLink");
ast = link(ast);
ast = applyPlugins(ast, options, plugins, "postLink");
// Compile
ast = applyPlugins(ast, options, plugins, "preCodeGen");
let js = (findReplacementFunc(plugins, "generateCode") || generateCode)(ast, {
pretty: options.pretty,
compileDebug: options.compileDebug,
doctype: options.doctype,
inlineRuntimeFunctions: options.inlineRuntimeFunctions,
globals: options.globals,
self: options.self,
includeSources: options.includeSources ? debugSources : false,
templateName: options.templateName,
}) as string;
js = applyPlugins(js, options, plugins, "postCodeGen");
// Debug compiler
if (options.debug) {
console.error(
"\nCompiled Function:\n\n\u001b[90m%s\u001b[0m",
js?.replace(/^/gm, " "),
);
}
return { body: js, dependencies: dependencies };
}
/**
* Get the template from a string or a file, either compiled on-the-fly or
* read from cache (if enabled), and cache the template if needed.
*
* If `str` is not set, the file specified in `options.filename` will be read.
*
* If `options.cache` is true, this function reads the file from
* `options.filename` so it must be set prior to calling this function.
*
* @param {Object} options
* @param {String=} str
* @return {Function}
* @api private
*/
function handleTemplateCache(options: Options, str?: string): CompileTemplate {
const key = options.filename!;
if (options.cache && cache[key]) {
return cache[key] as CompileTemplate;
} else {
if (str === undefined) str = Deno.readTextFileSync(key);
const templ = compile(str, options);
if (options.cache) cache[key] = templ;
return templ;
}
}
/**
* Compile a `Function` representation of the given pug `str`.
*
* Options:
*
* - `compileDebug` when `false` debugging code is stripped from the compiled
template, when it is explicitly `true`, the source code is included in
the compiled template for better accuracy.
* - `filename` used to improve errors when `compileDebug` is not `false` and to resolve imports/extends
*
* @param {String} str
* @param {Options} options
* @return {Function}
* @api public
*/
export function compile(str: string, options: Options = {}) {
str = String(str);
const parsed = compileBody(str, {
compileDebug: options.compileDebug !== false,
filename: options.filename,
basedir: options.basedir,
pretty: options.pretty,
doctype: options.doctype,
inlineRuntimeFunctions: options.inlineRuntimeFunctions,
globals: options.globals,
self: options.self,
includeSources: options.compileDebug === true,
debug: options.debug,
templateName: "template",
filters: options.filters,
filterOptions: options.filterOptions,
filterAliases: options.filterAliases,
plugins: options.plugins,
});
const res: CompileTemplate = options.inlineRuntimeFunctions
? new Function("", parsed.body + ";return template;")()
: runtimeWrap(parsed.body);
(res as any).dependencies = parsed.dependencies;
return res;
}
/**
* Compile a JavaScript source representation of the given pug `str`.
*
* Options:
*
* - `compileDebug` When it is `true`, the source code is included in
* the compiled template for better error messages.
* - `filename` used to improve errors when `compileDebug` is not `true` and to resolve imports/extends
* - `name` the name of the resulting function (defaults to "template")
* - `module` when it is explicitly `true`, the source code include export module syntax
*
* @param {String} str
* @param {Options} options
* @return {Object}
* @api public
*/
export function compileClientWithDependenciesTracked(
str: string,
options: Options = {},
) {
str = String(str);
const parsed = compileBody(str, {
compileDebug: options.compileDebug,
filename: options.filename,
basedir: options.basedir,
pretty: options.pretty,
doctype: options.doctype,
inlineRuntimeFunctions: options.inlineRuntimeFunctions !== false,
globals: options.globals,
self: options.self,
includeSources: options.compileDebug,
debug: options.debug,
templateName: options.name || "template",
filters: options.filters,
filterOptions: options.filterOptions,
filterAliases: options.filterAliases,
plugins: options.plugins,
});
let body = parsed.body;
if (options.module) {
if (options.inlineRuntimeFunctions === false) {
body = 'const pug = require("pug-runtime");' + body;
}
body += " module.exports = " + (options.name || "template") + ";";
}
return { body: body, dependencies: parsed.dependencies };
}
/**
* Compile a JavaScript source representation of the given pug `str`.
*
* Options:
*
* - `compileDebug` When it is `true`, the source code is included in
* the compiled template for better error messages.
* - `filename` used to improve errors when `compileDebug` is not `true` and to resolve imports/extends
* - `name` the name of the resulting function (defaults to "template")
*
* @param {String} str
* @param {Options} options
* @return {String}
* @api public
*/
export function compileClient(str: string, options: Options) {
return compileClientWithDependenciesTracked(str, options).body;
}
/**
* Compile a `Function` representation of the given pug file.
*
* Options:
*
* - `compileDebug` when `false` debugging code is stripped from the compiled
template, when it is explicitly `true`, the source code is included in
the compiled template for better accuracy.
*
* @param {String} path
* @param {Options} options
* @return {Function}
* @api public
*/
export function compileFile(path: string, options: Options) {
options = options || {};
options.filename = path;
return handleTemplateCache(options);
}
/**
* Render the given `str` of pug.
*
* Options:
*
* - `cache` enable template caching
* - `filename` filename required for `include` / `extends` and caching
*
* @param {String} str
* @param {Object|Function} options or fn
* @param {Function|undefined} fn
* @returns {String}
* @api public
*/
export function render(
str: string,
options?: (Options & LocalsObject) | Callback,
fn?: Callback<Error, string>,
): string | void {
// support callback API
if ("function" == typeof options) {
(fn = options), (options = undefined);
}
if (typeof fn === "function") {
let res: string;
try {
res = render(str, options) as string;
} catch (ex) {
return fn(ex);
}
return fn(null, res);
}
options = options || {};
// cache requires .filename
if (options.cache && !options.filename) {
throw new Error('the "filename" option is required for caching');
}
return handleTemplateCache(options, str)(options);
}
/**
* Render a Pug file at the given `path`.
*
* @param {String} path
* @param {Object|Function} options or callback
* @param {Function|undefined} fn
* @returns {String}
* @api public
*/
export function renderFile(
path: string,
options?: (Options & LocalsObject) | Callback,
fn?: Callback,
): string | void {
// support callback API
if ("function" == typeof options) {
(fn = options), (options = undefined);
}
if (typeof fn === "function") {
let res: string;
try {
res = renderFile(path, options) as string;
} catch (ex) {
return fn(ex);
}
return fn(null, res);
}
options = options || {};
options.filename = path;
return handleTemplateCache(options)(options);
}
/**
* Compile a Pug file at the given `path` for use on the client.
*
* @param {String} path
* @param {Object} options
* @returns {String}
* @api public
*/
export function compileFileClient(path: string, options: Options): string {
const key = path + ":client";
options = options || {};
options.filename = path;
if (options.cache && cache[key]) {
return cache[key] as string;
}
const decoder = new TextDecoder("utf-8");
const data = Deno.readFileSync(options.filename);
const str = decoder.decode(data);
const out = compileClient(str, options);
if (options.cache) cache[key] = out;
return out;
}