Move some examples to a staging area (keystonejs#5808)

* Move some examples to a staging area * Fix import * Fix tests
johannesspohr · May 27, 2021 · 9b22ae9 · 9b22ae9
1 parent 7bda87e
commit 9b22ae9
Show file tree

Hide file tree

Showing 89 changed files with 23 additions and 13 deletions.
diff --git a/docs/components/DocumentEditorDemo.tsx b/docs/components/DocumentEditorDemo.tsx
@@ -18,7 +18,7 @@ import {
 } from '@keystone-next/fields-document/component-blocks';
 import { Global, jsx } from '@keystone-ui/core';
 
-import { componentBlocks as componentBlocksInExampleProject } from '../../examples/basic/admin/fieldViews/Content';
+import { componentBlocks as componentBlocksInExampleProject } from '../../examples-staging/basic/admin/fieldViews/Content';
 import { initialContent } from '../lib/initialDocumentDemoContent';
 import { Code } from './Code';
 

diff --git a/examples-staging/README.md b/examples-staging/README.md
@@ -0,0 +1,9 @@
+# Examples - Staging Area
+
+Hello, you have found the staging area for our examples. 👋
+
+This is where we keep example projects which are still work-in-progress.
+Feel free to take a look around, there might be something useful for you in here.
+We careful though, these projects might not be working right now, or they might not demonstrate best practices.
+
+If you want to see completed, tested, and documented examples, head on over to our curated [examples](../examples) directory.
diff --git a/examples/auth/CHANGELOG.md → examples-staging/auth/CHANGELOG.md b/examples/auth/CHANGELOG.md → examples-staging/auth/CHANGELOG.md
diff --git a/examples/auth/keystone.ts → examples-staging/auth/keystone.ts b/examples/auth/keystone.ts → examples-staging/auth/keystone.ts
diff --git a/examples/auth/package.json → examples-staging/auth/package.json b/examples/auth/package.json → examples-staging/auth/package.json
@@ -22,5 +22,5 @@
   "engines": {
     "node": "^12.20 || >= 14.13"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/auth"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples-staging/auth"
 }
diff --git a/examples/auth/schema.graphql → examples-staging/auth/schema.graphql b/examples/auth/schema.graphql → examples-staging/auth/schema.graphql
diff --git a/examples/auth/schema.prisma → examples-staging/auth/schema.prisma b/examples/auth/schema.prisma → examples-staging/auth/schema.prisma
diff --git a/examples/auth/schema.ts → examples-staging/auth/schema.ts b/examples/auth/schema.ts → examples-staging/auth/schema.ts
diff --git a/examples/basic/.gitignore → examples-staging/basic/.gitignore b/examples/basic/.gitignore → examples-staging/basic/.gitignore
diff --git a/examples/basic/CHANGELOG.md → examples-staging/basic/CHANGELOG.md b/examples/basic/CHANGELOG.md → examples-staging/basic/CHANGELOG.md
diff --git a/examples/basic/admin/config.tsx → examples-staging/basic/admin/config.tsx b/examples/basic/admin/config.tsx → examples-staging/basic/admin/config.tsx
diff --git a/examples/basic/admin/fieldViews/Content.tsx → ...taging/basic/admin/fieldViews/Content.tsx b/examples/basic/admin/fieldViews/Content.tsx → ...taging/basic/admin/fieldViews/Content.tsx
diff --git a/examples/basic/admin/fieldViews/Test.tsx → ...s-staging/basic/admin/fieldViews/Test.tsx b/examples/basic/admin/fieldViews/Test.tsx → ...s-staging/basic/admin/fieldViews/Test.tsx
diff --git a/examples/basic/admin/lists/posts.tsx → examples-staging/basic/admin/lists/posts.tsx b/examples/basic/admin/lists/posts.tsx → examples-staging/basic/admin/lists/posts.tsx
diff --git a/examples/basic/admin/pages/post/[id].tsx → ...s-staging/basic/admin/pages/post/[id].tsx b/examples/basic/admin/pages/post/[id].tsx → ...s-staging/basic/admin/pages/post/[id].tsx
diff --git a/examples/basic/admin/pages/report.js → examples-staging/basic/admin/pages/report.js b/examples/basic/admin/pages/report.js → examples-staging/basic/admin/pages/report.js
diff --git a/examples/basic/keystone.ts → examples-staging/basic/keystone.ts b/examples/basic/keystone.ts → examples-staging/basic/keystone.ts
diff --git a/examples/basic/next-env.d.ts → examples-staging/basic/next-env.d.ts b/examples/basic/next-env.d.ts → examples-staging/basic/next-env.d.ts
diff --git a/examples/basic/next.config.js → examples-staging/basic/next.config.js b/examples/basic/next.config.js → examples-staging/basic/next.config.js
diff --git a/examples/basic/package.json → examples-staging/basic/package.json b/examples/basic/package.json → examples-staging/basic/package.json
@@ -36,5 +36,5 @@
   "engines": {
     "node": "^12.20 || >= 14.13"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/basic"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples-staging/basic"
 }
diff --git a/examples/basic/schema.graphql → examples-staging/basic/schema.graphql b/examples/basic/schema.graphql → examples-staging/basic/schema.graphql
diff --git a/examples/basic/schema.prisma → examples-staging/basic/schema.prisma b/examples/basic/schema.prisma → examples-staging/basic/schema.prisma
diff --git a/examples/basic/schema.ts → examples-staging/basic/schema.ts b/examples/basic/schema.ts → examples-staging/basic/schema.ts
diff --git a/examples/basic/tsconfig.json → examples-staging/basic/tsconfig.json b/examples/basic/tsconfig.json → examples-staging/basic/tsconfig.json
diff --git a/examples/ecommerce/CHANGELOG.md → examples-staging/ecommerce/CHANGELOG.md b/examples/ecommerce/CHANGELOG.md → examples-staging/ecommerce/CHANGELOG.md
diff --git a/examples/ecommerce/README.md → examples-staging/ecommerce/README.md b/examples/ecommerce/README.md → examples-staging/ecommerce/README.md
diff --git a/examples/ecommerce/access.ts → examples-staging/ecommerce/access.ts b/examples/ecommerce/access.ts → examples-staging/ecommerce/access.ts
diff --git a/examples/ecommerce/keystone.ts → examples-staging/ecommerce/keystone.ts b/examples/ecommerce/keystone.ts → examples-staging/ecommerce/keystone.ts
diff --git a/examples/ecommerce/lib/formatMoney.ts → ...ples-staging/ecommerce/lib/formatMoney.ts b/examples/ecommerce/lib/formatMoney.ts → ...ples-staging/ecommerce/lib/formatMoney.ts
diff --git a/examples/ecommerce/lib/mail.ts → examples-staging/ecommerce/lib/mail.ts b/examples/ecommerce/lib/mail.ts → examples-staging/ecommerce/lib/mail.ts
diff --git a/examples/ecommerce/lib/stripe.ts → examples-staging/ecommerce/lib/stripe.ts b/examples/ecommerce/lib/stripe.ts → examples-staging/ecommerce/lib/stripe.ts
diff --git a/examples/ecommerce/mutations/addToCart.ts → ...-staging/ecommerce/mutations/addToCart.ts b/examples/ecommerce/mutations/addToCart.ts → ...-staging/ecommerce/mutations/addToCart.ts
diff --git a/examples/ecommerce/mutations/checkout.ts → ...s-staging/ecommerce/mutations/checkout.ts b/examples/ecommerce/mutations/checkout.ts → ...s-staging/ecommerce/mutations/checkout.ts
diff --git a/examples/ecommerce/mutations/index.ts → ...ples-staging/ecommerce/mutations/index.ts b/examples/ecommerce/mutations/index.ts → ...ples-staging/ecommerce/mutations/index.ts
diff --git a/examples/ecommerce/package.json → examples-staging/ecommerce/package.json b/examples/ecommerce/package.json → examples-staging/ecommerce/package.json
@@ -36,5 +36,5 @@
   "engines": {
     "node": "^12.20 || >= 14.13"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/ecommerce"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples-staging/ecommerce"
 }
diff --git a/examples/ecommerce/sample.env → examples-staging/ecommerce/sample.env b/examples/ecommerce/sample.env → examples-staging/ecommerce/sample.env
diff --git a/examples/ecommerce/schema.graphql → examples-staging/ecommerce/schema.graphql b/examples/ecommerce/schema.graphql → examples-staging/ecommerce/schema.graphql
diff --git a/examples/ecommerce/schema.prisma → examples-staging/ecommerce/schema.prisma b/examples/ecommerce/schema.prisma → examples-staging/ecommerce/schema.prisma
diff --git a/examples/ecommerce/schemas/CartItem.ts → ...les-staging/ecommerce/schemas/CartItem.ts b/examples/ecommerce/schemas/CartItem.ts → ...les-staging/ecommerce/schemas/CartItem.ts
diff --git a/examples/ecommerce/schemas/Order.ts → examples-staging/ecommerce/schemas/Order.ts b/examples/ecommerce/schemas/Order.ts → examples-staging/ecommerce/schemas/Order.ts
diff --git a/examples/ecommerce/schemas/OrderItem.ts → ...es-staging/ecommerce/schemas/OrderItem.ts b/examples/ecommerce/schemas/OrderItem.ts → ...es-staging/ecommerce/schemas/OrderItem.ts
diff --git a/examples/ecommerce/schemas/Product.ts → ...ples-staging/ecommerce/schemas/Product.ts b/examples/ecommerce/schemas/Product.ts → ...ples-staging/ecommerce/schemas/Product.ts
diff --git a/examples/ecommerce/schemas/ProductImage.ts → ...staging/ecommerce/schemas/ProductImage.ts b/examples/ecommerce/schemas/ProductImage.ts → ...staging/ecommerce/schemas/ProductImage.ts
diff --git a/examples/ecommerce/schemas/Role.ts → examples-staging/ecommerce/schemas/Role.ts b/examples/ecommerce/schemas/Role.ts → examples-staging/ecommerce/schemas/Role.ts
diff --git a/examples/ecommerce/schemas/User.ts → examples-staging/ecommerce/schemas/User.ts b/examples/ecommerce/schemas/User.ts → examples-staging/ecommerce/schemas/User.ts
diff --git a/examples/ecommerce/schemas/fields.ts → examples-staging/ecommerce/schemas/fields.ts b/examples/ecommerce/schemas/fields.ts → examples-staging/ecommerce/schemas/fields.ts
diff --git a/examples/ecommerce/seed-data/data.ts → examples-staging/ecommerce/seed-data/data.ts b/examples/ecommerce/seed-data/data.ts → examples-staging/ecommerce/seed-data/data.ts
diff --git a/examples/ecommerce/seed-data/index.ts → ...ples-staging/ecommerce/seed-data/index.ts b/examples/ecommerce/seed-data/index.ts → ...ples-staging/ecommerce/seed-data/index.ts
diff --git a/examples/ecommerce/tests/mutations.test.ts → ...staging/ecommerce/tests/mutations.test.ts b/examples/ecommerce/tests/mutations.test.ts → ...staging/ecommerce/tests/mutations.test.ts
diff --git a/examples/ecommerce/types.ts → examples-staging/ecommerce/types.ts b/examples/ecommerce/types.ts → examples-staging/ecommerce/types.ts
diff --git a/examples/embedded-nextjs/CHANGELOG.md → ...ples-staging/embedded-nextjs/CHANGELOG.md b/examples/embedded-nextjs/CHANGELOG.md → ...ples-staging/embedded-nextjs/CHANGELOG.md
diff --git a/examples/embedded-nextjs/keystone.ts → examples-staging/embedded-nextjs/keystone.ts b/examples/embedded-nextjs/keystone.ts → examples-staging/embedded-nextjs/keystone.ts
diff --git a/examples/embedded-nextjs/next-env.d.ts → ...les-staging/embedded-nextjs/next-env.d.ts b/examples/embedded-nextjs/next-env.d.ts → ...les-staging/embedded-nextjs/next-env.d.ts
diff --git a/examples/embedded-nextjs/next.config.js → ...es-staging/embedded-nextjs/next.config.js b/examples/embedded-nextjs/next.config.js → ...es-staging/embedded-nextjs/next.config.js
diff --git a/examples/embedded-nextjs/package.json → ...ples-staging/embedded-nextjs/package.json b/examples/embedded-nextjs/package.json → ...ples-staging/embedded-nextjs/package.json
@@ -22,5 +22,5 @@
   "engines": {
     "node": "^12.20 || >= 14.13"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/embedded-nextjs"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples-staging/embedded-nextjs"
 }
diff --git a/...ples/embedded-nextjs/pages/api/graphql.js → ...ging/embedded-nextjs/pages/api/graphql.js b/...ples/embedded-nextjs/pages/api/graphql.js → ...ging/embedded-nextjs/pages/api/graphql.js
diff --git a/examples/embedded-nextjs/pages/index.js → ...es-staging/embedded-nextjs/pages/index.js b/examples/embedded-nextjs/pages/index.js → ...es-staging/embedded-nextjs/pages/index.js
diff --git a/...ples/embedded-nextjs/pages/post/[slug].js → ...ging/embedded-nextjs/pages/post/[slug].js b/...ples/embedded-nextjs/pages/post/[slug].js → ...ging/embedded-nextjs/pages/post/[slug].js
diff --git a/examples/embedded-nextjs/schema.graphql → ...es-staging/embedded-nextjs/schema.graphql b/examples/embedded-nextjs/schema.graphql → ...es-staging/embedded-nextjs/schema.graphql
diff --git a/examples/embedded-nextjs/schema.prisma → ...les-staging/embedded-nextjs/schema.prisma b/examples/embedded-nextjs/schema.prisma → ...les-staging/embedded-nextjs/schema.prisma
diff --git a/examples/embedded-nextjs/schema.ts → examples-staging/embedded-nextjs/schema.ts b/examples/embedded-nextjs/schema.ts → examples-staging/embedded-nextjs/schema.ts
diff --git a/examples/embedded-nextjs/tsconfig.json → ...les-staging/embedded-nextjs/tsconfig.json b/examples/embedded-nextjs/tsconfig.json → ...les-staging/embedded-nextjs/tsconfig.json
diff --git a/examples/graphql-api-endpoint/CHANGELOG.md → ...staging/graphql-api-endpoint/CHANGELOG.md b/examples/graphql-api-endpoint/CHANGELOG.md → ...staging/graphql-api-endpoint/CHANGELOG.md
diff --git a/examples/graphql-api-endpoint/keystone.ts → ...-staging/graphql-api-endpoint/keystone.ts b/examples/graphql-api-endpoint/keystone.ts → ...-staging/graphql-api-endpoint/keystone.ts
diff --git a/examples/graphql-api-endpoint/package.json → ...staging/graphql-api-endpoint/package.json b/examples/graphql-api-endpoint/package.json → ...staging/graphql-api-endpoint/package.json
@@ -18,5 +18,5 @@
     "@keystone-next/keystone": "^18.0.0",
     "apollo-server-micro": "^2.24.1"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/graphql-api-endpoint"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples-staging/graphql-api-endpoint"
 }
