exp:exptemplatecheck

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

Check templates of every engine (.tpl, .stpl, .twig, .html.twig) for valid syntax: files, directories, designs, extensions, siteaccesses; levels syntax/compile/strict; text, json, jsonl, junit, checkstyle, github and sarif output

Usage

./console exp:exptemplatecheck [options]
php bin/php/exptemplatecheck.php [options]
./console exp:template:check [options]
./console exp:template:lint [options]
./console exp:template:convert:check [options]

Aliases

exp:template:check, exp:template:lint, exp:template:convert:check

Help

The output of ./console help exp:exptemplatecheck (the script run with --help), without the standard options:

Usage: bin/php/exptemplatecheck.php [OPTION]... [TARGET]...
Check templates of every template engine for valid syntax
Exponential templates (.tpl), Smarty templates (.stpl) and Twig templates (.twig, .html.twig), each by
its own parser and compiler with the bridge loaded. Targets: files and directories (TARGET ...), '-' for
stdin, --design, --design-dir, --extension, --extensions, --siteaccess, --all-siteaccesses; nothing:
the current siteaccess's design chain. Nothing is written: compiled output goes to a private directory.

./console exp:template:check design/standard/templates/node/view/full.tpl
./console exp:template:check --design=<design> --level=strict
./console exp:template:check --siteaccess=<siteaccess> --format=json --output=var/tmp/check.json
./console exp:template:check --changed-since=HEAD --format=github
./console exp:template:check --rules

Levels: syntax (the parser), compile (the default: + compiled and the compiled PHP linted), strict
(+ the security policy, includes resolved, unknown operators). Every finding has a rule id
(--rules, --explain=<id>). Aliases: exp:template:lint, exp:template:convert:check.
Exit code: 0 all passed; 1 a finding at or above --fail-on; 2 usage error; 3 an engine needed is
unavailable (unless --allow-missing-engine); 4 internal error.


Options:
  --design=VALUE...          a design by name, in the kernel and in the (active) extensions; repeatable
  --design-dir=VALUE...      a design directory by path; repeatable
  --extension=VALUE...       every design of the extension; repeatable
  --extensions               every design of every active extension
  --all-extensions           with --design/--extensions: the inactive extensions on disk too
  --all-siteaccesses         every siteaccess of AvailableSiteAccessList
  --engine=VALUE             all (the default) or a list: tpl,stpl,twig
  --suffix-map=VALUE...      <ending>:<engine>, an extra file ending (.tpl.html:tpl); repeatable
  --level=VALUE              syntax, compile (the default) or strict
  --security                 check against the engine's security policy (on at strict)
  --includes                 every design: include must resolve (on at strict)
  --overrides                every override rule must point to an existing template (on with --siteaccess)
  --parity=VALUE             report templates present in two engines; =render is experimental
  --deprecations             report deprecated constructs (Twig deprecations while compiling)
  --encoding                 UTF-8 validity, byte order mark, mixed line endings
  --max-depth=VALUE          include depth for --includes (default 32)
  --format=VALUE             text (the default), json, jsonl, junit, checkstyle, github or sarif
  --output=VALUE             write the machine format to this file; the console keeps the text
  --color=VALUE              auto, always or never
  --no-progress              no progress counter
  --progress                 a progress counter on a terminal
  --summary-by=VALUE         group the summary by engine, design, extension, siteaccess or directory
  --fail-on=VALUE            the severity that fails: error (the default), warn or note
  --baseline=VALUE           report only findings that are not in this baseline file
  --generate-baseline=VALUE  write today's findings to this baseline file
  --ignore=VALUE...          a glob of files to leave out; repeatable (site.ini [TemplateCheckSettings] IgnoreList[] too)
  --rules                    list every rule id and exit
  --explain=VALUE            explain one rule id and exit
  --schema=VALUE             the machine output schema version (1)
  --stdin-engine=VALUE       the engine of the template read from stdin (-): tpl, stpl or twig
  --stdin-name=VALUE         the name of the template read from stdin, for the messages
  --allow-missing-engine     an unavailable engine does not make the exit code 3
  --keep-compiled            keep the private directory of compiled output for inspection
  --jobs=VALUE               check in this many worker processes
  --changed-since=VALUE      only the templates changed since this git reference (and untracked ones)
  --files-from=VALUE         check the files listed in this file, one per line (- for stdin)

Options

Arguments

[TARGET*]

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/exptemplatecheck.php, kernel/private/classes/commands/exptemplatecheck.php

See also

Generated example: exp:exptemplatecheck

Added to the reference for Exponential 6.0.15.