@toptal/davinci-graphql-codegen 0.3.1 → 0.3.2-alpha-feat-support-external-config-4fdb4b62.7

package/README.md

@@ -81,6 +81,25 @@ yarn davinci-graphql-codegen generate-schema --config=./graphql/codegen-schema.j
 
 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`.
+
+```json
+// codegen.json
+[
+  {
+    "schema": "@toptal/modularity-template-graphql/talent",
+    "documents": "src/**/*.gql",
+    "config": {
+      "skipTypename": false
+    }
+  }
+]
+```
+
+> List of options could be find in https://the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations
+
 ## Customizing the extension of generated files
 
 When generating operations, we have set a default setting that generates your operation types within a file named the same as where your query or mutation is and it will have the `.ts` extension. This is due to that the default extension for your queries or mutations should be `.graphql`. But you might have your query within a `.ts` file that comes with, for instance, a hook that makes use of this query, and if you'd run GraphQL Codegen Operations as is, you'll have that `.ts` file ovewriten. But you can avoid this conflict via CLI with the following command:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-graphql-codegen",
-  "version": "0.3.1",
+  "version": "0.3.2-alpha-feat-support-external-config-4fdb4b62.7+4fdb4b62",
   "description": "Codegen",
   "author": "Toptal",
   "license": "ISC",
@@ -29,14 +29,16 @@
     "@graphql-codegen/typescript-operations": "^2.3.5",
     "@graphql-codegen/typescript-resolvers": "^2.2.1",
     "@graphql-typed-document-node/core": "^3.1.0",
-    "@toptal/davinci-cli-shared": "^1.10.0",
-    "@toptal/davinci-monorepo": "6.8.6",
+    "@toptal/davinci-cli-shared": "1.10.1-alpha-feat-support-external-config-4fdb4b62.23+4fdb4b62",
+    "@toptal/davinci-monorepo": "6.8.7-alpha-feat-support-external-config-4fdb4b62.7+4fdb4b62",
     "chalk": "^4.1.2",
+    "deepmerge": "^4.2.2",
+    "fs-extra": "^10.1.0",
     "graphql": "^15.7.1",
-    "prettier": "^2.6.2",
-    "fs-extra": "^10.1.0"
+    "prettier": "^2.6.2"
   },
   "peerDependencies": {
     "prettier": "^2.6.2"
-  }
+  },
+  "gitHead": "4fdb4b62be02769af1e55476bafb82f031b5ebbd"
 }

package/src/commands/generate-operations.js

@@ -6,11 +6,12 @@ const readConfig = require('../read-config')
 const codegenGenerateOperations = async ({ config, extension = '.ts' }) => {
   const codegen = await readConfig(config)
 
-  for await (const { schema, documents } of codegen) {
+  for await (const { schema, documents, customConfig = {} } of codegen) {
     await generateOperations({
       schema,
       documents,
       extension,
+      customConfig,
     })
   }
 }

package/src/generate/operations.js

@@ -3,6 +3,7 @@ const { generate } = require('@graphql-codegen/cli')
 const { readFileSync, writeFileSync } = require('fs-extra')
 const prettier = require('prettier')
 const { dirname } = require('path')
+const merge = require('deepmerge')
 
 const {
   commonOperationTypesConfig,
@@ -11,7 +12,7 @@ const {
 const getSchemaPath = require('../services/get-schema-path')
 const getRelativeFilePath = require('../utils/get-relative-file-path')
 
-const generateOperations = async ({ schema, documents, extension }) => {
+const generateOperations = async ({ schema, documents, extension, config }) => {
   const docsPath = getRelativeFilePath(documents)
 
   const { target, schemaPath, schemaPathResolution } = getSchemaPath(schema)
@@ -22,9 +23,7 @@ const generateOperations = async ({ schema, documents, extension }) => {
   await generate(
     {
       documents: docsPath,
-      config: {
-        ...commonOperationTypesConfig,
-      },
+      config: merge(commonOperationTypesConfig, config),
       generates: {
         [schemaPath]: {
           schema: schemaPathResolution,

package/dist-package/package.json

@@ -1,42 +0,0 @@
-{
-  "name": "@toptal/davinci-graphql-codegen",
-  "version": "0.3.1",
-  "description": "Codegen",
-  "author": "Toptal",
-  "license": "ISC",
-  "homepage": "https://github.com/toptal/davinci/tree/master/packages/graphql-codegen#readme",
-  "publishConfig": {
-    "access": "public"
-  },
-  "bin": {
-    "davinci-graphql-codegen": "./bin/davinci-graphql-codegen.js"
-  },
-  "main": "./src/index.js",
-  "scripts": {
-    "build:package": "../../bin/build-package.js",
-    "prepublishOnly": "../../bin/prepublish.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "sideEffects": false,
-  "dependencies": {
-    "@google-cloud/storage": "^6.2.3",
-    "@graphql-codegen/add": "^3.1.0",
-    "@graphql-codegen/cli": "^2.11.3",
-    "@graphql-codegen/introspection": "^2.2.0",
-    "@graphql-codegen/near-operation-file-preset": "^2.4.4",
-    "@graphql-codegen/typed-document-node": "^2.3.2",
-    "@graphql-codegen/typescript": "^2.2.2",
-    "@graphql-codegen/typescript-operations": "^2.3.5",
-    "@graphql-codegen/typescript-resolvers": "^2.2.1",
-    "@graphql-typed-document-node/core": "^3.1.0",
-    "@toptal/davinci-cli-shared": "^1.10.0",
-    "@toptal/davinci-monorepo": "6.8.6",
-    "chalk": "^4.1.2",
-    "graphql": "^15.7.1",
-    "prettier": "^2.6.2",
-    "fs-extra": "^10.1.0"
-  },
-  "peerDependencies": {
-    "prettier": "^2.6.2"
-  }
-}

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

@@ -1,71 +0,0 @@
-jest.mock('@toptal/davinci-monorepo', () => ({
-  commands: [],
-  utils: { checkIfMonorepo: jest.fn() },
-}))
-
-jest.mock('./get-monorepo-schema-path', () =>
-  jest.fn(() => ({
-    target: 'talent',
-    schemaPath: '@toptal/modularity-template-graphql',
-    schemaPathResolution:
-      'home/users/alexvcasillas/toptal/libs/graphql/schema.graphql',
-  }))
-)
-
-jest.mock('./get-monolith-schema-path', () =>
-  jest.fn(() => ({
-    target: 'src/modules/graphql',
-    schemaPath: 'src/modules/graphql',
-    schemaPathResolution:
-      'home/users/alexvcasillas/toptal/screening-wizard/src/modules/graphql/schema.graphql',
-  }))
-)
-
-const {
-  utils: { checkIfMonorepo },
-} = require('@toptal/davinci-monorepo')
-
-const getSchemaPath = require('./get-schema-path')
-
-const monorepoSchema = '@toptal/modularity-template-graphql/talent'
-const monolithSchema = 'src/modules/graphql'
-
-describe('getSchemaPath', () => {
-  beforeEach(() => {
-    checkIfMonorepo.mockReset()
-  })
-
-  it('returns target, schemaPath and schemaPathResolution for monorepo', () => {
-    checkIfMonorepo.mockReturnValue(() => true)
-
-    const { target, schemaPath, schemaPathResolution } =
-      getSchemaPath(monorepoSchema)
-
-    expect(checkIfMonorepo).toHaveBeenCalledTimes(1)
-    expect(checkIfMonorepo).toHaveBeenCalledWith({
-      considerYarnWorkspaces: true,
-    })
-    expect(target).toBe('talent')
-    expect(schemaPath).toBe('@toptal/modularity-template-graphql')
-    expect(schemaPathResolution).toBe(
-      'home/users/alexvcasillas/toptal/libs/graphql/schema.graphql'
-    )
-  })
-
-  it('returns target, schemaPath and schemaPathResolution for monolith', () => {
-    checkIfMonorepo.mockReturnValue(false)
-
-    const { target, schemaPath, schemaPathResolution } =
-      getSchemaPath(monolithSchema)
-
-    expect(checkIfMonorepo).toHaveBeenCalledTimes(1)
-    expect(checkIfMonorepo).toHaveBeenCalledWith({
-      considerYarnWorkspaces: true,
-    })
-    expect(target).toBe('src/modules/graphql')
-    expect(schemaPath).toBe('src/modules/graphql')
-    expect(schemaPathResolution).toBe(
-      'home/users/alexvcasillas/toptal/screening-wizard/src/modules/graphql/schema.graphql'
-    )
-  })
-})

package/src/utils/detect-schema-source.test.js

@@ -1,29 +0,0 @@
-const {
-  isSchemaFromBucket,
-  isSchemaFromHttp,
-  isLocalSchema,
-} = require('./detect-schema-source')
-
-const gsBucketSchema = 'gs://toptal.net/gateway/graphql/talent'
-const httpSchema = 'https://toptal.net/gateway/graphql/talent'
-const localSchema = '../../graphql/talent'
-
-describe('Detect Schema Sources', () => {
-  it('detects that schema is from GS Bucket', () => {
-    expect(isSchemaFromBucket(gsBucketSchema)).toBe(true)
-    expect(isSchemaFromHttp(gsBucketSchema)).toBe(false)
-    expect(isLocalSchema(gsBucketSchema)).toBe(false)
-  })
-
-  it('detects that schema is from http', () => {
-    expect(isSchemaFromBucket(httpSchema)).toBe(false)
-    expect(isSchemaFromHttp(httpSchema)).toBe(true)
-    expect(isLocalSchema(httpSchema)).toBe(false)
-  })
-
-  it('detects that schema is from local folder', () => {
-    expect(isSchemaFromBucket(localSchema)).toBe(false)
-    expect(isSchemaFromHttp(localSchema)).toBe(false)
-    expect(isLocalSchema(localSchema)).toBe(true)
-  })
-})

package/src/utils/parse-gs-uri.test.js

@@ -1,12 +0,0 @@
-const parseGSURI = require('./parse-gs-uri')
-
-const bucketURI = 'gs://gqlgw-introspection/staging_talent_schema.graphql'
-
-describe('Parse Google Storage Bucket URI', () => {
-  it('parses a Google Storage Bucket URI correctly', () => {
-    const { bucketName, fileName } = parseGSURI(bucketURI)
-
-    expect(bucketName).toBe('gqlgw-introspection')
-    expect(fileName).toBe('staging_talent_schema.graphql')
-  })
-})

package/src/utils/process-args.test.js

@@ -1,10 +0,0 @@
-const processArgs = require('./process-args')
-
-describe('Argument processor', () => {
-  it('process arguments correctly', () => {
-    const args = processArgs(['generate-operations', '--projectId=toptal'])
-
-    expect(args.operation).toBe('generate-operations')
-    expect(args.projectId).toBe('toptal')
-  })
-})

package/src/utils/to-array.test.js

@@ -1,15 +0,0 @@
-const toArray = require('./to-array')
-
-describe('toArray', () => {
-  it("converts a value into an array if it's not one", () => {
-    const asArray = toArray('hello')
-
-    expect(Array.isArray(asArray)).toBe(true)
-  })
-
-  it("returns the array as is if it's an array", () => {
-    const asArray = toArray(['hello', 'there'])
-
-    expect(Array.isArray(asArray)).toBe(true)
-  })
-})