Add apollo-typed-documents as dependency to examples

Author: rubengrill

README.md

@@ -46,28 +46,24 @@ generates:
 
 `tsconfig.json`:
 
+Add `node_modules/apollo-typed-documents/lib/reactHooks.d.ts` in `include` to override the typings for `@apollo/react-hooks`, so that types can be inferred from typed documents.
+
+<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./examples/docs/tsconfig.json) -->
+<!-- The below code snippet is automatically added from ./examples/docs/tsconfig.json -->
 ```json
 {
   "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "@codegen-types": ["codegenTypes.ts"],
-      "@apollo/react-hooks": [
-        "./node_modules/apollo-typed-documents/lib/reactHooks.d.ts"
-      ]
-    }
-  }
+    "noEmit": true,
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    "jsx": "react",
+    "esModuleInterop": true
+  },
+  "include": ["src", "node_modules/apollo-typed-documents/lib/reactHooks.d.ts"]
 }
 ```
-
-`@codegen-types` points to the output of `typescript-operations` graphql-codegen plugin.
-
-This alias is required, because in ambient module declarations (`.d.ts`) only non relative imports are allowed.
-
-`@apollo/react-hooks` overrides the types to have generic hooks in your code: [reference](src/reactHooks.ts)
-
-If you don't have a TypeScript project but instead just want to get type safety and code completion,
-the configuration needs to have more options set: [reference](examples/docs/tsconfig.json)
+<!-- AUTO-GENERATED-CONTENT:END -->
 
 ### Example
 

examples/cra-ts/package.json

@@ -12,6 +12,7 @@
     "@types/node": "^12.0.0",
     "@types/react": "^16.9.0",
     "@types/react-dom": "^16.9.0",
+    "apollo-typed-documents": "link:../..",
     "babel-plugin-import-graphql": "^2.7.0",
     "customize-cra": "^0.9.1",
     "react": "^16.13.1",

examples/cra-ts/tsconfig.json

@@ -15,5 +15,5 @@
     "noEmit": true,
     "jsx": "react"
   },
-  "include": ["src", "../../lib/reactHooks.d.ts"]
+  "include": ["src", "node_modules/apollo-typed-documents/lib/reactHooks.d.ts"]
 }

examples/cra-ts/yarn.lock

@@ -1903,6 +1903,10 @@ anymatch@~3.1.1:
     normalize-path "^3.0.0"
     picomatch "^2.0.4"
 
+"apollo-typed-documents@link:../..":
+  version "0.0.0"
+  uid ""
+
 aproba@^1.1.1:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/aproba/-/aproba-1.2.0.tgz#6802e6264efd18c790a1b0d517f0f2627bf2c94a"

examples/cra/package.json

@@ -8,6 +8,7 @@
     "@testing-library/jest-dom": "^4.2.4",
     "@testing-library/react": "^9.3.2",
     "@testing-library/user-event": "^7.1.2",
+    "apollo-typed-documents": "link:../..",
     "babel-plugin-import-graphql": "^2.7.0",
     "customize-cra": "^0.9.1",
     "react": "^16.13.1",

examples/cra/src/tsconfig.json

@@ -7,5 +7,5 @@
     "jsx": "react",
     "esModuleInterop": true
   },
-  "include": [".", "../../../lib/reactHooks.d.ts"]
+  "include": [".", "../node_modules/apollo-typed-documents/lib/reactHooks.d.ts"]
 }

examples/cra/yarn.lock

@@ -1891,6 +1891,10 @@ anymatch@~3.1.1:
     normalize-path "^3.0.0"
     picomatch "^2.0.4"
 
+"apollo-typed-documents@link:../..":
+  version "0.0.0"
+  uid ""
+
 aproba@^1.1.1:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/aproba/-/aproba-1.2.0.tgz#6802e6264efd18c790a1b0d517f0f2627bf2c94a"

examples/docs/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "apollo-typed-documents": "link:../.."
+  }
+}

examples/docs/tsconfig.json

@@ -7,5 +7,5 @@
     "jsx": "react",
     "esModuleInterop": true
   },
-  "include": ["src", "../../lib/reactHooks.d.ts"]
+  "include": ["src", "node_modules/apollo-typed-documents/lib/reactHooks.d.ts"]
 }

examples/docs/yarn.lock

@@ -0,0 +1,7 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"apollo-typed-documents@link:../..":
+  version "0.0.0"
+  uid ""