prettify getting-started/index.mdx and guides/graphql-server-apollo-yoga.mdx
#7707
Conversation
|
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/theguild/graphql-code-generator/9UYg13vJ4SUNC1mrC4mHWRfEpyVV |
| @@ -76,22 +73,22 @@ interface PostQuery { | |||
| }[] | |||
| } | |||
|
|
|||
| const postsQueryDocument = ` | |||
| const postsQueryDocument = /* GraphQL */ ` | |||
There was a problem hiding this comment.
adding /* GraphQL */ comments helps prettier understand that this is not string but graphql document, so he will prettify
|
The latest changes of this PR are not available as alpha, since there are no linked |
| @@ -157,36 +149,38 @@ const Posts = () => { | |||
| </div> | |||
| </template> | |||
|
|
|||
| <script> | |||
| <script lang="ts"> | |||
There was a problem hiding this comment.
i think lang was missing, after adding this prettier prettified content inside script tag
| </script> | ||
|
|
||
| <ul> | ||
| { /* UI */ } |
There was a problem hiding this comment.
@jycouet does it valid syntax in svelte? I think comment must be <!-- UI -->
There was a problem hiding this comment.
You are right { /* UI */ } will not work.
If you want a comment in your HTML, you put HTML comment tag like: <!-- UI -->
There was a problem hiding this comment.
While looking at this guide, could we use KitQL instead of Svelte-Apollo in the example 😇?
There was a problem hiding this comment.
@dotansimha what do you think?
There was a problem hiding this comment.
We can do both but we have to keep in mind that guides are here to help most people get started with popular stacks
There was a problem hiding this comment.
FYI:
https://github.com/timhall/svelte-apollo => It's without code gen
https://github.com/ticruz38/graphql-codegen-svelte-apollo => is the codegen for 👆 svelte-apollo
Adding in the list will probably not fit.
|
|
||
| const typeDefs = readFileSync('./schema.graphql').toString('utf-8') | ||
| const typeDefs = readFileSync('./schema.graphql', 'utf8') |
There was a problem hiding this comment.
.toString('utf-8') is redundant, utf8 can be passed as 2nd argument to readFileSync()
| @@ -540,6 +522,6 @@ Then, you can either read a guide or go over [the list of available plugins](/pl | |||
| If you are experiencing any issues, you can reach us via the following channels: | |||
|
|
|||
| - Found a bug? [report it in our GitHub repo](https://github.com/dotansimha/graphql-code-generator) | |||
| - Need help or have a question? You can use the live chat box in the corner of the screen, [ask it in our GitHub Discussions page](https://github.com/dotansimha/graphql-code-generator/discussions) or [reach out to us directly in our Discord](http://bit.ly/guild-chat). | |||
| - Need help or have a question? You can use the live chat box in the corner of the screen, [ask it in our GitHub Discussions page](https://github.com/dotansimha/graphql-code-generator/discussions) or [reach out to us directly in our Discord](http://bit.ly/guild-chat) | |||
There was a problem hiding this comment.
no need dot as it's list
| @@ -124,7 +125,7 @@ Assuming that, as recommended, your `package.json` has the following script: | |||
| ```json | |||
| { | |||
| "scripts": { | |||
| "generate": "graphql-codegen", | |||
There was a problem hiding this comment.
no need comma as it's json
|
|
||
| - **less boilerplate** (thanks to full code generation such as React hooks generation) | ||
|
|
||
| - **autocompletion on all queries, mutations and, subscription variables and results** |
There was a problem hiding this comment.
Actually not true in Svelte.
Need ardatan/graphql-tools#4349 and a PR (that I will do now on vscode)
|
Nice one 👌 |
https://graphql-codegen.com/docs/getting-started
vs
https://graphql-code-generator-git-improve-docs-theguild.vercel.app/docs/getting-started
https://graphql-codegen.com/docs/guides/graphql-server-apollo-yoga
vs
https://graphql-code-generator-git-improve-docs-theguild.vercel.app/docs/guides/graphql-server-apollo-yoga