docs: add monorepo example (#25)

titanom · Mar 12, 2024 · 8668d68 · 8668d68
1 parent 97f14de
commit 8668d68
Show file tree

Hide file tree

Showing 35 changed files with 2,946 additions and 43 deletions.
diff --git a/docs/guide/monorepo.md b/docs/guide/monorepo.md
@@ -53,3 +53,9 @@ const config = {
 
 export default config;
 ```
+
+::: tip
+
+For a full example see [examples/monorepo](https://github.com/titanom/css2tailwind/tree/master/examples/monorepo).
+
+:::
diff --git a/examples/monorepo/app/.gitignore b/examples/monorepo/app/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/examples/monorepo/app/README.md b/examples/monorepo/app/README.md
@@ -0,0 +1,30 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@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
+
+## Expanding the ESLint configuration
+
+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 {
+  // other rules...
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json', './tsconfig.node.json'],
+    tsconfigRootDir: __dirname,
+  },
+}
+```
+
+- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
+- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
diff --git a/examples/monorepo/app/index.html b/examples/monorepo/app/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/examples/monorepo/app/package.json b/examples/monorepo/app/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "@repo/app",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "dependencies": {
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@repo/ui": "workspace:^",
+    "@types/react": "18.2.64",
+    "@types/react-dom": "18.2.21",
+    "@vitejs/plugin-react-swc": "3.5.0",
+    "autoprefixer": "10.4.18",
+    "postcss": "8.4.35",
+    "tailwindcss": "3.4.1",
+    "typescript": "5.2.2",
+    "vite": "5.1.6"
+  }
+}
diff --git a/examples/monorepo/app/postcss.config.js b/examples/monorepo/app/postcss.config.js
@@ -0,0 +1,6 @@
+export default {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+};
diff --git a/examples/monorepo/app/public/vite.svg b/examples/monorepo/app/public/vite.svg
diff --git a/examples/monorepo/app/src/App.tsx b/examples/monorepo/app/src/App.tsx
@@ -0,0 +1,7 @@
+export default function App() {
+  return (
+    <div>
+      <button className="button button-primary">Button</button>
+    </div>
+  );
+}
diff --git a/examples/monorepo/app/src/index.css b/examples/monorepo/app/src/index.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
diff --git a/examples/monorepo/app/src/main.tsx b/examples/monorepo/app/src/main.tsx
@@ -0,0 +1,12 @@
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+
+import App from './App.tsx';
+
+import './index.css';
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>,
+);
diff --git a/examples/monorepo/app/src/vite-env.d.ts b/examples/monorepo/app/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/examples/monorepo/app/tailwind.config.ts b/examples/monorepo/app/tailwind.config.ts
@@ -0,0 +1,10 @@
+import { plugin } from '../ui/tailwind.config';
+
+import type { Config } from 'tailwindcss';
+
+const config = {
+  content: ['./src/index.html', './src/**/*.tsx'],
+  plugins: [plugin],
+} satisfies Config;
+
+export default config;
diff --git a/examples/monorepo/app/tsconfig.json b/examples/monorepo/app/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}
diff --git a/examples/monorepo/app/tsconfig.node.json b/examples/monorepo/app/tsconfig.node.json
@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "strict": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/examples/monorepo/app/vite.config.ts b/examples/monorepo/app/vite.config.ts
@@ -0,0 +1,7 @@
+import react from '@vitejs/plugin-react-swc';
+import { defineConfig } from 'vite';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+});
diff --git a/examples/monorepo/package.json b/examples/monorepo/package.json
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "repo",
+  "scripts": {
+    "dev": "turbo dev",
+    "build": "turbo build",
+    "preview": "turbo preview",
+    "format": "turbo root:format format",
+    "format:check": "turbo root:format:check format:check",
+    "root:format": "prettier --write ./*.*",
+    "root:format:check": "prettier --check ./*.*"
+  },
+  "devDependencies": {
+    "turbo": "^1.12.5"
+  }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -53,3 +53,9 @@ const config = { @@
     export default config;
     ```
+    ::: tip
+    For a full example see [examples/monorepo](https://github.com/titanom/css2tailwind/tree/master/examples/monorepo).
+    :::