Skip to content

Add basic documentation on what is and isn't checked by template check #4989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add basic documentation on what is and isn't checked by template check #4989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/reference/cli/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,12 @@ INFO mas_core::templates::check: Rendering template name="register.html" context
INFO mas_core::templates::check: Rendering template name="index.html" context={"csrf_token":"fake_csrf_token","current_session":{"active":true,"created_at":"2021-09-24T13:26:52.962135085Z","id":1,"last_authd_at":"2021-09-24T13:26:52.962135316Z","user_id":2,"username":"john"},"discovery_url":"https://example.com/.well-known/openid-configuration"}
...
```

What is checked:
- the Jinja templates are syntactically valid
- all translation keys exist

What is not checked:
- the validity of the generated HTML (you can forget closing tags, or otherwise create invalid HTML output)
- undefined variables (`{{ undefined_variable }}` will render as an empty string and not raise an error)
- all translation keys exist *in your intended language(s)* (so some translation keys may fall back to English)
Loading