Customizable comments

[Solanar]

Description of your enhancement/feature request proposal.

Really liking everything so far, after Djaneiro and django-sublime-syntax stopped working this has been a relief.

My only issue so far is that Jinja comments are different from Django template comments, Django comments for single lines are {# ... #} and {% comment %}...{% endcomment %} for blocks. Is there a way to override these? (other than forking of course) Thanks.

Alternatives.

I'm not sure if this feature exists within sublime already, but adding to the docs if there's a way to do this would be helpful. I'm not sure if a dedicated syntax file is required for this either.

[deathaxe]

All of Jinja, Liquid and Twig scope comment and endcomment as ordinary tags because they are not just punctuation like {# or #}, but normal statement tags, which treat content in between special - ignoring it. Can be compared with raw tags to some degree.

Hence scoping whole {% comment %} just punctuation.definition.comment is syntactically and semantically wrong.

Beyond that it might be desirable to ensure evaluated tags are highlighted different then those just belonging to comment content.

{% comment "begin of comment" %}
{% comment "just comment content, not evaluated" %}
{% endcomment "end of comment" %}

As comment tags don't receive dedicated scopes to distinguish them, any attempt to add dedicated highlighting requires a syntax definition change (of all affected languages).

An easy change might be to scope comment and endcomment special to enable color schemes to assign dedicated colors. This wouldn't affect surrounding {%..%} punctuation nor optional description texts though.

Current implementation ties them pretty strict to ordinary statement tags {% ... %}.

It is theoretically possible to extend syntaxes to override existing rules. This is how all syntaxes of this package are built like - by extending default syntaxes shipped with ST and adding rules for Jinja tags. It might be possible to override certain rules by creating another Text (Jinja).sublime-syntax which extends on the existing one, but i doubt that's desirable.

[Solanar]

The syntax highlighting for {% comment %}...{% endcomment %} works fine, ideally the start/end tags would also be green (or whatever comment colour has been selected), but that's not my main sticking point.

I was asking if there's a way to change or override commenting out lines via ctrl + / or ctrl + shift + / as it doesn't match Django template comments: {# ... #} doesn't work over multiple lines and ## is not a comment.

[deathaxe]

ST's default toggle_comment...

1. is not able to implicitly distinguish multiple block comment-like expressions such as {# #} and {% comment %}...{% endcomment %}. It would toggle the first, only, unless a variant argument was provided via key binding. The latter works either globally or would require distinction of jinja vs. django files to do so automatically.

2. requires {% comment %} and {% endcomment %} to be scoped comment.block punctuation.definition.comment. With current syntax definition, it would be able to add those tags, but would not be able to remove them again.

A plugin could provide a custom django_toggle_comment text command, with a key binding overriding default toggle comment in appropriate context. It would still require an alias syntax to assign a dedicated django main scope for the binding to know when to fire.

[deathaxe]

A naive keybinding only way to toggle django block comments would be something like:

[
	{
		"keys": ["ctrl+/"],
		"command": "insert_snippet",
		"args": {
			"contents": "{% comment %}\n${0:$SELECTION}\n{% endcomment %}"
		},
		"context": [
			{ "key": "selector", "operand": "meta.template.jinja - meta.template.jinja meta.embedded - meta.template.jinja string - meta.template.jinja comment" },
		],
	},
	{
		"keys": ["ctrl+/"],
		"command": "chain",
		"args": {
			"commands": [
				{ "command": "expand_selection", "args": {"to": "scope"} },
				{ "command": "swap_line_down" },
				{ "command": "move", "args": {"by": "characters", "forward": false} },
				{ "command": "delete_line_before" },
				{ "command": "delete_line_before" },
			]
		},
		"context": [
			{ "key": "selector", "operand": "meta.template.jinja comment.block.jinja.django" },
		],
	},
]

Also note, comment snippets are available via jcomment trigger.