spadgos / sublime-jsdocs

Simplifies writing DocBlock comments in Javascript, PHP, CoffeeScript, Actionscript, C & C++

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DocBlock for SASS/Jinja2?

dschu-lab opened this issue Β· comments

First of all, I want to thank all of you for this great plugin.
It helps me everyday at work and since I installed it I can't life a day without it anymore. πŸ‘
I'm currently in a project and I would like to extend your plugin for SASS & Jinja Templates, but I've never written a plugin for sublime. However, I'm familiar with python and would like to support you.

Questions are:

  • How to start? Do I just need to add a scss.sublime-completions file?
  • Jinja2 needs {# ... #} instead of /* ... */ – How to do that? Can't find it in coffee.sublime-completions?

Cheers,
dschu

Do I just need to add a scss.sublime-completions file?

I think so, yeah. It's been quite a while since I touched this part of the plugin.

Jinja2 needs {# ... #} instead of /* ... */ – How to do that?

Take a look in the keymap file. This contains the regex which triggers DocBlockr to do its thing. https://github.com/spadgos/sublime-jsdocs/blob/master/Default.sublime-keymap#L8 You'd then need to add a language class in jsdocs.py. Take a look how the others have been done here https://github.com/spadgos/sublime-jsdocs/blob/master/jsdocs.py#L58-L74

πŸ‘ for support SassDoc syntax support

πŸ‘ for Jinja and Sass support!

+1 sassdoc

I guess it will be more appropriate to move Sass or Jinja language support request into standalone issue.

Also, to note, same syntax could be applied to Nunjucks, Twig and Swig. So, community of that addition will be quite larger than just for Jinja :)