Include @graphql-codegen/client-preset in @graphql-codegen/cli by def…

…ault (#9601) * include client preset in @graphql-codegen/cli by default * add changeset * Update docs * chore(dependencies): updated changesets for modified dependencies * remove dependecy from example * fix types --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
dotansimha · Oct 25, 2023 · e176eab · e176eab
1 parent 1efda78
commit e176eab
Show file tree

Hide file tree

Showing 27 changed files with 27 additions and 34 deletions.
diff --git a/.changeset/@graphql-codegen_cli-9601-dependencies.md b/.changeset/@graphql-codegen_cli-9601-dependencies.md
@@ -0,0 +1,5 @@
+---
+"@graphql-codegen/cli": patch
+---
+dependencies updates:
+  - Added dependency [`@graphql-codegen/client-preset@^4.1.0` ↗︎](https://www.npmjs.com/package/@graphql-codegen/client-preset/v/4.1.0) (to `dependencies`)
diff --git a/.changeset/quiet-flies-perform.md b/.changeset/quiet-flies-perform.md
@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/cli': patch
+---
+
+Include @graphql-codegen/client-preset in @graphql-codegen/cli by default
diff --git a/examples/persisted-documents-string-mode/package.json b/examples/persisted-documents-string-mode/package.json
@@ -11,7 +11,6 @@
     "jest": "28.1.3",
     "babel-jest": "29.6.4",
     "@graphql-codegen/cli": "5.0.0",
-    "@graphql-codegen/client-preset": "4.1.0",
     "@babel/core": "7.22.11",
     "@babel/preset-env": "7.22.10",
     "@babel/preset-typescript": "7.22.11"

diff --git a/examples/persisted-documents/package.json b/examples/persisted-documents/package.json
@@ -11,7 +11,6 @@
     "jest": "28.1.3",
     "babel-jest": "29.6.4",
     "@graphql-codegen/cli": "5.0.0",
-    "@graphql-codegen/client-preset": "4.1.0",
     "@babel/core": "7.22.11",
     "@babel/preset-env": "7.22.10",
     "@babel/preset-typescript": "7.22.11"

diff --git a/examples/react/apollo-client-defer/package.json b/examples/react/apollo-client-defer/package.json
@@ -12,7 +12,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@types/jest": "^27.5.2",
     "@types/node": "^18.11.18",
     "@types/react": "^18.0.15",

diff --git a/examples/react/apollo-client-swc-plugin/package.json b/examples/react/apollo-client-swc-plugin/package.json
@@ -9,7 +9,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/client-preset-swc-plugin": "0.2.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@graphql-codegen/cli": "^5.0.0",
     "@vitejs/plugin-react-swc": "^3.3.0",
     "@types/react": "18.2.21",

diff --git a/examples/react/apollo-client/package.json b/examples/react/apollo-client/package.json
@@ -10,7 +10,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@vitejs/plugin-react": "^3.1.0",
     "@types/jest": "^27.5.2",
     "@types/node": "^18.11.18",

diff --git a/examples/react/http-executor/package.json b/examples/react/http-executor/package.json
@@ -9,7 +9,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@vitejs/plugin-react": "^3.1.0",
     "@types/jest": "^27.5.2",
     "@types/node": "^18.11.18",

diff --git a/examples/react/nextjs-swr/hooks/use-query.ts b/examples/react/nextjs-swr/hooks/use-query.ts
@@ -20,10 +20,10 @@ export function useGraphQL<TResult, TVariables>(
       document.definitions.find(isOperationDefinition)?.name,
       variables,
     ] as const,
-    async (_key, variables) =>
+    async (_key: string, variables: any) =>
       executor({
-        document: document as any,
-        variables: variables as any,
+        document,
+        variables,
       }) as Promise<ExecutionResult<TResult>>
   );
 }
diff --git a/examples/react/nextjs-swr/package.json b/examples/react/nextjs-swr/package.json
@@ -20,7 +20,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@graphql-codegen/schema-ast": "4.0.0",
     "@graphql-codegen/client-preset-swc-plugin": "0.2.0",
     "@types/node": "^18.11.18",

diff --git a/examples/react/tanstack-react-query/package.json b/examples/react/tanstack-react-query/package.json
@@ -9,7 +9,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@vitejs/plugin-react": "^3.1.0",
     "@types/jest": "^27.5.2",
     "@types/node": "^18.11.18",

