refactor: split playground into examples

unjs · Apr 7, 2022 · 62bf44d · 62bf44d
1 parent 9388b7d
commit 62bf44d
Show file tree

Hide file tree

Showing 29 changed files with 150 additions and 54 deletions.
diff --git a/examples/api-routes/api/hello.ts b/examples/api-routes/api/hello.ts
@@ -0,0 +1,3 @@
+import { defineEventHandler } from 'h3'
+
+export default defineEventHandler(() => 'Nitro is amazing!')
diff --git a/playground/api/hello/:name.ts → examples/api-routes/api/hello/:name.ts b/playground/api/hello/:name.ts → examples/api-routes/api/hello/:name.ts
diff --git a/examples/api-routes/nitro.config.ts b/examples/api-routes/nitro.config.ts
@@ -0,0 +1,4 @@
+import { defineNitroConfig } from 'nitropack'
+
+export default defineNitroConfig({
+})
diff --git a/examples/api-routes/package.json b/examples/api-routes/package.json
@@ -0,0 +1,11 @@
+{
+  "name": "example-api-routes",
+  "private": true,
+  "scripts": {
+    "dev": "nitro dev",
+    "build": "nitro build"
+  },
+  "devDependencies": {
+    "nitropack": "latest"
+  }
+}
diff --git a/examples/api-routes/public/index.html b/examples/api-routes/public/index.html
@@ -0,0 +1,2 @@
+<a href="/api/hello">/api/hello</a><br>
+<a href="/api/hello/world">/api/hello/world</a><br>
diff --git a/examples/api-routes/tsconfig.json b/examples/api-routes/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "./.nitro/types/tsconfig.json"
+}
diff --git a/examples/cached-handler/api/test.ts b/examples/cached-handler/api/test.ts
@@ -0,0 +1,6 @@
+import { defineCachedEventHandler } from '#nitro'
+
+export default defineCachedEventHandler(async () => {
+  await new Promise(resolve => setTimeout(resolve, 1000))
+  return `Response generated at ${new Date().toISOString()} (took 1 second)`
+})
diff --git a/examples/cached-handler/nitro.config.ts b/examples/cached-handler/nitro.config.ts
@@ -0,0 +1,4 @@
+import { defineNitroConfig } from 'nitropack'
+
+export default defineNitroConfig({
+})
diff --git a/examples/cached-handler/package.json b/examples/cached-handler/package.json
@@ -0,0 +1,11 @@
+{
+  "name": "example-cached-handler",
+  "private": true,
+  "scripts": {
+    "dev": "nitro dev",
+    "build": "nitro build"
+  },
+  "devDependencies": {
+    "nitropack": "latest"
+  }
+}
diff --git a/examples/cached-handler/tsconfig.json b/examples/cached-handler/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "./.nitro/types/tsconfig.json"
+}
diff --git a/examples/hello-world/nitro.config.ts b/examples/hello-world/nitro.config.ts
@@ -0,0 +1,4 @@
+import { defineNitroConfig } from 'nitropack'
+
+export default defineNitroConfig({
+})
diff --git a/examples/hello-world/package.json b/examples/hello-world/package.json
@@ -1,11 +1,11 @@
 {
-  "name": "nitro-example-hello-world",
+  "name": "example-hello-world",
   "private": true,
   "scripts": {
     "dev": "nitro dev",
     "build": "nitro build"
   },
   "devDependencies": {
-    "nitropack-edge": "latest"
+    "nitropack": "latest"
   }
 }
diff --git a/examples/hello-world/tsconfig.json b/examples/hello-world/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "./.nitro/types/tsconfig.json"
+}
diff --git a/playground/middleware/test.ts → examples/middleware/middleware/test.ts b/playground/middleware/test.ts → examples/middleware/middleware/test.ts
diff --git a/examples/middleware/nitro.config.ts b/examples/middleware/nitro.config.ts
@@ -0,0 +1,4 @@
+import { defineNitroConfig } from 'nitropack'
+
+export default defineNitroConfig({
+})
diff --git a/examples/middleware/package.json b/examples/middleware/package.json
@@ -0,0 +1,11 @@
+{
+  "name": "example-middleware",
+  "private": true,
+  "scripts": {
+    "dev": "nitro dev",
+    "build": "nitro build"
+  },
+  "devDependencies": {
+    "nitropack": "latest"
+  }
+}
diff --git a/examples/middleware/tsconfig.json b/examples/middleware/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "./.nitro/types/tsconfig.json"
+}
diff --git a/examples/plugins/nitro.config.ts b/examples/plugins/nitro.config.ts
@@ -0,0 +1,7 @@
+import { defineNitroConfig } from 'nitropack'
+
+export default defineNitroConfig({
+  plugins: [
+    '~/plugins/test'
+  ]
+})
diff --git a/examples/plugins/package.json b/examples/plugins/package.json
@@ -0,0 +1,11 @@
+{
+  "name": "example-plugins",
+  "private": true,
+  "scripts": {
+    "dev": "nitro dev",
+    "build": "nitro build"
+  },
+  "devDependencies": {
+    "nitropack": "latest"
+  }
+}
diff --git a/playground/plugins/test.ts → examples/plugins/plugins/test.ts b/playground/plugins/test.ts → examples/plugins/plugins/test.ts
diff --git a/examples/plugins/tsconfig.json b/examples/plugins/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "./.nitro/types/tsconfig.json"
+}
diff --git a/package.json b/package.json
@@ -4,6 +4,12 @@
   "description": "Next Generation Web Tooling",
   "license": "MIT",
   "type": "module",
