What's the best way to add @tag directive to generated schema file?

[jwpark511]

Looking for some guidance or an example to add directives to the generated schema file.

export default {
  getSchema: (): Promise<GraphQLSchema> =>
    buildSchema({
      resolvers: [
        SomeResolver,
      ],
      emitSchemaFile: path.resolve(__dirname, './schema.graphql'),
    }),
};

[carlocorradini]

See https://typegraphql.com/docs/emit-schema.html#emit-schema-with-custom-directives

Currently TypeGraphQL does not directly support emitting the schema with custom directives due to printSchema function limitations from graphql-js.
If we want the custom directives to appear in the generated schema definition file we have to create a custom function that use a third-party printSchema function.
Below there is an example that uses the printSchemaWithDirectives function from @graphql-tools/utils:

import { GraphQLSchema, lexicographicSortSchema } from "graphql";
import { printSchemaWithDirectives } from "@graphql-tools/utils";
import { outputFile } from "type-graphql/dist/helpers/filesystem";

export async function emitSchemaDefinitionWithDirectivesFile(
  schemaFilePath: string,
  schema: GraphQLSchema,
): Promise<void> {
  const schemaFileContent = printSchemaWithDirectives(lexicographicSortSchema(schema));
  await outputFile(schemaFilePath, schemaFileContent);
}

The usage of emitSchemaDefinitionWithDirectivesFile function is the same as with standard emitSchemaDefinitionFile:

const schema = await buildSchema(/*...*/);

await emitSchemaDefinitionWithDirectivesFile("/path/to/folder/schema.gql", schema);

[carlocorradini]

@jwpark511 Did you solve your issue?

[jwpark511]

Yes, thanks for the docs!