templates: Be strict about undefined variables #5201
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We shouldn't have any reason to use undefined variables in MAS, so silently printing as empty strings (etc) seems undesirable. This will also be helpful for operators with custom templates, since then they will notice their templates being broken.
Deploying matrix-authentication-service-docs with
|
| Latest commit: |
eeeec35
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://abacde21.matrix-authentication-service-docs.pages.dev |
| Branch Preview URL: | https://rei-templatecheck-stricter.matrix-authentication-service-docs.pages.dev |
sandhose
reviewed
Oct 27, 2025
templates/components/footer.html
Outdated
| {%- endif -%} | ||
|
|
||
| {%- if branding.tos_uri -%} | ||
| {%- if branding.tos_uri is defined -%} |
Member
There was a problem hiding this comment.
This scares me a little bit, we don't have 100% coverage of templates with the samples, so we might have missed some spots. What about using SemiStrict instead, which allows for if undefined?
Contributor
Author
There was a problem hiding this comment.
Changed my mind on this: how about using is none instead? So we never make fields undefined, just none/nullable. I think this would offer even more typo resistance than is_defined
Member
There was a problem hiding this comment.
Agreed on using none instead of undefined, but the point that this PR might break other stuff still stands
Contributor
Author
There was a problem hiding this comment.
Yeah OK, this is going to be gnarly, I've downgraded in 20a13f4
reivilibre
force-pushed
the
rei/templatecheck_stricter
branch
from
20a13f4 to
eeeec35
Compare
sandhose
approved these changes
Oct 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the template engine is lax about undefined variables, meaning typos become silent rendering issues.
By switching to the strict undefined variable behaviour, we can make these issues noisier and easier to notice.
This also makes the
templates checkcommand more useful.