search

osoco / sublimetext-grails

Grails support for Sublime Text
75 stars 21 forks source link

Supported .gdoc as GrailsDoc #3

Closed nobeans closed 11 years ago

nobeans commented 11 years ago

I added a support for .gdoc based on Textile package.

gcrick commented 11 years ago

Thanks, looks good! I've merged in your pull request with only a couple of small changes. First, no change was needed in SyntaxDetector.py because the .tmLanguage file already takes care of detecting the file extension. Second, I changed the scope to source.grails.gdoc because gdoc doesn't really inherit from groovy source code. I would have liked to use text.html.textile.gdoc, but this breaks the snippets due to the way the HTML plugin works. Please let me know if it works for you like this.

nobeans commented 11 years ago

No problem for your changes. Thanks a lot!

First, no change was needed in SyntaxDetector.py because the .tmLanguage file already takes care of detecting the file extension.

I understand as below: .groovy file is used for some artifacts and the individual syntax are needed for each artifact. So SyntaxDetector.py is needed for .groovy. But .gdoc is used only for src/docs, so fileType of .tmLanguage is enough.

Second, I changed the scope to source.grails.gdoc because gdoc doesn't really inherit from groovy source code. I would have liked to use text.html.textile.gdoc, but this breaks the snippets due to the way the HTML plugin works. Please let me know if it works for you like this.

source.grails.gdoc is certainly better than source.grails.groovy.gdoc. About text.html.text.gdoc, I guess that there are no support of html tag in gdoc syntax. At least, so far, I haven't ever thought that I want to use html tags. So source.grails.gdoc seems better for me.

cf. http://grails.org/doc/latest/guide/conf.html#docengine

gcrick commented 11 years ago

Exactly :) I only wanted to use text.html.textile.gdoc so that the snippets in the textile plugin would also work in gdoc, but I can't seem to get them to work even in a normal textile file, so there is really no point. Btw, I've added some extra snippets for gdoc that you might find useful (based on the documentation you linked to).

nobeans commented 11 years ago

Great! It's just what I wanted. Thanks!