Handle non-src dirs for TypeScript documents

[ddimaria]

The static typing docs don't include documents outside of the src folder and .ts files. I made a note beneath the code block. The error messages generated aren't overly helpful:

Invariant Violation: Argument of [object Object] passed to parser was not a valid GraphQL DocumentNode. You may need to use 'graphql-tag' or another method to convert your operation into a document

This will be problematic for anyone upgrading to using the App Router in NextJS v13.

[apollo-cla]

@ddimaria: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/

[netlify]

👷 Deploy request for apollo-client-docs pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	b55672c

[changeset-bot]

⚠️ No Changeset found

Latest commit: b55672c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[phryneas]

I think it might be more discoverable to people to have this as a comment in the above code example.

For example:

const config: CodegenConfig = {
  schema: '<URL_OF_YOUR_GRAPHQL_API>',
+  // this assumes that all your source files are in a top-level `src/` directory - you might need to adjust this to your file structure  
+  documents: ['src/**/*.{ts,tsx}'],
-  documents: ['src/**/*.tsx'],
  generates: {

[phryneas]

I've applied these suggestions to get this PR out.

[phryneas]

This will be problematic for anyone upgrading to using the App Router in NextJS v13.

Do you mean that because there is now a top-level app directory? To my knowledge, there is still the option to have a src directory, which means you would end up with src/app.

Generally, it can't be said enough: please be very careful with anything regarding the app directory. That is still very much unstable on the Next.js side, and we are still exploring how we can best support that. At this point, expect that both Next.js itself and every external library will break and don't use it for any kind of production project!