feat: reduce code output

dotansimha · Jul 28, 2024 · 0e7e51f · 0e7e51f
1 parent d0cdb8f
commit 0e7e51f
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 180 deletions.
diff --git a/.changeset/cold-pants-carry.md b/.changeset/cold-pants-carry.md
@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/client-preset': minor
+---
+
+Reduce noise of generated code by only generating code relevant to GraphQL operations.
diff --git a/.changeset/silent-maps-dress.md b/.changeset/silent-maps-dress.md
@@ -0,0 +1,6 @@
+---
+'@graphql-codegen/visitor-plugin-common': minor
+'@graphql-codegen/typescript': minor
+---
+
+Add config option `onlyTypescriptOperationTypes` for only emitting types relevant for the typescript-operations plugin.
diff --git a/packages/plugins/other/visitor-plugin-common/src/base-types-visitor.ts b/packages/plugins/other/visitor-plugin-common/src/base-types-visitor.ts
@@ -60,6 +60,7 @@ export interface ParsedTypesConfig extends ParsedConfig {
   wrapEntireDefinitions: boolean;
   ignoreEnumValuesFromSchema: boolean;
   directiveArgumentAndInputFieldMappings: ParsedDirectiveArgumentAndInputFieldMappings;
+  onlyTypescriptOperationTypes: boolean;
 }
 
 export interface RawTypesConfig extends RawConfig {
@@ -704,6 +705,7 @@ export class BaseTypesVisitor<
   }
 
   FieldDefinition(node: FieldDefinitionNode): string {
+    if (this.config.onlyTypescriptOperationTypes) return '';
     if (this.config.onlyEnums) return '';
 
     const typeString = node.type as any as string;
@@ -714,6 +716,7 @@ export class BaseTypesVisitor<
   }
 
   UnionTypeDefinition(node: UnionTypeDefinitionNode, key: string | number | undefined, parent: any): string {
+    if (this.config.onlyTypescriptOperationTypes) return '';
     if (this.config.onlyOperationTypes || this.config.onlyEnums) return '';
     const originalNode = parent[key] as UnionTypeDefinitionNode;
     const possibleTypes = originalNode.types
@@ -783,6 +786,7 @@ export class BaseTypesVisitor<
   }
 
   ObjectTypeDefinition(node: ObjectTypeDefinitionNode, key: number | string, parent: any): string {
+    if (this.config.onlyTypescriptOperationTypes) return '';
     if (this.config.onlyOperationTypes || this.config.onlyEnums) return '';
     const originalNode = parent[key] as ObjectTypeDefinitionNode;
 
@@ -805,6 +809,7 @@ export class BaseTypesVisitor<
   }
 
   InterfaceTypeDefinition(node: InterfaceTypeDefinitionNode, key: number | string, parent: any): string {
+    if (this.config.onlyTypescriptOperationTypes) return '';
     if (this.config.onlyOperationTypes || this.config.onlyEnums) return '';
     const originalNode = parent[key] as InterfaceTypeDefinitionNode;
 

diff --git a/packages/plugins/typescript/typescript/src/config.ts b/packages/plugins/typescript/typescript/src/config.ts
@@ -512,4 +512,8 @@ export interface TypeScriptPluginConfig extends RawTypesConfig {
    * ```
    */
   allowEnumStringTypes?: boolean;
+  /**
+   * @description Only generate types used by typescript operations
+   */
+  onlyTypescriptOperationTypes?: boolean;
 }
diff --git a/packages/plugins/typescript/typescript/src/visitor.ts b/packages/plugins/typescript/typescript/src/visitor.ts
@@ -44,6 +44,7 @@ export interface TypeScriptPluginParsedConfig extends ParsedTypesConfig {
   inputMaybeValue: string;
   noExport: boolean;
   useImplementingTypes: boolean;
+  onlyTypescriptOperationTypes: boolean;
 }
 
 export const EXACT_SIGNATURE = `type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };`;
@@ -77,6 +78,7 @@ export class TsVisitor<
       useImplementingTypes: getConfigValue(pluginConfig.useImplementingTypes, false),
       entireFieldWrapperValue: getConfigValue(pluginConfig.entireFieldWrapperValue, 'T'),
       wrapEntireDefinitions: getConfigValue(pluginConfig.wrapEntireFieldDefinitions, false),
+      onlyTypescriptOperationTypes: getConfigValue(pluginConfig.onlyTypescriptOperationTypes, false),
       ...additionalConfig,
     } as TParsedConfig);
 
@@ -243,6 +245,7 @@ export class TsVisitor<
   }
 
   UnionTypeDefinition(node: UnionTypeDefinitionNode, key: string | number | undefined, parent: any): string {
+    if (this.config.onlyTypescriptOperationTypes) return '';
     if (this.config.onlyOperationTypes || this.config.onlyEnums) return '';
 
     let withFutureAddedValue: string[] = [];

diff --git a/packages/presets/client/src/index.ts b/packages/presets/client/src/index.ts
@@ -213,7 +213,11 @@ export const preset: Types.OutputPreset<ClientPresetConfig> = {
 
     const plugins: Array<Types.ConfiguredPlugin> = [
       { [`add`]: { content: `/* eslint-disable */` } },
-      { [`typescript`]: {} },
+      {
+        [`typescript`]: {
+          onlyTypescriptOperationTypes: true,
+        },
+      },
       { [`typescript-operations`]: {} },
       {
         [`typed-document-node`]: {