chore(example): convert with-stitches to TS (#38892)

* chore(example): convert `with-stitches` to TS * refactor: change arrow to declaration * refactor: change import default to `* as` * feat: add next.config.js * refactor: improve typing Co-authored-by: JJ Kasper <jj@jjsweb.site>
vercel · Jul 22, 2022 · 4d8d99e · 4d8d99e
1 parent e8bbf14
commit 4d8d99e
Show file tree

Hide file tree

Showing 10 changed files with 71 additions and 35 deletions.
diff --git a/examples/with-stitches/.gitignore b/examples/with-stitches/.gitignore
@@ -23,12 +23,13 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.pnpm-debug.log*
 
 # local env files
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+.env*.local
 
 # vercel
 .vercel
+
+# typescript
+*.tsbuildinfo
diff --git a/...with-stitches/components/StitchesLogo.jsx → ...with-stitches/components/StitchesLogo.tsx b/...with-stitches/components/StitchesLogo.jsx → ...with-stitches/components/StitchesLogo.tsx
diff --git a/examples/with-stitches/next-env.d.ts b/examples/with-stitches/next-env.d.ts
@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.
diff --git a/examples/with-stitches/next.config.js b/examples/with-stitches/next.config.js
@@ -0,0 +1,6 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+}
+
+module.exports = nextConfig
diff --git a/examples/with-stitches/package.json b/examples/with-stitches/package.json
@@ -1,14 +1,20 @@
 {
   "private": true,
   "scripts": {
-    "dev": "next dev",
     "build": "next build",
+    "dev": "next dev",
     "start": "next start"
   },
   "dependencies": {
-    "@stitches/react": "^1.2.6",
+    "@stitches/react": "1.2.8",
     "next": "latest",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.0.6",
+    "@types/react": "^18.0.15",
+    "@types/react-dom": "^18.0.6",
+    "typescript": "^4.7.4"
   }
 }
diff --git a/examples/with-stitches/pages/_document.jsx b/examples/with-stitches/pages/_document.jsx
diff --git a/examples/with-stitches/pages/_document.tsx b/examples/with-stitches/pages/_document.tsx
@@ -0,0 +1,19 @@
+import { Head, Html, Main, NextScript } from 'next/document'
+import { getCssText } from '../stitches.config'
+
+export default function MyDocument() {
+  return (
+    <Html lang="en">
+      <Head>
+        <style
+          id="stitches"
+          dangerouslySetInnerHTML={{ __html: getCssText() }}
+        />
+      </Head>
+      <body>
+        <Main />
+        <NextScript />
+      </body>
+    </Html>
+  )
+}
diff --git a/examples/with-stitches/pages/index.jsx → examples/with-stitches/pages/index.tsx b/examples/with-stitches/pages/index.jsx → examples/with-stitches/pages/index.tsx
@@ -1,6 +1,6 @@
 import Head from 'next/head'
-import { styled } from '../stitches.config'
 import StitchesLogo from '../components/StitchesLogo'
+import { styled } from '../stitches.config'
 
 const Box = styled('div', {})
 

diff --git a/examples/with-stitches/stitches.config.js → examples/with-stitches/stitches.config.ts b/examples/with-stitches/stitches.config.js → examples/with-stitches/stitches.config.ts
@@ -1,3 +1,4 @@
+import type * as Stitches from '@stitches/react'
 import { createStitches } from '@stitches/react'
 
 export const {
@@ -57,19 +58,19 @@ export const {
     },
   },
   utils: {
-    marginX: (value) => ({
+    marginX: (value: Stitches.PropertyValue<'margin'>) => ({
       marginLeft: value,
       marginRight: value,
     }),
-    marginY: (value) => ({
+    marginY: (value: Stitches.PropertyValue<'margin'>) => ({
       marginTop: value,
       marginBottom: value,
     }),
-    paddingX: (value) => ({
+    paddingX: (value: Stitches.PropertyValue<'padding'>) => ({
       paddingLeft: value,
       paddingRight: value,
     }),
-    paddingY: (value) => ({
+    paddingY: (value: Stitches.PropertyValue<'padding'>) => ({
       paddingTop: value,
       paddingBottom: value,
     }),

diff --git a/examples/with-stitches/tsconfig.json b/examples/with-stitches/tsconfig.json
@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}