-
Notifications
You must be signed in to change notification settings - Fork 22
/
templateAnalysis.ts
110 lines (98 loc) · 3.29 KB
/
templateAnalysis.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
/*
* Copyright (C) 2023 PixieBrix, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import {
type Analysis,
type AnalysisAnnotation,
} from "@/analysis/analysisTypes";
import { type BrickPosition } from "@/bricks/types";
import { isMustacheOnly } from "@/components/fields/fieldUtils";
import { Template } from "nunjucks";
import PipelineExpressionVisitor from "@/bricks/PipelineExpressionVisitor";
import { type ModComponentFormState } from "@/pageEditor/starterBricks/formStateTypes";
import { type Expression } from "@/types/runtimeTypes";
import { AnnotationType } from "@/types/annotationTypes";
import {
isNunjucksExpression,
isTemplateExpression,
} from "@/utils/expressionUtils";
const TEMPLATE_ERROR_MESSAGE =
"Invalid text template. Read more about text templates: https://docs.pixiebrix.com/developing-mods/developer-concepts/text-template-guide";
type PushAnnotationArgs = {
position: BrickPosition;
message: string;
expression: Expression<unknown>;
};
class TemplateAnalysis extends PipelineExpressionVisitor implements Analysis {
get id() {
return "template";
}
protected readonly annotations: AnalysisAnnotation[] = [];
getAnnotations(): AnalysisAnnotation[] {
return this.annotations;
}
run(extension: ModComponentFormState): void {
this.visitRootPipeline(extension.extension.blockPipeline, {
extensionPointType: extension.type,
});
}
private pushErrorAnnotation({
position,
message,
expression,
}: PushAnnotationArgs) {
this.annotations.push({
position,
message,
analysisId: this.id,
type: AnnotationType.Error,
detail: expression,
});
}
override visitExpression(
position: BrickPosition,
expression: Expression<unknown>,
): void {
if (!isTemplateExpression(expression)) {
return;
}
// We don't want to show duplicated message,
// even if both conditions are true
if (
expression.__type__ !== "mustache" &&
isMustacheOnly(expression.__value__)
) {
this.pushErrorAnnotation({
position,
message: TEMPLATE_ERROR_MESSAGE,
expression,
});
} else if (isNunjucksExpression(expression)) {
try {
// eslint-disable-next-line no-new
new Template(expression.__value__, undefined, undefined, true);
} catch (error) {
// @ts-expect-error nunjucks error does have message property
const failureCause = (error.message as string)
?.replace("(unknown path)", "")
.trim();
const message = `Invalid template: ${failureCause}.`;
this.pushErrorAnnotation({ position, message, expression });
}
}
}
}
export default TemplateAnalysis;