refactor(syntaxes): Update embedded languages and block name (#1967)

This commit updates the embedded languages of template.blocks.ng to more accurately reflect content. It also makes expressions switch the javascript language. Lastly, this updates the block capture to name the entire content control.block.ng rather than just contentName, which excluded the block name and expression.
angular · Jul 19, 2024 · b424eaa · b424eaa
1 parent 208e6e3
commit b424eaa
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 59 deletions.
diff --git a/.aspect/rules/external_repository_action_cache/npm_translate_lock_LTE4Nzc1MDcwNjU= b/.aspect/rules/external_repository_action_cache/npm_translate_lock_LTE4Nzc1MDcwNjU=
@@ -2,7 +2,7 @@
 # Input hashes for repository rule npm_translate_lock(name = "npm", pnpm_lock = "//:pnpm-lock.yaml").
 # This file should be checked into version control along with the pnpm-lock.yaml file.
 .npmrc=974837034
-pnpm-lock.yaml=1988059937
-yarn.lock=448809282
-package.json=172429918
+pnpm-lock.yaml=-1342496482
+yarn.lock=-1243860663
+package.json=1843460007
 pnpm-workspace.yaml=1711114604
diff --git a/package.json b/package.json
@@ -164,12 +164,22 @@
       {
         "path": "./syntaxes/template.json",
         "scopeName": "template.ng",
-        "injectTo": ["text.html.derivative", "source.ts"]
+        "injectTo": ["text.html.derivative", "source.ts"],
+        "embeddedLanguages": {
+          "text.html": "html",
+          "source.css": "css",
+          "expression.ng": "javascript"
+        }
       },
       {
         "path": "./syntaxes/template-blocks.json",
         "scopeName": "template.blocks.ng",
-        "injectTo": ["text.html.derivative", "source.ts"]
+        "injectTo": ["text.html.derivative", "source.ts"],
+        "embeddedLanguages": {
+          "text.html": "html",
+          "control.block.expression.ng": "javascript",
+          "control.block.body.ng": "html"
+        }
       },
       {
         "path": "./syntaxes/let-declaration.json",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/syntaxes/src/template-blocks.ts b/syntaxes/src/template-blocks.ts
@@ -33,7 +33,7 @@ export const TemplateBlocks: GrammarDefinition = {
         2: {name: 'keyword.control.block.kind.ng'},
       },
       patterns: [{include: '#blockExpression'}, {include: '#blockBody'}],
-      contentName: 'control.block.ng',
+      name: 'control.block.ng',
       // The block ends at the close `}` but we don't capture it here because. It's captured instead
       // by the #blockBody.
       end: /(?<=\})/,

diff --git a/syntaxes/template-blocks.json b/syntaxes/template-blocks.json
@@ -33,7 +33,7 @@
           "include": "#blockBody"
         }
       ],