diff --git a/examples/graphql-api-endpoint/schema.graphql → ...aging/graphql-api-endpoint/schema.graphql b/examples/graphql-api-endpoint/schema.graphql → ...aging/graphql-api-endpoint/schema.graphql
diff --git a/examples/graphql-api-endpoint/schema.prisma → ...taging/graphql-api-endpoint/schema.prisma b/examples/graphql-api-endpoint/schema.prisma → ...taging/graphql-api-endpoint/schema.prisma
diff --git a/examples/graphql-api-endpoint/schema.ts → ...es-staging/graphql-api-endpoint/schema.ts b/examples/graphql-api-endpoint/schema.ts → ...es-staging/graphql-api-endpoint/schema.ts
diff --git a/examples/roles/CHANGELOG.md → examples-staging/roles/CHANGELOG.md b/examples/roles/CHANGELOG.md → examples-staging/roles/CHANGELOG.md
diff --git a/examples/roles/README.md → examples-staging/roles/README.md b/examples/roles/README.md → examples-staging/roles/README.md
diff --git a/examples/roles/access.ts → examples-staging/roles/access.ts b/examples/roles/access.ts → examples-staging/roles/access.ts
diff --git a/examples/roles/keystone.ts → examples-staging/roles/keystone.ts b/examples/roles/keystone.ts → examples-staging/roles/keystone.ts
diff --git a/examples/roles/package.json → examples-staging/roles/package.json b/examples/roles/package.json → examples-staging/roles/package.json
@@ -23,5 +23,5 @@
   "engines": {
     "node": "^12.20 || >= 14.13"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/roles"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples-staging/roles"
 }
