Document .graphql and .gql file loading with graphql.macro

[petetnt]

This PR follows up #3909 and #5076 by adding documentation for the .graphql loading features through babel-plugin-macros.

Signed-off-by: petetnt pete.a.nykanen@gmail.com

[petetnt]

This should probably target the docs too https://github.com/facebook/create-react-app/blob/master/docusaurus/docs/

[petetnt]

Aaaand now it targets the docusaurus docs 🦎

[Timer]

Let's skip the part talking about macros and just combine these two sentences.

[petetnt]

@Timer addressed comments, thanks!

[Timer]

Shouldn't this come right after Relay docs?

[petetnt]

Adding loading other types of assets (images, svgs, styles...) are on that section and AFAIK the graphql-tag loading isn't applicable to Relay so it might be a confusing. Then again they are both graphql related so it might make sense to put it there too anyway (that's where I put it when I opened this PR).

Anyway is fine with me, you can take the pick 😄

[AndresRodH]

I think you meant graphql.macro rather than graphql-tag.macro here

[petetnt]

Thanks a ton @AndresRodH ! You are totally right, graphql.macro offers both the gql and the loader while graphql-tag only has the tag.

[AndresRodH]

You missed this one! 😆yarn add graphql.macro

[petetnt]

Hahaa 🤦‍♂️ maybe it's fixed now. I blame the GitHub editor and doing changes on the go 😂

[petetnt]

Thanks @AndresRodH for reviewing!

[audiolion]

Just going to throw this out there, graphql.macro currently doesn't support absolute paths, if you have a monorepo setup where your .gql files are stored in another package like @app/graphql and yarn workspaces symlinks it into the CRA app's node_modules, graphql.macro won't find it.

I made a PR which adds support for this, but, it looks like babel-plugin-macros doesn't apply to imports from node_modules. I ultimately had to run @babel/cli with a proper .babelrc setup and import compiled files to get graphql support to work in 2.0 after graphql and monorepo support was removed.

I am also somewhat concerned because it does not look like the repository is being actively maintained, I made a fork with absolute path and node modules path support at @kimmel/graphql.macro to use for now with the hope that the maintainer will become active.

[petetnt]

Good catch @donovantc, fixed!

[petetnt]

It seems that @audiolion's comment has been addressed in graphql.macro so this can probably be safely merged.

[iansu]

The deploy preview seems to be broken. Can you try rebasing with master to see if that fixes it?