feat: mark plugins as optional (#8893)

dotansimha · Feb 15, 2023 · a118c30 · a118c30
1 parent 6fa3f0a
commit a118c30
Show file tree

Hide file tree

Showing 31 changed files with 50 additions and 84 deletions.
diff --git a/.changeset/bright-islands-pretend.md b/.changeset/bright-islands-pretend.md
@@ -0,0 +1,7 @@
+---
+'@graphql-codegen/cli': minor
+'@graphql-codegen/client-preset': minor
+'@graphql-codegen/gql-tag-operations-preset': minor
+---
+
+It is no longer mandatory to declare an empty plugins array when using a preset
diff --git a/.changeset/chilly-beers-sleep.md b/.changeset/chilly-beers-sleep.md
@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/plugin-helpers': minor
+---
+
+mark `plugins` in config optional
diff --git a/dev-test/codegen.ts b/dev-test/codegen.ts
@@ -189,34 +189,29 @@ const config: CodegenConfig = {
       schema: './dev-test/gql-tag-operations/schema.graphql',
       documents: './dev-test/gql-tag-operations/src/**/*.ts',
       preset: 'gql-tag-operations-preset',
-      plugins: [],
     },
     './dev-test/gql-tag-operations/graphql/': {
       schema: './dev-test/gql-tag-operations/schema.graphql',
       documents: './dev-test/gql-tag-operations/src/**/*.ts',
       preset: 'client',
-      plugins: [],
     },
     './dev-test/gql-tag-operations-urql/gql': {
       schema: './dev-test/gql-tag-operations-urql/schema.graphql',
       documents: './dev-test/gql-tag-operations-urql/src/**/*.ts',
       preset: 'gql-tag-operations-preset',
       presetConfig: { augmentedModuleName: '@urql/core' },
-      plugins: [],
     },
     './dev-test/gql-tag-operations-masking/gql': {
       schema: './dev-test/gql-tag-operations-masking/schema.graphql',
       documents: './dev-test/gql-tag-operations-masking/src/**/*.tsx',
       preset: 'gql-tag-operations-preset',
       presetConfig: { fragmentMasking: true },
-      plugins: [],
     },
     './dev-test/gql-tag-operations-masking-star-wars/gql': {
       schema: './dev-test/gql-tag-operations-masking-star-wars/schema.json',
       documents: './dev-test/gql-tag-operations-masking-star-wars/src/**/*.tsx',
       preset: 'gql-tag-operations-preset',
       presetConfig: { fragmentMasking: true },
-      plugins: [],
     },
   },
 };

