Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

73 lines (55 loc) · 2.51 KB
Raw

Contributing

Contributions are welcome! The below notes are intended to give a quick overview of how this package works. The main grammar file, Glimmer.json contains all of the glimmer syntax patterns.

The injections files handle injecting those patterns into other common scopes where glimmer syntax highlighting is desired.

Naming Conventions:

  • .hbs file scopeName is .source.glimmer
  • .js template string scope is meta.source.glimmer.js
  • Matches should end in .glimmer

TODO: The below needs a quick revision

Top Level Patterns

After an Ember template has been matched, the following top level patterns are used:

  • #htmlbars-unescaped (triple curlies)
  • #htmlbars-comment (htmlbars comments)
  • #htmlbars-block (htmlbars block && inline)
  • #html-tag (any html tag)
  • #html-comment-block (html comments)
  • #entities (html entities eg: &)
Curlies Patterns
  • #as-keyword
  • #as-params
  • #htmlbars-subexp
  • #htmlbars-property
  • #htmlbars-property-value
  • #string-single-quoted
  • #string-double-quoted
HTML Patterns

The #html-tag pattern matches on any opening or closing html tag. This pattern includes all of the patterns for html attributes as well as HTMLBars expressions for attribute values.

  • #htmlbars-unescaped
  • #htmlbars-comment
  • #htmlbars-block
  • #html-attribute
  • #string-double-quoted
  • #string-single-quoted
  • #unquoted-attribute-value

The contents of any html tag will match first on htmlbars expressions, then attributes, then the values of attributes will match on either strings or unquoted. If the value of an attribute is an htmlbars expression it will have already matched on the htmlbars patterns.

TODO

  • [] Cleanup htmlbars component names vs props vs helpers patterns: htmlbars-property-name, variable
  • Combine regexes for htmlbars block open/close/inline if possible
  • Add appropriate comment syntax for htmlbars
  • Move htmlbars core to separate file
  • [] Add real increaseIndentPattern && decreaseIndentPattern regexes in settings
  • Create a specific parsing rule for inline hbs instead of using quasi-js
  • Migrate html and htmlbars patterns to repo
  • Switch namespace for everything to meta.tag.htmlbars
  • Change HTMLBars to source.htmlbars.js
  • [] Match variable names instead of unquoted string inside {{concat "aria-labelledby-" elementId}}
  • [] Can we use the same patterns for attributes for HTML and Components?
  • Why does tag id have nested double string patterns?
  • Single Regex for open and close html elements