Update README and package.json for fork
This commit is contained in:
parent
3c6b0fa167
commit
7df54fccbe
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"target": "convert_file",
|
||||
"source": "json",
|
||||
"target_format": "plist",
|
||||
"ext": "tmLanguage",
|
||||
"selector": "Handlebars.json"
|
||||
}
|
||||
143
README.md
143
README.md
|
|
@ -1,138 +1,15 @@
|
|||
# Atom and Sublime Text 2 / 3 Handlebars.js bundle
|
||||
# Sublime Text 3 Handlebars
|
||||
|
||||
- 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 }}` (Sublime only)
|
||||
- <kbd>Tab</kbd> triggers for
|
||||
- `if` → `{{#if }}`
|
||||
- `ifel` → `{{#if }} {{else}}`
|
||||
- `el` → `{{else}}`
|
||||
- `elif` → `{{else if }}`
|
||||
- `un` → `{{#unless }}`
|
||||
- `ea` → `{{#each }}`
|
||||
- `wi` → `{{#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)
|
||||
Forked from https://github.com/daaain/Handlebars, updated to Sublime-syntax and a bug fixed.
|
||||
|
||||
Since (as of February 2017) the syntax definitions in this repository are driving the highlights on [Github](https://github.com/github/linguist/tree/master/vendor) and in [Visual Studio Code](https://github.com/Microsoft/vscode/tree/master/extensions/handlebars), it's fair game to open issues related to either of these 😺
|
||||
At the time of writing, there is still discussion about fixing this upstream, leaving the future of this fork unclear.
|
||||
|
||||
## About Handlebars.js
|
||||
## Installation
|
||||
|
||||
It's a great JavaScript templating engine, based on [Mustache](http://mustache.github.com/), but amongst others adding the ability to precompile templates and to create custom helpers.
|
||||
Although not on Package Control, installation with git is very easy. Navigate to your Sublime Data directory. For help finding your data directory, see https://docs.sublimetext.io/guide/getting-started/basic-concepts.html#the-data-directory
|
||||
|
||||
Official website: [handlebarsjs.com](http://handlebarsjs.com/)
|
||||
|
||||
## Sublime Text installation
|
||||
|
||||
Get it through [Sublime Package Control](https://packagecontrol.io/).
|
||||
|
||||
If you haven't used it yet, just install it from the link above and then:
|
||||
|
||||
1. Press <kbd>Shift</kbd> + <kbd>Cmd</kbd> + <kbd>P</kbd> (OS X) or <kbd>Shift</kbd> + <kbd>Ctrl</kbd> + <kbd>P</kbd> (Windows)
|
||||
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!
|
||||
|
||||
## Atom installation
|
||||
|
||||
1. Open Preferences > Install
|
||||
2. Type `Handlebars` into the search field
|
||||
3. Click the Install button
|
||||
4. Disable the core `language-mustache` package so that it doesn't prevent this package to be used automatically with the supported file extensions
|
||||
|
||||
## Known problems and workarounds
|
||||
|
||||
### Sublime: No auto-complete on closing HTML tags ([#23](https://github.com/daaain/Handlebars/issues/23) & [#49](https://github.com/daaain/Handlebars/issues/49))
|
||||
|
||||
**Problem**: when closing an HTML tag, the tag name doesn't get auto-completed after typing <kbd>/</kbd> (or when using the <kbd>Cmd</kbd> + <kbd>Alt</kbd> + <kbd>.</kbd> (OS X) shortcut anywhere), even though this is the default behaviour with the HTML package.
|
||||
|
||||
**Solution**: installing the [Tag](https://packagecontrol.io/packages/Tag) package re-instates these functionalities and seems to be working well with this one.
|
||||
|
||||
### Sublime: HTML tag pair doesn't get highlighted ([#48](https://github.com/daaain/Handlebars/issues/48))
|
||||
|
||||
**Problem**: moving the cursor over an HTML tag doesn't highlight its pair.
|
||||
|
||||
**Solution**: installing the [BracketHighlighter](https://packagecontrol.io/packages/BracketHighlighter) package nicely solves the problem and adds much more powerful bracket matching than the built-in one.
|
||||
|
||||
### Sublime: Expand selection to tag doesn't work ([#47](https://github.com/daaain/Handlebars/issues/47))
|
||||
|
||||
**Problem**: Expanding selection to tag doesn't work (Sublime command: `expand_selection {"to": "tag"}`).
|
||||
|
||||
**Solution**: if you install the [Emmet](https://packagecontrol.io/packages/Emmet) package you can use the `Match Tag Pair` functionality by pressing <kbd>Ctrl</kbd> + <kbd>D</kbd> (OS X) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>A</kbd> (Windows).
|
||||
|
||||
### Sublime: `.sublime-build` in the build system menu ([#73](https://github.com/daaain/Handlebars/issues/73))
|
||||
|
||||
**Problem**: a useless and confusing item named `.sublime-build` is added to the build system menu. This is because the package internally uses a custom build configuration to be able to target both Atom and Sublime and this gets exposed. Though it's only needed for development, Sublime doesn't seem to offer an option to hide this as the package gets installed.
|
||||
|
||||
**Solution**: delete the file from the package by running `zip -d Handlebars.sublime-package ".sublime-build"` in the folder it's installed or by any other means.
|
||||
|
||||
## Testing / contribution
|
||||
|
||||
I've recently stopped heavily 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.
|
||||
|
||||
### Sublime Text
|
||||
|
||||
If you want to work on the package you should install PackageDev either [from Github](https://github.com/SublimeText/PackageDev) or from Package Control. With that you can edit the JSON version (`grammars/Handlebars.json`) and let it export the Plist (`grammars/Handlebars.tmLanguage`) 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 (<kbd>Shift</kbd> + <kbd>Ctrl</kbd> + <kbd>P</kbd> (OS X) or <kbd>Shift</kbd> + <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>P</kbd> (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](https://sublime.wbond.net/packages/ScopeAlways) or the full on [ScopeHunter](https://sublime.wbond.net/packages/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
|
||||
|
||||
### Atom
|
||||
|
||||
To see what scope Atom detects under the keyboard cursor, press <kbd>Option</kbd> + <kbd>Cmd</kbd> + <kbd>P</kbd>.
|
||||
|
||||
To publish a new version to atom.io the command is: `apm publish [<newversion> | major | minor | patch | build]`
|
||||
|
||||
TODO: add contribution notes
|
||||
TODO: add proper testing based on specs in https://github.com/atom/language-mustache and https://github.com/Sneagan/atom-handlebars
|
||||
|
||||
## Precompilation
|
||||
|
||||
This package does not offer any Handlebars precompilation functionality to keep things simple, but you can use [Guard](https://github.com/guard/guard) (which is a file system watcher) and [Guard-Steering](https://github.com/guard/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](https://github.com/cyphactor/sublime_guard) 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 / Gulp based compilers too ([like this](https://npmjs.org/package/grunt-handlebars-js) and [this](https://www.npmjs.com/package/gulp-compile-handlebars)), but I haven't personally used any yet for precompilation.
|
||||
|
||||
## Credits
|
||||
|
||||
Adapted from the great [sublime-text-handlebars](https://github.com/nrw/sublime-text-handlebars) package by Nicholas Westlake.
|
||||
|
||||
Thanks a lot to all the [generous contributors](https://github.com/daaain/Handlebars/graphs/contributors)!
|
||||
|
||||
## 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.
|
||||
Then, in a Unix-like shell:
|
||||
```sh
|
||||
Sublime Text$ cd Packages
|
||||
Packages$ git clone https://tildegit.org/matthias/Sublime-Handlebars
|
||||
```
|
||||
|
|
|
|||
11
package.json
11
package.json
|
|
@ -1,11 +1,8 @@
|
|||
{
|
||||
"name": "Handlebars",
|
||||
"version": "1.9.0",
|
||||
"description": "Fullest Handlebars syntax support for Atom",
|
||||
"repository": "https://github.com/daaain/Handlebars",
|
||||
"name": "Sublime Handlebars",
|
||||
"version": "2.0.0",
|
||||
"description": "Handlebars syntax support for Sublime Text 4",
|
||||
"repository": "https://tildegit.org/matthias/Sublime-Handlebars",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"atom": ">0.50.0"
|
||||
},
|
||||
"dependencies": {}
|
||||
}
|
||||
|
|
|
|||
Reference in New Issue