diff --git a/examples/persisted-documents/codegen.ts b/examples/persisted-documents/codegen.ts
@@ -6,7 +6,6 @@ const config: CodegenConfig = {
   documents: ['src/**/*.ts'],
   generates: {
     './src/gql/': {
-      plugins: [],
       preset: 'client-preset',
       presetConfig: {
         persistedDocuments: true,

diff --git a/examples/react/apollo-client/codegen.ts b/examples/react/apollo-client/codegen.ts
@@ -7,7 +7,6 @@ const config: CodegenConfig = {
   generates: {
     './src/gql/': {
       preset: 'client',
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/react/babel-optimized/codegen.ts b/examples/react/babel-optimized/codegen.ts
@@ -7,7 +7,6 @@ const config: CodegenConfig = {
   generates: {
     './src/gql/': {
       preset: 'client',
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/react/graphql-request/codegen.ts b/examples/react/graphql-request/codegen.ts
@@ -7,7 +7,6 @@ const config: CodegenConfig = {
   generates: {
     './src/gql/': {
       preset: 'client',
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/react/nextjs-swr/codegen.ts b/examples/react/nextjs-swr/codegen.ts
@@ -7,7 +7,6 @@ const config: CodegenConfig = {
   generates: {
     './gql/': {
       preset: 'client',
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/react/tanstack-react-query/codegen.ts b/examples/react/tanstack-react-query/codegen.ts
@@ -7,7 +7,6 @@ const config: CodegenConfig = {
   generates: {
     './src/gql/': {
       preset: 'client',
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/react/urql/codegen.ts b/examples/react/urql/codegen.ts
@@ -7,7 +7,6 @@ const config: CodegenConfig = {
   generates: {
     './src/gql/': {
       preset: 'client',
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/typescript-esm/codegen.cjs b/examples/typescript-esm/codegen.cjs
@@ -7,7 +7,6 @@ const config = {
   emitLegacyCommonJSImports: false,
   generates: {
     './src/gql/': {
-      plugins: [],
       preset: 'client-preset',
     },
   },

diff --git a/examples/typescript-graphql-request/codegen.ts b/examples/typescript-graphql-request/codegen.ts
@@ -7,7 +7,6 @@ const config: CodegenConfig = {
   generates: {
     './src/gql/': {
       preset: 'client',
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/vue/apollo-composable/codegen.ts b/examples/vue/apollo-composable/codegen.ts
@@ -9,7 +9,6 @@ const config: CodegenConfig = {
       config: {
         useTypeImports: true,
       },
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/vue/urql/codegen.ts b/examples/vue/urql/codegen.ts
@@ -9,7 +9,6 @@ const config: CodegenConfig = {
       config: {
         useTypeImports: true,
       },
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/vue/villus/codegen.ts b/examples/vue/villus/codegen.ts
@@ -9,7 +9,6 @@ const config: CodegenConfig = {
       config: {
         useTypeImports: true,
       },
-      plugins: [],
     },
   },
   hooks: { afterAllFileWrite: ['prettier --write'] },

diff --git a/examples/yoga-tests/codegen.ts b/examples/yoga-tests/codegen.ts
@@ -6,7 +6,6 @@ const config: CodegenConfig = {
   documents: ['src/**/*.ts'],
   generates: {
     './src/gql/': {
-      plugins: [],
       preset: 'client-preset',
     },
   },

diff --git a/packages/graphql-codegen-cli/tests/codegen.spec.ts b/packages/graphql-codegen-cli/tests/codegen.spec.ts
@@ -164,23 +164,47 @@ describe('Codegen Executor', () => {
       }
     });
 
-    it('Should throw when one output has no plugins defined', async () => {
+    it.only('Should throw when one output has no plugins or preset defined', async () => {
+      expect.assertions(1);
       try {
         await executeCodegen({
+          schema: SIMPLE_TEST_SCHEMA,
+          generates: {
+            'out.ts': {},
+          },
+        });
+      } catch (e) {
+        expect(e.message).toMatch('Invalid Codegen Configuration!');
+      }
+    });
+
+    it.only('Should throw when one output has no plugins defined', async () => {
+      expect.assertions(1);
+      try {
+        await executeCodegen({
+          schema: SIMPLE_TEST_SCHEMA,
           generates: {
             'out.ts': {
               plugins: [],
             },
           },
         });
-
-        throw new Error(SHOULD_NOT_THROW_STRING);
       } catch (e) {
-        expect(e.message).not.toBe(SHOULD_NOT_THROW_STRING);
         expect(e.message).toMatch('Invalid Codegen Configuration!');
       }
     });
 
+    it.only('Should succeed when one output has no plugins but preset defined', async () => {
+      await executeCodegen({
+        schema: SIMPLE_TEST_SCHEMA,
+        generates: {
+          './src/gql/': {
+            preset: 'client-preset',
+          },
+        },
+      });
+    });
+
     it('should handle extend keyword when GraphQLSchema is used', async () => {
       const output = await executeCodegen({
         schema: './tests/test-files/schema-dir/with-extend.js',

diff --git a/packages/presets/client/tests/client-preset.spec.ts b/packages/presets/client/tests/client-preset.spec.ts
@@ -21,7 +21,6 @@ describe('client-preset', () => {
       generates: {
         'out1/': {
           preset,
-          plugins: [],
         },
       },
     });
@@ -109,7 +108,6 @@ export * from "./gql";`);
       generates: {
         'out1/': {
           preset,
-          plugins: [],
         },
       },
     });
@@ -197,7 +195,6 @@ export * from "./gql";`);
       generates: {
         'out1/': {
           preset,
-          plugins: [],
         },
       },
     });
@@ -273,7 +270,6 @@ export * from "./gql";`);
       generates: {
         'out1/': {
           preset,
-          plugins: [],
         },
       },
       config: {
@@ -402,7 +398,6 @@ export * from "./gql";`);
       generates: {
         'out1/': {
           preset,
-          plugins: [],
         },
       },
       config: {
@@ -524,7 +519,6 @@ export * from "./gql";`);
       generates: {
         'out1/': {
           preset,
-          plugins: [],
         },
       },
       config: {
@@ -629,7 +623,6 @@ export * from "./gql";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               fragmentMasking: false,
             },
@@ -717,7 +710,6 @@ export * from "./gql";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               fragmentMasking: {},
             },
@@ -743,7 +735,6 @@ export * from "./gql";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               fragmentMasking: {
                 unmaskFunctionName: 'iLikeTurtles',
@@ -859,7 +850,6 @@ export * from "./gql";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               fragmentMasking: true,
             },
@@ -899,7 +889,6 @@ export * from "./gql";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               fragmentMasking: true,
             },
@@ -937,7 +926,6 @@ export * from "./gql";`);
       generates: {
         'out1/': {
           preset,
-          plugins: [],
         },
       },
       emitLegacyCommonJSImports: false,
@@ -1026,7 +1014,6 @@ export * from "./gql.js";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
           },
         },
         emitLegacyCommonJSImports: false,
@@ -1098,7 +1085,6 @@ export * from "./gql.js";`);
       generates: {
         'out1/': {
           preset,
-          plugins: [],
           presetConfig: {
             onExecutableDocumentNode(node) {
               return {
@@ -1167,7 +1153,6 @@ export * from "./gql.js";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               persistedDocuments: true,
             },
@@ -1245,7 +1230,6 @@ export * from "./gql.js";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               persistedDocuments: {
                 mode: 'replaceDocumentWithHash',
@@ -1325,7 +1309,6 @@ export * from "./gql.js";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               persistedDocuments: {
                 hashPropertyName: 'custom_property_name',
@@ -1416,7 +1399,6 @@ export * from "./gql.js";`);
         generates: {
           'out1/': {
             preset,
-            plugins: [],
             presetConfig: {
               persistedDocuments: true,
               onExecutableDocumentNode(node) {

diff --git a/packages/presets/gql-tag-operations/src/index.ts b/packages/presets/gql-tag-operations/src/index.ts
@@ -36,7 +36,6 @@ export type GqlTagConfig = {
    *    generates: {
    *      'path/to/file.ts': {
    *        preset: 'gql-tag-operations',
-   *        plugins: [],
    *        presetConfig: {
    *          augmentedModuleName: '@urql/core'
    *        },
@@ -58,7 +57,6 @@ export type GqlTagConfig = {
    *    generates: {
    *      'path/to/file.ts': {
    *        preset: 'gql-tag-operations',
-   *        plugins: [],
    *        presetConfig: {
    *          fragmentMasking: true
    *        },
@@ -78,7 +76,6 @@ export type GqlTagConfig = {
    *    generates: {
    *      'path/to/file.ts': {
    *        preset: 'gql-tag-operations',
-   *        plugins: [],
    *        presetConfig: {
    *          augmentedModuleName: '@urql/core',
    *          fragmentMasking: {
@@ -107,7 +104,6 @@ export type GqlTagConfig = {
    *    generates: {
    *      'path/to/file.ts': {
    *        preset: 'gql-tag-operations',
-   *        plugins: [],
    *        presetConfig: {
    *          gqlTagName: 'graphql'
    *        },