@toptal/davinci-graphql-codegen 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @toptal/davinci-graphql-codegen
 
+## 3.3.0
+
+### Minor Changes
+
+- [#2085](https://github.com/toptal/davinci/pull/2085) [`eb0f3e46`](https://github.com/toptal/davinci/commit/eb0f3e463533ef5ae8e2391c17b0b2d2956918bf) Thanks [@sashuk](https://github.com/sashuk)!
+- extend configuration of operations generation
+
 ## 3.2.0
 
 ### Minor Changes

package/README.md

@@ -86,7 +86,7 @@ The above script will search for `codegen-schema.json` within `./graphql`.
 
 ## Using custom config
 
-To override default config, a config option could be added in `codegen.json`.
+To override default configuration, `preset`, `presetConfig`, `plugins`, and `config` options can be added to `codegen.json`.
 
 ```json
 // codegen.json
@@ -94,14 +94,15 @@ To override default config, a config option could be added in `codegen.json`.
   {
     "schema": "@toptal/modularity-template-graphql/talent",
     "documents": "src/**/*.gql",
-    "config": {
-      "skipTypename": false
-    }
+    "preset": "...",
+    "presetConfig": { ... },
+    "plugins": [ ... ],
+    "config": { ... }
   }
 ]
 ```
 
-> List of options could be find in https://the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations
+> Please see the https://the-guild.dev/graphql/codegen/docs/config-reference/codegen-config for more information about these options.
 
 ## Customizing the extension of generated files
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-graphql-codegen",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Codegen",
   "author": "Toptal",
   "license": "SEE LICENSE IN LICENSE.MD",

package/src/commands/generate-operations.js

@@ -3,6 +3,7 @@ import { createOption } from '@toptal/davinci-cli-shared'
 
 import { generateOperations } from '../generate/index.js'
 import readConfig from '../read-config/index.js'
+import { getConfigurationType } from '../services/get-configutation-type.js'
 
 const codegenGenerateOperations = async ({
   config,
@@ -13,17 +14,37 @@ const codegenGenerateOperations = async ({
 }) => {
   process.env.VERBOSE = verbose
 
-  const codegen = await readConfig(config)
+  const codegenConfigurations = await readConfig(config)
 
-  for (const { schema, documents, config: customConfig = {} } of codegen) {
-    await generateOperations({
-      schema,
-      documents,
-      extension,
-      experiments,
-      schemaName,
-      config: customConfig,
-    })
+  for (const codegenConfiguration of codegenConfigurations) {
+    if (getConfigurationType(codegenConfiguration) === 'operations') {
+      const {
+        schema,
+        documents,
+        preset,
+        presetConfig,
+        plugins,
+        config: customConfig = {},
+      } = codegenConfiguration
+
+      await generateOperations({
+        schema,
+        documents,
+        preset,
+        presetConfig,
+        plugins,
+        extension,
+        experiments,
+        schemaName,
+        config: customConfig,
+      })
+    } else {
+      console.log(
+        `ℹ️  Operations generation configuration was skipped when reading [${chalk.yellow(
+          config
+        )}]`
+      )
+    }
   }
 }
 

package/src/commands/generate-schema.js

@@ -2,17 +2,28 @@ import chalk from 'chalk'
 
 import { generateSchema } from '../generate/index.js'
 import readConfig from '../read-config/index.js'
+import { getConfigurationType } from '../services/get-configutation-type.js'
 
 const codegenGenerateSchema = async ({ projectId, config }) => {
-  const codegen = await readConfig(config)
+  const codegenConfigurations = await readConfig(config)
 
-  for (const { schema, documents, target } of codegen) {
-    await generateSchema({
-      schema,
-      documents,
-      target,
-      projectId,
-    })
+  for (const codegenConfiguration of codegenConfigurations) {
+    if (getConfigurationType(codegenConfiguration) === 'schema') {
+      const { schema, documents, target } = codegenConfiguration
+
+      await generateSchema({
+        schema,
+        documents,
+        target,
+        projectId,
+      })
+    } else {
+      console.log(
+        `ℹ️  Schema generation configuration was skipped when reading [${chalk.yellow(
+          config
+        )}]`
+      )
+    }
   }
 }
 

package/src/config/config.js

@@ -20,6 +20,7 @@ const commonTypesConfig = {
     Time: 'string',
     TimeOfDay: 'string',
     Upload: 'unknown',
+    HTML: 'string',
   },
 }
 

package/src/generate/operations.js

@@ -18,9 +18,13 @@ const { readFileSync, writeFileSync } = fsExtra
 const generateOperations = async ({
   schema,
   documents,
+  preset,
+  presetConfig,
+  plugins,
   extension,
   experiments,
   schemaName,
+  config,
 }) => {
   const enabledExperiments = experiments ? experiments.split(',') : []
 
@@ -36,59 +40,72 @@ const generateOperations = async ({
     enabledExperiments.includes('fragment-resolver')
 
   const docsPath = castArray(documents).map(getRelativeFilePath)
+  const schemas = castArray(schema)
 
-  const { target, schemaPath, schemaPathResolution } = getSchemaPath(schema)
+  // Picking the primary schema for the operation generation
+  const primarySchema = schemas[0]
+  const { target, schemaPath } = getSchemaPath(primarySchema)
+
+  const schemasPathResoltuions = schemas.map(
+    schema => getSchemaPath(schema).schemaPathResolution
+  )
 
   console.log(`ℹ️  Generating [${chalk.green(target)}] operations`)
   console.log(`ℹ️  Documents pattern: [${chalk.green(documents)}]`)
 
-  await generate(
-    {
-      documents: isFragmentResolverExperimentEnabled
-        ? docsPath.flatMap(fragmentImportResolverGraphQL)
-        : docsPath,
-      config: {
-        ...commonOperationTypesConfig,
-      },
-      generates: {
-        [schemaPath]: {
-          schema: schemaPathResolution,
-          preset: 'near-operation-file',
-          presetConfig: {
-            extension,
-            baseTypesPath: `~${schema}/${schemaName}`,
-          },
-          plugins: [
-            'typescript-operations',
-            'typed-document-node',
-            {
-              add: {
-                content: autoGenerationComments,
-              },
-            },
-          ],
+  const gqlConfiguration = {
+    documents: isFragmentResolverExperimentEnabled
+      ? docsPath.flatMap(fragmentImportResolverGraphQL)
+      : docsPath,
+    config: {
+      ...commonOperationTypesConfig,
+    },
+    generates: {
+      [schemaPath]: {
+        schema: schemasPathResoltuions,
+        preset: preset || 'near-operation-file',
+        presetConfig: presetConfig || {
+          extension,
+          baseTypesPath: `~${primarySchema}/${schemaName}`,
         },
-      },
-      hooks: {
-        afterAllFileWrite: [
-          async (...filePaths) => {
-            for (const path of filePaths) {
-              const rawText = readFileSync(path, 'utf8')
-              const options = await prettier.resolveConfig(dirname(path))
-
-              const formattedText = prettier.format(rawText, {
-                parser: 'typescript',
-                ...options,
-              })
-
-              writeFileSync(path, formattedText)
-            }
+        plugins: plugins || [
+          'typescript-operations',
+          'typed-document-node',
+          {
+            add: {
+              content: autoGenerationComments,
+            },
           },
         ],
+        config: config || undefined,
       },
     },
-    true
-  )
+    hooks: {
+      afterAllFileWrite: [
+        async (...filePaths) => {
+          for (const path of filePaths) {
+            const rawText = readFileSync(path, 'utf8')
+            const options = await prettier.resolveConfig(dirname(path))
+
+            const formattedText = prettier.format(rawText, {
+              parser: 'typescript',
+              ...options,
+            })
+
+            writeFileSync(path, formattedText)
+          }
+        },
+      ],
+    },
+  }
+
+  if (process.env.VERBOSE) {
+    console.log(`ℹ️  GQL configuration:
+${JSON.stringify(gqlConfiguration, null, 2)}
+`)
+  }
+
+  await generate(gqlConfiguration, true)
 }
 
 export default generateOperations

package/src/services/get-configutation-type.js

@@ -0,0 +1,7 @@
+export const getConfigurationType = codegenConfiguration => {
+  if (codegenConfiguration && 'documents' in codegenConfiguration) {
+    return 'operations'
+  }
+
+  return 'schema'
+}

package/src/services/get-configutation-type.test.js

@@ -0,0 +1,20 @@
+import { getConfigurationType } from './get-configutation-type.js'
+
+describe('getConfigutationType', () => {
+  describe('when configuration contains "documents" field', () => {
+    it('identifies configuration as a configuration used for generating operations', () => {
+      expect(
+        getConfigurationType({
+          schema: ['./abc.graphql'],
+          documents: ['**/*.ts'],
+        })
+      ).toBe('operations')
+    })
+  })
+
+  describe('when configuration does not contain "documents" field', () => {
+    it('identifies configuration as a configuration used for generating schema', () => {
+      expect(getConfigurationType({ schema: ['./abc.graphql'] })).toBe('schema')
+    })
+  })
+})

package/src/services/get-monorepo-schema-path.js

@@ -4,7 +4,7 @@ const localRequire = createRequire(import.meta.url)
 
 export const createGetMonorepoSchemaPathResolver = pathResolver => schema => {
   // @toptal/modularity-template-graphql/talent -> talent
-  const target = schema.split('/').pop()
+  const target = schema.split('/').slice(2).join('/')
   // @toptal/modularity-template-graphql/talent -> @toptal/modularity-template-graphql
   const schemaPath = schema.split('/').slice(0, 2).join('/')
 

package/src/services/get-monorepo-schema-path.test.js

@@ -10,13 +10,22 @@ const getMonorepoSchemaPath =
 
 describe('getMonorepoSchemaPath', () => {
   it('returns target, schemaPath and schemaPathResolution', () => {
-    const schemaPath = '@toptal/modularity-template-graphql/talent'
-
-    expect(getMonorepoSchemaPath(schemaPath)).toEqual({
+    expect(
+      getMonorepoSchemaPath('@toptal/modularity-template-graphql/talent')
+    ).toEqual({
       target: 'talent',
       schemaPath: '@toptal/modularity-template-graphql',
       schemaPathResolution:
         'home/users/johndoe/toptal/libs/graphql/schema.graphql',
     })
+
+    expect(
+      getMonorepoSchemaPath('@toptal/modularity-template-graphql/talent/schema')
+    ).toEqual({
+      target: 'talent/schema',
+      schemaPath: '@toptal/modularity-template-graphql',
+      schemaPathResolution:
+        'home/users/johndoe/toptal/libs/graphql/schema.graphql',
+    })
   })
 })