Package org.apache.juneau.console.freemarker

Class ConsoleTemplateValidator

java.lang.Object

org.apache.juneau.console.freemarker.ConsoleTemplateValidator

public final class ConsoleTemplateValidator
extends Object

Static lint for console FreeMarker templates. Scans each template for console directive calls and reports unknown directives, unknown attributes, dangling template references, duplicate nav and card ids, non-strict booleans, removed card types and globals, a chart card whose ECharts WebJar is missing (E-70), and a wrong <@main/> count, without rendering any page.

The attribute sets are the same ones the directives enforce at render time. Interpolated values (visible="${x}") and unquoted expressions (visible=flag) are skipped; the render-time errors cover them. Macros defined in the template, in literally <#include>d templates and in the chrome template are in scope, as are <@ns.x> calls on an <#import … as ns> namespace.

Example:

@Test void templatesLint() { List<ConsoleTemplateValidator.Finding> f = ConsoleTemplateValidator.create() .templateRoot(Paths.get("src/main/resources/templates")) .chromeTemplate("base.ftlh") .allowDirective("pageHero") .validateAll(); assertTrue(f.isEmpty(), f::toString); }

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ConsoleTemplateValidator.Finding	One lint finding.

Method Summary

Modifier and Type	Method	Description
ConsoleTemplateValidator	allowDirective(String name)
ConsoleTemplateValidator	chromeTemplate(String name)
ConsoleTemplateValidator	classpathRoot(String prefix)
static ConsoleTemplateValidator	create()
ConsoleTemplateValidator	templateRoot(Path dir)
List<ConsoleTemplateValidator.Finding>	validate(String templateName)
List<ConsoleTemplateValidator.Finding>	validateAll()	Lints every *.ftlh and *.ftl file under the template root.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static ConsoleTemplateValidator create()

Returns:

A new validator with no roots.

templateRoot

public ConsoleTemplateValidator templateRoot(Path dir)

Parameters:

dir - The file-system directory templates are resolved against and validateAll() walks.

Returns:

This object.

classpathRoot

public ConsoleTemplateValidator classpathRoot(String prefix)

Parameters:

prefix - The classpath prefix templates are resolved against when not found under the template root, for example "/templates/".

Returns:

This object.

chromeTemplate

public ConsoleTemplateValidator chromeTemplate(String name)

Parameters:

name - The chrome template the <@page> directive renders. Its macros are in scope for every template.

Returns:

This object.

allowDirective

public ConsoleTemplateValidator allowDirective(String name)

Parameters:

name - An adopter-defined directive or macro name to accept, for example "pageHero".

Returns:

This object.

validate

public List<ConsoleTemplateValidator.Finding> validate(String templateName)

Parameters:

templateName - The template to lint, relative to the template root or classpath root.

Returns:

The findings, sorted by line and column. Empty when the template is clean.

Throws:

IllegalArgumentException - If the template cannot be found.

validateAll

public List<ConsoleTemplateValidator.Finding> validateAll()

Lints every *.ftlh and *.ftl file under the template root.

Returns:

The findings, sorted by template, line and column. Empty when every template is clean.

Throws:

IllegalStateException - If no template root is set.