diff --git a/examples/roles/schema.graphql → examples-staging/roles/schema.graphql b/examples/roles/schema.graphql → examples-staging/roles/schema.graphql
diff --git a/examples/roles/schema.prisma → examples-staging/roles/schema.prisma b/examples/roles/schema.prisma → examples-staging/roles/schema.prisma
diff --git a/examples/roles/schema.ts → examples-staging/roles/schema.ts b/examples/roles/schema.ts → examples-staging/roles/schema.ts
diff --git a/examples/roles/types.ts → examples-staging/roles/types.ts b/examples/roles/types.ts → examples-staging/roles/types.ts
diff --git a/examples/sandbox/.gitignore → examples-staging/sandbox/.gitignore b/examples/sandbox/.gitignore → examples-staging/sandbox/.gitignore
diff --git a/examples/sandbox/CHANGELOG.md → examples-staging/sandbox/CHANGELOG.md b/examples/sandbox/CHANGELOG.md → examples-staging/sandbox/CHANGELOG.md
diff --git a/examples/sandbox/keystone.ts → examples-staging/sandbox/keystone.ts b/examples/sandbox/keystone.ts → examples-staging/sandbox/keystone.ts
diff --git a/examples/sandbox/package.json → examples-staging/sandbox/package.json b/examples/sandbox/package.json → examples-staging/sandbox/package.json
@@ -15,5 +15,5 @@
   "engines": {
     "node": "^12.20 || >= 14.13"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/sandbox"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples-staging/sandbox"
 }
