summaryrefslogtreecommitdiff
path: root/node_modules/@11ty/eleventy/src/Data/ComputedDataTemplateString.js
blob: d5241b23ef46fa40a23ad0057aca562ce1257334 (plain)
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
import lodash from "@11ty/lodash-custom";
import debugUtil from "debug";

const { set: lodashSet } = lodash;
const debug = debugUtil("Eleventy:ComputedDataTemplateString");

/* Calculates computed data in Template Strings.
 * Ideally we would use the Proxy approach but it doesn’t work
 * in some template languages that visit all available data even if
 * it isn’t used in the template (Nunjucks)
 */
class ComputedDataTemplateString {
	constructor(computedKeys) {
		if (Array.isArray(computedKeys)) {
			this.computedKeys = new Set(computedKeys);
		} else {
			this.computedKeys = computedKeys;
		}

		// is this ¯\_(lisp)_/¯
		// must be strings that won’t be escaped by template languages
		this.prefix = "(((11ty(((";
		this.suffix = ")))11ty)))";
	}

	getProxyData() {
		let proxyData = {};

		// use these special strings as a workaround to check the rendered output
		// can’t use proxies here as some template languages trigger proxy for all
		// keys in data
		for (let key of this.computedKeys) {
			// TODO don’t allow to set eleventyComputed.page? other disallowed computed things?
			lodashSet(proxyData, key, this.prefix + key + this.suffix);
		}

		return proxyData;
	}

	findVarsInOutput(output = "") {
		let vars = new Set();
		let splits = output.split(this.prefix);
		for (let split of splits) {
			let varName = split.slice(0, split.indexOf(this.suffix) < 0 ? 0 : split.indexOf(this.suffix));
			if (varName) {
				vars.add(varName);
			}
		}
		return Array.from(vars);
	}

	async findVarsUsed(fn) {
		let proxyData = this.getProxyData();
		let output;
		// Mitigation for #1061, errors with filters in the first pass shouldn’t fail the whole thing.
		try {
			output = await fn(proxyData);
		} catch (e) {
			debug("Computed Data first pass data resolution error: %o", e);
		}

		// page.outputPath on serverless urls returns false.
		if (typeof output === "string") {
			return this.findVarsInOutput(output);
		}
		return [];
	}
}

export default ComputedDataTemplateString;