Rename documentTransformPlugins to documentTransforms

Author: kazekyo

packages/graphql-codegen-cli/src/codegen.ts

@@ -316,8 +316,8 @@ export async function executeCodegen(input: CodegenContext | Types.Config): Prom
                             emitLegacyCommonJSImports: shouldEmitLegacyCommonJSImports(config),
                           };
 
-                          const documentTransformPlugins = await Promise.all(
-                            normalizeConfig(outputConfig.documentTransformPlugins).map(async pluginConfig => {
+                          const documentTransforms = await Promise.all(
+                            normalizeConfig(outputConfig.documentTransforms).map(async pluginConfig => {
                               const name = Object.keys(pluginConfig)[0];
                               const plugin = await getPluginByName(name, pluginLoader);
                               return { [name]: { plugin, config: Object.values(pluginConfig)[0] } };
@@ -338,7 +338,7 @@ export async function executeCodegen(input: CodegenContext | Types.Config): Prom
                                     pluginMap,
                                     pluginContext,
                                     profiler: context.profiler,
-                                    documentTransformPlugins,
+                                    documentTransforms,
                                   }),
                                 `Build Generates Section: ${filename}`
                               )
@@ -353,7 +353,7 @@ export async function executeCodegen(input: CodegenContext | Types.Config): Prom
                                   pluginMap,
                                   pluginContext,
                                   profiler: context.profiler,
-                                  documentTransformPlugins,
+                                  documentTransforms,
                                 },
                               ];
 

packages/graphql-codegen-cli/tests/codegen.spec.ts

@@ -1095,7 +1095,7 @@ describe('Codegen Executor', () => {
         generates: {
           'out1.ts': {
             plugins: ['typescript', 'typescript-operations'],
-            documentTransformPlugins: ['./tests/custom-plugins/document-transform.js'],
+            documentTransforms: ['./tests/custom-plugins/document-transform.js'],
           },
         },
       });
@@ -1111,7 +1111,7 @@ describe('Codegen Executor', () => {
         generates: {
           'out1.ts': {
             plugins: ['typescript', 'typescript-operations'],
-            documentTransformPlugins: [
+            documentTransforms: [
               {
                 './tests/custom-plugins/document-transform-config.js': {
                   queryName: 'test',
@@ -1132,7 +1132,7 @@ describe('Codegen Executor', () => {
         documents: `query root { f }`,
         generates: {
           'out1.ts': {
-            documentTransformPlugins: ['./tests/custom-plugins/document-transform-context.js'],
+            documentTransforms: ['./tests/custom-plugins/document-transform-context.js'],
             plugins: ['./tests/custom-plugins/document-transform-context.js'],
           },
         },
@@ -1149,7 +1149,7 @@ describe('Codegen Executor', () => {
           generates: {
             'out1.ts': {
               plugins: ['typescript'],
-              documentTransformPlugins: ['./tests/custom-plugins/document-transform-validation.js'],
+              documentTransforms: ['./tests/custom-plugins/document-transform-validation.js'],
             },
           },
         });

packages/graphql-codegen-core/src/transform-document.ts

@@ -2,19 +2,19 @@ import { createNoopProfiler, Types } from '@graphql-codegen/plugin-helpers';
 import { buildASTSchema, GraphQLSchema } from 'graphql';
 
 export async function transformDocuments(options: Types.GenerateOptions): Promise<Types.DocumentFile[]> {
-  const documentTransformPlugins = options.documentTransformPlugins || [];
+  const documentTransforms = options.documentTransforms || [];
   let documents = options.documents;
-  if (documentTransformPlugins.length === 0) {
+  if (documentTransforms.length === 0) {
     return documents;
   }
 
   const profiler = options.profiler ?? createNoopProfiler();
   const outputSchema: GraphQLSchema = options.schemaAst || buildASTSchema(options.schema, options.config as any);
 
-  for (const documentTransformPlugin of documentTransformPlugins) {
-    const name = Object.keys(documentTransformPlugin)[0];
-    const transformPlugin = documentTransformPlugin[name].plugin;
-    const pluginConfig = documentTransformPlugin[name].config;
+  for (const documentTransform of documentTransforms) {
+    const name = Object.keys(documentTransform)[0];
+    const transformPlugin = documentTransform[name].plugin;
+    const pluginConfig = documentTransform[name].config;
 
     const config =
       typeof pluginConfig !== 'object'

packages/presets/client/src/index.ts

@@ -240,7 +240,7 @@ export const preset: Types.OutputPreset<ClientPresetConfig> = {
           unmaskFunctionName: fragmentMaskingConfig.unmaskFunctionName,
         },
         documents: [],
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       };
     }
 
@@ -267,7 +267,7 @@ export const preset: Types.OutputPreset<ClientPresetConfig> = {
         schema: options.schema,
         config: {},
         documents: [],
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       };
     }
 
@@ -282,7 +282,7 @@ export const preset: Types.OutputPreset<ClientPresetConfig> = {
           ...forwardedConfig,
         },
         documents: sources,
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       },
       {
         filename: `${options.baseOutputDir}gql${gqlArtifactFileExtension}`,
@@ -294,7 +294,7 @@ export const preset: Types.OutputPreset<ClientPresetConfig> = {
           gqlTagName: options.presetConfig.gqlTagName || 'graphql',
         },
         documents: sources,
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       },
       ...(isPersistedOperations
         ? [

packages/presets/gql-tag-operations/src/index.ts

@@ -207,7 +207,7 @@ export const preset: Types.OutputPreset<GqlTagConfig> = {
           unmaskFunctionName: fragmentMaskingConfig.unmaskFunctionName,
         },
         documents: [],
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       };
     }
 
@@ -231,7 +231,7 @@ export const preset: Types.OutputPreset<GqlTagConfig> = {
         schema: options.schema,
         config: {},
         documents: [],
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       };
     }
 
@@ -243,7 +243,7 @@ export const preset: Types.OutputPreset<GqlTagConfig> = {
         schema: options.schema,
         config,
         documents: sources,
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       },
       {
         filename: `${options.baseOutputDir}/gql${gqlArtifactFileExtension}`,
@@ -256,7 +256,7 @@ export const preset: Types.OutputPreset<GqlTagConfig> = {
           gqlTagName: options.presetConfig.gqlTagName || 'gql',
         },
         documents: sources,
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       },
       ...(fragmentMaskingFileGenerateConfig ? [fragmentMaskingFileGenerateConfig] : []),
       ...(indexFileGenerateConfig ? [indexFileGenerateConfig] : []),

packages/presets/graphql-modules/src/index.ts

@@ -69,7 +69,7 @@ export const preset: Types.OutputPreset<ModulesConfig> = {
         enumsAsTypes: true,
       },
       schemaAst: options.schemaAst!,
-      documentTransformPlugins: options.documentTransformPlugins,
+      documentTransforms: options.documentTransforms,
     };
 
     const baseTypesFilename = baseTypesPath.replace(/\.(js|ts|d.ts)$/, '');
@@ -121,7 +121,7 @@ export const preset: Types.OutputPreset<ModulesConfig> = {
         },
         config: options.config,
         schemaAst: options.schemaAst,
-        documentTransformPlugins: options.documentTransformPlugins,
+        documentTransforms: options.documentTransforms,
       };
     });
 

packages/utils/plugins-helpers/src/types.ts

@@ -19,7 +19,7 @@ export namespace Types {
     pluginContext?: { [key: string]: any };
     profiler?: Profiler;
     cache?<T>(namespace: string, key: string, factory: () => Promise<T>): Promise<T>;
-    documentTransformPlugins?: ConfiguredDocumentTransformPlugin[];
+    documentTransforms?: ConfiguredDocumentTransform[];
   }
 
   export type FileOutput = {
@@ -233,7 +233,7 @@ export namespace Types {
     | 'import-types';
   export type PresetNames = `${PresetNamesBase}-preset` | PresetNamesBase;
 
-  export interface ConfiguredDocumentTransformPlugin {
+  export interface ConfiguredDocumentTransform {
     [name: string]: { config: PluginConfig; plugin: CodegenPlugin };
   }
   /**
@@ -324,7 +324,7 @@ export namespace Types {
      * @description Specifies plugins that have the transformDocuments function.
      * Document transform plugin changes documents before executing plugins.
      */
-    documentTransformPlugins?: OutputConfig[];
+    documentTransforms?: OutputConfig[];
   }
 
   /* Output Builder Preset */
@@ -349,7 +349,7 @@ export namespace Types {
     };
     profiler?: Profiler;
     cache?<T>(namespace: string, key: string, factory: () => Promise<T>): Promise<T>;
-    documentTransformPlugins: ConfiguredDocumentTransformPlugin[];
+    documentTransforms: ConfiguredDocumentTransform[];
   };
 
   export type OutputPreset<TPresetConfig = any> = {