Initial work to support StringTemplates.

Author: tjprescott

tools/apiview/emitters/typespec-apiview/package-lock.json

@@ -13,22 +13,23 @@ import {
   IdentifierNode,
   InterfaceStatementNode,
   IntersectionExpressionNode,
-  listServices,
   MemberExpressionNode,
   ModelExpressionNode,
   ModelPropertyNode,
   ModelSpreadPropertyNode,
   ModelStatementNode,
   Namespace,
   navigateProgram,
-  NoTarget,
   NumericLiteralNode,
   OperationSignatureDeclarationNode,
   OperationSignatureReferenceNode,
   OperationStatementNode,
   Program,
   ScalarStatementNode,
   StringLiteralNode,
+  StringTemplateExpressionNode,
+  StringTemplateHeadNode,
+  StringTemplateSpanNode,
   SyntaxKind,
   TemplateArgumentNode,
   TemplateParameterDeclarationNode,
@@ -43,7 +44,6 @@ import { ApiViewDiagnostic, ApiViewDiagnosticLevel } from "./diagnostic.js";
 import { ApiViewNavigation } from "./navigation.js";
 import { generateId, NamespaceModel } from "./namespace-model.js";
 import { LIB_VERSION } from "./version.js";
-import { reportDiagnostic } from "./lib.js";
 
 const WHITESPACE = " ";
 
@@ -633,9 +633,45 @@ export class ApiView {
             this.tokenize(obj.argument);
         }
         break;
+      case SyntaxKind.StringTemplateExpression:
+        obj = node as StringTemplateExpressionNode;
+        const multiLine = (obj.head.value.includes("\n") || obj.spans.some(x => x.literal.value.includes("\n")))
+
+        if (multiLine) {
+          this.punctuation(`"""`);
+          this.newline();
+          this.indent();
+        } else {
+          this.punctuation(`"`);
+        }
+        this.tokenize(obj.head);
+        for (const span of obj.spans) {
+            this.tokenize(span);
+        }
+        if (multiLine) {
+          this.newline();
+          this.deindent();
+          this.punctuation(`"""`);
+        } else {
+          this.punctuation(`"`);
+        }
+        break;
+      case SyntaxKind.StringTemplateSpan:
+        obj = node as StringTemplateSpanNode;
+        this.punctuation("${", false, false);
+        this.tokenize(obj.expression);
+        this.punctuation("}", false, false);
+        this.tokenize(obj.literal);
+        break;
+      case SyntaxKind.StringTemplateHead:
+      case SyntaxKind.StringTemplateMiddle:
+      case SyntaxKind.StringTemplateTail:
+        obj = node as StringTemplateHeadNode;
+        this.literal(obj.value);
+        break;
       default:
         // All Projection* cases should fall in here...
-        throw new Error(`Case "${node.kind.toString()}" not implemented`);
+        throw new Error(`Case "${SyntaxKind[node.kind].toString()}" not implemented`);
     }
   }
 

tools/apiview/emitters/typespec-apiview/src/apiview.ts

@@ -693,4 +693,50 @@ describe("apiview: tests", () => {
       validateDefinitionIds(apiview);
     });  
   });
+
+  describe("string templates", () => {
+    it("templates", async () => {
+      const input = `
+      @TypeSpec.service( { title: "Test", version: "1" } )
+      namespace Azure.Test {  
+        alias myconst = "foobar";
+        model Person {
+          simple: "Simple \${123} end";
+          multiline: """
+            Multi
+               \${123}
+               \${true}
+            line
+          """;
+          ref: "Ref this alias \${myconst} end";
+          template: Template<"custom">;          
+        }
+        alias Template<T extends valueof string> = "Foo \${T} bar";
+      }`;
+
+      const expect = `
+      namespace Azure.Test {
+        model Person {
+          simple: "Simple \${123} end";
+          multiline: """
+            Multi
+               \${123}
+               \${true}
+            line
+          """;
+          ref: "Ref this alias \${myconst} end";
+          template: Template<"custom">;
+        }
+
+        alias myconst = "foobar";
+
+        alias Template<T extends valueof string> = "Foo \${T} bar";
+      }
+      `;
+      const apiview = await apiViewFor(input, {});
+      const lines = apiViewText(apiview);
+      compare(expect, lines, 9);
+      validateDefinitionIds(apiview);
+    });
+  });
 });