-      "contentName": "control.block.ng",
+      "name": "control.block.ng",
       "end": "(?<=\\})"
     },
     "blockExpression": {

diff --git a/syntaxes/test/data/template-blocks.html.snap b/syntaxes/test/data/template-blocks.html.snap
@@ -1,7 +1,7 @@
 >@defer (doSomething({111})) {
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^^^^ template.blocks.ng keyword.control.block.kind.ng
-#      ^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#      ^ template.blocks.ng control.block.ng
 #       ^ template.blocks.ng control.block.ng meta.brace.round.ts
 #        ^^^^^^^^^^^ template.blocks.ng control.block.ng control.block.expression.ng entity.name.function.ts
 #                   ^ template.blocks.ng control.block.ng control.block.expression.ng meta.brace.round.ts
@@ -18,19 +18,19 @@
 #^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >
 >@defer {
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^^^^ template.blocks.ng keyword.control.block.kind.ng
-#      ^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#      ^ template.blocks.ng control.block.ng
 #       ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >    <a></a>
 #^^^^^^^^^^^^ template.blocks.ng control.block.ng control.block.body.ng
 >}
 #^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >
 >@switch (a) {
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^^^^^ template.blocks.ng keyword.control.block.kind.ng
-#       ^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^^^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#       ^ template.blocks.ng control.block.ng
 #        ^ template.blocks.ng control.block.ng meta.brace.round.ts
 #         ^ template.blocks.ng control.block.ng control.block.expression.ng variable.other.readwrite.ts
 #          ^ template.blocks.ng control.block.ng meta.brace.round.ts
@@ -50,9 +50,9 @@
 #    ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >    @case (2) {
 #^^^^ template.blocks.ng
-#    ^ template.blocks.ng keyword.control.block.transition.ng
-#     ^^^^ template.blocks.ng keyword.control.block.kind.ng
-#         ^ template.blocks.ng
+#    ^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+#     ^^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#         ^ template.blocks.ng control.block.ng
 #          ^ template.blocks.ng control.block.ng meta.brace.round.ts
 #           ^ template.blocks.ng control.block.ng control.block.expression.ng constant.numeric.decimal.ts
 #            ^ template.blocks.ng control.block.ng meta.brace.round.ts
@@ -72,9 +72,9 @@
 #    ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >    @default {
 #^^^^ template.blocks.ng
-#    ^ template.blocks.ng keyword.control.block.transition.ng
-#     ^^^^^^^ template.blocks.ng keyword.control.block.kind.ng
-#            ^ template.blocks.ng
+#    ^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+#     ^^^^^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#            ^ template.blocks.ng control.block.ng
 #             ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >        default case
 #^^^^^^^^^^^^^^^^^^^^^ template.blocks.ng control.block.ng control.block.body.ng
@@ -85,9 +85,9 @@
 #^^ template.blocks.ng
 >
 >@if (a==b) { hello } @else  { goodbye }
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^ template.blocks.ng keyword.control.block.kind.ng
-#   ^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#   ^ template.blocks.ng control.block.ng
 #    ^ template.blocks.ng control.block.ng meta.brace.round.ts
 #     ^ template.blocks.ng control.block.ng control.block.expression.ng variable.other.readwrite.ts
 #      ^^ template.blocks.ng control.block.ng control.block.expression.ng keyword.operator.comparison.ts
@@ -98,17 +98,17 @@
 #            ^^^^^^^ template.blocks.ng control.block.ng control.block.body.ng
 #                   ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 #                    ^ template.blocks.ng
-#                     ^ template.blocks.ng keyword.control.block.transition.ng
-#                      ^^^^ template.blocks.ng keyword.control.block.kind.ng
-#                          ^^ template.blocks.ng
+#                     ^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+#                      ^^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#                          ^^ template.blocks.ng control.block.ng
 #                            ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 #                             ^^^^^^^^^ template.blocks.ng control.block.ng control.block.body.ng
 #                                      ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >
 >@if (a==b) { 
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^ template.blocks.ng keyword.control.block.kind.ng
-#   ^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#   ^ template.blocks.ng control.block.ng
 #    ^ template.blocks.ng control.block.ng meta.brace.round.ts
 #     ^ template.blocks.ng control.block.ng control.block.expression.ng variable.other.readwrite.ts
 #      ^^ template.blocks.ng control.block.ng control.block.expression.ng keyword.operator.comparison.ts
@@ -122,9 +122,9 @@
 >} @else if (b==a) { 
 #^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 # ^ template.blocks.ng
-#  ^ template.blocks.ng keyword.control.block.transition.ng
-#   ^^^^^^^ template.blocks.ng keyword.control.block.kind.ng
-#          ^ template.blocks.ng
+#  ^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+#   ^^^^^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#          ^ template.blocks.ng control.block.ng
 #           ^ template.blocks.ng control.block.ng meta.brace.round.ts
 #            ^ template.blocks.ng control.block.ng control.block.expression.ng variable.other.readwrite.ts
 #             ^^ template.blocks.ng control.block.ng control.block.expression.ng keyword.operator.comparison.ts
@@ -139,9 +139,9 @@
 #^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >
 >@for (let item of items; track $index) {
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^^ template.blocks.ng keyword.control.block.kind.ng
-#    ^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#    ^ template.blocks.ng control.block.ng
 #     ^ template.blocks.ng control.block.ng meta.brace.round.ts
 #      ^^^ template.blocks.ng control.block.ng control.block.expression.ng storage.type.ts
 #         ^ template.blocks.ng control.block.ng control.block.expression.ng
@@ -163,9 +163,9 @@
 #^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >
 >@if (
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^ template.blocks.ng keyword.control.block.kind.ng
-#   ^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#   ^ template.blocks.ng control.block.ng
 #    ^ template.blocks.ng control.block.ng meta.brace.round.ts
 >    items;
 #^^^^ template.blocks.ng control.block.ng control.block.expression.ng
@@ -199,9 +199,9 @@
 #^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >
 >@if 
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^ template.blocks.ng keyword.control.block.kind.ng
-#   ^^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#   ^^ template.blocks.ng control.block.ng
 >(items) {}
 #^ template.blocks.ng control.block.ng meta.brace.round.ts
 # ^^^^^ template.blocks.ng control.block.ng control.block.expression.ng variable.other.readwrite.ts
@@ -211,9 +211,9 @@
 #         ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >
 >@for 
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^^ template.blocks.ng keyword.control.block.kind.ng
-#    ^^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#    ^^ template.blocks.ng control.block.ng
 >(item of items; track $index) { }
 #^ template.blocks.ng control.block.ng meta.brace.round.ts
 # ^^^^ template.blocks.ng control.block.ng control.block.expression.ng variable.other.readwrite.ts
@@ -232,9 +232,9 @@
 #                                ^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >
 >@for (item of items; track $index) { 
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^^ template.blocks.ng keyword.control.block.kind.ng
-#    ^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#    ^ template.blocks.ng control.block.ng
 #     ^ template.blocks.ng control.block.ng meta.brace.round.ts
 #      ^^^^ template.blocks.ng control.block.ng control.block.expression.ng variable.other.readwrite.ts
 #          ^ template.blocks.ng control.block.ng control.block.expression.ng
@@ -254,9 +254,9 @@
 #^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 # ^^ template.blocks.ng
 >@empty 
-#^ template.blocks.ng keyword.control.block.transition.ng
-# ^^^^^ template.blocks.ng keyword.control.block.kind.ng
-#      ^^ template.blocks.ng
+#^ template.blocks.ng control.block.ng keyword.control.block.transition.ng
+# ^^^^^ template.blocks.ng control.block.ng keyword.control.block.kind.ng
+#      ^^ template.blocks.ng control.block.ng
 >{
 #^ template.blocks.ng control.block.ng punctuation.definition.block.ts
 >