use customDirectives config

Author: danadajian

src/annotations/build-directive-annotations.ts

@@ -60,26 +60,43 @@ export function buildDirectiveAnnotations(
           ).join("\n") + "\n"
         );
       }
-      return buildDefaultKotlinAnnotations(directive, config);
+      if (config.customDirectives) {
+        return buildCustomDirectives(directive);
+      }
+      return "";
     })
     .join("");
 }
 
-function buildDefaultKotlinAnnotations(
+function buildCustomDirectives(directive: ConstDirectiveNode) {
+  const directiveName = directive.name.value;
+  return `@${titleCase(directiveName)}\n`;
+}
+
+function buildDirectiveArguments(
   directive: ConstDirectiveNode,
-  config: CodegenConfigWithDefaults,
+  argumentsToRetain: string[],
 ) {
-  const directiveName = directive.name.value;
-  if (
-    config.directiveReplacements?.find(
-      ({ directive }) => directive === directiveName,
-    )
-  ) {
-    return "";
-  }
-  return directive.name.value === "deprecated"
-    ? ""
-    : `@${titleCase(directiveName)}\n`;
+  return argumentsToRetain
+    .map((argumentToRetain) => {
+      const argumentValueNode = directive.arguments?.find(
+        (argument) => argument.name.value === argumentToRetain,
+      )?.value;
+      if (!argumentValueNode)
+        throw new Error(
+          `Argument ${argumentToRetain} was provided in argumentsToRetain config but was not found in directive ${directive.name.value}`,
+        );
+      if (!("value" in argumentValueNode))
+        throw new Error(
+          `Directive argument ${argumentToRetain} in directive ${directive.name.value} has an unsupported type. Only INT, FLOAT, STRING, BOOLEAN, and ENUM are supported.`,
+        );
+      const argumentValue =
+        argumentValueNode.kind === Kind.STRING
+          ? `"${argumentValueNode.value}"`
+          : argumentValueNode.value;
+      return `${argumentToRetain} = ${argumentValue}`;
+    })
+    .join(", ");
 }
 
 function buildKotlinAnnotationsFromConfig(
@@ -90,26 +107,10 @@ function buildKotlinAnnotationsFromConfig(
 ) {
   return kotlinAnnotations.map((kotlinAnnotation) => {
     if (typeof kotlinAnnotation === "string") return kotlinAnnotation;
-    const directiveArguments = kotlinAnnotation.argumentsToRetain
-      ?.map((argumentToRetain) => {
-        const argumentValueNode = directive.arguments?.find(
-          (argument) => argument.name.value === argumentToRetain,
-        )?.value;
-        if (!argumentValueNode)
-          throw new Error(
-            `Argument ${argumentToRetain} was provided in argumentsToRetain config but was not found in directive ${directive.name.value}`,
-          );
-        if (!("value" in argumentValueNode))
-          throw new Error(
-            `Directive argument ${argumentToRetain} in directive ${directive.name.value} has an unsupported type. Only INT, FLOAT, STRING, BOOLEAN, and ENUM are supported.`,
-          );
-        const argumentValue =
-          argumentValueNode.kind === Kind.STRING
-            ? `"${argumentValueNode.value}"`
-            : argumentValueNode.value;
-        return `${argumentToRetain} = ${argumentValue}`;
-      })
-      .join(", ");
+    const directiveArguments = buildDirectiveArguments(
+      directive,
+      kotlinAnnotation.argumentsToRetain,
+    );
     return `@${kotlinAnnotation.annotationName}(${directiveArguments})`;
   });
 }

src/config/schema.ts

@@ -32,6 +32,16 @@ export const configSchema = object({
    * @link https://opensource.expediagroup.com/graphql-kotlin-codegen/docs/class-consolidation
    */
   classConsolidationEnabled: optional(boolean()),
+  /**
+   * Denotes directives to generate as @GraphQLDirective annotations.
+   *
+   * Directive arguments are not yet supported and will be ignored.
+   *
+   * @example ["myCustomDirective"]
+   *
+   * @link https://opensource.expediagroup.com/graphql-kotlin/docs/schema-generator/customizing-schemas/directives/#custom-directives
+   */
+  customDirectives: optional(array(string())),
   /**
    * Limits dependent types to include from `onlyTypes` list. Can be used to exclude classes that are imported from external packages.
    *

src/definitions/directive.ts

@@ -14,24 +14,20 @@ limitations under the License.
 import { DirectiveDefinitionNode } from "graphql";
 import { CodegenConfigWithDefaults } from "../config/build-config-with-defaults";
 import { titleCase } from "../utils/title-case";
-import { FEDERATION_DIRECTIVES } from "../annotations/build-directive-annotations";
 
 export function buildDirectiveDefinition(
   node: DirectiveDefinitionNode,
   config: CodegenConfigWithDefaults,
 ): string {
-  if (
-    config.directiveReplacements?.find(
-      ({ directive }) => directive === node.name.value,
-    ) ||
-    Object.values(FEDERATION_DIRECTIVES).includes(node.name.value)
-  ) {
+  const directiveName = node.name.value;
+  const isCustomDirective = config.customDirectives?.includes(directiveName);
+  if (!isCustomDirective) {
     return "";
   }
   return `@GraphQLDirective(
-    name = "${titleCase(node.name.value)}",
+    name = "${titleCase(directiveName)}",
     description = "${node.description?.value ?? ""}",
     locations = [${node.locations.map((location) => `graphql.introspection.Introspection.DirectiveLocation.${location.value}`).join(", ")}]
 )
-annotation class MyCustomDirective`;
+annotation class ${titleCase(directiveName)}`;
 }

test/unit/should_generate_default_directives/codegen.config.ts renamed to test/unit/should_generate_custom_directives/codegen.config.ts

@@ -1,6 +1,7 @@
 import { GraphQLKotlinCodegenConfig } from "../../../src/plugin";
 
 export default {
+  customDirectives: ["myCustomDirective", "myCustomDirectiveWithArgs"],
   extraImports: ["should_honor_directiveReplacements_config.*"],
   directiveReplacements: [
     {