diff --git a/examples/sandbox/sandbox.config.json → examples-staging/sandbox/sandbox.config.json b/examples/sandbox/sandbox.config.json → examples-staging/sandbox/sandbox.config.json
diff --git a/examples/sandbox/schema.graphql → examples-staging/sandbox/schema.graphql b/examples/sandbox/schema.graphql → examples-staging/sandbox/schema.graphql
diff --git a/examples/sandbox/schema.prisma → examples-staging/sandbox/schema.prisma b/examples/sandbox/schema.prisma → examples-staging/sandbox/schema.prisma
diff --git a/examples/sandbox/schema.ts → examples-staging/sandbox/schema.ts b/examples/sandbox/schema.ts → examples-staging/sandbox/schema.ts
diff --git a/package.json b/package.json
@@ -33,8 +33,8 @@
     "npm-tag": "manypkg npm-tag",
     "update": "manypkg upgrade",
     "no-cypress-install": "cross-env CYPRESS_INSTALL_BINARY=0 yarn",
-    "postinstall-examples": "for d in `find examples -type d -maxdepth 1 -mindepth 1`; do cd $d; yarn keystone-next postinstall --fix; cd ../..; done",
-    "lint:examples": "for d in `find examples -type d -maxdepth 1 -mindepth 1`; do cd $d; echo $d; SKIP_PROMPTS=1 yarn keystone-next postinstall; if [ $? -ne 0 ]; then exit 1; fi; cd ../..; done"
+    "postinstall-examples": "for d in `find examples -type d -maxdepth 1 -mindepth 1`; do cd $d; yarn keystone-next postinstall --fix; cd ../..; done; for d in `find examples-staging -type d -maxdepth 1 -mindepth 1`; do cd $d; yarn keystone-next postinstall --fix; cd ../..; done",
+    "lint:examples": "for d in `find examples -type d -maxdepth 1 -mindepth 1`; do cd $d; echo $d; SKIP_PROMPTS=1 yarn keystone-next postinstall; if [ $? -ne 0 ]; then exit 1; fi; cd ../..; done; for d in `find examples-staging -type d -maxdepth 1 -mindepth 1`; do cd $d; echo $d; SKIP_PROMPTS=1 yarn keystone-next postinstall; if [ $? -ne 0 ]; then exit 1; fi; cd ../..; done"
   },
   "dependencies": {
     "@babel/core": "^7.14.3",
@@ -109,6 +109,7 @@
       "tests/examples-smoke-tests",
       "projects/*",
       "examples/*",
+      "examples-staging/*",
       "packages-next/*",
       "design-system/packages/*",
       "design-system/website",

diff --git a/tests/examples-smoke-tests/auth.test.ts b/tests/examples-smoke-tests/auth.test.ts
@@ -1,7 +1,7 @@
 import { Browser, Page } from 'playwright';
 import { exampleProjectTests, initFirstItemTest } from './utils';
 
-exampleProjectTests('auth', browserType => {
+exampleProjectTests('../examples-staging/auth', browserType => {
   let browser: Browser = undefined as any;
   let page: Page = undefined as any;
   beforeAll(async () => {

diff --git a/tests/examples-smoke-tests/basic.test.ts b/tests/examples-smoke-tests/basic.test.ts
@@ -2,7 +2,7 @@ import { Browser, Page } from 'playwright';
 import fetch from 'node-fetch';
 import { exampleProjectTests, initFirstItemTest } from './utils';
 
-exampleProjectTests('basic', browserType => {
+exampleProjectTests('../examples-staging/basic', browserType => {
   let browser: Browser = undefined as any;
   let page: Page = undefined as any;
   beforeAll(async () => {

diff --git a/tests/examples-smoke-tests/roles.test.ts b/tests/examples-smoke-tests/roles.test.ts
@@ -1,7 +1,7 @@
 import { Browser, Page } from 'playwright';
 import { exampleProjectTests, initFirstItemTest } from './utils';
 
-exampleProjectTests('roles', browserType => {
+exampleProjectTests('../examples-staging/roles', browserType => {
   let browser: Browser = undefined as any;
   let page: Page = undefined as any;
   beforeAll(async () => {