feat: add a demo app and SWRDevTools

koba04 · Feb 8, 2021 · 65544f2 · 65544f2
1 parent 1e5f6b7
commit 65544f2
Show file tree

Hide file tree

Showing 18 changed files with 3,019 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/examples/swr-devtools-demo/.gitignore b/examples/swr-devtools-demo/.gitignore
@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel
diff --git a/examples/swr-devtools-demo/README.md b/examples/swr-devtools-demo/README.md
@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
diff --git a/examples/swr-devtools-demo/package.json b/examples/swr-devtools-demo/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "swr-devtools-demo",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "dependencies": {
+    "next": "10.0.6",
+    "react": "17.0.1",
+    "react-dom": "17.0.1",
+    "swr-devtools": "0.1.0"
+  }
+}
diff --git a/examples/swr-devtools-demo/pages/_app.js b/examples/swr-devtools-demo/pages/_app.js
@@ -0,0 +1,14 @@
+import '../styles/globals.css'
+import { SWRDevTools } from "swr-devtools"
+import { cache } from "swr";
+
+function MyApp({ Component, pageProps }) {
+  return (
+    <>
+      <Component {...pageProps} />
+      <SWRDevTools cache={cache} />
+    </>
+  );
+}
+
+export default MyApp
diff --git a/examples/swr-devtools-demo/pages/api/hello.js b/examples/swr-devtools-demo/pages/api/hello.js
@@ -0,0 +1,5 @@
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+
+export default (req, res) => {
+  res.status(200).json({ name: 'John Doe' })
+}
diff --git a/examples/swr-devtools-demo/pages/index.js b/examples/swr-devtools-demo/pages/index.js
@@ -0,0 +1,37 @@
+import Head from 'next/head'
+import styles from '../styles/Home.module.css'
+import useSWR from "swr";
+
+export default function Home() {
+  const { data } = useSWR("/api/hello");
+
+  return (
+    <div className={styles.container}>
+      <Head>
+        <title>Create Next App</title>
+        <link rel="icon" href="/favicon.ico" />
+      </Head>
+
+      <main className={styles.main}>
+        <h1 className={styles.title}>
+          Welcome to <a href="https://nextjs.org">Next.js!</a>
+        </h1>
+
+        <h2>SWR</h2>
+        <div>{data ? data.name : '...loading'}</div>
+
+      </main>
+
+      <footer className={styles.footer}>
+        <a
+          href="https://vercel.com?utm_source=create-next-app&utm_medium=default-template&utm_campaign=create-next-app"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          Powered by{' '}
+          <img src="/vercel.svg" alt="Vercel Logo" className={styles.logo} />
+        </a>
+      </footer>
+    </div>
+  )
+}
diff --git a/examples/swr-devtools-demo/public/favicon.ico b/examples/swr-devtools-demo/public/favicon.ico
diff --git a/examples/swr-devtools-demo/public/vercel.svg b/examples/swr-devtools-demo/public/vercel.svg
diff --git a/examples/swr-devtools-demo/styles/Home.module.css b/examples/swr-devtools-demo/styles/Home.module.css
@@ -0,0 +1,122 @@
+.container {
+  min-height: 100vh;
+  padding: 0 0.5rem;
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+}
+
+.main {
+  padding: 5rem 0;
+  flex: 1;
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+}
+
+.footer {
+  width: 100%;
+  height: 100px;
+  border-top: 1px solid #eaeaea;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+}
+
+.footer img {
+  margin-left: 0.5rem;
+}
+
+.footer a {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+}
+
+.title a {
+  color: #0070f3;
+  text-decoration: none;
+}
+
+.title a:hover,
+.title a:focus,
+.title a:active {
+  text-decoration: underline;
+}
+
+.title {
+  margin: 0;
+  line-height: 1.15;
+  font-size: 4rem;
+}
+
+.title,
+.description {
+  text-align: center;
+}
+
+.description {
+  line-height: 1.5;
+  font-size: 1.5rem;
+}
+
+.code {
+  background: #fafafa;
+  border-radius: 5px;
+  padding: 0.75rem;
+  font-size: 1.1rem;
+  font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono,
+    Bitstream Vera Sans Mono, Courier New, monospace;
+}
+
+.grid {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-wrap: wrap;
+  max-width: 800px;
+  margin-top: 3rem;
+}
+
+.card {
+  margin: 1rem;
+  flex-basis: 45%;
+  padding: 1.5rem;
+  text-align: left;
+  color: inherit;
+  text-decoration: none;
+  border: 1px solid #eaeaea;
+  border-radius: 10px;
+  transition: color 0.15s ease, border-color 0.15s ease;
+}
+
+.card:hover,
+.card:focus,
+.card:active {
+  color: #0070f3;
+  border-color: #0070f3;
+}
+
+.card h3 {
+  margin: 0 0 1rem 0;
+  font-size: 1.5rem;
+}
+
+.card p {
+  margin: 0;
+  font-size: 1.25rem;
+  line-height: 1.5;
+}
+
+.logo {
+  height: 1em;
+}
+
+@media (max-width: 600px) {
+  .grid {
+    width: 100%;
+    flex-direction: column;
+  }
+}
diff --git a/examples/swr-devtools-demo/styles/globals.css b/examples/swr-devtools-demo/styles/globals.css
@@ -0,0 +1,16 @@
+html,
+body {
+  padding: 0;
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen,
+    Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;
+}
+
+a {
+  color: inherit;
+  text-decoration: none;
+}
+
+* {
+  box-sizing: border-box;
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "swr-devtools",
+  "version": "1.0.0",
+  "private": true,
+  "workspaces": [
+    "packages/*",
+    "examples/*"
+  ],
+  "scripts": {
+    "start:demo": "yarn workspace swr-devtools-demo dev",
+    "start:dev": "yarn workspace swr-devtools start",
+    "start": "run-p -l start:*"
+  },
+  "repository": "ssh://git@github.com/koba04/swr-devtools.git",
+  "author": "Toru Kobayashi <koba0004@gmail.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "npm-run-all": "^4.1.5"
+  }
+}
diff --git a/packages/swr-devtools/.gitignore b/packages/swr-devtools/.gitignore
@@ -0,0 +1 @@
+lib
diff --git a/packages/swr-devtools/package.json b/packages/swr-devtools/package.json
@@ -0,0 +1,24 @@
+{
+  "name": "swr-devtools",
+  "version": "0.1.0",
+  "main": "lib/index.js",
+  "license": "MIT",
+  "scripts": {
+    "start": "tsc --watch"
+  },
+  "peerDependencies": {
+    "react": "^17.0.1",
+    "react-dom": "^17.0.1",
+    "swr": "^0.4.2"
+  },
+  "devDependencies": {
+    "react": "^17.0.1",
+    "react-dom": "^17.0.1",
+    "swr": "^0.4.2",
+    "typescript": "^4.1.3"
+  },
+  "dependencies": {
+    "@types/react": "^17.0.1",
+    "csstype": "^3.0.6"
+  }
+}
diff --git a/packages/swr-devtools/src/SWRDevTool.tsx b/packages/swr-devtools/src/SWRDevTool.tsx
@@ -0,0 +1,34 @@
+import React, { useEffect, useState } from "react";
+import * as CSS from "csstype";
+import { CacheInterface } from "swr";
+
+
+const style: CSS.Properties = {
+  position: 'fixed',
+  bottom: 0,
+  width: '100%',
+  height: '200px',
+  opacity: 0.5,
+  backgroundColor: '#EEE',
+}
+
+export const SWRDevTools = ({ cache }: { cache: CacheInterface }) => {
+  const [cacheData, setCacheData] = useState<Array<{ key: string, data : object }>>([]);
+  useEffect(() => {
+    cache.subscribe(() => {
+      // validating@{key} is a key for the validating status corresponding with the key
+      // err@{key} is a key for the error that corresponding with the key
+      setCacheData(cache.keys().map(key => ({ key, data: cache.get(key)})))
+    })
+  }, [cache]);
+
+  return (
+    <div style={style}>
+      <ul>
+      {cacheData.map(({ key, data }) => (
+        <li key={key}>[{key}]: {JSON.stringify(data)}</li>
+      ))}
+      </ul>
+    </div>
+  )
+}
diff --git a/packages/swr-devtools/src/index.ts b/packages/swr-devtools/src/index.ts
@@ -0,0 +1 @@
+export { SWRDevTools } from "./SWRDevTool"