fix: use backticks for example strings containing doublequotes (smithy-lang#1556)

kuhe · web-flow · commit bb4f6ff08b61 · 2025-03-27T09:07:04.000-07:00
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/documentation/DocumentationExampleGenerator.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/documentation/DocumentationExampleGenerator.java
@@ -84,6 +84,9 @@ private static String write(Node node, int indent) {
             }
             case STRING -> {
                 StringNode stringNode = node.expectStringNode();
+                if (stringNode.getValue().contains("\"")) {
+                    return "`" + stringNode.getValue() + "`";
+                }
                 return "\"" + stringNode.getValue() + "\"";
             }
             case NUMBER -> {

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,9 @@ private static String write(Node node, int indent) {`
`84`	`84`	`}`
`85`	`85`	`case STRING -> {`
`86`	`86`	`StringNode stringNode = node.expectStringNode();`
	`87`	`+ if (stringNode.getValue().contains("\"")) {`
	`88`	+ return "`" + stringNode.getValue() + "`";
	`89`	`+ }`
`87`	`90`	`return "\"" + stringNode.getValue() + "\"";`
`88`	`91`	`}`
`89`	`92`	`case NUMBER -> {`