Add deprecation message in shape docs (#1209)

smithy-lang · Mar 15, 2024 · ae49717 · ae49717
1 parent a53fe36
commit ae49717
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java b/...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java
@@ -190,7 +190,11 @@ boolean writeShapeDocs(Shape shape, UnaryOperator<String> preprocessor) {
                         .replace("}", "\\}");
                     docs = preprocessor.apply(docs);
                     if (shape.getTrait(DeprecatedTrait.class).isPresent()) {
-                        docs = "@deprecated\n\n" + docs;
+                        DeprecatedTrait deprecatedTrait = shape.getTrait(DeprecatedTrait.class).get();
+                        String deprecationMessage = deprecatedTrait.getMessage().orElse("");
+                        String deprecationString = "@deprecated"
+                            + (deprecationMessage.isEmpty() ? "" : " " + deprecationMessage);
+                        docs = deprecationString + "\n\n" + docs;
                     }
                     docs = addReleaseTag(shape, docs);
                     writeDocs(docs);