fix: trim deprecated reasons (#33)

ExpediaGroup · Apr 15, 2024 · d58e0b9 · d58e0b9
1 parent 3df8ef3
commit d58e0b9
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 13 deletions.
diff --git a/src/helpers/build-directive-annotations.ts b/src/helpers/build-directive-annotations.ts
@@ -12,7 +12,11 @@ limitations under the License.
 */
 
 import { CodegenConfig, GraphQLKotlinCodegenConfig } from "../plugin";
-import { DefinitionNode, isDeprecatedDescription } from "./build-annotations";
+import {
+  DefinitionNode,
+  isDeprecatedDescription,
+  trimDescription,
+} from "./build-annotations";
 import { getFederationDirectiveReplacement } from "./get-federation-directive-replacement";
 import { TypeMetadata } from "./build-type-metadata";
 import { ConstDirectiveNode } from "graphql/language";
@@ -46,7 +50,8 @@ export function buildDirectiveAnnotations(
         const descriptionAnnotator = resolvedType?.unionAnnotation
           ? "@GraphQLDescription"
           : "@Deprecated";
-        return `${descriptionAnnotator}("${deprecatedReason}")\n`;
+        const trimmedDeprecatedReason = trimDescription(deprecatedReason);
+        return `${descriptionAnnotator}("${trimmedDeprecatedReason}")\n`;
       }
       const federationReplacement =
         getFederationDirectiveReplacement(directive);

diff --git a/test/unit/should_annotate_types_properly/expected.kt b/test/unit/should_annotate_types_properly/expected.kt
@@ -4,11 +4,11 @@ import com.expediagroup.graphql.generator.annotations.*
 
 @GraphQLDescription("A description for MyType")
 data class TypeThatShouldBeProperlyAnnotated(
-    val username: String? = null,
-    @GraphQLDescription("A description for email")
-    val email: String? = null,
-    @GraphQLDescription("A `weird` description for name")
-    val name: String? = null,
+    val field: String? = null,
+    @GraphQLDescription("A description for fieldWithDescription")
+    val fieldWithDescription: String? = null,
+    @GraphQLDescription("A `weird` description for weirdDescription")
+    val weirdDescription: String? = null,
     @Deprecated("Use something else instead")
     val deprecated1: String? = null,
     @Deprecated("")
@@ -25,7 +25,9 @@ data class TypeThatShouldBeProperlyAnnotated(
     val deprecated6: Any? = null,
     @UnionThatShouldBeProperlyAnnotated
     @GraphQLDescription("When there is a description")
-    val deprecated7: Any? = null
+    val deprecated7: Any? = null,
+    @Deprecated("Multiline reason")
+    val deprecated8: String? = null
 )
 
 @GraphQLUnion(

diff --git a/test/unit/should_annotate_types_properly/schema.graphql b/test/unit/should_annotate_types_properly/schema.graphql
@@ -4,13 +4,13 @@ A "description" for MyType
 It can be multiline
 """
 type TypeThatShouldBeProperlyAnnotated {
-  username: String
-  "A description for email"
-  email: String
+  field: String
+  "A description for fieldWithDescription"
+  fieldWithDescription: String
   """
-  A \`weird\` description for name
+  A \`weird\` description for weirdDescription
   """
-  name: String
+  weirdDescription: String
   "DEPRECATED: Use something else instead"
   deprecated1: String
   deprecated2: String @deprecated
@@ -27,6 +27,10 @@ type TypeThatShouldBeProperlyAnnotated {
   "When there is a description"
   deprecated7: UnionThatShouldBeProperlyAnnotated
     @deprecated(reason: "It omits the @Deprecated annotation for now")
+  deprecated8: String
+    @deprecated(
+      reason: "\n        Multiline reason\n        with spaces\n        "
+    )
 }
 
 union UnionThatShouldBeProperlyAnnotated = TypeThatShouldBeProperlyAnnotated