diff --git a/examples/react/urql/package.json b/examples/react/urql/package.json
@@ -11,7 +11,6 @@
     "@types/react": "^18.0.17",
     "@types/react-dom": "^18.0.10",
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@vitejs/plugin-react": "^3.1.0",
     "typescript": "5.2.2",
     "serve": "14.2.1",

diff --git a/examples/typescript-esm/package.json b/examples/typescript-esm/package.json
@@ -3,8 +3,7 @@
   "version": "0.0.0",
   "private": true,
   "devDependencies": {
-    "@graphql-codegen/cli": "5.0.0",
-    "@graphql-codegen/client-preset": "4.1.0"
+    "@graphql-codegen/cli": "5.0.0"
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "3.2.0",

diff --git a/examples/typescript-graphql-request/package.json b/examples/typescript-graphql-request/package.json
@@ -4,7 +4,6 @@
   "private": true,
   "devDependencies": {
     "@graphql-codegen/cli": "5.0.0",
-    "@graphql-codegen/client-preset": "4.1.0",
     "babel-jest": "29.6.4",
     "jest": "28.1.3"
   },

diff --git a/examples/vite/vite-react-cts/package.json b/examples/vite/vite-react-cts/package.json
@@ -22,7 +22,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "5.0.0",
-    "@graphql-codegen/client-preset": "4.1.0",
     "@types/react": "^18.0.27",
     "@types/react-dom": "^18.0.10",
     "cypress": "12.17.4",

diff --git a/examples/vite/vite-react-mts/package.json b/examples/vite/vite-react-mts/package.json
@@ -22,7 +22,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "5.0.0",
-    "@graphql-codegen/client-preset": "4.1.0",
     "@types/react": "^18.0.27",
     "@types/react-dom": "^18.0.10",
     "cypress": "12.17.4",

diff --git a/examples/vite/vite-react-ts/package.json b/examples/vite/vite-react-ts/package.json
@@ -22,7 +22,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "5.0.0",
-    "@graphql-codegen/client-preset": "4.1.0",
     "@types/react": "^18.0.27",
     "@types/react-dom": "^18.0.10",
     "cypress": "12.17.4",

diff --git a/examples/vue/apollo-composable/package.json b/examples/vue/apollo-composable/package.json
@@ -18,7 +18,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@vitejs/plugin-vue": "^4.0.0",
     "typescript": "^5.0.0",
     "vite": "^4.1.0",

diff --git a/examples/vue/urql/package.json b/examples/vue/urql/package.json
@@ -17,7 +17,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@vitejs/plugin-vue": "^4.0.0",
     "typescript": "^5.0.0",
     "vite": "^4.1.0",

diff --git a/examples/vue/villus/package.json b/examples/vue/villus/package.json
@@ -17,7 +17,6 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/client-preset": "^4.1.0",
     "@vitejs/plugin-vue": "^4.0.0",
     "typescript": "^5.0.0",
     "vite": "^4.1.0",

diff --git a/examples/yoga-tests/package.json b/examples/yoga-tests/package.json
@@ -10,7 +10,6 @@
     "jest": "28.1.3",
     "babel-jest": "29.6.4",
     "@graphql-codegen/cli": "5.0.0",
-    "@graphql-codegen/client-preset": "4.1.0",
     "@babel/core": "7.22.11",
     "@babel/preset-env": "7.22.10",
     "@babel/preset-typescript": "7.22.11"

diff --git a/packages/graphql-codegen-cli/package.json b/packages/graphql-codegen-cli/package.json
@@ -43,6 +43,7 @@
     "@babel/generator": "^7.18.13",
     "@babel/template": "^7.18.10",
     "@babel/types": "^7.18.13",
+    "@graphql-codegen/client-preset": "^4.1.0",
     "@graphql-codegen/core": "^4.0.0",
     "@graphql-codegen/plugin-helpers": "^5.0.1",
     "@graphql-tools/apollo-engine-loader": "^8.0.0",

diff --git a/website/src/pages/docs/getting-started/index.mdx b/website/src/pages/docs/getting-started/index.mdx
@@ -260,7 +260,7 @@ After installing 3 packages:
 
 ```sh npm2yarn
 npm i graphql
-npm i -D typescript @graphql-codegen/cli @graphql-codegen/client-preset
+npm i -D typescript @graphql-codegen/cli
 ```
 
 and providing a simple configuration:

diff --git a/website/src/pages/docs/getting-started/installation.mdx b/website/src/pages/docs/getting-started/installation.mdx
@@ -64,7 +64,7 @@ If you are looking for the **best way to leverage GraphQL Code Generator on your
 
 #### Client
 
-We recommend using [a `client` preset](/plugins/presets/preset-client) that has a recommended configuration for the client applications. You can follow one of the following guides:
+We recommend using [a `client` preset](/plugins/presets/preset-client) that has a recommended configuration for the client applications. It's included in the `@graphql-codegen/cli` package by default. Follow one of the following guides to learn more:
 
 - [React](/docs/guides/react-vue)
 - [Vue](/docs/guides/react-vue)

diff --git a/website/src/pages/docs/guides/api-testing.mdx b/website/src/pages/docs/guides/api-testing.mdx
@@ -29,7 +29,7 @@ npm i graphql-yoga
 Install the following development dependencies:
 
 ```sh npm2yarn
-npm i -D typescript ts-node @graphql-codegen/cli @graphql-codegen/client-preset jest @babel/core @babel/preset-env @babel/preset-typescript babel-jest @graphql-typed-document-node/core
+npm i -D typescript ts-node @graphql-codegen/cli jest @babel/core @babel/preset-env @babel/preset-typescript babel-jest @graphql-typed-document-node/core
 ```
 
 ## Setup

diff --git a/website/src/pages/docs/guides/react-vue.mdx b/website/src/pages/docs/guides/react-vue.mdx
@@ -49,21 +49,21 @@ For most GraphQL clients and frameworks (React, Vue), install the following pack
 
 ```bash
 yarn add graphql
-yarn add -D typescript ts-node @graphql-codegen/cli @graphql-codegen/client-preset
+yarn add -D typescript ts-node @graphql-codegen/cli
 ```
 
 **For npm:**
 
 ```bash
 npm i -S graphql
-npm i -D typescript ts-node @graphql-codegen/cli @graphql-codegen/client-preset
+npm i -D typescript ts-node @graphql-codegen/cli
 ```
 
 **For pnpm:**
 
 ```bash
 pnpm i graphql @graphql-typed-document-node/core
-pnpm i -D typescript ts-node @graphql-codegen/cli @graphql-codegen/client-preset
+pnpm i -D typescript ts-node @graphql-codegen/cli
 ```
 
 <br />

diff --git a/yarn.lock b/yarn.lock
@@ -4513,16 +4513,16 @@
   resolved "https://registry.yarnpkg.com/@types/trusted-types/-/trusted-types-2.0.2.tgz#fc25ad9943bcac11cceb8168db4f275e0e72e756"
   integrity sha512-F5DIZ36YVLE+PN+Zwws4kJogq47hNgX3Nx6WyDJ3kcplxyke3XIzB8uK5n/Lpm1HBsbGzd6nmGehL8cPekP+Tg==
 
-"@types/unist@*", "@types/unist@^2.0.0", "@types/unist@^2.0.2":
-  version "2.0.6"
-  resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.6.tgz#250a7b16c3b91f672a24552ec64678eeb1d3a08d"
-  integrity sha512-PBjIUxZHOuj0R15/xuwJYjFi+KZdNFrehocChv4g5hu6aFroHue8m0lBP0POdK2nKzbw0cgV1mws8+V/JAcEkQ==
-
-"@types/unist@^3.0.0":
+"@types/unist@*", "@types/unist@^3.0.0":
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.0.tgz#988ae8af1e5239e89f9fbb1ade4c935f4eeedf9a"
   integrity sha512-MFETx3tbTjE7Uk6vvnWINA/1iJ7LuMdO4fcq8UfF0pRbj01aGLduVvQcRyswuACJdpnHgg8E3rQLhaRdNEJS0w==
 
+"@types/unist@^2.0.0", "@types/unist@^2.0.2":
+  version "2.0.6"
+  resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.6.tgz#250a7b16c3b91f672a24552ec64678eeb1d3a08d"
+  integrity sha512-PBjIUxZHOuj0R15/xuwJYjFi+KZdNFrehocChv4g5hu6aFroHue8m0lBP0POdK2nKzbw0cgV1mws8+V/JAcEkQ==
+
 "@types/ws@^8.0.0":
   version "8.5.4"
   resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.5.4.tgz#bb10e36116d6e570dd943735f86c933c1587b8a5"