Merge pull request #78 from Thom1729/template-lookahead

Add lookahead templates

README.md

@@ -138,7 +138,7 @@ const myStyle = style`div { color: red }`;
 
 ##### `comments`: object
 
-Highlight tagged template literals based on a preceding block comment. Example configuration:
+Highlight untagged template literals based on a preceding block comment. Example configuration:
 
 ```json
 {
@@ -161,6 +161,30 @@ const myStyle = /*style*/`div { color: red }`;
 const myStyle = /* style */`div { color: red }`;
 ```
 
+##### `lookaheads`: object
+
+Highlight untagged template literals based on the contents. Example configuration:
+
+```json
+{
+    "configurations": {
+        "My Config": {
+            "custom_templates": {
+                "lookaheads": {
+                    "select\b": "scope:source.sql"
+                }
+            }
+        }
+    }
+}
+```
+
+Example JavaScript:
+
+```js
+const myQuery = `select 1 from dual`;
+```
+
 ##### `styled_components`: boolean
 
 Highlight template string literals for [Styled Components](https://www.styled-components.com/).

extensions/custom_templates/custom_templates.syntax-extension

@@ -13,6 +13,7 @@ contexts: !merge
     - match: (?=`)
       set:
         - include: literal-string-template-custom-comments
+        - include: literal-string-template-custom-lookahead
         - include: literal-string-template
 
   literal-string-template-custom-tags: !foreach
@@ -31,6 +32,14 @@ contexts: !merge
       scope: variable.function.tagged-template.js
       set: !include_resource Packages/JSCustom/extensions/custom_templates/template.yaml
 
+  literal-string-template-custom-lookahead: !foreach
+    in: !argument [lookaheads, {}]
+    as: [lookahead, include]
+    value:
+      match: !format '(?=`(?:{lookahead}))'
+      scope: variable.function.tagged-template.js
+      set: !include_resource Packages/JSCustom/extensions/custom_templates/template.yaml
+
   styled-components: !if
     - !argument styled_components
     - - match: (?=(?:styled|css|createGlobalStyle|injectGlobal|keyframes){{identifier_break}})

tests/syntax_test_suites/templates/syntax_test_templates.js

@@ -17,6 +17,12 @@
 //       ^ punctuation.definition.string.begin
 //            ^ punctuation.definition.string.end
 
+    `select * from dual`;
+//  ^^^^^^^^^^^^^^^^^^^^ meta.string
+//  ^ string.quoted.other punctuation.definition.string.begin
+//   ^^^^^^^^^^^^^^^^^^ source.sql - string
+//                     ^ string.quoted.other punctuation.definition.string.end
+
     styled`color: red`
 //  ^^^^^^ variable.function.tagged-template
 //        ^ string.quoted.other punctuation.definition.string.begin

tests/test_syntaxes.py

@@ -102,6 +102,9 @@ def test_templates(self):
                     'comments': {
                         'css': 'scope:source.css',
                     },
+                    'lookaheads': {
+                        r'select\b': 'scope:source.sql',
+                    },
                     'styled_components': True,
                 }
             },