fix: use gqlTagName in the autogenerated example (#8995)

Co-authored-by: Laurin Quast <laurinquast@googlemail.com>
dotansimha · Feb 16, 2023 · fe2e9c7 · fe2e9c7
1 parent 9c600c6
commit fe2e9c7
Show file tree

Hide file tree

Showing 17 changed files with 122 additions and 116 deletions.
diff --git a/.changeset/nasty-eggs-rule.md b/.changeset/nasty-eggs-rule.md
@@ -0,0 +1,6 @@
+---
+'@graphql-codegen/gql-tag-operations': patch
+'@graphql-codegen/client-preset': patch
+---
+
+Use `gqlTagName` for generated examples
diff --git a/dev-test/gql-tag-operations/graphql/gql.ts b/dev-test/gql-tag-operations/graphql/gql.ts
@@ -24,7 +24,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/persisted-documents/src/gql/gql.ts b/examples/persisted-documents/src/gql/gql.ts
@@ -22,7 +22,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/react/apollo-client/src/gql/gql.ts b/examples/react/apollo-client/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/react/babel-optimized/src/gql/gql.ts b/examples/react/babel-optimized/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/react/graphql-request/src/gql/gql.ts b/examples/react/graphql-request/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/react/nextjs-swr/gql/gql.ts b/examples/react/nextjs-swr/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/react/tanstack-react-query/src/gql/gql.ts b/examples/react/tanstack-react-query/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/react/urql/src/gql/gql.ts b/examples/react/urql/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/typescript-esm/src/gql/gql.ts b/examples/typescript-esm/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/typescript-graphql-request/src/gql/gql.ts b/examples/typescript-graphql-request/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/vue/apollo-composable/src/gql/gql.ts b/examples/vue/apollo-composable/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/vue/urql/src/gql/gql.ts b/examples/vue/urql/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/vue/villus/src/gql/gql.ts b/examples/vue/villus/src/gql/gql.ts
@@ -25,7 +25,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/examples/yoga-tests/src/gql/gql.ts b/examples/yoga-tests/src/gql/gql.ts
@@ -24,7 +24,7 @@ const documents = {
  *
  * @example
  * ```ts
- * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
  * ```
  *
  * The query argument is unknown!

diff --git a/packages/plugins/typescript/gql-tag-operations/src/index.ts b/packages/plugins/typescript/gql-tag-operations/src/index.ts
@@ -54,7 +54,7 @@ export const plugin: PluginFunction<{
         `/**\n * The ${gqlTagName} function is used to parse GraphQL queries into a document that can be used by GraphQL clients.\n *\n`,
         ` *\n * @example\n`,
         ' * ```ts\n',
-        ' * const query = gql(`query GetUser($id: ID!) { user(id: $id) { name } }`);\n',
+        ` * const query = ${gqlTagName}` + '(`query GetUser($id: ID!) { user(id: $id) { name } }`);\n',
         ' * ```\n *\n',
         ` * The query argument is unknown!\n`,
         ` * Please regenerate the types.\n`,