Improve @deprecated Enum Type developer experience (#7628)

* Add failing test for enum value deprecated support

* Make deprecation comment function usable for both field definition and enum value

* Update deprecation comment function to handle both field definitions and enum values

* Remove unnecessary console log

* Create silver-mice-rule.md

* Update name from getDeprecationComment to getNodeComment

Co-authored-by: Tom Bailey <tbailey.ni>
Co-authored-by: Charly POLY <1252066+charlypoly@users.noreply.github.com>

Author: tombailey14

.changeset/silver-mice-rule.md

@@ -0,0 +1,6 @@
+---
+"@graphql-codegen/typescript": patch
+"@graphql-codegen/visitor-plugin-common": patch
+---
+
+Improve @Deprecated Enum Type developer experience

packages/plugins/other/visitor-plugin-common/src/base-types-visitor.ts

@@ -456,7 +456,7 @@ export class BaseTypesVisitor<
   FieldDefinition(node: FieldDefinitionNode): string {
     const typeString = node.type as any as string;
     const { type } = this._parsedConfig.declarationKind;
-    const comment = this.getFieldComment(node);
+    const comment = this.getNodeComment(node);
 
     return comment + indent(`${node.name}: ${typeString}${this.getPunctuation(type)}`);
   }
@@ -526,17 +526,6 @@ export class BaseTypesVisitor<
     return declarationBlock;
   }
 
-  getFieldComment(node: FieldDefinitionNode): string {
-    let commentText: string = node.description as any;
-    const deprecationDirective = node.directives.find((v: any) => v.name === 'deprecated');
-    if (deprecationDirective) {
-      const deprecationReason = this.getDeprecationReason(deprecationDirective);
-      commentText = `${commentText ? `${commentText}\n` : ''}@deprecated ${deprecationReason}`;
-    }
-    const comment = transformComment(commentText, 1);
-    return comment;
-  }
-
   protected mergeAllFields(allFields: string[], _hasInterfaces: boolean): string {
     return allFields.join('\n');
   }
@@ -664,7 +653,7 @@ export class BaseTypesVisitor<
         const optionName = this.makeValidEnumIdentifier(
           this.convertName(enumOption, { useTypesPrefix: false, transformUnderscore: true })
         );
-        const comment = transformComment(enumOption.description as any as string, 1);
+        const comment = this.getNodeComment(enumOption);
         const schemaEnumValue =
           schemaEnumType && !this.config.ignoreEnumValuesFromSchema
             ? schemaEnumType.getValue(enumOption.name as any).value
@@ -799,6 +788,17 @@ export class BaseTypesVisitor<
     return null;
   }
 
+  getNodeComment(node: FieldDefinitionNode | EnumValueDefinitionNode): string {
+    let commentText: string = node.description as any;
+    const deprecationDirective = node.directives.find((v: any) => v.name === 'deprecated');
+    if (deprecationDirective) {
+      const deprecationReason = this.getDeprecationReason(deprecationDirective);
+      commentText = `${commentText ? `${commentText}\n` : ''}@deprecated ${deprecationReason}`;
+    }
+    const comment = transformComment(commentText, 1);
+    return comment;
+  }
+
   protected getDeprecationReason(directive: DirectiveNode): string | void {
     if ((directive.name as any) === 'deprecated') {
       const hasArguments = directive.arguments.length > 0;

packages/plugins/typescript/typescript/src/visitor.ts

@@ -258,7 +258,7 @@ export class TsVisitor<
       : (node.type as any as string);
     const originalFieldNode = parent[key] as FieldDefinitionNode;
     const addOptionalSign = !this.config.avoidOptionals.field && originalFieldNode.type.kind !== Kind.NON_NULL_TYPE;
-    const comment = this.getFieldComment(node);
+    const comment = this.getNodeComment(node);
     const { type } = this.config.declarationKind;
 
     return (

packages/plugins/typescript/typescript/tests/typescript.spec.ts

@@ -937,6 +937,23 @@ describe('TypeScript', () => {
       validateTs(result);
     });
 
+    it('#7627 - enum value @deprecated directive support', async () => {
+      const schema = buildSchema(`
+      enum MyEnum {
+        A
+        B @deprecated(reason: "Enum value \`B\` has been deprecated.")
+      }`);
+
+      const result = await plugin(schema, [], {}, { outputFile: '' });
+      expect(result.content).toBeSimilarStringTo(`
+      export enum MyEnum {
+        A = 'A',
+        /** @deprecated Enum value \`B\` has been deprecated. */
+        B = 'B'
+      }`);
+      validateTs(result);
+    });
+
     it('#1462 - Union of scalars and argument of directive', async () => {
       const schema = buildSchema(`
       union Any = String | Int | Float | ID