Usage with Django templates

[knyghty]

Check for existing issues

• Completed

Describe the feature

I looked through previous issues and found similar things but not exactly this. For example, for Hugo etc. templates I think in the past you've suggested rendering the static site first. With Django templates, but also Jinja, etc. this isn't really an option.

I thought of the following workarounds:

• Strip all template language stuff from the templates and run vale against that, but seems very hacky.
• Write tests to render each template and run vale against this using --built, would be way too slow, was planning this as a pre-commit hook.
• Inline directves, looks awful, doesn't scale well, adds noise.
• Run against the gettext catalogue instead - works for my current project since we have i18n enabled, but would miss the comments in the files.

I did manage to look through the code and get something that seems to work well without any obvious footguns without much code - but I get the feeling from reading older issues that this is more of a philosophical choice?

Could you let me know if you'd be interested in a contribution here, or alternatively, if there's a workaround I haven't thought of?

[jdkato]

I'm not sure I understand what you're asking. You want to run Vale on the templates themselves or on an file format with them embedded (like the Hugo case)?

Could you give an example?

[knyghty]

If I understand you correctly, the templates themselves.

Usually Django templates are given the extension of the file format it gets rendered to, so in 99% of cases this is .html but can be .txt for say emails, or anything else really. So being able to use TokenIgnores and BlockIgnores here would be really useful.

So for example I might have a simple template:

{% comment %}A comment could look like this.{% endcomment %}
{# Or like this. #}
<p>And some content</p>
<p>With a {{ variable.from.somewhere }}.</p>
<p>{% translate "Or translated content" %}</p>
<p>
  {% blocktranslate %}
    For longer stuff or if there's {{ varables }}.
    Etc.
  {% endblocktranslate %}
</p>
<p>
  And the final spelling I'll pull from the docs directly:
  {% some_tag _("Page not found") value|yesno:_("yes,no") %}
</p>

And ideally I'd love to be able to lint the prose in the comments and content. At the moment if I try this it lints the variables and such as if they're prose, which causes a lot of errors because, well, it isn't prose.