anandarajpandey / Handlebars

Sublime Text 2 / 3 package for Handlebars.js templates.

Home Page:https://sublime.wbond.net/packages/Handlebars

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Sublime Text 2 / 3 Handlebars.js bundle

  • Colours of Handlebars expressions are selected to be in contrast with the surrounding HTML.
  • Handlebars expressions get syntax highlighting in HTML attributes.
  • Parameters passed to block expressions get syntax highlighting too.
  • Works both with individual template files and inline templates in script tags.
  • Key bindings for {{! Handlebars comments }}
  • Tab triggers for
    • if{{#if }}
    • ifel{{#if }} {{else}}
    • el{{else}}
    • un{{#unless }}
    • each{{#each }}
    • with{{#with }}
    • par{{> }} (for partials)
    • x-temp<script type="text/x-handlebars" data-template-name="$1"> (inline script tag in HTML files using the Ember recommended data-template-name attribute)
    • x-id<script type="text/x-handlebars-template" id="$1"> (inline script tag in HTML files using the legacy id attribute)

About Handlebars.js

It's a great JavaScript templating engine, based on Mustache, but adding the ability to precompile templates and to create custom helpers.

Official website: handlebarsjs.com

Installation

Get it through Sublime Package Control.

If you haven't used it yet, just install it from the link above and then:

  1. Press Shift + Command (or Control) + P
  2. Type "install", to bring up the "Package Control: Install Package" option, and press Enter
  3. Look for "Handlebars", and press Enter to install it.
  4. Choose "Handlebars" in the bottom right corner with one of your template files open (or in case you have inline templates use Handlebars instead of HTML, it's gracefully extending it so you shouldn't lose anything)
  5. Profit

Package Control will also auto-update the package from this point on!

Testing / contribution

I've recently stopped using Handlebars at my day job and became a father, so any contributions are more than welcome! I'm still using Github so will make sure to keep on being responsive on issues and pull requests.

There are some sample templates in test/ folder. It's possible to see the different supported and yet to be implemented use cases there.

If you want to work on the package you should install AAAPackageDev either from Github or from Package Control. With that you can edit the JSON version (Handlebars.JSON-tmLanguage) and let it export the Plist with the ST Build System.

The nicest development setup I found so far is to have the package installed via Package Control and then symlinking the development Git repo to Sublime settings folder > Packages, which then overrides the installed one so you can toggle between them easily.

Another great trick I found out about recently is the Show scope name shortcut (Shift + Control + P (OSX) or Shift + Control + Alt + P (Windows)) which will display the language scope on the status bar based on where your cursor is. If you're getting tired of pressing all these keys all the time, there are a few brilliant packages which do this automatically like the more subtle ScopeAlways or the full on ScopeHunter – note: both need to be activated via the Command Palette.

Resources on ST / Textmate syntax definitions:

http://docs.sublimetext.info/en/latest/extensibility/syntaxdefs.html http://manual.macromates.com/en/language_grammars

Precompilation

This package does not offer any Handlebars precompilation functionality to keep things simple, but you can use Guard (which is a file system watcher) and Guard-Steering (a Handlebars precompiler from yours truly) to have all templates precompiled as you save them.

There's also a Guard package for Sublime if you want integration, but I don't personally use this as I'm happy with Guard running in an iTerm window I can access from anywhere.

There are of course Node.js / Grunt based compilers too (like this), but I haven't personally used any yet.

Credits

Adapted from the great sublime-text-handlebars package by Nicholas Westlake.

Thanks a lot to all the generous contributors (in alphabetical order): bittersweetryan, bradcliffe, calumbrodie, jonschlinkert, Krutius, samselikoff, utkarshkukreti

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Sublime Text 2 / 3 package for Handlebars.js templates.

https://sublime.wbond.net/packages/Handlebars