feat: add ignore switch

Author: jedwards1211

README.md

@@ -736,6 +736,26 @@ type User = {
 }
 ```
 
+## `ignore [data | variables]`
+
+`ignore data` makes `graphql-typegen` not output a data type.
+`ignore variables` makes `graphql-typegen` not output a variables type.
+`ignore` makes `graphql-typegen` not output either a data or variables type.
+
+This may be set in a comment in your GraphQL operation:
+
+```js
+const query = gql`
+  # @graphql-typegen ignore variables
+  query user($id: Int!) {
+    user(id: $id) {
+      id
+      name
+    }
+  }
+`
+```
+
 # CLI Usage
 
 ```

src/internal/analyzeSchema.ts

@@ -22,55 +22,55 @@ export type TypeKind =
 export type IntrospectionArg = {
   name: string
   type: IntrospectionType
-  description: string
+  description?: string | null
 }
 
 export type AnalyzedArg = {
   name: string
   type: AnalyzedType
-  description: string
+  description: string | null | undefined
   config?: ConfigDirectives
 }
 
 export type IntrospectionField = {
   name: string
   args: IntrospectionArg[]
   type: IntrospectionType
-  description: string
+  description?: string | null
 }
 
 export type AnalyzedField = {
   name: string
   args: Record<string, AnalyzedArg>
   type: AnalyzedType
-  description: string
+  description: string | null | undefined
   parent?: AnalyzedType
   config?: ConfigDirectives
 }
 
 export type IntrospectionInputField = {
   name: string
   type: IntrospectionType
-  description: string
+  description: string | null
 }
 
 export type AnalyzedInputField = {
   name: string
   type: AnalyzedType
-  description: string
+  description: string | null | undefined
   parent?: AnalyzedType
   config?: ConfigDirectives
 }
 
 export type EnumValue = {
   name: string
-  description: string
+  description?: string | null
 }
 
 export type IntrospectionType = {
   kind: TypeKind
   name: string
-  description: string
+  description?: string | null
   ofType?: IntrospectionType | null
   fields?: IntrospectionField[] | null
   inputFields?: IntrospectionInputField[] | null
@@ -82,7 +82,7 @@ export type IntrospectionType = {
 export type AnalyzedType = {
   kind: TypeKind
   name: string
-  description: string
+  description: string | null | undefined
   ofType?: AnalyzedType | null
   fields?: Record<string, AnalyzedField> | null
   inputFields?: Record<string, AnalyzedInputField> | null
@@ -103,41 +103,42 @@ function analyzeTypes(
 ): Record<string, AnalyzedType> {
   const introspectionTypes: IntrospectionType[] = data.__schema.types as any
   function getDescriptionDirectives(
-    description: string | undefined
+    node:
+      | IntrospectionField
+      | IntrospectionInputField
+      | IntrospectionType
+      | IntrospectionArg
   ): ConfigDirectives {
-    return getConfigDirectives(
-      description ? description.split(/\n/gm) : [],
-      cwd
-    )
+    const description = (node as any).description || ''
+    return getConfigDirectives(description ? description.split(/\n/gm) : [], {
+      cwd,
+    })
   }
 
   function convertIntrospectionArgs(
     args: IntrospectionArg[]
   ): Record<string, AnalyzedArg> {
     const AnalyzedArgs: Record<string, AnalyzedArg> = {}
-    for (const { name, type, description } of args) {
+    for (const arg of args) {
+      const { name, type, description } = arg
       AnalyzedArgs[name] = {
         name,
         type: convertIntrospectionType(type),
         description,
-        config: getDescriptionDirectives(description),
+        config: getDescriptionDirectives(arg),
       }
     }
     return AnalyzedArgs
   }
 
-  function convertIntrospectionField({
-    name,
-    args,
-    type,
-    description,
-  }: IntrospectionField): AnalyzedField {
+  function convertIntrospectionField(field: IntrospectionField): AnalyzedField {
+    const { name, args, type, description } = field
     return {
       name,
       type: convertIntrospectionType(type),
       args: convertIntrospectionArgs(args),
       description,
-      config: getDescriptionDirectives(description),
+      config: getDescriptionDirectives(field),
     }
   }
 
@@ -151,16 +152,15 @@ function analyzeTypes(
     return AnalyzedFields
   }
 
-  function convertIntrospectionInputField({
-    name,
-    type,
-    description,
-  }: IntrospectionInputField): AnalyzedInputField {
+  function convertIntrospectionInputField(
+    field: IntrospectionInputField
+  ): AnalyzedInputField {
+    const { name, type, description } = field
     return {
       name,
       type: convertIntrospectionType(type),
       description,
-      config: getDescriptionDirectives(description),
+      config: getDescriptionDirectives(field),
     }
   }
 
@@ -174,17 +174,18 @@ function analyzeTypes(
     return AnalyzedFields
   }
 
-  function convertIntrospectionType({
-    name,
-    description,
-    kind,
-    ofType,
-    fields,
-    inputFields,
-    enumValues,
-    interfaces,
-    possibleTypes,
-  }: IntrospectionType): AnalyzedType {
+  function convertIntrospectionType(type: IntrospectionType): AnalyzedType {
+    const {
+      name,
+      description,
+      kind,
+      ofType,
+      fields,
+      inputFields,
+      enumValues,
+      interfaces,
+      possibleTypes,
+    } = type
     return {
       name,
       description,
@@ -195,7 +196,7 @@ function analyzeTypes(
         ? convertIntrospectionInputFields(inputFields)
         : null,
       enumValues,
-      config: getDescriptionDirectives(description),
+      config: getDescriptionDirectives(type),
       interfaces: interfaces
         ? interfaces.map(iface => convertIntrospectionType(iface))
         : null,

src/internal/generateFlowTypesFromDocument.ts

@@ -29,13 +29,13 @@ import simplifyIntersection from './simplifyIntersection'
 
 type GeneratedQueryType = {
   variables?: TypeAlias
-  data: TypeAlias
+  data?: TypeAlias
 }
 
 type GeneratedMutationType = {
   variables?: TypeAlias
-  data: TypeAlias
-  mutationFunction: TypeAlias
+  data?: TypeAlias
+  mutationFunction?: TypeAlias
 }
 
 type GeneratedTypes = {
@@ -106,6 +106,8 @@ export default function generateFlowTypesFromDocument({
       addTypename,
       extract,
       external,
+      ignoreData: undefined,
+      ignoreVariables: undefined,
     }
   }
 
@@ -261,10 +263,14 @@ export default function generateFlowTypesFromDocument({
   function convertOperationDefinition(
     def: graphql.OperationDefinitionNode
   ): void {
+    const ownDirectives = getCommentDirectives(def, cwd)
+    const { ignoreData, ignoreVariables } = ownDirectives
+    if (ignoreData && ignoreVariables) return
+
     const { operation, selectionSet, variableDefinitions } = def
     const config = getCombinedConfig(
       { external: null, extract: null },
-      getCommentDirectives(def, cwd)
+      ownDirectives
     )
 
     let name = def.name ? upperFirst(def.name.value) : `Unnamed`
@@ -277,38 +283,70 @@ export default function generateFlowTypesFromDocument({
     if (name.toLowerCase().lastIndexOf(operation) < 0) {
       name += upperFirst(operation)
     }
-    const data = addTypeAlias(
-      `${name}Data`,
-      convertSelectionSet(selectionSet, types[upperFirst(operation)], config)
-    )
     if (operation === 'query' || operation === 'subscription') {
       const operationTypes: GeneratedQueryType = def.name
-        ? (generatedTypes[operation][def.name.value] = { data })
-        : { data }
-      if (variableDefinitions && variableDefinitions.length) {
+        ? (generatedTypes[operation][def.name.value] = {})
+        : {}
+      if (!ignoreData) {
+        operationTypes.data = addTypeAlias(
+          `${name}Data`,
+          convertSelectionSet(
+            selectionSet,
+            types[upperFirst(operation)],
+            config
+          )
+        )
+      }
+      if (
+        !ignoreVariables &&
+        variableDefinitions &&
+        variableDefinitions.length
+      ) {
         operationTypes.variables = addTypeAlias(
           `${name}Variables`,
           convertVariableDefinitions(variableDefinitions, config)
         )
       }
     } else if (operation === 'mutation') {
-      const variables =
-        variableDefinitions && variableDefinitions.length
-          ? addTypeAlias(
-              `${name}Variables`,
-              convertVariableDefinitions(variableDefinitions, config)
-            )
-          : null
-      const mutationFunction = statement([
-        `type ${name}Function = ${MutationFunction()}<${data.id.name}${
-          variables ? `, ${variables.id.name}` : ''
-        }>`,
-      ])
-      statements.push(mutationFunction)
       const operationTypes: GeneratedMutationType = def.name
-        ? (generatedTypes.mutation[def.name.value] = { data, mutationFunction })
-        : { data, mutationFunction }
-      if (variables) operationTypes.variables = variables
+        ? (generatedTypes[operation][def.name.value] = {})
+        : {}
+
+      let data, variables
+
+      if (!ignoreData) {
+        const _data = addTypeAlias(
+          `${name}Data`,
+          convertSelectionSet(
+            selectionSet,
+            types[upperFirst(operation)],
+            config
+          )
+        )
+        data = _data
+        operationTypes.data = _data
+      }
+      if (
+        !ignoreVariables &&
+        variableDefinitions &&
+        variableDefinitions.length
+      ) {
+        const _variables = addTypeAlias(
+          `${name}Variables`,
+          convertVariableDefinitions(variableDefinitions, config)
+        )
+        variables = _variables
+        operationTypes.variables = _variables
+      }
+      if (data && variables) {
+        const mutationFunction = statement([
+          `type ${name}Function = ${MutationFunction()}<${data.id.name}${
+            variables ? `, ${variables.id.name}` : ''
+          }>`,
+        ])
+        operationTypes.mutationFunction = mutationFunction
+        statements.push(mutationFunction)
+      }
     }
   }
 

src/internal/getCommentDirectives.spec.ts

@@ -61,6 +61,8 @@ describe(`getCommentDirectives`, function() {
         extract: 'Foob',
         external: undefined,
         addTypename: undefined,
+        ignoreData: undefined,
+        ignoreVariables: undefined,
       })
     })
   })

src/internal/getCommentDirectives.ts

@@ -11,5 +11,5 @@ export default function getCommentDirectives(
       if (typeof value === 'string') yield value
     }
   }
-  return getConfigDirectives(lines(), cwd)
+  return getConfigDirectives(lines(), { cwd, nodeKind: node.kind })
 }