Scaffold a new Vite React+TypeScript project

Created using `bun create vite image-editor-poc-react-image-crop --template react-ts`
TomasHubelbauer · Oct 2, 2024 · c2f6b86 · c2f6b86
1 parent cc1aad0
commit c2f6b86
Show file tree

Hide file tree

Showing 21 changed files with 321 additions and 152 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,2 @@
-bun.lockb
 node_modules
+bun.lockb
diff --git a/App.tsx b/App.tsx
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+)
diff --git a/index.css b/index.css
diff --git a/index.html b/index.html
@@ -1,23 +1,13 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <title>Bun React</title>
-    <link rel="icon" href="https://fav.farm/⚛️" />
-    <link rel="stylesheet" href="index.css" />
-    <link rel="stylesheet" href="https://esm.sh/react-image-crop/dist/ReactCrop.css" />
-    <script type="importmap">
-      {
-        "imports": {
-          "react": "https://esm.sh/react?dev",
-          "react-dom/client": "https://esm.sh/react-dom/client?dev",
-          "react-image-crop": "https://esm.sh/react-image-crop"
-        }
-      }
-    </script>
-    <script type="module" src="index.tsx"></script>
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>Vite + React + TS</title>
   </head>
   <body>
-    <div id="rootDiv"></div>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
   </body>
 </html>
diff --git a/index.tsx b/index.tsx
diff --git a/package.json b/package.json
@@ -1,13 +1,29 @@
 {
+  "name": "image-editor-poc-react-image-crop",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
   "scripts": {
-    "start": "bun --hot serve.ts"
-  },
-  "devDependencies": {
-    "@types/bun": "latest",
-    "@types/react": "latest",
-    "@types/react-dom": "latest"
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
   },
   "dependencies": {
-    "@types/react-image-crop": "^8.1.6"
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.9.0",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "@vitejs/plugin-react": "^4.3.1",
+    "eslint": "^9.9.0",
+    "eslint-plugin-react-hooks": "^5.1.0-rc.0",
+    "eslint-plugin-react-refresh": "^0.4.9",
+    "globals": "^15.9.0",
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^8.0.1",
+    "vite": "^5.4.1"
   }
 }
diff --git a/public/vite.svg b/public/vite.svg
diff --git a/readme.md b/readme.md
@@ -1,15 +1,50 @@
-# Image editor proof of concept with `react-image-crop`
+# React + TypeScript + Vite
 
-This repository is based on https://github.com/TomasHubelbauer/bun-react.
-It contains a PoC of https://github.com/TomasHubelbauer/image-editor-poc built
-with the `react-image-crop` library.
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
 
-NPM: https://www.npmjs.com/package/react-image-crop
-GitHub: https://github.com/sekoyo/react-image-crop
+Currently, two official plugins are available:
 
-## To-Do
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
 
-### Figure out how to fix the `canvas` with checkerboard pattern misplacement
+## Expanding the ESLint configuration
 
-It appears behind everything for some reason.
-When I pull out the `ReactCrop` from the `dialog` it is still broken.
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+export default tseslint.config({
+  languageOptions: {
+    // other options...
+    parserOptions: {
+      project: ['./tsconfig.node.json', './tsconfig.app.json'],
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+})
+```
+
+- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
+- Optionally add `...tseslint.configs.stylisticTypeChecked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
+
+```js
+// eslint.config.js
+import react from 'eslint-plugin-react'
+
+export default tseslint.config({
+  // Set the react version
+  settings: { react: { version: '18.3' } },
+  plugins: {
+    // Add the react plugin
+    react,
+  },
+  rules: {
+    // other rules...
+    // Enable its recommended rules
+    ...react.configs.recommended.rules,
+    ...react.configs['jsx-runtime'].rules,
+  },
+})
+```
diff --git a/sample.jpg b/sample.jpg
diff --git a/serve.ts b/serve.ts
diff --git a/src/App.css b/src/App.css
@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}
diff --git a/src/App.tsx b/src/App.tsx
@@ -0,0 +1,35 @@
+import { useState } from 'react'
+import reactLogo from './assets/react.svg'
+import viteLogo from '/vite.svg'
+import './App.css'
+
+function App() {
+  const [count, setCount] = useState(0)
+
+  return (
+    <>
+      <div>
+        <a href="https://vitejs.dev" target="_blank">
+          <img src={viteLogo} className="logo" alt="Vite logo" />
+        </a>
+        <a href="https://react.dev" target="_blank">
+          <img src={reactLogo} className="logo react" alt="React logo" />
+        </a>
+      </div>
+      <h1>Vite + React</h1>
+      <div className="card">
+        <button onClick={() => setCount((count) => count + 1)}>
+          count is {count}
+        </button>
+        <p>
+          Edit <code>src/App.tsx</code> and save to test HMR
+        </p>
+      </div>
+      <p className="read-the-docs">
+        Click on the Vite and React logos to learn more
+      </p>
+    </>
+  )
+}
+
+export default App
diff --git a/src/assets/react.svg b/src/assets/react.svg