diff --git a/examples/react/graphql-request/.gitignore b/examples/react/http-executor/.gitignore similarity index 100% rename from examples/react/graphql-request/.gitignore rename to examples/react/http-executor/.gitignore diff --git a/examples/react/graphql-request/README.md b/examples/react/http-executor/README.md similarity index 100% rename from examples/react/graphql-request/README.md rename to examples/react/http-executor/README.md diff --git a/examples/react/graphql-request/codegen.ts b/examples/react/http-executor/codegen.ts similarity index 100% rename from examples/react/graphql-request/codegen.ts rename to examples/react/http-executor/codegen.ts diff --git a/examples/react/graphql-request/cypress.config.ts b/examples/react/http-executor/cypress.config.ts similarity index 100% rename from examples/react/graphql-request/cypress.config.ts rename to examples/react/http-executor/cypress.config.ts diff --git a/examples/react/graphql-request/cypress/e2e/end2end.cy.ts b/examples/react/http-executor/cypress/e2e/end2end.cy.ts similarity index 100% rename from examples/react/graphql-request/cypress/e2e/end2end.cy.ts rename to examples/react/http-executor/cypress/e2e/end2end.cy.ts diff --git a/examples/react/graphql-request/cypress/support/commands.ts b/examples/react/http-executor/cypress/support/commands.ts similarity index 100% rename from examples/react/graphql-request/cypress/support/commands.ts rename to examples/react/http-executor/cypress/support/commands.ts diff --git a/examples/react/graphql-request/cypress/support/e2e.ts b/examples/react/http-executor/cypress/support/e2e.ts similarity index 100% rename from examples/react/graphql-request/cypress/support/e2e.ts rename to examples/react/http-executor/cypress/support/e2e.ts diff --git a/examples/react/graphql-request/index.html b/examples/react/http-executor/index.html similarity index 100% rename from examples/react/graphql-request/index.html rename to examples/react/http-executor/index.html diff --git a/examples/react/graphql-request/package.json b/examples/react/http-executor/package.json similarity index 100% rename from examples/react/graphql-request/package.json rename to examples/react/http-executor/package.json diff --git a/examples/react/graphql-request/public/vite.svg b/examples/react/http-executor/public/vite.svg similarity index 100% rename from examples/react/graphql-request/public/vite.svg rename to examples/react/http-executor/public/vite.svg diff --git a/examples/react/graphql-request/src/App.css b/examples/react/http-executor/src/App.css similarity index 100% rename from examples/react/graphql-request/src/App.css rename to examples/react/http-executor/src/App.css diff --git a/examples/react/graphql-request/src/App.tsx b/examples/react/http-executor/src/App.tsx similarity index 100% rename from examples/react/graphql-request/src/App.tsx rename to examples/react/http-executor/src/App.tsx diff --git a/examples/react/graphql-request/src/Film.tsx b/examples/react/http-executor/src/Film.tsx similarity index 100% rename from examples/react/graphql-request/src/Film.tsx rename to examples/react/http-executor/src/Film.tsx diff --git a/examples/react/graphql-request/src/gql/fragment-masking.ts b/examples/react/http-executor/src/gql/fragment-masking.ts similarity index 100% rename from examples/react/graphql-request/src/gql/fragment-masking.ts rename to examples/react/http-executor/src/gql/fragment-masking.ts diff --git a/examples/react/graphql-request/src/gql/gql.ts b/examples/react/http-executor/src/gql/gql.ts similarity index 100% rename from examples/react/graphql-request/src/gql/gql.ts rename to examples/react/http-executor/src/gql/gql.ts diff --git a/examples/react/graphql-request/src/gql/graphql.ts b/examples/react/http-executor/src/gql/graphql.ts similarity index 100% rename from examples/react/graphql-request/src/gql/graphql.ts rename to examples/react/http-executor/src/gql/graphql.ts diff --git a/examples/react/graphql-request/src/gql/index.ts b/examples/react/http-executor/src/gql/index.ts similarity index 100% rename from examples/react/graphql-request/src/gql/index.ts rename to examples/react/http-executor/src/gql/index.ts diff --git a/examples/react/graphql-request/src/logo.svg b/examples/react/http-executor/src/logo.svg similarity index 100% rename from examples/react/graphql-request/src/logo.svg rename to examples/react/http-executor/src/logo.svg diff --git a/examples/react/graphql-request/src/main.css b/examples/react/http-executor/src/main.css similarity index 100% rename from examples/react/graphql-request/src/main.css rename to examples/react/http-executor/src/main.css diff --git a/examples/react/graphql-request/src/main.tsx b/examples/react/http-executor/src/main.tsx similarity index 100% rename from examples/react/graphql-request/src/main.tsx rename to examples/react/http-executor/src/main.tsx diff --git a/examples/react/graphql-request/tsconfig.json b/examples/react/http-executor/tsconfig.json similarity index 100% rename from examples/react/graphql-request/tsconfig.json rename to examples/react/http-executor/tsconfig.json diff --git a/examples/react/graphql-request/tsconfig.node.json b/examples/react/http-executor/tsconfig.node.json similarity index 100% rename from examples/react/graphql-request/tsconfig.node.json rename to examples/react/http-executor/tsconfig.node.json diff --git a/examples/react/graphql-request/vite.config.ts b/examples/react/http-executor/vite.config.ts similarity index 100% rename from examples/react/graphql-request/vite.config.ts rename to examples/react/http-executor/vite.config.ts diff --git a/examples/typescript-graphql-request/babel.config.js b/examples/typescript-graphql-request/babel.config.js new file mode 100644 index 00000000000..3e4899f4a74 --- /dev/null +++ b/examples/typescript-graphql-request/babel.config.js @@ -0,0 +1,6 @@ +module.exports = { + presets: [ + ['@babel/preset-env', { targets: { node: process.versions.node.split('.')[0] } }], + '@babel/preset-typescript', + ], +}; diff --git a/examples/typescript-graphql-request/jest.config.js b/examples/typescript-graphql-request/jest.config.js new file mode 100644 index 00000000000..05b73658e17 --- /dev/null +++ b/examples/typescript-graphql-request/jest.config.js @@ -0,0 +1,4 @@ +module.exports = { + transform: { '^.+\\.ts': 'babel-jest' }, + testPathIgnorePatterns: ['/node_modules/', '/dist/'], +}; diff --git a/examples/typescript-graphql-request/package.json b/examples/typescript-graphql-request/package.json index 67c990bf845..853b5cf25d7 100644 --- a/examples/typescript-graphql-request/package.json +++ b/examples/typescript-graphql-request/package.json @@ -17,7 +17,7 @@ "codegen": "graphql-codegen --config codegen.ts", "build": "tsc", "dev": "ts-node src/main.ts", - "test:end2end": "exit 0" + "test:end2end": "yarn jest" }, "type": "commonjs", "bob": false diff --git a/examples/typescript-graphql-request/src/main.spec.ts b/examples/typescript-graphql-request/src/main.spec.ts new file mode 100644 index 00000000000..69d2911f21f --- /dev/null +++ b/examples/typescript-graphql-request/src/main.spec.ts @@ -0,0 +1,13 @@ +import { getPeople } from './main'; + +describe('TypeScript GraphQL Request tests', () => { + it('works without variables', async () => { + const result = await getPeople(); + expect(result?.map(o => o?.node?.name)).toContain('Luke Skywalker'); + }); + + it('returns first 3 entries', async () => { + const result = await getPeople(3); + expect(result).toHaveLength(3); + }); +}); diff --git a/examples/typescript-graphql-request/src/main.ts b/examples/typescript-graphql-request/src/main.ts index c820b60ab3b..890790df416 100644 --- a/examples/typescript-graphql-request/src/main.ts +++ b/examples/typescript-graphql-request/src/main.ts @@ -1,6 +1,7 @@ /* eslint-disable no-console */ import { GraphQLClient } from 'graphql-request'; import { graphql } from './gql'; +import { AllPeopleQueryQuery } from './gql/graphql'; const AllPeopleQueryDocument = graphql(/* GraphQL */ ` query AllPeopleQuery { @@ -36,10 +37,15 @@ const apiUrl = 'https://swapi-graphql.netlify.app/.netlify/functions/index'; const client = new GraphQLClient(apiUrl); -client.request(AllPeopleQueryDocument.toString()).then(res => { - console.log(res?.allPeople?.edges); -}); +export const getPeople = async (first?: number) => { + let res: AllPeopleQueryQuery; + if (first) { + res = await client.request(AllPeopleWithVariablesQueryDocument.toString(), { first }); + } else { + res = await client.request(AllPeopleQueryDocument.toString()); + } + return res?.allPeople?.edges; +}; -client.request(AllPeopleWithVariablesQueryDocument.toString(), { first: 10 }).then(res => { - console.log(res?.allPeople?.edges); -}); +getPeople().then(res => console.log(res)); +getPeople(10).then(res => console.log(res)); diff --git a/website/src/pages/docs/advanced/document-transform.mdx b/website/src/pages/docs/advanced/document-transform.mdx index 475acb99e50..f5be0967f15 100644 --- a/website/src/pages/docs/advanced/document-transform.mdx +++ b/website/src/pages/docs/advanced/document-transform.mdx @@ -1,3 +1,7 @@ +--- +description: Document transform is a feature that allows you to modify documents before they are used by plugins. +--- + import { Callout } from '@theguild/components' # Document Transform diff --git a/website/src/pages/docs/advanced/generated-files-colocation.mdx b/website/src/pages/docs/advanced/generated-files-colocation.mdx index c098393cba5..a229f269b84 100644 --- a/website/src/pages/docs/advanced/generated-files-colocation.mdx +++ b/website/src/pages/docs/advanced/generated-files-colocation.mdx @@ -1,3 +1,6 @@ +--- +description: Generate types near your GraphQL operations. Colocate your generated files with your original GraphQL operations. +--- import { PackageCmd, Callout } from '@theguild/components' # Generated files colocation diff --git a/website/src/pages/docs/advanced/how-does-it-work.mdx b/website/src/pages/docs/advanced/how-does-it-work.mdx index 9abd8118531..0c92718c53d 100644 --- a/website/src/pages/docs/advanced/how-does-it-work.mdx +++ b/website/src/pages/docs/advanced/how-does-it-work.mdx @@ -1,3 +1,6 @@ +--- +description: GraphQL Introspection allows fetching the types defined in the target GraphQL API. GraphQL AST allows to navigate through both client-side operations and remote schema types. +--- # How does GraphQL Code Generator Work? In order to generate code and types, GraphQL Code Generator relies on 2 main core concepts of GraphQL: diff --git a/website/src/pages/docs/advanced/profiler.mdx b/website/src/pages/docs/advanced/profiler.mdx index aae7ca3e9e0..2523c074054 100644 --- a/website/src/pages/docs/advanced/profiler.mdx +++ b/website/src/pages/docs/advanced/profiler.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator CLI provides a flag that enables the profiler mode. This allows you to identify performance bottlenecks in your codegen configuration. +--- + import { PackageCmd } from '@theguild/components' # GraphQL Code Generator Profiler diff --git a/website/src/pages/docs/advanced/programmatic-usage.mdx b/website/src/pages/docs/advanced/programmatic-usage.mdx index f18dd4d6bf8..5716ea4bfbe 100644 --- a/website/src/pages/docs/advanced/programmatic-usage.mdx +++ b/website/src/pages/docs/advanced/programmatic-usage.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator also provides a complete programmatic API. The programmatic API can be used if you need to customize the execution flow or write a tool that uses the codegen. +--- + import { Callout } from '@theguild/components' # Programmatic Usage diff --git a/website/src/pages/docs/config-reference/codegen-config.mdx b/website/src/pages/docs/config-reference/codegen-config.mdx index 2972f1897de..5320c34b127 100644 --- a/website/src/pages/docs/config-reference/codegen-config.mdx +++ b/website/src/pages/docs/config-reference/codegen-config.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to configure GraphQL Code Generator to generate code from your GraphQL schema and documents. +--- + import { PackageCmd, Callout } from '@theguild/components' # `codegen.ts` file diff --git a/website/src/pages/docs/config-reference/config-field.mdx b/website/src/pages/docs/config-reference/config-field.mdx index 99b8557afe6..b732dea4371 100644 --- a/website/src/pages/docs/config-reference/config-field.mdx +++ b/website/src/pages/docs/config-reference/config-field.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to configure GraphQL Code Generator to fit your needs. The `config` field is used to pass configuration to Plugins. +--- + import { Callout } from '@theguild/components' # `config` field diff --git a/website/src/pages/docs/config-reference/documents-field.mdx b/website/src/pages/docs/config-reference/documents-field.mdx index 1f1ae564735..e76947d99ba 100644 --- a/website/src/pages/docs/config-reference/documents-field.mdx +++ b/website/src/pages/docs/config-reference/documents-field.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to specify the documents field in your GraphQL Code Generator config file. +--- + import { Callout } from '@theguild/components' # `documents` field diff --git a/website/src/pages/docs/config-reference/lifecycle-hooks.mdx b/website/src/pages/docs/config-reference/lifecycle-hooks.mdx index 9629f22b7ce..4ec4ab57b40 100644 --- a/website/src/pages/docs/config-reference/lifecycle-hooks.mdx +++ b/website/src/pages/docs/config-reference/lifecycle-hooks.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to use the GraphQL Code Generator CLI to generate code from your GraphQL schema and operations. +--- + import { Callout } from '@theguild/components' # Lifecycle Hooks diff --git a/website/src/pages/docs/config-reference/multiproject-config.mdx b/website/src/pages/docs/config-reference/multiproject-config.mdx index 52d928ead4a..abd4667638c 100644 --- a/website/src/pages/docs/config-reference/multiproject-config.mdx +++ b/website/src/pages/docs/config-reference/multiproject-config.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to use GraphQL Code Generator with multiple projects in the same config file. +--- + # Multi Project In some cases, it's useful to have multiple projects in the same config file. diff --git a/website/src/pages/docs/config-reference/naming-convention.mdx b/website/src/pages/docs/config-reference/naming-convention.mdx index fd277ae3767..fb175a530fe 100644 --- a/website/src/pages/docs/config-reference/naming-convention.mdx +++ b/website/src/pages/docs/config-reference/naming-convention.mdx @@ -1,3 +1,7 @@ +--- +description: 'GraphQL Code Generator is a tool for generating code from GraphQL schema and operations.' +--- + # Naming Convention GraphQL Code Generation provides a `namingConvention` option to control the naming convention of the different code elements generated (types, enum values, …). diff --git a/website/src/pages/docs/config-reference/require-field.mdx b/website/src/pages/docs/config-reference/require-field.mdx index dc3079b8cdb..55041d18cae 100644 --- a/website/src/pages/docs/config-reference/require-field.mdx +++ b/website/src/pages/docs/config-reference/require-field.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to use the require field to load external files without transpiling them. +--- + import { Callout } from '@theguild/components' # `require` field diff --git a/website/src/pages/docs/config-reference/schema-field.mdx b/website/src/pages/docs/config-reference/schema-field.mdx index e5b5f1eeccc..2354100a517 100644 --- a/website/src/pages/docs/config-reference/schema-field.mdx +++ b/website/src/pages/docs/config-reference/schema-field.mdx @@ -1,3 +1,7 @@ +--- +description: How to specify your GraphQL Schema in GraphQL Code Generator. Learn how to load your schema from a remote server, local file, or multiple files. +--- + import { Callout } from '@theguild/components' # `schema` field diff --git a/website/src/pages/docs/custom-codegen/contributing.mdx b/website/src/pages/docs/custom-codegen/contributing.mdx index 40707c0c86f..8b46d776359 100644 --- a/website/src/pages/docs/custom-codegen/contributing.mdx +++ b/website/src/pages/docs/custom-codegen/contributing.mdx @@ -1,3 +1,7 @@ +--- +description: Create a new GraphQL Code Generator plugin for your favorite language or platform. +--- + import { Callout } from '@theguild/components' # Contributing diff --git a/website/src/pages/docs/custom-codegen/extend-schema.mdx b/website/src/pages/docs/custom-codegen/extend-schema.mdx index e4bee921dcb..f1040851080 100644 --- a/website/src/pages/docs/custom-codegen/extend-schema.mdx +++ b/website/src/pages/docs/custom-codegen/extend-schema.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to create a custom plugin for GraphQL Code Generator. How to extend the GraphQL Schema? +--- + # How to extend the GraphQL Schema? Each plugin can also specify `addToSchema` field, and to extend the `GraphQLSchema` with more types: diff --git a/website/src/pages/docs/custom-codegen/index.mdx b/website/src/pages/docs/custom-codegen/index.mdx index 6fe4840f366..a31cbb2f155 100644 --- a/website/src/pages/docs/custom-codegen/index.mdx +++ b/website/src/pages/docs/custom-codegen/index.mdx @@ -1,3 +1,7 @@ +--- +description: The general purpose of GraphQL Code Generator is to parse GraphQL syntax, transform it into an AST and then output it into desired formats which can vary. +--- + # What are Plugins? The general purpose of GraphQL Code Generator is to parse GraphQL syntax, transform it into an AST and then output it into desired formats which can vary. diff --git a/website/src/pages/docs/custom-codegen/plugin-structure.mdx b/website/src/pages/docs/custom-codegen/plugin-structure.mdx index 1b4278b5dd3..38bdd0e9a0f 100644 --- a/website/src/pages/docs/custom-codegen/plugin-structure.mdx +++ b/website/src/pages/docs/custom-codegen/plugin-structure.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to write your own GraphQL Code Generator Plugin. You can use it to generate custom output, or to extend the existing plugins. +--- + import { Callout } from '@theguild/components' # Write your first Plugin diff --git a/website/src/pages/docs/custom-codegen/using-visitor.mdx b/website/src/pages/docs/custom-codegen/using-visitor.mdx index 89100fed068..5c3257605b4 100644 --- a/website/src/pages/docs/custom-codegen/using-visitor.mdx +++ b/website/src/pages/docs/custom-codegen/using-visitor.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to write your own plugins for GraphQL Code Generator. Most of the codegen's plugins are written with a design-pattern called Visitor. +--- + # Visitor Pattern Most of the codegen's plugins are written with a design-pattern called [Visitor](https://en.wikipedia.org/wiki/Visitor_pattern). diff --git a/website/src/pages/docs/custom-codegen/validate-configuration.mdx b/website/src/pages/docs/custom-codegen/validate-configuration.mdx index a4d979edfe2..32dca5c9a81 100644 --- a/website/src/pages/docs/custom-codegen/validate-configuration.mdx +++ b/website/src/pages/docs/custom-codegen/validate-configuration.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to create your own plugins for GraphQL Code Generator. You can use plugins to generate code, documents, or even to modify the schema. +--- + import { Callout } from '@theguild/components' # Validate Plugin Configuration diff --git a/website/src/pages/docs/getting-started/development-workflow.mdx b/website/src/pages/docs/getting-started/development-workflow.mdx index 36e63174e52..628f2408c8a 100644 --- a/website/src/pages/docs/getting-started/development-workflow.mdx +++ b/website/src/pages/docs/getting-started/development-workflow.mdx @@ -1,3 +1,7 @@ +--- +description: How to integrate GraphQL Code Generator into your development workflow. Learn how to run it in watch mode, or as part of your CI flow. +--- + # Development workflow GraphQL Code Generator should be integrated as part of your development workflow. diff --git a/website/src/pages/docs/getting-started/esm-typescript-usage.mdx b/website/src/pages/docs/getting-started/esm-typescript-usage.mdx index 61d71417b94..811be608a93 100644 --- a/website/src/pages/docs/getting-started/esm-typescript-usage.mdx +++ b/website/src/pages/docs/getting-started/esm-typescript-usage.mdx @@ -1,5 +1,6 @@ --- title: ESM TypeScript Usage +description: How to use ESM with TypeScript. ESM is an important step in the JavaScript ecosystem because it allows static analysis of the dependency tree. --- # ESM TypeScript Usage diff --git a/website/src/pages/docs/getting-started/index.mdx b/website/src/pages/docs/getting-started/index.mdx index 13752691e52..435bf3056f7 100644 --- a/website/src/pages/docs/getting-started/index.mdx +++ b/website/src/pages/docs/getting-started/index.mdx @@ -1,5 +1,6 @@ --- title: Introduction +description: GraphQL Code Generator is a plugin-based tool that helps you get the best out of your GraphQL stack. From back-end to front-end, GraphQL Code Generator automates the generation of typed Queries, Mutations and, Subscriptions for React, Vue, Angular, Next.js, Svelte, whether you are using Apollo Client, URQL or, React Query. --- import { Tabs, Tab, Callout, PackageCmd } from '@theguild/components' diff --git a/website/src/pages/docs/getting-started/installation.mdx b/website/src/pages/docs/getting-started/installation.mdx index 0b69937a85a..202a2630a71 100644 --- a/website/src/pages/docs/getting-started/installation.mdx +++ b/website/src/pages/docs/getting-started/installation.mdx @@ -1,3 +1,7 @@ +--- +description: 'GraphQL Code Generator is a tool for generating code from GraphQL schema and operations. It can generate code for various platforms, such as React, Angular, Node, and more.' +--- + import { Callout, PackageCmd } from '@theguild/components' # Installation diff --git a/website/src/pages/docs/guides/angular.mdx b/website/src/pages/docs/guides/angular.mdx index 7929ace8a0e..15b482e3a73 100644 --- a/website/src/pages/docs/guides/angular.mdx +++ b/website/src/pages/docs/guides/angular.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator provides the @graphql-codegen/typescript-apollo-angular plugin that generates full-typed Apollo GraphQL services. +--- + import { PackageCmd, Callout } from '@theguild/components' # Guide: Angular diff --git a/website/src/pages/docs/guides/api-testing.mdx b/website/src/pages/docs/guides/api-testing.mdx index fca30b5f0cc..9f565bf0634 100644 --- a/website/src/pages/docs/guides/api-testing.mdx +++ b/website/src/pages/docs/guides/api-testing.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator can generate typed results for your GraphQL operations. This tutorial uses GraphQL Yoga, but the practices are applicable to testing any GraphQL server. +--- + import { Callout, PackageCmd } from '@theguild/components' # Guide: API Testing diff --git a/website/src/pages/docs/guides/flutter-freezed.mdx b/website/src/pages/docs/guides/flutter-freezed.mdx index abd9b605d7c..aa78116ee17 100644 --- a/website/src/pages/docs/guides/flutter-freezed.mdx +++ b/website/src/pages/docs/guides/flutter-freezed.mdx @@ -1,3 +1,7 @@ +--- +description: Boost 🚀 your development of Dart/Flutter apps using a GraphQL API by generating models directly from your GraphQL Schema. +--- + import { PackageCmd, Callout } from '@theguild/components' # Guide: Dart/Flutter diff --git a/website/src/pages/docs/guides/further-reading.mdx b/website/src/pages/docs/guides/further-reading.mdx index 2aceb626fdb..2d97c3ea786 100644 --- a/website/src/pages/docs/guides/further-reading.mdx +++ b/website/src/pages/docs/guides/further-reading.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator is a tool for generating code from your GraphQL schema and operations. It's a great way to get type-safety and auto-completion in your code. +--- + # Further Reading Our guides helps you getting started with the most popular frameworks, GraphQL clients and servers. diff --git a/website/src/pages/docs/guides/graphql-modules.mdx b/website/src/pages/docs/guides/graphql-modules.mdx index 854741c34bb..ee2671a65c9 100644 --- a/website/src/pages/docs/guides/graphql-modules.mdx +++ b/website/src/pages/docs/guides/graphql-modules.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator's `@graphql-codegen/graphql-modules-preset` plugin helps to generate resolvers type for each module of a GraphQL Modules GraphQL API. +--- + import { PackageCmd } from '@theguild/components' # Guide: GraphQL Modules diff --git a/website/src/pages/docs/guides/graphql-server-apollo-yoga-with-server-preset.mdx b/website/src/pages/docs/guides/graphql-server-apollo-yoga-with-server-preset.mdx index cd3221de6d2..b73a93c9252 100644 --- a/website/src/pages/docs/guides/graphql-server-apollo-yoga-with-server-preset.mdx +++ b/website/src/pages/docs/guides/graphql-server-apollo-yoga-with-server-preset.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator's server preset, `@eddeee888/gcg-typescript-resolver-files`, helps GraphQL APIs work at any scale by enforcing best practices such as type-safety and schema module conventions. +--- + import { PackageCmd, Callout, Tabs, Tab } from '@theguild/components' # Guide: GraphQL Yoga / Apollo Server with Server Preset diff --git a/website/src/pages/docs/guides/graphql-server-apollo-yoga.mdx b/website/src/pages/docs/guides/graphql-server-apollo-yoga.mdx index 6d6c20348fb..d7745c11f6d 100644 --- a/website/src/pages/docs/guides/graphql-server-apollo-yoga.mdx +++ b/website/src/pages/docs/guides/graphql-server-apollo-yoga.mdx @@ -1,3 +1,6 @@ +--- +description: GraphQL Code Generator's `@graphql-codegen/typescript-resolvers` plugin generates TypeScript types for your GraphQL API's resolvers. +--- import { PackageCmd, Tabs, Tab, Callout } from '@theguild/components' # Guide: GraphQL Yoga / Apollo Server diff --git a/website/src/pages/docs/guides/react-vue.mdx b/website/src/pages/docs/guides/react-vue.mdx index 0f8c56c2bfb..fd2bc314535 100644 --- a/website/src/pages/docs/guides/react-vue.mdx +++ b/website/src/pages/docs/guides/react-vue.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator is a tool that generates code from your GraphQL schema and operations. It can generate TypeScript, Flow, Swift, Kotlin, and more. +--- + import { Tabs, Tab, Callout, PackageCmd } from '@theguild/components' # Guide: React and Vue diff --git a/website/src/pages/docs/guides/svelte.mdx b/website/src/pages/docs/guides/svelte.mdx index 534be30562a..ff0342aa871 100644 --- a/website/src/pages/docs/guides/svelte.mdx +++ b/website/src/pages/docs/guides/svelte.mdx @@ -1,3 +1,7 @@ +--- +description: Generate typed code for SvelteKit and Apollo. GraphQL Code Generator and the community provide typed code generation for Apollo, SvelteKit _native_, and other clients. +--- + import { Callout, PackageCmd } from '@theguild/components' # Guide: Svelte / Kit diff --git a/website/src/pages/docs/integrations/apollo-local-state.mdx b/website/src/pages/docs/integrations/apollo-local-state.mdx index fd62b918153..ee2a88c906f 100644 --- a/website/src/pages/docs/integrations/apollo-local-state.mdx +++ b/website/src/pages/docs/integrations/apollo-local-state.mdx @@ -1,3 +1,7 @@ +--- +description: Apollo Local State. Suppose you are using apollo-client >2.5 or older, with apollo-link-state to manage your app state with GraphQL. In that case, you're probably using a client-side only GraphQL schema and client-side directives such as `@client`. +--- + # Apollo Local State Suppose you are using [apollo-client](https://apollographql.com/docs/react/v2/data/local-state) >2.5 (or older, with [apollo-link-state](https://apollographql.com/docs/link/links/state.html)) to manage your app state with GraphQL. In that case, you're probably using a client-side only GraphQL schema and client-side directives such as `@client`. diff --git a/website/src/pages/docs/integrations/create-react-app.mdx b/website/src/pages/docs/integrations/create-react-app.mdx index b258d20d8bb..dc3882da5f7 100644 --- a/website/src/pages/docs/integrations/create-react-app.mdx +++ b/website/src/pages/docs/integrations/create-react-app.mdx @@ -1,3 +1,7 @@ +--- +description: Codegen for React Apollo with TypeScript. Generates React Hooks and TypeScript types. +--- + # Create-React-App Since v2 of [Create-React-App](https://github.com/facebook/create-react-app), you can use TypeScript without the need to eject from the basic scripts packages. diff --git a/website/src/pages/docs/integrations/federation.mdx b/website/src/pages/docs/integrations/federation.mdx index 244eacef0e1..9788fb1cda6 100644 --- a/website/src/pages/docs/integrations/federation.mdx +++ b/website/src/pages/docs/integrations/federation.mdx @@ -1,3 +1,7 @@ +--- +description: Generate TypeScript resolvers signatures for your GraphQL schema. Supports Apollo Federation. +--- + # Apollo Federation The `typescript-resolvers` plugin also supports [Apollo Federation](https://apollographql.com/docs/apollo-server/federation/introduction). diff --git a/website/src/pages/docs/integrations/gatsby.mdx b/website/src/pages/docs/integrations/gatsby.mdx index 1705eccd912..da195509942 100644 --- a/website/src/pages/docs/integrations/gatsby.mdx +++ b/website/src/pages/docs/integrations/gatsby.mdx @@ -1,3 +1,7 @@ +--- +description: GraphQL Code Generator is a tool for generating code based on your GraphQL schema and operations. +--- + # Gatsby If you build apps using [Gatsby](https://gatsbyjs.com), you can use its built-in feature called [GraphQL Typegen](https://gatsbyjs.com/docs/how-to/local-development/graphql-typegen). Under the hood it uses the GraphQL Code Generator to generate TypeScript types, but you don't need to set anything up other than enabling an option. diff --git a/website/src/pages/docs/integrations/prettier.mdx b/website/src/pages/docs/integrations/prettier.mdx index ecb42f07fa5..13167588b8b 100644 --- a/website/src/pages/docs/integrations/prettier.mdx +++ b/website/src/pages/docs/integrations/prettier.mdx @@ -1,3 +1,7 @@ +--- +description: Learn how to use Prettier and other linters with GraphQL Code Generator to apply your custom code style and formatting rules. +--- + import { Callout } from '@theguild/components' # Prettier & Linters diff --git a/website/src/pages/docs/integrations/vscode.mdx b/website/src/pages/docs/integrations/vscode.mdx index 47de00c06fc..fb1093c74ad 100644 --- a/website/src/pages/docs/integrations/vscode.mdx +++ b/website/src/pages/docs/integrations/vscode.mdx @@ -1,3 +1,7 @@ +--- +description: Code generation for your GraphQL operations. Generate code from your GraphQL queries, mutations, subscriptions, fragments, and schema. +--- + # VSCode In VSCode, you can install a lightweight extension to get your codegen on every save effortlessly. diff --git a/website/src/pages/docs/migration/from-0-13.mdx b/website/src/pages/docs/migration/from-0-13.mdx index c79dba859d9..5e40f24726b 100644 --- a/website/src/pages/docs/migration/from-0-13.mdx +++ b/website/src/pages/docs/migration/from-0-13.mdx @@ -1,3 +1,7 @@ +--- +description: Migrating from 0.13 to 0.18. What has changed? How to migrate? What are the new features? +--- + import { Callout } from '@theguild/components' # Migration from 0.13 to 0.18 diff --git a/website/src/pages/docs/migration/from-0-18.mdx b/website/src/pages/docs/migration/from-0-18.mdx index fdb03262b05..cf1736206c7 100644 --- a/website/src/pages/docs/migration/from-0-18.mdx +++ b/website/src/pages/docs/migration/from-0-18.mdx @@ -1,3 +1,7 @@ +--- +description: Migrating to 1.0.0. What has changed? How to migrate? What are the new features? +--- + import { Callout, Tabs, Tab, PackageCmd } from '@theguild/components' # Migration to 1.0.0 diff --git a/website/src/pages/plugins/c-sharp/c-sharp-operations.mdx b/website/src/pages/plugins/c-sharp/c-sharp-operations.mdx index 63cfd7db56a..8d76b695c32 100644 --- a/website/src/pages/plugins/c-sharp/c-sharp-operations.mdx +++ b/website/src/pages/plugins/c-sharp/c-sharp-operations.mdx @@ -1,5 +1,6 @@ --- title: c-sharp-operations +description: C# operations plugin. Generates C# methods for the resolvers' signature. Works with GraphQL. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/dart/flutter-freezed.mdx b/website/src/pages/plugins/dart/flutter-freezed.mdx index 77568d827dd..2ecdb8bdcce 100644 --- a/website/src/pages/plugins/dart/flutter-freezed.mdx +++ b/website/src/pages/plugins/dart/flutter-freezed.mdx @@ -1,5 +1,6 @@ --- title: flutter-freezed +description: Flutter plugin for generating Dart classes from GraphQL queries. It uses the freezed package. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/flow/flow-operations.mdx b/website/src/pages/plugins/flow/flow-operations.mdx index f92726f55da..74db4c783d0 100644 --- a/website/src/pages/plugins/flow/flow-operations.mdx +++ b/website/src/pages/plugins/flow/flow-operations.mdx @@ -1,5 +1,6 @@ --- title: flow-operations +description: Flow Operations plugin. This plugin allows you to create and manage operations in your Flow blockchain. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/flow/flow-resolvers.mdx b/website/src/pages/plugins/flow/flow-resolvers.mdx index b18c631ef24..8b469ea002d 100644 --- a/website/src/pages/plugins/flow/flow-resolvers.mdx +++ b/website/src/pages/plugins/flow/flow-resolvers.mdx @@ -1,5 +1,6 @@ --- title: flow-resolvers +description: Flow plugin for GraphQL Code Generator. Generates Flow types for your GraphQL resolvers. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/java/java-apollo-android.mdx b/website/src/pages/plugins/java/java-apollo-android.mdx index 4504e31ef7d..9ad1bc56ec2 100644 --- a/website/src/pages/plugins/java/java-apollo-android.mdx +++ b/website/src/pages/plugins/java/java-apollo-android.mdx @@ -1,5 +1,6 @@ --- title: java-apollo-android +description: GraphQL Code Generator plugin for generating Java code for Apollo Android. --- import { Callout, PackageCmd } from '@theguild/components' diff --git a/website/src/pages/plugins/java/java-resolvers.mdx b/website/src/pages/plugins/java/java-resolvers.mdx index d654b1a2549..faf62f4d8ae 100644 --- a/website/src/pages/plugins/java/java-resolvers.mdx +++ b/website/src/pages/plugins/java/java-resolvers.mdx @@ -1,5 +1,6 @@ --- title: java-resolvers +description: Java Resolvers Plugin. Generate Java interfaces for your resolvers. Works with graphql-java library. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/java/java.mdx b/website/src/pages/plugins/java/java.mdx index ebc3c8c9b8a..8883494f7c2 100644 --- a/website/src/pages/plugins/java/java.mdx +++ b/website/src/pages/plugins/java/java.mdx @@ -1,5 +1,6 @@ --- title: java +description: Java plugin. Generate Java classes from your GraphQL schema. Use it in your resolvers. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/java/kotlin.mdx b/website/src/pages/plugins/java/kotlin.mdx index 1f61a05744f..29a4b640731 100644 --- a/website/src/pages/plugins/java/kotlin.mdx +++ b/website/src/pages/plugins/java/kotlin.mdx @@ -1,5 +1,6 @@ --- title: kotlin +description: Kotlin plugin for GraphQL Code Generator. Generate Kotlin classes for Enums and Input types. --- import { Callout, PackageCmd } from '@theguild/components' diff --git a/website/src/pages/plugins/other/add.mdx b/website/src/pages/plugins/other/add.mdx index 8cc6962a97d..f7a27b29706 100644 --- a/website/src/pages/plugins/other/add.mdx +++ b/website/src/pages/plugins/other/add.mdx @@ -1,5 +1,6 @@ --- title: add +description: Adds custom text to your output file. You can use this plugin to add custom code, imports, comments and more to your output file. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/other/fragment-matcher.mdx b/website/src/pages/plugins/other/fragment-matcher.mdx index 84e5d9f8d90..539459a4773 100644 --- a/website/src/pages/plugins/other/fragment-matcher.mdx +++ b/website/src/pages/plugins/other/fragment-matcher.mdx @@ -1,5 +1,6 @@ --- title: fragment-matcher +description: Generate fragment matcher for Apollo Client. This plugin is required for using fragments with Apollo Client. --- import { Callout, Tabs, Tab } from '@theguild/components' diff --git a/website/src/pages/plugins/other/hasura-allow-list.mdx b/website/src/pages/plugins/other/hasura-allow-list.mdx index 4cc9a611bd3..770f8ccf723 100644 --- a/website/src/pages/plugins/other/hasura-allow-list.mdx +++ b/website/src/pages/plugins/other/hasura-allow-list.mdx @@ -1,5 +1,6 @@ --- title: hasura-allow-list +description: Generate hasura allow list metadata from graphql files. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/other/introspection.mdx b/website/src/pages/plugins/other/introspection.mdx index f0cf865d1f2..c1d6fcf6a20 100644 --- a/website/src/pages/plugins/other/introspection.mdx +++ b/website/src/pages/plugins/other/introspection.mdx @@ -1,5 +1,6 @@ --- title: introspection +description: Introspection plugin for Prisma. This plugin allows you to introspect your database and generate a Prisma schema from it. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/other/jsdoc.mdx b/website/src/pages/plugins/other/jsdoc.mdx index fd40375b1f8..a050e9967c2 100644 --- a/website/src/pages/plugins/other/jsdoc.mdx +++ b/website/src/pages/plugins/other/jsdoc.mdx @@ -1,5 +1,6 @@ --- title: jsdoc +description: This plugin generates types in the form of JSDoc comments based on your GraphQLSchema. --- import { PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/other/reason-client.mdx b/website/src/pages/plugins/other/reason-client.mdx index b8a867a6457..fbdd2d8a6ef 100644 --- a/website/src/pages/plugins/other/reason-client.mdx +++ b/website/src/pages/plugins/other/reason-client.mdx @@ -1,5 +1,6 @@ --- title: reason-client +description: GraphQL Code Generator plugin for ReasonML types. A plugin for GraphQL Codegen to generate ReasonML types based on your GraphQL schema for use in a client application. --- import { PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/other/schema-ast.mdx b/website/src/pages/plugins/other/schema-ast.mdx index b28313af202..9c9ed5beaf3 100644 --- a/website/src/pages/plugins/other/schema-ast.mdx +++ b/website/src/pages/plugins/other/schema-ast.mdx @@ -1,5 +1,6 @@ --- title: schema-ast +description: Generate an AST representation of your GraphQL schema. This plugin is used internally by other plugins. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/other/time.mdx b/website/src/pages/plugins/other/time.mdx index 958488ddb2a..4b54fb74060 100644 --- a/website/src/pages/plugins/other/time.mdx +++ b/website/src/pages/plugins/other/time.mdx @@ -1,5 +1,6 @@ --- title: time +description: Plugin for time. This plugin is used to get the current time. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/other/urql-introspection.mdx b/website/src/pages/plugins/other/urql-introspection.mdx index f0788065b9f..3784231ce7a 100644 --- a/website/src/pages/plugins/other/urql-introspection.mdx +++ b/website/src/pages/plugins/other/urql-introspection.mdx @@ -1,5 +1,6 @@ --- title: urql-introspection +description: Introspection plugin for urql. Generates a JSON file with the GraphQL schema. This file can be used to create a schema-aware cache. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/presets/gql-tag-operations-preset.mdx b/website/src/pages/plugins/presets/gql-tag-operations-preset.mdx index c6d1bb1279c..1be647ab80d 100644 --- a/website/src/pages/plugins/presets/gql-tag-operations-preset.mdx +++ b/website/src/pages/plugins/presets/gql-tag-operations-preset.mdx @@ -1,5 +1,6 @@ --- title: gql-tag-operations-preset +description: Generates typings for your inline gql function usages, without having to manually specify import statements for the documents. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/presets/graphql-modules-preset.mdx b/website/src/pages/plugins/presets/graphql-modules-preset.mdx index bea34c6ca28..3ffdeb23b42 100644 --- a/website/src/pages/plugins/presets/graphql-modules-preset.mdx +++ b/website/src/pages/plugins/presets/graphql-modules-preset.mdx @@ -1,5 +1,6 @@ --- title: graphql-modules-preset +description: GraphQL Code Generator preset for graphql-modules. It generates a single file with all the modules and their dependencies. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/presets/import-types-preset.mdx b/website/src/pages/plugins/presets/import-types-preset.mdx index 9e50b2dfefc..157d31fc92d 100644 --- a/website/src/pages/plugins/presets/import-types-preset.mdx +++ b/website/src/pages/plugins/presets/import-types-preset.mdx @@ -1,5 +1,6 @@ --- title: import-types-preset +description: This preset generates a file per each operation file, and allow to import types from another file. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/presets/near-operation-file-preset.mdx b/website/src/pages/plugins/presets/near-operation-file-preset.mdx index 79306cd5960..81f470027d6 100644 --- a/website/src/pages/plugins/presets/near-operation-file-preset.mdx +++ b/website/src/pages/plugins/presets/near-operation-file-preset.mdx @@ -1,5 +1,6 @@ --- title: near-operation-file-preset +description: GraphQL Code Generator - Near Operation File Preset. Generates a file per each operation file. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/presets/preset-client.mdx b/website/src/pages/plugins/presets/preset-client.mdx index f9766abbd6d..681b26a26ab 100644 --- a/website/src/pages/plugins/presets/preset-client.mdx +++ b/website/src/pages/plugins/presets/preset-client.mdx @@ -1,5 +1,6 @@ --- title: client-preset +description: The client preset provides typed GraphQL operations (Query, Mutation and Subscription) by perfectly integrating with your favorite GraphQL clients. --- import { Callout, PackageCmd } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/named-operations-object.mdx b/website/src/pages/plugins/typescript/named-operations-object.mdx index a6b07d7a206..4db8a22dd6a 100644 --- a/website/src/pages/plugins/typescript/named-operations-object.mdx +++ b/website/src/pages/plugins/typescript/named-operations-object.mdx @@ -1,5 +1,6 @@ --- title: named-operations-object +description: Generates an object containing a list of all your GraphQL operations and fragments. This is useful if you are using Apollo-Client and wish to have type validation when you are using `refetchQueries`. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/relay-operation-optimizer.mdx b/website/src/pages/plugins/typescript/relay-operation-optimizer.mdx index e417c379377..d98d4d14350 100644 --- a/website/src/pages/plugins/typescript/relay-operation-optimizer.mdx +++ b/website/src/pages/plugins/typescript/relay-operation-optimizer.mdx @@ -1,5 +1,6 @@ --- title: relay-operation-optimizer +description: A GraphQL Codegen feature for bringing the benefits of Relay Compiler to any GraphQL Client using Relay Operation Optimizer. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typed-document-node.mdx b/website/src/pages/plugins/typescript/typed-document-node.mdx index cdec75f3fb0..2b7115219ef 100644 --- a/website/src/pages/plugins/typescript/typed-document-node.mdx +++ b/website/src/pages/plugins/typescript/typed-document-node.mdx @@ -1,5 +1,6 @@ --- title: typed-document-node +description: Generate TypedDocumentNode for GraphQL operations. This plugin is a wrapper for graphql-typed-document-node. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-apollo-angular.mdx b/website/src/pages/plugins/typescript/typescript-apollo-angular.mdx index 8a6135115db..f4d8923db0c 100644 --- a/website/src/pages/plugins/typescript/typescript-apollo-angular.mdx +++ b/website/src/pages/plugins/typescript/typescript-apollo-angular.mdx @@ -1,5 +1,6 @@ --- title: typescript-apollo-angular +description: GraphQL Code Generator plugin for Angular services using Apollo Angular. It generates Angular services with observables and typed variables. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-apollo-client-helpers.mdx b/website/src/pages/plugins/typescript/typescript-apollo-client-helpers.mdx index 5f15365ff0f..c71e8d63554 100644 --- a/website/src/pages/plugins/typescript/typescript-apollo-client-helpers.mdx +++ b/website/src/pages/plugins/typescript/typescript-apollo-client-helpers.mdx @@ -1,5 +1,6 @@ --- title: typescript-apollo-client-helpers +description: Generates helpers for improving the integration of TypeScript and Apollo-Client, based on your schema. This plugin generates fully-typed keyFields and Type-Policies for Apollo-Client. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-apollo-next.mdx b/website/src/pages/plugins/typescript/typescript-apollo-next.mdx index 9034133311c..27f95290873 100644 --- a/website/src/pages/plugins/typescript/typescript-apollo-next.mdx +++ b/website/src/pages/plugins/typescript/typescript-apollo-next.mdx @@ -1,5 +1,6 @@ --- title: typescript-apollo-next +description: Apollo Client plugin for GraphQL Code Generator. Generates React Apollo HOC and React Hooks. --- import { PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-document-nodes.mdx b/website/src/pages/plugins/typescript/typescript-document-nodes.mdx index 778d466a9a9..67da0c436c7 100644 --- a/website/src/pages/plugins/typescript/typescript-document-nodes.mdx +++ b/website/src/pages/plugins/typescript/typescript-document-nodes.mdx @@ -1,5 +1,6 @@ --- title: typescript-document-nodes +description: Generate TypeScript code for GraphQL documents. Useful for GraphQL codegen. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-generic-sdk.mdx b/website/src/pages/plugins/typescript/typescript-generic-sdk.mdx index 4f22d65263c..990eb21823b 100644 --- a/website/src/pages/plugins/typescript/typescript-generic-sdk.mdx +++ b/website/src/pages/plugins/typescript/typescript-generic-sdk.mdx @@ -1,5 +1,6 @@ --- title: typescript-generic-sdk +description: Generate TypeScript SDK for GraphQL APIs. Supports Apollo Client, React Query, and more. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-graphql-files-modules.mdx b/website/src/pages/plugins/typescript/typescript-graphql-files-modules.mdx index bb5c722d95b..a63451f9332 100644 --- a/website/src/pages/plugins/typescript/typescript-graphql-files-modules.mdx +++ b/website/src/pages/plugins/typescript/typescript-graphql-files-modules.mdx @@ -1,5 +1,6 @@ --- title: typescript-graphql-files-modules +description: GraphQL Code Generator plugin for generating TypeScript types for GraphQL files. This plugin generates a single file per GraphQL file, and uses the `graphql-tag/loader` to load the GraphQL files. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-graphql-request.mdx b/website/src/pages/plugins/typescript/typescript-graphql-request.mdx index 282e8731e41..b7b533e359c 100644 --- a/website/src/pages/plugins/typescript/typescript-graphql-request.mdx +++ b/website/src/pages/plugins/typescript/typescript-graphql-request.mdx @@ -1,5 +1,6 @@ --- title: typescript-graphql-request +description: GraphQL Code Generator plugin for generating TypeScript code using graphql-request. This plugin generates a fully-typed SDK based on your GraphQL operations. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-mock-data.mdx b/website/src/pages/plugins/typescript/typescript-mock-data.mdx index 3cce13e8abe..4eadd8eaec2 100644 --- a/website/src/pages/plugins/typescript/typescript-mock-data.mdx +++ b/website/src/pages/plugins/typescript/typescript-mock-data.mdx @@ -1,5 +1,6 @@ --- title: typescript-mock-data +description: Generate mock data for your TypeScript types. Useful for testing and prototyping. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-mongodb.mdx b/website/src/pages/plugins/typescript/typescript-mongodb.mdx index d8d362d4270..3fad44b0ad0 100644 --- a/website/src/pages/plugins/typescript/typescript-mongodb.mdx +++ b/website/src/pages/plugins/typescript/typescript-mongodb.mdx @@ -1,5 +1,6 @@ --- title: typescript-mongodb +description: GraphQL Code Generator plugin for generating TypeScript types for MongoDB models. This plugin generates TypeScript types for MongoDB models, which makes it relevant for server-side development only. It uses GraphQL directives to declare the types you want to generate and use in your MongoDB backend. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-msw.mdx b/website/src/pages/plugins/typescript/typescript-msw.mdx index 453c0d2bf7d..711bd33e559 100644 --- a/website/src/pages/plugins/typescript/typescript-msw.mdx +++ b/website/src/pages/plugins/typescript/typescript-msw.mdx @@ -1,5 +1,6 @@ --- title: typescript-msw +description: TypeScript-MSW - Mock GraphQL requests with MSW. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-nhost.mdx b/website/src/pages/plugins/typescript/typescript-nhost.mdx index 00d26867640..9fdbc21b54f 100644 --- a/website/src/pages/plugins/typescript/typescript-nhost.mdx +++ b/website/src/pages/plugins/typescript/typescript-nhost.mdx @@ -1,5 +1,6 @@ --- title: typescript-nhost +description: GraphQL Code Generator plugin for Nhost Typescript SDK. It generates the schema for the Typescript Nhost SDK. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-oclif.mdx b/website/src/pages/plugins/typescript/typescript-oclif.mdx index 6b1224d3941..efc820b2d03 100644 --- a/website/src/pages/plugins/typescript/typescript-oclif.mdx +++ b/website/src/pages/plugins/typescript/typescript-oclif.mdx @@ -1,5 +1,6 @@ --- title: typescript-oclif +description: Generate a Typescript Oclif CLI. This plugin is based on the official Typescript plugin. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-operations.mdx b/website/src/pages/plugins/typescript/typescript-operations.mdx index 23484568599..59c9f140e0c 100644 --- a/website/src/pages/plugins/typescript/typescript-operations.mdx +++ b/website/src/pages/plugins/typescript/typescript-operations.mdx @@ -1,5 +1,6 @@ --- title: typescript-operations +description: Generate TypeScript operations from GraphQL queries. This plugin is based on the `typescript` plugin, but it generates operations instead of types. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-react-apollo.mdx b/website/src/pages/plugins/typescript/typescript-react-apollo.mdx index d7f1a4695ce..1f1099390f2 100644 --- a/website/src/pages/plugins/typescript/typescript-react-apollo.mdx +++ b/website/src/pages/plugins/typescript/typescript-react-apollo.mdx @@ -1,5 +1,6 @@ --- title: typescript-react-apollo +description: GraphQL Code Generator plugin for TypeScript and React Apollo. Generates React Hooks and HOCs for your GraphQL operations. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-react-query.mdx b/website/src/pages/plugins/typescript/typescript-react-query.mdx index 29a433e7f63..aea4f7c3793 100644 --- a/website/src/pages/plugins/typescript/typescript-react-query.mdx +++ b/website/src/pages/plugins/typescript/typescript-react-query.mdx @@ -1,5 +1,6 @@ --- title: typescript-react-query +description: GraphQL Code Generator plugin for generating React Query hooks. Supports TypeScript and Flow. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-resolvers.mdx b/website/src/pages/plugins/typescript/typescript-resolvers.mdx index e3f43b24828..d7de0b87943 100644 --- a/website/src/pages/plugins/typescript/typescript-resolvers.mdx +++ b/website/src/pages/plugins/typescript/typescript-resolvers.mdx @@ -1,5 +1,6 @@ --- title: typescript-resolvers +description: Generate TypeScript resolvers types. Works with graphql-tools and apollo-server. Supports custom mappers and enum resolvers. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-rtk-query.mdx b/website/src/pages/plugins/typescript/typescript-rtk-query.mdx index 58bb8241597..03450c5488d 100644 --- a/website/src/pages/plugins/typescript/typescript-rtk-query.mdx +++ b/website/src/pages/plugins/typescript/typescript-rtk-query.mdx @@ -1,5 +1,6 @@ --- title: typescript-rtk-query +description: RTK Query codegen plugin for GraphQL. Generates React Hooks for GraphQL queries and mutations. Works with any GraphQL client. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-stencil-apollo.mdx b/website/src/pages/plugins/typescript/typescript-stencil-apollo.mdx index f33ee2ac574..a0843aed272 100644 --- a/website/src/pages/plugins/typescript/typescript-stencil-apollo.mdx +++ b/website/src/pages/plugins/typescript/typescript-stencil-apollo.mdx @@ -1,5 +1,6 @@ --- title: typescript-stencil-apollo +description: A Stencil plugin for generating TypeScript code from GraphQL queries. This plugin uses Apollo Client. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-svelte-apollo.mdx b/website/src/pages/plugins/typescript/typescript-svelte-apollo.mdx index 018540414ad..fc695441b8a 100644 --- a/website/src/pages/plugins/typescript/typescript-svelte-apollo.mdx +++ b/website/src/pages/plugins/typescript/typescript-svelte-apollo.mdx @@ -1,5 +1,6 @@ --- title: typescript-svelte-apollo +description: This plugin generates observable Apollo queries with Typescript typings. This is a community plugin, to report eventual issues or find more examples, refer to this repository --- import { PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-type-graphql.mdx b/website/src/pages/plugins/typescript/typescript-type-graphql.mdx index c304d7376cc..556b38b272d 100644 --- a/website/src/pages/plugins/typescript/typescript-type-graphql.mdx +++ b/website/src/pages/plugins/typescript/typescript-type-graphql.mdx @@ -1,5 +1,6 @@ --- title: typescript-type-graphql +description: Generate TypeScript types for use with TypeGraphQL. This plugin is similar to the basic TypeScript plugin. However, this package generates types that can be used by TypeGraphQL to generate a GraphQL schema. This is especially useful if you are building a service that is a gateway to multiple downstream GraphQL services, or otherwise combining GraphQL schemas. In this case, this plugin can be used to re-expose types defined in downstream GraphQL services without redefining them as TypeGraphQL objects. This plugin should be compatible with other client-side plugins, such as typescript-operations. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-urql.mdx b/website/src/pages/plugins/typescript/typescript-urql.mdx index 9aca8778bb5..2baa2e5a03e 100644 --- a/website/src/pages/plugins/typescript/typescript-urql.mdx +++ b/website/src/pages/plugins/typescript/typescript-urql.mdx @@ -1,5 +1,6 @@ --- title: typescript-urql +description: GraphQL codegen plugin for generating TypeScript code using urql. This plugin generates React Hooks and TypeScript types. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-validation-schema.mdx b/website/src/pages/plugins/typescript/typescript-validation-schema.mdx index b2449c229d7..a0056f2c5c9 100644 --- a/website/src/pages/plugins/typescript/typescript-validation-schema.mdx +++ b/website/src/pages/plugins/typescript/typescript-validation-schema.mdx @@ -1,5 +1,6 @@ --- title: typescript-validation-schema +description: A plugin for GraphQL Codegen to generate form validation schema (such as yup, zod) based on your GraphQL schema for use in a client application. --- import { PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-vue-apollo-smart-ops.mdx b/website/src/pages/plugins/typescript/typescript-vue-apollo-smart-ops.mdx index 6c6d8d9f296..f8945804921 100644 --- a/website/src/pages/plugins/typescript/typescript-vue-apollo-smart-ops.mdx +++ b/website/src/pages/plugins/typescript/typescript-vue-apollo-smart-ops.mdx @@ -1,5 +1,6 @@ --- title: typescript-vue-apollo-smart-ops +description: A Vue plugin for Apollo GraphQL with smart operations. It generates Vue composition functions for your GraphQL queries and mutations. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin' diff --git a/website/src/pages/plugins/typescript/typescript-vue-apollo.mdx b/website/src/pages/plugins/typescript/typescript-vue-apollo.mdx index ccf73212d40..53e734fd6eb 100644 --- a/website/src/pages/plugins/typescript/typescript-vue-apollo.mdx +++ b/website/src/pages/plugins/typescript/typescript-vue-apollo.mdx @@ -1,5 +1,6 @@ --- title: typescript-vue-apollo +description: GraphQL Code Generator plugin for Vue Apollo. It generates Vue Apollo hooks and TypeScript types. It also generates a Vue plugin that can be used to register the generated hooks as global components. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript-vue-urql.mdx b/website/src/pages/plugins/typescript/typescript-vue-urql.mdx index 432ca288882..5e21cec4bb4 100644 --- a/website/src/pages/plugins/typescript/typescript-vue-urql.mdx +++ b/website/src/pages/plugins/typescript/typescript-vue-urql.mdx @@ -1,5 +1,6 @@ --- title: typescript-vue-urql +description: GraphQL Code Generator plugin for Vue.js and urql. It generates Vue.js components and urql hooks. It also generates TypeScript types. --- import { Callout } from '@theguild/components' diff --git a/website/src/pages/plugins/typescript/typescript.mdx b/website/src/pages/plugins/typescript/typescript.mdx index 83abfae8bff..72181b710f8 100644 --- a/website/src/pages/plugins/typescript/typescript.mdx +++ b/website/src/pages/plugins/typescript/typescript.mdx @@ -1,5 +1,6 @@ --- title: typescript +description: TypeScript plugin. Adds support for TypeScript. --- import { PluginApiDocs, PluginHeader } from '@/components/plugin'