/
pug.ts
121 lines (100 loc) 路 3.04 KB
/
pug.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
import { compile } from "../deps/pug.ts";
import { join } from "../deps/path.ts";
import loader from "../core/loaders/text.ts";
import { merge } from "../core/utils.ts";
import type {
Data,
DeepPartial,
Engine,
Helper,
HelperOptions,
Site,
} from "../core.ts";
import type { Options as PugOptions } from "../deps/pug.ts";
export interface Options {
/** The list of extensions this plugin applies to */
extensions: string[] | {
pages: string[];
components: string[];
};
/** Custom includes path for Pug */
includes: string;
/** Options passed to Pug */
options: PugOptions;
}
// Default options
export const defaults: Options = {
extensions: [".pug"],
includes: "",
options: {},
};
type Compiler = typeof compile;
/** Template engine to render Pug files */
export class PugEngine implements Engine {
options: PugOptions;
compiler: Compiler;
cache = new Map<string, (data?: Data) => string>();
basePath: string;
constructor(compiler: Compiler, basePath: string, options: PugOptions = {}) {
this.compiler = compiler;
this.options = options;
this.basePath = basePath;
}
deleteCache(): void {
this.cache.clear();
}
render(content: string, data?: Data, filename?: string): string {
return this.renderSync(content, data, filename);
}
renderSync(content: string, data?: Data, filename?: string): string {
if (!filename) {
return this.compiler(content, this.options)(data);
}
if (!this.cache.has(filename)) {
this.cache.set(
filename,
this.compiler(content, {
...this.options,
filename: join(this.basePath, filename),
}),
);
}
return this.cache.get(filename)!(data);
}
addHelper(name: string, fn: Helper, options: HelperOptions) {
switch (options.type) {
case "filter": {
this.options.filters ||= {};
const filter = (text: string, opt: Record<string, unknown>) => {
delete opt.filename;
const args = Object.values(opt);
return fn(text, ...args);
};
this.options.filters[name] = filter as Helper;
return;
}
}
}
}
/** Register the plugin to use Pug as a template engine */
export default function (userOptions?: DeepPartial<Options>) {
return (site: Site) => {
const options = merge(
{ ...defaults, includes: site.options.includes },
userOptions,
);
options.options.basedir = site.src(options.includes);
const extensions = Array.isArray(options.extensions)
? { pages: options.extensions, components: options.extensions }
: options.extensions;
const engine = new PugEngine(compile, site.src(), options.options);
site.loadPages(extensions.components, loader, engine);
site.includes(extensions.pages, options.includes);
site.loadComponents(extensions.components, loader, engine);
// Register the pug filter
site.filter("pug", filter as Helper, true);
function filter(string: string, data?: Data) {
return engine.render(string, { ...site.globalData, ...data });
}
};
}