Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonsmithers/vim-html-template-literals
Syntax highlighting for html template literals in javascript (as in lit-html and polymer 3)
https://github.com/jonsmithers/vim-html-template-literals
javascript js lit-element lit-html litelement polymer-3 syntax-highlighting tagged-template-literals template-literals vim
Last synced: about 1 month ago
JSON representation
Syntax highlighting for html template literals in javascript (as in lit-html and polymer 3)
- Host: GitHub
- URL: https://github.com/jonsmithers/vim-html-template-literals
- Owner: jonsmithers
- License: mit
- Created: 2018-03-18T16:20:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T20:55:38.000Z (3 months ago)
- Last Synced: 2024-09-14T11:55:03.328Z (3 months ago)
- Topics: javascript, js, lit-element, lit-html, litelement, polymer-3, syntax-highlighting, tagged-template-literals, template-literals, vim
- Language: Vim Script
- Homepage:
- Size: 86.9 KB
- Stars: 71
- Watchers: 6
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-lit - vim-html-template-literals - Syntax highlighting and indentation for HTML inside of tagged template literals. (Tools / IDE Plugins)
README
# HTML Template Literals
Syntax highlighting and indentation for html inside of tagged template
literals, as seen in [lit-html] and [Polymer 3].
[lit-html]: https://lit-html.polymer-project.org
[Polymer 3]: https://polymer-library.polymer-project.org/3.0/docs/about_30
## Supported Syntaxes inside ``html`...` ``
- HTML (including CSS embedded in `` tags)
- JavaScript string interpolation (`${...}`)
- nested templates (``` html`${html`${}`}` ```)
See [Configuration](#configuration) for support for css tagged literals (``css`...` ``).
## Installation
This plugin requires [vim-javascript] (or [typescript-vim] if you're using
typescript). If you use [vim-plug] for package management, installation looks
like this:
[vim-javascript]: https://github.com/pangloss/vim-javascript
[typescript-vim]: https://github.com/leafgarland/typescript-vim
[vim-plug]: https://github.com/junegunn/vim-plug
```vim
Plug 'jonsmithers/vim-html-template-literals'
Plug 'pangloss/vim-javascript'
```
_NOTE_: it's generally a good idea to have `let g:html_indent_style1 = "inc"`
in your vimrc for reasonable indentation of `<style>` tags. See `:help
html-indenting`.
## Configuration
| Flag | Description |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `g:htl_css_templates` | Enable css syntax inside css-tagged template literals (`` css`...` ``). Indentation behavior is currently not implemented. |
| `g:htl_all_templates` | (Experimental) Enable html syntax inside _all_ template literals (`` `...` ``). |
| `g:htl_tag_names` | (Experimental) Specify the tag names in which to enable html syntax highlighting (default `['html']`). |
## Known Issues
- Indentation in general still has some kinks. If you see an issue, please
report it.
- This plugin conflicts a bit with vim-jsx. Having both installed
simultaneously may result in undesired indentation behaviors.
- A patch in vim 8.1 introduced native typescript support in Vim. However, its
region definitions are less precise and it's not easy to translate
vim-html-template-literals indentation behavior to work with Vim's native
typescript region definitions.
## Tips
- You can configure the [vim-closetag] plugin to work inside html template
literals:
```vim
let g:closetag_filetypes = 'html,xhtml,phtml,javascript,typescript'
let g:closetag_regions = {
\ 'typescript.tsx': 'jsxRegion,tsxRegion,litHtmlRegion',
\ 'javascript.jsx': 'jsxRegion,litHtmlRegion',
\ 'javascript': 'litHtmlRegion',
\ 'typescript': 'litHtmlRegion',
\ }
```
[vim-closetag]: https://github.com/alvan/vim-closetag