Feature request: add support for Django / Jinja templates about shiki HOT 8 CLOSED

Alright, that makes a lot of sense :) I'll try to get something up this weekend

from shiki.

I'm looking into this but I have a question. I found this repo which includes a lot of syntaxes for various combinations of Jinja with other languages.

This works just fine in VS Code due to file extensions but with shiki there's a need for explicitly specifiying which language to use for tokenization. Which means that to have JS syntax highlighting within a Jinja template you'd have to pass jinja-js which wouldn't necessarily work with CSS highlighting within the same file.

The question is what is the desired API? Do we want to have things work automagically when we just pass jinja as the language or is it OK if we expect the user to specify which one they want to use specifically (like jinja-js or jinja-css)? I can't think of an easy way to implement the first one and the second one is a bit limited because you'd have to add a new syntax file for every combination you would want to use.

Or we just add Jinja's raw syntax and leave it at that. Thoughts?

from shiki.

At least for me during past ~15 years of Django development, most code involving Djano/Jinja templates have mostly or fully been HTML-only (not including special cases when you're intentionally writing something special w/ other languages but usually no code formatter works in those cases).

I'm not sure what's the difference between first case and just implementing the raw Jinja syntax? I think the initial solution could (and should) be as simple as possible, and if someone needs a more fine-tuned API, they can file a new ticket for the specific use case which then can be evaluated case by case. In other words, the basic use case would be jinja-html or whatever the base Jinja syntax is :)

from shiki.

I'm not sure if something is missing, but this doesn't look right and I'm not familiari with Jinja.

I'm using:
https://github.com/samuelcolvin/jinjahtml-vscode/blob/master/syntaxes/jinja.tmLanguage.json

from shiki.

Indeed, no, it does not look right. Jinja is a superset of Django templates, most Django (vscode) plugins seem to get the syntax right.

Although, as with all templates and colorizations, it's also somewhat of opinion as well...

from shiki.

It seems django can generate any text file and has no strict grammar. How should it be highlighted then?

from shiki.

Well that is true in the sense that Django is just a tool like Vue, but Django templates do have a strictly defined grammar just as Vue templates do. (You can opt-out from using the template language but obviously then you're not expecting to use template highlighter tools either.)

I'm not really sure how Django templates are defined, though. I'm sorry if my previous comment was misleading. I meant that the styling (theme) of the syntax highlighting is a matter of opinion, not the syntax itself. (In the posted example above the HTML is not properly highlighted for example, but most Django template tools do highlight HTML as it should be in my opinion.)

If it helps I can dig up the source for Django templates or maybe some examples of vscode plugins? I'm not an expert of these matters by any means but I'm happy to help in any way I can.

from shiki.

OK, I added jinja-html lang:

from shiki.