+  "workspaces": [
+    "./examples/**"
+  ],
+  "resolutions": {
+    "nitropack": "link:."
+  },
   "exports": {
     ".": "./dist/index.mjs",
     "./cli": "./dist/cli.mjs",
@@ -22,6 +28,7 @@
   "scripts": {
     "build": "unbuild",
     "dev": "yarn nitro dev playground",
+    "example": "yarn workspace example-$0 dev",
     "dev:build": "yarn nitro build playground",
     "dev:start": "node playground/.output/server/index.mjs",
     "lint": "eslint --ext .ts,.mjs,.cjs .",

diff --git a/playground/api/error.ts b/playground/api/error.ts
diff --git a/playground/api/swr.ts b/playground/api/swr.ts
diff --git a/playground/api/test.ts b/playground/api/test.ts
diff --git a/playground/app.ts b/playground/app.ts
@@ -1,26 +1,3 @@
 import { eventHandler } from 'h3'
 
-export default eventHandler(() => {
-  const links = [
-    '/api/hello/you',
-    '/api/test',
-    '/api/swr',
-    '/api/error'
-  ]
-  return `<!DOCTYPE html>
-  <html lang="en">
-    <head>
-      <meta charset="utf-8">
-      <link rel="icon" type="image/x-icon" href="/favicon.ico">
-      <title>Nitro Playground</title>
-    </head>
-
-    <body>
-      <h1>Welcome to Nitro playground!</h1>
-      <ul>
-${links.map(link => `        <li><a href="${link}">${link}</a></li>`).join('\n')}
-      </ul>
-    </body>
-
-</html>`
-})
+export default eventHandler(() => '<h1>Hello Nitro!</h1>')
diff --git a/playground/nitro.config.ts b/playground/nitro.config.ts
@@ -1,15 +1,5 @@
 import { defineNitroConfig } from '../src'
 
 export default defineNitroConfig({
-  renderer: './app',
-  prerender: {
-    crawlLinks: true
-  },
-  // baseURL: '/app',
-  routes: {
-    '/api/swr': { swr: true }
-  },
-  plugins: [
-    '~/plugins/test'
-  ]
+  renderer: '~/app'
 })
diff --git a/playground/public/favicon.ico b/playground/public/favicon.ico
diff --git a/yarn.lock b/yarn.lock
@@ -3442,6 +3442,46 @@ __metadata:
   languageName: node
   linkType: hard
 
+"example-api-routes@workspace:examples/api-routes":
+  version: 0.0.0-use.local
+  resolution: "example-api-routes@workspace:examples/api-routes"
+  dependencies:
+    nitropack: latest
+  languageName: unknown
+  linkType: soft
+
+"example-cached-handler@workspace:examples/cached-handler":
+  version: 0.0.0-use.local
+  resolution: "example-cached-handler@workspace:examples/cached-handler"
+  dependencies:
+    nitropack: latest
+  languageName: unknown
+  linkType: soft
+
+"example-hello-world@workspace:examples/hello-world":
+  version: 0.0.0-use.local
+  resolution: "example-hello-world@workspace:examples/hello-world"
+  dependencies:
+    nitropack: latest
+  languageName: unknown
+  linkType: soft
+
+"example-middleware@workspace:examples/middleware":
+  version: 0.0.0-use.local
+  resolution: "example-middleware@workspace:examples/middleware"
+  dependencies:
+    nitropack: latest
+  languageName: unknown
+  linkType: soft
+
+"example-plugins@workspace:examples/plugins":
+  version: 0.0.0-use.local
+  resolution: "example-plugins@workspace:examples/plugins"
+  dependencies:
+    nitropack: latest
+  languageName: unknown
+  linkType: soft
+
 "execa@npm:^5.1.1":
   version: 5.1.1
   resolution: "execa@npm:5.1.1"
@@ -5602,6 +5642,12 @@ __metadata:
   languageName: node
   linkType: hard
 
+"nitropack@link:.::locator=nitropack%40workspace%3A.":
+  version: 0.0.0-use.local
+  resolution: "nitropack@link:.::locator=nitropack%40workspace%3A."
+  languageName: node
+  linkType: soft
+
 "nitropack@workspace:.":
   version: 0.0.0-use.local
   resolution: "nitropack@workspace:."