Compare commits
3 Commits
fb00563dc3
...
backup/leg
| Author | SHA1 | Date | |
|---|---|---|---|
| f7f86e4462 | |||
| 5cc476cedc | |||
| 1ccda13cdf |
5
.vscode/extensions.json
vendored
@@ -2,8 +2,11 @@
|
|||||||
"recommendations": [
|
"recommendations": [
|
||||||
"biomejs.biome",
|
"biomejs.biome",
|
||||||
"hverlin.mise-vscode",
|
"hverlin.mise-vscode",
|
||||||
|
"mikestead.dotenv",
|
||||||
"oven.bun-vscode",
|
"oven.bun-vscode",
|
||||||
"redhat.vscode-yaml",
|
"redhat.vscode-yaml",
|
||||||
"tamasfe.even-better-toml"
|
"rust-lang.rust-analyzer",
|
||||||
|
"tamasfe.even-better-toml",
|
||||||
|
"tauri-apps.tauri-vscode"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
40
.vscode/settings.json
vendored
@@ -1,42 +1,48 @@
|
|||||||
{
|
{
|
||||||
|
// Disable the default formatter & linter, use biome instead
|
||||||
|
"prettier.enable": false,
|
||||||
|
"eslint.enable": false,
|
||||||
|
|
||||||
|
// Auto fix
|
||||||
|
"editor.codeActionsOnSave": {
|
||||||
|
"source.fixAll.biome": "explicit",
|
||||||
|
"source.organizeImports.biome": "explicit"
|
||||||
|
},
|
||||||
|
"editor.defaultFormatter": "biomejs.biome",
|
||||||
|
"editor.formatOnSave": true,
|
||||||
"[javascript]": {
|
"[javascript]": {
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
},
|
},
|
||||||
"[javascriptreact]": {
|
"[javascriptreact]": {
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
},
|
},
|
||||||
|
"[typescript]": {
|
||||||
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
|
},
|
||||||
|
"[typescriptreact]": {
|
||||||
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
|
},
|
||||||
"[json]": {
|
"[json]": {
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
},
|
},
|
||||||
"[jsonc]": {
|
"[jsonc]": {
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
},
|
},
|
||||||
"[toml]": {
|
|
||||||
"editor.defaultFormatter": "tamasfe.even-better-toml"
|
|
||||||
},
|
|
||||||
"[typescript]": {
|
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
|
||||||
},
|
|
||||||
"[typescriptreact]": {
|
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
|
||||||
},
|
|
||||||
"[yaml]": {
|
"[yaml]": {
|
||||||
"editor.defaultFormatter": "redhat.vscode-yaml"
|
"editor.defaultFormatter": "redhat.vscode-yaml"
|
||||||
},
|
},
|
||||||
"editor.codeActionsOnSave": {
|
"[toml]": {
|
||||||
"source.fixAll.biome": "explicit",
|
"editor.defaultFormatter": "tamasfe.even-better-toml"
|
||||||
"source.organizeImports.biome": "explicit"
|
|
||||||
},
|
},
|
||||||
"editor.defaultFormatter": "biomejs.biome",
|
|
||||||
"editor.formatOnSave": true,
|
|
||||||
"files.associations": {
|
"files.associations": {
|
||||||
".env": "dotenv",
|
".env": "dotenv",
|
||||||
".env.*": "dotenv",
|
".env.*": "dotenv",
|
||||||
|
"**/tsconfig*.json": "jsonc",
|
||||||
"**/biome.json": "jsonc",
|
"**/biome.json": "jsonc",
|
||||||
"**/opencode.json": "jsonc",
|
"**/opencode.json": "jsonc"
|
||||||
"**/tsconfig.*.json": "jsonc",
|
|
||||||
"**/tsconfig.json": "jsonc"
|
|
||||||
},
|
},
|
||||||
|
|
||||||
|
// TanStack Router
|
||||||
"files.readonlyInclude": {
|
"files.readonlyInclude": {
|
||||||
"**/routeTree.gen.ts": true
|
"**/routeTree.gen.ts": true
|
||||||
},
|
},
|
||||||
|
|||||||
330
AGENTS.md
@@ -1,219 +1,193 @@
|
|||||||
# AGENTS.md - AI Coding Agent Guidelines
|
# AGENTS.md - AI Coding Agent Guidelines
|
||||||
|
|
||||||
Guidelines for AI agents working in this Bun monorepo.
|
|
||||||
|
|
||||||
## Project Overview
|
## Project Overview
|
||||||
|
|
||||||
> **This project uses [Bun](https://bun.sh) exclusively as both the JavaScript runtime and package manager. Do NOT use Node.js / npm / yarn / pnpm. All commands start with `bun` — use `bun install` for dependencies and `bun run <script>` for scripts. Always prefer `bun run <script>` over `bun <script>` to avoid conflicts with Bun built-in subcommands (e.g. `bun build` invokes Bun's bundler, NOT your package.json script). Never use `npm`, `npx`, or `node`.**
|
TanStack Start fullstack app with Tauri desktop shell.
|
||||||
|
|
||||||
- **Monorepo**: Bun workspaces + Turborepo orchestration
|
| Layer | Tech |
|
||||||
- **Runtime**: Bun (see `mise.toml` for version) — **NOT Node.js**
|
|-------|------|
|
||||||
- **Package Manager**: Bun — **NOT npm / yarn / pnpm**
|
| Framework | TanStack Start (React SSR, file-based routing) |
|
||||||
- **Apps**:
|
| Runtime | Bun |
|
||||||
- `apps/server` - TanStack Start fullstack web app (see `apps/server/AGENTS.md`)
|
| Language | TypeScript (strict mode) |
|
||||||
- `apps/desktop` - Electron desktop shell, sidecar server pattern (see `apps/desktop/AGENTS.md`)
|
| Styling | Tailwind CSS v4 |
|
||||||
- **Packages**: `packages/tsconfig` (shared TS configs)
|
| Database | PostgreSQL + Drizzle ORM |
|
||||||
|
| RPC | ORPC (contract-first, type-safe) |
|
||||||
|
| Build | Vite + Turbo |
|
||||||
|
| Linting | Biome |
|
||||||
|
| Desktop | Tauri v2 (optional, see `src-tauri/AGENTS.md`) |
|
||||||
|
|
||||||
## Build / Lint / Test Commands
|
## Commands
|
||||||
|
|
||||||
### Root Commands (via Turbo)
|
|
||||||
```bash
|
```bash
|
||||||
bun run dev # Start all apps in dev mode
|
# Development
|
||||||
bun run build # Build all apps
|
bun dev # Start Tauri + Vite via Turbo
|
||||||
bun run compile # Compile server to standalone binary (current platform)
|
bun dev:vite # Vite only (localhost:3000)
|
||||||
bun run compile:darwin # Compile server for macOS (arm64 + x64)
|
bun db:studio # Drizzle Studio
|
||||||
bun run compile:linux # Compile server for Linux (x64 + arm64)
|
|
||||||
bun run compile:windows # Compile server for Windows x64
|
# Build
|
||||||
bun run dist # Package desktop distributable (current platform)
|
bun build # Full build (Vite → compile → Tauri)
|
||||||
bun run dist:linux # Package desktop for Linux (x64 + arm64)
|
bun build:vite # Vite only (outputs to .output/)
|
||||||
bun run dist:mac # Package desktop for macOS (arm64 + x64)
|
|
||||||
bun run dist:win # Package desktop for Windows x64
|
# Code Quality
|
||||||
bun run fix # Lint + format (Biome auto-fix)
|
bun typecheck # TypeScript check (tsc -b)
|
||||||
bun run typecheck # TypeScript check across monorepo
|
bun fix # Biome auto-fix (format + lint)
|
||||||
|
|
||||||
|
# Database
|
||||||
|
bun db:generate # Generate migrations from schema
|
||||||
|
bun db:migrate # Run migrations
|
||||||
|
bun db:push # Push schema changes (dev only)
|
||||||
|
|
||||||
|
# Testing (not configured yet)
|
||||||
|
# When adding tests, use Vitest or Bun test runner:
|
||||||
|
# bun test path/to/test.ts # Single file
|
||||||
|
# bun test -t "pattern" # By test name
|
||||||
```
|
```
|
||||||
|
|
||||||
### Server App (`apps/server`)
|
## Code Style
|
||||||
```bash
|
|
||||||
bun run dev # Vite dev server (localhost:3000)
|
|
||||||
bun run build # Production build -> .output/
|
|
||||||
bun run compile # Compile to standalone binary (current platform)
|
|
||||||
bun run compile:darwin # Compile for macOS (arm64 + x64)
|
|
||||||
bun run compile:darwin:arm64 # Compile for macOS arm64
|
|
||||||
bun run compile:darwin:x64 # Compile for macOS x64
|
|
||||||
bun run compile:linux # Compile for Linux (x64 + arm64)
|
|
||||||
bun run compile:linux:arm64 # Compile for Linux arm64
|
|
||||||
bun run compile:linux:x64 # Compile for Linux x64
|
|
||||||
bun run compile:windows # Compile for Windows (default: x64)
|
|
||||||
bun run compile:windows:x64 # Compile for Windows x64
|
|
||||||
bun run fix # Biome auto-fix
|
|
||||||
bun run typecheck # TypeScript check
|
|
||||||
|
|
||||||
# Database (Drizzle)
|
### Formatting (Biome enforced)
|
||||||
bun run db:generate # Generate migrations from schema
|
|
||||||
bun run db:migrate # Run migrations
|
|
||||||
bun run db:push # Push schema (dev only)
|
|
||||||
bun run db:studio # Open Drizzle Studio
|
|
||||||
```
|
|
||||||
|
|
||||||
### Desktop App (`apps/desktop`)
|
- **Indent**: 2 spaces
|
||||||
```bash
|
- **Line endings**: LF
|
||||||
bun run dev # electron-vite dev mode (requires server dev running)
|
- **Quotes**: Single `'string'`
|
||||||
bun run build # electron-vite build (main + preload)
|
- **Semicolons**: As needed (ASI)
|
||||||
bun run dist # Build + package for current platform
|
- **Arrow parens**: Always `(x) => x`
|
||||||
bun run dist:linux # Build + package for Linux (x64 + arm64)
|
|
||||||
bun run dist:linux:x64 # Build + package for Linux x64
|
|
||||||
bun run dist:linux:arm64 # Build + package for Linux arm64
|
|
||||||
bun run dist:mac # Build + package for macOS (arm64 + x64)
|
|
||||||
bun run dist:mac:arm64 # Build + package for macOS arm64
|
|
||||||
bun run dist:mac:x64 # Build + package for macOS x64
|
|
||||||
bun run dist:win # Build + package for Windows x64
|
|
||||||
bun run fix # Biome auto-fix
|
|
||||||
bun run typecheck # TypeScript check
|
|
||||||
```
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
No test framework configured yet. When adding tests:
|
|
||||||
```bash
|
|
||||||
bun test path/to/test.ts # Run single test file
|
|
||||||
bun test -t "pattern" # Run tests matching pattern
|
|
||||||
```
|
|
||||||
|
|
||||||
## Code Style (TypeScript)
|
|
||||||
|
|
||||||
### Formatting (Biome)
|
|
||||||
- **Indent**: 2 spaces | **Line endings**: LF
|
|
||||||
- **Quotes**: Single `'` | **Semicolons**: Omit (ASI)
|
|
||||||
- **Arrow parentheses**: Always `(x) => x`
|
|
||||||
|
|
||||||
### Imports
|
### Imports
|
||||||
Biome auto-organizes. Order: 1) External packages → 2) Internal `@/*` aliases → 3) Type imports (`import type { ... }`)
|
|
||||||
|
Biome auto-organizes. Order: external → internal (`@/*`) → type-only imports.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
import { createFileRoute } from '@tanstack/react-router'
|
||||||
import { z } from 'zod'
|
import { z } from 'zod'
|
||||||
import { db } from '@/server/db'
|
import { db } from '@/db'
|
||||||
import type { ReactNode } from 'react'
|
import type { ReactNode } from 'react'
|
||||||
```
|
```
|
||||||
|
|
||||||
### TypeScript Strictness
|
### TypeScript
|
||||||
- `strict: true`, `noUncheckedIndexedAccess: true`, `noImplicitOverride: true`, `verbatimModuleSyntax: true`
|
|
||||||
- Use `@/*` path aliases (maps to `src/*`)
|
|
||||||
|
|
||||||
### Naming Conventions
|
Strict mode with extra checks:
|
||||||
| Type | Convention | Example |
|
- `noUncheckedIndexedAccess: true` - array/object index returns `T | undefined`
|
||||||
|------|------------|---------|
|
- `noImplicitOverride: true`
|
||||||
| Files (utils) | kebab-case | `auth-utils.ts` |
|
- `verbatimModuleSyntax: true`
|
||||||
| Files (components) | PascalCase | `UserProfile.tsx` |
|
|
||||||
| Components | PascalCase arrow | `const Button = () => {}` |
|
Path alias: `@/*` → `src/*`
|
||||||
| Functions | camelCase | `getUserById` |
|
|
||||||
| Constants | UPPER_SNAKE | `MAX_RETRIES` |
|
### Naming
|
||||||
| Types/Interfaces | PascalCase | `UserProfile` |
|
|
||||||
|
| Entity | Convention | Example |
|
||||||
|
|--------|------------|---------|
|
||||||
|
| Files (utils) | kebab-case | `utils.ts`, `db-provider.ts` |
|
||||||
|
| Files (components) | PascalCase | `NotFound.tsx` |
|
||||||
|
| Routes | TanStack conventions | `routes/index.tsx`, `routes/__root.tsx` |
|
||||||
|
| Components | PascalCase arrow functions | `const MyComponent = () => {}` |
|
||||||
|
| Functions | camelCase | `handleSubmit` |
|
||||||
|
| Constants | UPPER_SNAKE_CASE | `MAX_RETRIES` |
|
||||||
|
| Types/Interfaces | PascalCase | `TodoItem`, `RouterContext` |
|
||||||
|
|
||||||
### React Patterns
|
### React Patterns
|
||||||
- Components: arrow functions (enforced by Biome)
|
|
||||||
- Routes: TanStack Router file conventions (`export const Route = createFileRoute(...)`)
|
|
||||||
- Data fetching: `useSuspenseQuery(orpc.feature.list.queryOptions())`
|
|
||||||
- Let React Compiler handle memoization (no manual `useMemo`/`useCallback`)
|
|
||||||
|
|
||||||
### Error Handling
|
|
||||||
- Use `try-catch` for async operations; throw descriptive errors
|
|
||||||
- ORPC: Use `ORPCError` with proper codes (`NOT_FOUND`, `INPUT_VALIDATION_FAILED`)
|
|
||||||
- Never use empty catch blocks
|
|
||||||
|
|
||||||
## Database (Drizzle ORM v1 beta + postgres-js)
|
|
||||||
|
|
||||||
- **ORM**: Drizzle ORM `1.0.0-beta` (RQBv2)
|
|
||||||
- **Driver**: `drizzle-orm/postgres-js` (NOT `bun-sql`)
|
|
||||||
- **Validation**: `drizzle-orm/zod` (built-in, NOT separate `drizzle-zod` package)
|
|
||||||
- **Relations**: Defined via `defineRelations()` in `src/server/db/relations.ts` (contains schema info, so `drizzle()` only needs `{ relations }`)
|
|
||||||
- **Query style**: RQBv2 object syntax (`orderBy: { createdAt: 'desc' }`, `where: { id: 1 }`)
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
export const myTable = pgTable('my_table', {
|
// Components: arrow functions (Biome enforces)
|
||||||
id: uuid().primaryKey().default(sql`uuidv7()`),
|
const MyComponent = ({ title }: { title: string }) => {
|
||||||
name: text().notNull(),
|
return <div>{title}</div>
|
||||||
createdAt: timestamp({ withTimezone: true }).notNull().defaultNow(),
|
}
|
||||||
updatedAt: timestamp({ withTimezone: true }).notNull().defaultNow().$onUpdateFn(() => new Date()),
|
|
||||||
|
// Routes: createFileRoute
|
||||||
|
export const Route = createFileRoute('/')({
|
||||||
|
component: Home,
|
||||||
|
loader: async ({ context }) => {
|
||||||
|
await context.queryClient.ensureQueryData(orpc.todo.list.queryOptions())
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
// Data fetching: TanStack Query
|
||||||
|
const query = useSuspenseQuery(orpc.todo.list.queryOptions())
|
||||||
|
const mutation = useMutation(orpc.todo.create.mutationOptions())
|
||||||
|
```
|
||||||
|
|
||||||
|
### ORPC Pattern (Contract-First RPC)
|
||||||
|
|
||||||
|
1. **Define contract** (`src/orpc/contracts/my-feature.ts`):
|
||||||
|
```typescript
|
||||||
|
import { oc } from '@orpc/contract'
|
||||||
|
import { z } from 'zod'
|
||||||
|
|
||||||
|
export const get = oc.input(z.object({ id: z.uuid() })).output(schema)
|
||||||
|
export const create = oc.input(insertSchema).output(schema)
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Implement handler** (`src/orpc/handlers/my-feature.ts`):
|
||||||
|
```typescript
|
||||||
|
import { os } from '@/orpc/server'
|
||||||
|
import { dbProvider } from '@/orpc/middlewares'
|
||||||
|
|
||||||
|
export const get = os.myFeature.get
|
||||||
|
.use(dbProvider)
|
||||||
|
.handler(async ({ context, input }) => {
|
||||||
|
return await context.db.query.myTable.findFirst(...)
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
## Environment Variables
|
3. **Register** in `contract.ts` and `router.ts`
|
||||||
|
4. **Use** in components via `orpc.myFeature.get.queryOptions()`
|
||||||
|
|
||||||
- Use `@t3-oss/env-core` with Zod validation in `src/env.ts`
|
### Drizzle Schema
|
||||||
- Server vars: no prefix | Client vars: `VITE_` prefix required
|
|
||||||
- Never commit `.env` files
|
|
||||||
|
|
||||||
## Dependency Management
|
```typescript
|
||||||
|
import { sql } from 'drizzle-orm'
|
||||||
|
import { pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
|
||||||
|
|
||||||
- All versions centralized in root `package.json` `catalog` field
|
export const myTable = pgTable('my_table', {
|
||||||
- Workspace packages use `"catalog:"` — never hardcode versions
|
id: uuid('id').primaryKey().default(sql`uuidv7()`),
|
||||||
- Internal packages use `"workspace:*"` references
|
name: text('name').notNull(),
|
||||||
|
createdAt: timestamp('created_at', { withTimezone: true }).notNull().defaultNow(),
|
||||||
|
updatedAt: timestamp('updated_at', { withTimezone: true }).notNull().defaultNow().$onUpdateFn(() => new Date()),
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
## Development Principles
|
### Environment Variables
|
||||||
|
|
||||||
> **These principles apply to ALL code changes. Agents MUST follow them on every task.**
|
- Server: no prefix (e.g., `DATABASE_URL`)
|
||||||
|
- Client: `VITE_` prefix required
|
||||||
1. **No backward compatibility** — This project is in rapid iteration. Always use the latest API and patterns. Never keep deprecated code paths or old API fallbacks "just in case".
|
- Validated via `@t3-oss/env-core` in `src/env.ts`
|
||||||
2. **Always sync documentation** — When code changes, immediately update all related documentation (`AGENTS.md`, `README.md`, inline code examples). Code and docs must never drift apart. This includes updating code snippets in docs when imports, APIs, or patterns change.
|
|
||||||
3. **Forward-only migration** — When upgrading dependencies, fully adopt the new API. Don't mix old and new patterns in the same codebase.
|
|
||||||
|
|
||||||
## Critical Rules
|
|
||||||
|
|
||||||
**DO:**
|
|
||||||
- Run `bun run fix` before committing
|
|
||||||
- Use `@/*` path aliases (not relative imports)
|
|
||||||
- Include `createdAt`/`updatedAt` on all tables
|
|
||||||
- Use `catalog:` for dependency versions
|
|
||||||
- Update `AGENTS.md` and other docs whenever code patterns change
|
|
||||||
|
|
||||||
**DON'T:**
|
|
||||||
- Use `npm`, `npx`, `node`, `yarn`, `pnpm` — always use `bun` / `bunx`
|
|
||||||
- Edit `src/routeTree.gen.ts` (auto-generated)
|
|
||||||
- Use `as any`, `@ts-ignore`, `@ts-expect-error`
|
|
||||||
- Commit `.env` files
|
|
||||||
- Use empty catch blocks `catch(e) {}`
|
|
||||||
- Hardcode dependency versions in workspace packages
|
|
||||||
- Leave docs out of sync with code changes
|
|
||||||
|
|
||||||
## Git Workflow
|
|
||||||
|
|
||||||
1. Make changes following style guide
|
|
||||||
2. `bun run fix` - auto-format and lint
|
|
||||||
3. `bun run typecheck` - verify types
|
|
||||||
4. `bun run dev` - test locally
|
|
||||||
5. Commit with descriptive message
|
|
||||||
|
|
||||||
## Directory Structure
|
## Directory Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
.
|
src/
|
||||||
├── apps/
|
├── components/ # Reusable React components
|
||||||
│ ├── server/ # TanStack Start fullstack app
|
├── db/
|
||||||
│ │ ├── src/
|
│ ├── schema/ # Drizzle schema definitions
|
||||||
│ │ │ ├── client/ # ORPC client + TanStack Query utils
|
│ └── index.ts # Database instance
|
||||||
│ │ │ ├── components/
|
├── integrations/ # TanStack Query/Router setup
|
||||||
│ │ │ ├── routes/ # File-based routing
|
├── lib/ # Utility functions
|
||||||
│ │ │ └── server/ # API layer + database
|
├── orpc/
|
||||||
│ │ │ ├── api/ # ORPC contracts, routers, middlewares
|
│ ├── contracts/ # Input/output schemas
|
||||||
│ │ │ └── db/ # Drizzle schema
|
│ ├── handlers/ # Server procedure implementations
|
||||||
│ │ └── AGENTS.md
|
│ ├── middlewares/ # Middleware (e.g., dbProvider)
|
||||||
│ └── desktop/ # Electron desktop shell
|
│ ├── contract.ts # Contract aggregation
|
||||||
│ ├── src/
|
│ ├── router.ts # Router composition
|
||||||
│ │ ├── main/
|
│ └── client.ts # Isomorphic client
|
||||||
│ │ │ └── index.ts # Main process entry
|
├── routes/ # File-based routes
|
||||||
│ │ └── preload/
|
│ ├── __root.tsx # Root layout
|
||||||
│ │ └── index.ts # Preload script
|
│ └── api/rpc.$.ts # ORPC HTTP endpoint
|
||||||
│ ├── electron.vite.config.ts
|
└── env.ts # Environment validation
|
||||||
│ ├── electron-builder.yml # Packaging config
|
|
||||||
│ └── AGENTS.md
|
|
||||||
├── packages/
|
|
||||||
│ └── tsconfig/ # Shared TS configs
|
|
||||||
├── biome.json # Linting/formatting config
|
|
||||||
├── turbo.json # Turbo task orchestration
|
|
||||||
└── package.json # Workspace root + dependency catalog
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## See Also
|
## Critical Rules
|
||||||
|
|
||||||
- `apps/server/AGENTS.md` - Detailed TanStack Start / ORPC patterns
|
- **DO NOT** edit `src/routeTree.gen.ts` (auto-generated)
|
||||||
- `apps/desktop/AGENTS.md` - Electron desktop development guide
|
- **DO NOT** commit `.env` files
|
||||||
|
- **MUST** run `bun fix` before commits
|
||||||
|
- **MUST** use `@/*` path alias (not relative imports)
|
||||||
|
- **MUST** use React Compiler (no manual memoization needed)
|
||||||
|
- **MUST** use `Readonly<T>` for immutable props
|
||||||
|
|
||||||
|
## Git Workflow
|
||||||
|
|
||||||
|
1. Make changes following style guide
|
||||||
|
2. Run `bun fix` (format + lint)
|
||||||
|
3. Run `bun typecheck` (type safety)
|
||||||
|
4. Test with `bun dev`
|
||||||
|
5. Commit with descriptive message
|
||||||
|
|||||||
3
apps/desktop/.gitignore
vendored
@@ -1,3 +0,0 @@
|
|||||||
# electron-vite build output
|
|
||||||
out/
|
|
||||||
dist/
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
# AGENTS.md - Desktop App Guidelines
|
|
||||||
|
|
||||||
Thin Electron shell hosting the fullstack server app.
|
|
||||||
|
|
||||||
## Tech Stack
|
|
||||||
|
|
||||||
> **⚠️ This project uses Bun as the package manager. Runtime is Electron (Node.js). Always use `bun run <script>` (not `bun <script>`) to avoid conflicts with Bun built-in subcommands. Never use `npm`, `npx`, `yarn`, or `pnpm`.**
|
|
||||||
|
|
||||||
- **Type**: Electron desktop shell
|
|
||||||
- **Design**: Server-driven desktop (thin native window hosting web app)
|
|
||||||
- **Runtime**: Electron (Main/Renderer) + Sidecar server binary (Bun-compiled)
|
|
||||||
- **Build Tool**: electron-vite (Vite-based, handles main + preload builds)
|
|
||||||
- **Packager**: electron-builder (installers, signing, auto-update)
|
|
||||||
- **Orchestration**: Turborepo
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
- **Server-driven design**: The desktop app is a "thin" native shell. It does not contain UI or business logic; it opens a BrowserWindow pointing to the `apps/server` TanStack Start application.
|
|
||||||
- **Dev mode**: Opens a BrowserWindow pointing to `localhost:3000`. Requires `apps/server` to be running separately (Turbo handles this).
|
|
||||||
- **Production mode**: Spawns a compiled server binary (from `resources/`) as a sidecar process, waits for readiness, then loads its URL.
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
```bash
|
|
||||||
bun run dev # electron-vite dev (requires server dev running)
|
|
||||||
bun run build # electron-vite build (main + preload)
|
|
||||||
bun run dist # Build + package for current platform
|
|
||||||
bun run dist:linux # Build + package for Linux (x64 + arm64)
|
|
||||||
bun run dist:linux:x64 # Build + package for Linux x64
|
|
||||||
bun run dist:linux:arm64 # Build + package for Linux arm64
|
|
||||||
bun run dist:mac # Build + package for macOS (arm64 + x64)
|
|
||||||
bun run dist:mac:arm64 # Build + package for macOS arm64
|
|
||||||
bun run dist:mac:x64 # Build + package for macOS x64
|
|
||||||
bun run dist:win # Build + package for Windows x64
|
|
||||||
bun run fix # Biome auto-fix
|
|
||||||
bun run typecheck # TypeScript check
|
|
||||||
```
|
|
||||||
|
|
||||||
## Directory Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
.
|
|
||||||
├── src/
|
|
||||||
│ ├── main/
|
|
||||||
│ │ └── index.ts # Main process (server lifecycle + BrowserWindow)
|
|
||||||
│ └── preload/
|
|
||||||
│ └── index.ts # Preload script (security isolation)
|
|
||||||
├── resources/ # Sidecar binaries (gitignored, copied from server build)
|
|
||||||
├── out/ # electron-vite build output (gitignored)
|
|
||||||
├── electron.vite.config.ts
|
|
||||||
├── electron-builder.yml # Packaging configuration
|
|
||||||
├── package.json
|
|
||||||
├── turbo.json
|
|
||||||
└── AGENTS.md
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development Workflow
|
|
||||||
|
|
||||||
1. **Start server**: `bun run dev` in `apps/server` (or use root `bun run dev` via Turbo).
|
|
||||||
2. **Start desktop**: `bun run dev` in `apps/desktop`.
|
|
||||||
3. **Connection**: Main process polls `localhost:3000` until responsive, then opens BrowserWindow.
|
|
||||||
|
|
||||||
## Production Build Workflow
|
|
||||||
|
|
||||||
From monorepo root, run `bun run dist` to execute the full pipeline automatically (via Turbo task dependencies):
|
|
||||||
|
|
||||||
1. **Build server**: `apps/server` → `vite build` → `.output/`
|
|
||||||
2. **Compile server**: `apps/server` → `bun compile.ts --target ...` → `out/server-{os}-{arch}`
|
|
||||||
3. **Package desktop**: `apps/desktop` → `electron-vite build` + `electron-builder` → distributable
|
|
||||||
|
|
||||||
The `electron-builder.yml` `extraResources` config reads binaries directly from `../server/out/`, no manual copy needed.
|
|
||||||
|
|
||||||
To build for a specific platform explicitly, use `bun run dist:linux` / `bun run dist:mac` / `bun run dist:win` in `apps/desktop`.
|
|
||||||
For single-arch output, use `bun run dist:linux:x64`, `bun run dist:linux:arm64`, `bun run dist:mac:x64`, or `bun run dist:mac:arm64`.
|
|
||||||
|
|
||||||
## Development Principles
|
|
||||||
|
|
||||||
> **These principles apply to ALL code changes. Agents MUST follow them on every task.**
|
|
||||||
|
|
||||||
1. **No backward compatibility** — This project is in rapid iteration. Always use the latest API and patterns. Never keep deprecated code paths or old API fallbacks.
|
|
||||||
2. **Always sync documentation** — When code changes, immediately update all related documentation (`AGENTS.md`, `README.md`, inline code examples). Code and docs must never drift apart.
|
|
||||||
3. **Forward-only migration** — When upgrading dependencies, fully adopt the new API. Don't mix old and new patterns.
|
|
||||||
|
|
||||||
## Critical Rules
|
|
||||||
|
|
||||||
**DO:**
|
|
||||||
- Use arrow functions for all utility functions.
|
|
||||||
- Keep the desktop app as a thin shell — no UI or business logic.
|
|
||||||
- Use `catalog:` for all dependency versions in `package.json`.
|
|
||||||
|
|
||||||
**DON'T:**
|
|
||||||
- Use `npm`, `npx`, `yarn`, or `pnpm`. Use `bun` for package management.
|
|
||||||
- Include UI components or business logic in the desktop app.
|
|
||||||
- Use `as any` or `@ts-ignore`.
|
|
||||||
- Leave docs out of sync with code changes.
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "../../node_modules/@biomejs/biome/configuration_schema.json",
|
|
||||||
"extends": "//",
|
|
||||||
"css": {
|
|
||||||
"parser": {
|
|
||||||
"tailwindDirectives": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
Before Width: | Height: | Size: 83 KiB |
@@ -1,48 +0,0 @@
|
|||||||
# yaml-language-server: $schema=https://raw.githubusercontent.com/electron-userland/electron-builder/refs/heads/master/packages/app-builder-lib/scheme.json
|
|
||||||
appId: com.furtherverse.desktop
|
|
||||||
productName: Furtherverse
|
|
||||||
executableName: furtherverse
|
|
||||||
|
|
||||||
npmRebuild: false
|
|
||||||
asarUnpack:
|
|
||||||
- resources/**
|
|
||||||
|
|
||||||
files:
|
|
||||||
- "!**/.vscode/*"
|
|
||||||
- "!src/*"
|
|
||||||
- "!electron.vite.config.{js,ts,mjs,cjs}"
|
|
||||||
- "!{.env,.env.*,bun.lock}"
|
|
||||||
- "!{tsconfig.json,tsconfig.node.json}"
|
|
||||||
- "!{AGENTS.md,README.md,CHANGELOG.md}"
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
mac:
|
|
||||||
target:
|
|
||||||
- dmg
|
|
||||||
category: public.app-category.productivity
|
|
||||||
extraResources:
|
|
||||||
- from: ../server/out/server-darwin-${arch}
|
|
||||||
to: server
|
|
||||||
dmg:
|
|
||||||
artifactName: ${productName}-${version}-${os}-${arch}.${ext}
|
|
||||||
|
|
||||||
# Windows
|
|
||||||
win:
|
|
||||||
target:
|
|
||||||
- portable
|
|
||||||
extraResources:
|
|
||||||
- from: ../server/out/server-windows-${arch}.exe
|
|
||||||
to: server.exe
|
|
||||||
portable:
|
|
||||||
artifactName: ${productName}-${version}-${os}-${arch}-Portable.${ext}
|
|
||||||
|
|
||||||
# Linux
|
|
||||||
linux:
|
|
||||||
target:
|
|
||||||
- AppImage
|
|
||||||
category: Utility
|
|
||||||
extraResources:
|
|
||||||
- from: ../server/out/server-linux-${arch}
|
|
||||||
to: server
|
|
||||||
appImage:
|
|
||||||
artifactName: ${productName}-${version}-${os}-${arch}.${ext}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
import tailwindcss from '@tailwindcss/vite'
|
|
||||||
import react from '@vitejs/plugin-react'
|
|
||||||
import { defineConfig } from 'electron-vite'
|
|
||||||
|
|
||||||
export default defineConfig({
|
|
||||||
main: {},
|
|
||||||
preload: {},
|
|
||||||
renderer: {
|
|
||||||
plugins: [react(), tailwindcss()],
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@furtherverse/desktop",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"private": true,
|
|
||||||
"main": "out/main/index.js",
|
|
||||||
"scripts": {
|
|
||||||
"build": "electron-vite build",
|
|
||||||
"dev": "electron-vite dev --watch",
|
|
||||||
"dist": "electron-builder",
|
|
||||||
"dist:linux": "bun run dist:linux:x64 && bun run dist:linux:arm64",
|
|
||||||
"dist:linux:arm64": "electron-builder --linux --arm64",
|
|
||||||
"dist:linux:x64": "electron-builder --linux --x64",
|
|
||||||
"dist:mac": "bun run dist:mac:arm64 && bun run dist:mac:x64",
|
|
||||||
"dist:mac:arm64": "electron-builder --mac --arm64",
|
|
||||||
"dist:mac:x64": "electron-builder --mac --x64",
|
|
||||||
"dist:win": "electron-builder --win --x64",
|
|
||||||
"fix": "biome check --write",
|
|
||||||
"typecheck": "tsc -b"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"motion": "catalog:",
|
|
||||||
"react": "catalog:",
|
|
||||||
"react-dom": "catalog:",
|
|
||||||
"tree-kill": "catalog:"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@furtherverse/tsconfig": "workspace:*",
|
|
||||||
"@tailwindcss/vite": "catalog:",
|
|
||||||
"@types/node": "catalog:",
|
|
||||||
"@vitejs/plugin-react": "catalog:",
|
|
||||||
"electron": "catalog:",
|
|
||||||
"electron-builder": "catalog:",
|
|
||||||
"electron-vite": "catalog:",
|
|
||||||
"tailwindcss": "catalog:",
|
|
||||||
"vite": "catalog:"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,198 +0,0 @@
|
|||||||
import { join } from 'node:path'
|
|
||||||
import { app, BrowserWindow, dialog, session, shell } from 'electron'
|
|
||||||
import { createSidecarRuntime } from './sidecar'
|
|
||||||
|
|
||||||
const DEV_SERVER_URL = 'http://localhost:3000'
|
|
||||||
const SAFE_EXTERNAL_PROTOCOLS = new Set(['https:', 'http:', 'mailto:'])
|
|
||||||
|
|
||||||
let mainWindow: BrowserWindow | null = null
|
|
||||||
let windowCreationPromise: Promise<void> | null = null
|
|
||||||
let isQuitting = false
|
|
||||||
|
|
||||||
const showErrorAndQuit = (title: string, detail: string) => {
|
|
||||||
if (isQuitting) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
dialog.showErrorBox(title, detail)
|
|
||||||
app.quit()
|
|
||||||
}
|
|
||||||
|
|
||||||
const sidecar = createSidecarRuntime({
|
|
||||||
devServerUrl: DEV_SERVER_URL,
|
|
||||||
isPackaged: app.isPackaged,
|
|
||||||
resourcesPath: process.resourcesPath,
|
|
||||||
isQuitting: () => isQuitting,
|
|
||||||
onUnexpectedStop: (detail) => {
|
|
||||||
showErrorAndQuit('Service Stopped', detail)
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
const toErrorMessage = (error: unknown): string => (error instanceof Error ? error.message : String(error))
|
|
||||||
|
|
||||||
const canOpenExternally = (url: string): boolean => {
|
|
||||||
try {
|
|
||||||
const parsed = new URL(url)
|
|
||||||
return SAFE_EXTERNAL_PROTOCOLS.has(parsed.protocol)
|
|
||||||
} catch {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const loadSplash = async (windowRef: BrowserWindow) => {
|
|
||||||
if (process.env.ELECTRON_RENDERER_URL) {
|
|
||||||
await windowRef.loadURL(process.env.ELECTRON_RENDERER_URL)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
await windowRef.loadFile(join(__dirname, '../renderer/index.html'))
|
|
||||||
}
|
|
||||||
|
|
||||||
const createWindow = async () => {
|
|
||||||
if (mainWindow && !mainWindow.isDestroyed()) {
|
|
||||||
mainWindow.focus()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
const windowRef = new BrowserWindow({
|
|
||||||
width: 1200,
|
|
||||||
height: 800,
|
|
||||||
show: false,
|
|
||||||
webPreferences: {
|
|
||||||
preload: join(__dirname, '../preload/index.js'),
|
|
||||||
sandbox: true,
|
|
||||||
contextIsolation: true,
|
|
||||||
nodeIntegration: false,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
mainWindow = windowRef
|
|
||||||
|
|
||||||
windowRef.webContents.setWindowOpenHandler(({ url }) => {
|
|
||||||
if (!canOpenExternally(url)) {
|
|
||||||
if (!app.isPackaged) {
|
|
||||||
console.warn(`Blocked external URL: ${url}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
return { action: 'deny' }
|
|
||||||
}
|
|
||||||
|
|
||||||
void shell.openExternal(url)
|
|
||||||
return { action: 'deny' }
|
|
||||||
})
|
|
||||||
|
|
||||||
windowRef.webContents.on('will-navigate', (event, url) => {
|
|
||||||
const allowed = [DEV_SERVER_URL, sidecar.lastResolvedUrl].filter((v): v is string => v != null)
|
|
||||||
const isAllowed = allowed.some((origin) => url.startsWith(origin))
|
|
||||||
|
|
||||||
if (!isAllowed) {
|
|
||||||
event.preventDefault()
|
|
||||||
|
|
||||||
if (canOpenExternally(url)) {
|
|
||||||
void shell.openExternal(url)
|
|
||||||
} else if (!app.isPackaged) {
|
|
||||||
console.warn(`Blocked navigation to: ${url}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
windowRef.on('closed', () => {
|
|
||||||
if (mainWindow === windowRef) {
|
|
||||||
mainWindow = null
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
try {
|
|
||||||
await loadSplash(windowRef)
|
|
||||||
} catch (error) {
|
|
||||||
if (mainWindow === windowRef) {
|
|
||||||
mainWindow = null
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!windowRef.isDestroyed()) {
|
|
||||||
windowRef.destroy()
|
|
||||||
}
|
|
||||||
|
|
||||||
throw error
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!windowRef.isDestroyed()) {
|
|
||||||
windowRef.show()
|
|
||||||
}
|
|
||||||
|
|
||||||
const targetUrl = await sidecar.resolveUrl()
|
|
||||||
if (isQuitting || windowRef.isDestroyed()) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
await windowRef.loadURL(targetUrl)
|
|
||||||
} catch (error) {
|
|
||||||
if (mainWindow === windowRef) {
|
|
||||||
mainWindow = null
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!windowRef.isDestroyed()) {
|
|
||||||
windowRef.destroy()
|
|
||||||
}
|
|
||||||
|
|
||||||
throw error
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const ensureWindow = async () => {
|
|
||||||
if (windowCreationPromise) {
|
|
||||||
return windowCreationPromise
|
|
||||||
}
|
|
||||||
|
|
||||||
windowCreationPromise = createWindow().finally(() => {
|
|
||||||
windowCreationPromise = null
|
|
||||||
})
|
|
||||||
|
|
||||||
return windowCreationPromise
|
|
||||||
}
|
|
||||||
|
|
||||||
const beginQuit = () => {
|
|
||||||
isQuitting = true
|
|
||||||
sidecar.stop()
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleWindowCreationError = (error: unknown, context: string) => {
|
|
||||||
console.error(`${context}:`, error)
|
|
||||||
showErrorAndQuit(
|
|
||||||
"App Couldn't Start",
|
|
||||||
app.isPackaged
|
|
||||||
? 'A required component failed to start. Please reinstall the app.'
|
|
||||||
: `${context}: ${toErrorMessage(error)}`,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
app
|
|
||||||
.whenReady()
|
|
||||||
.then(() => {
|
|
||||||
session.defaultSession.setPermissionRequestHandler((_webContents, _permission, callback) => {
|
|
||||||
callback(false)
|
|
||||||
})
|
|
||||||
|
|
||||||
return ensureWindow()
|
|
||||||
})
|
|
||||||
.catch((error) => {
|
|
||||||
handleWindowCreationError(error, 'Failed to create window')
|
|
||||||
})
|
|
||||||
|
|
||||||
app.on('window-all-closed', () => {
|
|
||||||
if (process.platform !== 'darwin') {
|
|
||||||
app.quit()
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
app.on('activate', () => {
|
|
||||||
if (isQuitting || BrowserWindow.getAllWindows().length > 0) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
ensureWindow().catch((error) => {
|
|
||||||
handleWindowCreationError(error, 'Failed to re-create window')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
app.on('before-quit', beginQuit)
|
|
||||||
@@ -1,256 +0,0 @@
|
|||||||
import { type ChildProcess, spawn } from 'node:child_process'
|
|
||||||
import { existsSync } from 'node:fs'
|
|
||||||
import { createServer } from 'node:net'
|
|
||||||
import { join } from 'node:path'
|
|
||||||
import killProcessTree from 'tree-kill'
|
|
||||||
|
|
||||||
const SERVER_HOST = '127.0.0.1'
|
|
||||||
const SERVER_READY_TIMEOUT_MS = 10_000
|
|
||||||
const SERVER_REQUEST_TIMEOUT_MS = 1_500
|
|
||||||
const SERVER_POLL_INTERVAL_MS = 250
|
|
||||||
const SERVER_PROBE_PATHS = ['/api/health', '/']
|
|
||||||
|
|
||||||
type SidecarState = {
|
|
||||||
process: ChildProcess | null
|
|
||||||
startup: Promise<string> | null
|
|
||||||
url: string | null
|
|
||||||
}
|
|
||||||
|
|
||||||
type SidecarRuntimeOptions = {
|
|
||||||
devServerUrl: string
|
|
||||||
isPackaged: boolean
|
|
||||||
resourcesPath: string
|
|
||||||
isQuitting: () => boolean
|
|
||||||
onUnexpectedStop: (detail: string) => void
|
|
||||||
}
|
|
||||||
|
|
||||||
type SidecarRuntime = {
|
|
||||||
resolveUrl: () => Promise<string>
|
|
||||||
stop: () => void
|
|
||||||
lastResolvedUrl: string | null
|
|
||||||
}
|
|
||||||
|
|
||||||
const sleep = (ms: number): Promise<void> => new Promise((resolve) => setTimeout(resolve, ms))
|
|
||||||
|
|
||||||
const isProcessAlive = (processToCheck: ChildProcess | null): processToCheck is ChildProcess => {
|
|
||||||
if (!processToCheck || !processToCheck.pid) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
return processToCheck.exitCode === null && !processToCheck.killed
|
|
||||||
}
|
|
||||||
|
|
||||||
const getAvailablePort = (): Promise<number> =>
|
|
||||||
new Promise((resolve, reject) => {
|
|
||||||
const server = createServer()
|
|
||||||
server.listen(0, () => {
|
|
||||||
const addr = server.address()
|
|
||||||
if (!addr || typeof addr === 'string') {
|
|
||||||
server.close()
|
|
||||||
reject(new Error('Failed to resolve port'))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
server.close(() => resolve(addr.port))
|
|
||||||
})
|
|
||||||
server.on('error', reject)
|
|
||||||
})
|
|
||||||
|
|
||||||
const isServerReady = async (url: string): Promise<boolean> => {
|
|
||||||
for (const probePath of SERVER_PROBE_PATHS) {
|
|
||||||
try {
|
|
||||||
const probeUrl = new URL(probePath, `${url}/`)
|
|
||||||
const response = await fetch(probeUrl, {
|
|
||||||
method: 'GET',
|
|
||||||
cache: 'no-store',
|
|
||||||
signal: AbortSignal.timeout(SERVER_REQUEST_TIMEOUT_MS),
|
|
||||||
})
|
|
||||||
|
|
||||||
if (response.status < 500) {
|
|
||||||
if (probePath === '/api/health' && response.status === 404) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
} catch {
|
|
||||||
// Expected: probe request fails while server is still starting up
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
const waitForServer = async (url: string, isQuitting: () => boolean, processRef?: ChildProcess): Promise<boolean> => {
|
|
||||||
const start = Date.now()
|
|
||||||
while (Date.now() - start < SERVER_READY_TIMEOUT_MS && !isQuitting()) {
|
|
||||||
if (processRef && processRef.exitCode !== null) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if (await isServerReady(url)) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
await sleep(SERVER_POLL_INTERVAL_MS)
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
const resolveBinaryPath = (resourcesPath: string): string => {
|
|
||||||
const binaryName = process.platform === 'win32' ? 'server.exe' : 'server'
|
|
||||||
return join(resourcesPath, binaryName)
|
|
||||||
}
|
|
||||||
|
|
||||||
const formatUnexpectedStopMessage = (
|
|
||||||
isPackaged: boolean,
|
|
||||||
code: number | null,
|
|
||||||
signal: NodeJS.Signals | null,
|
|
||||||
): string => {
|
|
||||||
if (isPackaged) {
|
|
||||||
return 'The background service stopped unexpectedly. Please restart the app.'
|
|
||||||
}
|
|
||||||
|
|
||||||
return `Server process exited unexpectedly (code ${code ?? 'unknown'}, signal ${signal ?? 'none'}).`
|
|
||||||
}
|
|
||||||
|
|
||||||
export const createSidecarRuntime = (options: SidecarRuntimeOptions): SidecarRuntime => {
|
|
||||||
const state: SidecarState = {
|
|
||||||
process: null,
|
|
||||||
startup: null,
|
|
||||||
url: null,
|
|
||||||
}
|
|
||||||
|
|
||||||
const resetState = (processRef?: ChildProcess) => {
|
|
||||||
if (processRef && state.process !== processRef) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
state.process = null
|
|
||||||
state.url = null
|
|
||||||
}
|
|
||||||
|
|
||||||
const stop = () => {
|
|
||||||
const runningServer = state.process
|
|
||||||
resetState()
|
|
||||||
|
|
||||||
if (!runningServer?.pid || runningServer.exitCode !== null) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
killProcessTree(runningServer.pid, 'SIGTERM', (error?: Error) => {
|
|
||||||
if (error) {
|
|
||||||
console.error('Failed to stop server process:', error)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
const attachLifecycleHandlers = (processRef: ChildProcess) => {
|
|
||||||
processRef.on('error', (error) => {
|
|
||||||
if (state.process !== processRef) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
const hadReadyServer = state.url !== null
|
|
||||||
resetState(processRef)
|
|
||||||
|
|
||||||
if (!options.isQuitting() && hadReadyServer) {
|
|
||||||
options.onUnexpectedStop('The background service crashed unexpectedly. Please restart the app.')
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
console.error('Failed to start server process:', error)
|
|
||||||
})
|
|
||||||
|
|
||||||
processRef.on('exit', (code, signal) => {
|
|
||||||
if (state.process !== processRef) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
const hadReadyServer = state.url !== null
|
|
||||||
resetState(processRef)
|
|
||||||
|
|
||||||
if (!options.isQuitting() && hadReadyServer) {
|
|
||||||
options.onUnexpectedStop(formatUnexpectedStopMessage(options.isPackaged, code, signal))
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
const startPackagedServer = async (): Promise<string> => {
|
|
||||||
if (state.url && isProcessAlive(state.process)) {
|
|
||||||
return state.url
|
|
||||||
}
|
|
||||||
|
|
||||||
if (state.startup) {
|
|
||||||
return state.startup
|
|
||||||
}
|
|
||||||
|
|
||||||
state.startup = (async () => {
|
|
||||||
const binaryPath = resolveBinaryPath(options.resourcesPath)
|
|
||||||
if (!existsSync(binaryPath)) {
|
|
||||||
throw new Error(`Sidecar server binary is missing: ${binaryPath}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (options.isQuitting()) {
|
|
||||||
throw new Error('Application is shutting down.')
|
|
||||||
}
|
|
||||||
|
|
||||||
const port = await getAvailablePort()
|
|
||||||
const nextServerUrl = `http://${SERVER_HOST}:${port}`
|
|
||||||
const processRef = spawn(binaryPath, [], {
|
|
||||||
env: {
|
|
||||||
...process.env,
|
|
||||||
HOST: SERVER_HOST,
|
|
||||||
PORT: String(port),
|
|
||||||
},
|
|
||||||
stdio: 'ignore',
|
|
||||||
windowsHide: true,
|
|
||||||
})
|
|
||||||
|
|
||||||
processRef.unref()
|
|
||||||
state.process = processRef
|
|
||||||
attachLifecycleHandlers(processRef)
|
|
||||||
|
|
||||||
const ready = await waitForServer(nextServerUrl, options.isQuitting, processRef)
|
|
||||||
if (ready && isProcessAlive(processRef)) {
|
|
||||||
state.url = nextServerUrl
|
|
||||||
return nextServerUrl
|
|
||||||
}
|
|
||||||
|
|
||||||
const failureReason =
|
|
||||||
processRef.exitCode !== null
|
|
||||||
? `The service exited early (code ${processRef.exitCode}).`
|
|
||||||
: `The service did not respond at ${nextServerUrl} within 10 seconds.`
|
|
||||||
|
|
||||||
stop()
|
|
||||||
throw new Error(failureReason)
|
|
||||||
})().finally(() => {
|
|
||||||
state.startup = null
|
|
||||||
})
|
|
||||||
|
|
||||||
return state.startup
|
|
||||||
}
|
|
||||||
|
|
||||||
const resolveUrl = async (): Promise<string> => {
|
|
||||||
if (options.isPackaged) {
|
|
||||||
return startPackagedServer()
|
|
||||||
}
|
|
||||||
|
|
||||||
const ready = await waitForServer(options.devServerUrl, options.isQuitting)
|
|
||||||
if (!ready) {
|
|
||||||
throw new Error('Dev server not responding. Run `bun dev` in apps/server first.')
|
|
||||||
}
|
|
||||||
|
|
||||||
state.url = options.devServerUrl
|
|
||||||
return options.devServerUrl
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
resolveUrl,
|
|
||||||
stop,
|
|
||||||
get lastResolvedUrl() {
|
|
||||||
return state.url
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
export {}
|
|
||||||
|
Before Width: | Height: | Size: 83 KiB |
@@ -1,33 +0,0 @@
|
|||||||
import { motion } from 'motion/react'
|
|
||||||
import logoImage from '../assets/logo.png'
|
|
||||||
|
|
||||||
export const SplashApp = () => {
|
|
||||||
return (
|
|
||||||
<main className="m-0 flex h-screen w-screen cursor-default select-none items-center justify-center overflow-hidden bg-white font-sans antialiased">
|
|
||||||
<motion.section
|
|
||||||
animate={{ opacity: 1, y: 0 }}
|
|
||||||
className="flex flex-col items-center gap-8"
|
|
||||||
initial={{ opacity: 0, y: 4 }}
|
|
||||||
transition={{
|
|
||||||
duration: 1,
|
|
||||||
ease: [0.16, 1, 0.3, 1],
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<img alt="Logo" className="h-20 w-auto object-contain" draggable={false} src={logoImage} />
|
|
||||||
|
|
||||||
<div className="relative h-[4px] w-36 overflow-hidden rounded-full bg-zinc-100">
|
|
||||||
<motion.div
|
|
||||||
animate={{ x: '100%' }}
|
|
||||||
className="h-full w-full bg-zinc-800"
|
|
||||||
initial={{ x: '-100%' }}
|
|
||||||
transition={{
|
|
||||||
duration: 2,
|
|
||||||
ease: [0.4, 0, 0.2, 1],
|
|
||||||
repeat: Infinity,
|
|
||||||
}}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</motion.section>
|
|
||||||
</main>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>Furtherverse</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div id="root"></div>
|
|
||||||
<script type="module" src="./main.tsx"></script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
import { StrictMode } from 'react'
|
|
||||||
import { createRoot } from 'react-dom/client'
|
|
||||||
import { SplashApp } from './components/SplashApp'
|
|
||||||
import './styles.css'
|
|
||||||
|
|
||||||
// biome-ignore lint/style/noNonNullAssertion: 一定存在
|
|
||||||
createRoot(document.getElementById('root')!).render(
|
|
||||||
<StrictMode>
|
|
||||||
<SplashApp />
|
|
||||||
</StrictMode>,
|
|
||||||
)
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "@furtherverse/tsconfig/react.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"composite": true,
|
|
||||||
"types": ["vite/client"]
|
|
||||||
},
|
|
||||||
"include": ["src/renderer/**/*"]
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"files": [],
|
|
||||||
"references": [
|
|
||||||
{
|
|
||||||
"path": "./tsconfig.app.json"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"path": "./tsconfig.node.json"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "@furtherverse/tsconfig/base.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"composite": true,
|
|
||||||
"types": ["node"]
|
|
||||||
},
|
|
||||||
"include": ["src/main/**/*", "src/preload/**/*", "electron.vite.config.ts"]
|
|
||||||
}
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "../../node_modules/turbo/schema.json",
|
|
||||||
"extends": ["//"],
|
|
||||||
"tasks": {
|
|
||||||
"build": {
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"dist": {
|
|
||||||
"dependsOn": ["build", "@furtherverse/server#compile"],
|
|
||||||
"outputs": ["dist/**"]
|
|
||||||
},
|
|
||||||
"dist:linux": {
|
|
||||||
"dependsOn": ["build", "@furtherverse/server#compile:linux:arm64", "@furtherverse/server#compile:linux:x64"],
|
|
||||||
"outputs": ["dist/**"]
|
|
||||||
},
|
|
||||||
"dist:linux:arm64": {
|
|
||||||
"dependsOn": ["build", "@furtherverse/server#compile:linux:arm64"],
|
|
||||||
"outputs": ["dist/**"]
|
|
||||||
},
|
|
||||||
"dist:linux:x64": {
|
|
||||||
"dependsOn": ["build", "@furtherverse/server#compile:linux:x64"],
|
|
||||||
"outputs": ["dist/**"]
|
|
||||||
},
|
|
||||||
"dist:mac": {
|
|
||||||
"dependsOn": ["build", "@furtherverse/server#compile:darwin:arm64", "@furtherverse/server#compile:darwin:x64"],
|
|
||||||
"outputs": ["dist/**"]
|
|
||||||
},
|
|
||||||
"dist:mac:arm64": {
|
|
||||||
"dependsOn": ["build", "@furtherverse/server#compile:darwin:arm64"],
|
|
||||||
"outputs": ["dist/**"]
|
|
||||||
},
|
|
||||||
"dist:mac:x64": {
|
|
||||||
"dependsOn": ["build", "@furtherverse/server#compile:darwin:x64"],
|
|
||||||
"outputs": ["dist/**"]
|
|
||||||
},
|
|
||||||
"dist:win": {
|
|
||||||
"dependsOn": ["build", "@furtherverse/server#compile:windows:x64"],
|
|
||||||
"outputs": ["dist/**"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,279 +0,0 @@
|
|||||||
# AGENTS.md - Server App Guidelines
|
|
||||||
|
|
||||||
TanStack Start fullstack web app with ORPC (contract-first RPC).
|
|
||||||
|
|
||||||
## Tech Stack
|
|
||||||
|
|
||||||
> **⚠️ This project uses Bun — NOT Node.js / npm. All commands use `bun`. Always use `bun run <script>` (not `bun <script>`) to avoid conflicts with Bun built-in subcommands. Never use `npm`, `npx`, or `node`.**
|
|
||||||
|
|
||||||
- **Framework**: TanStack Start (React 19 SSR, file-based routing)
|
|
||||||
- **Runtime**: Bun — **NOT Node.js**
|
|
||||||
- **Package Manager**: Bun — **NOT npm / yarn / pnpm**
|
|
||||||
- **Language**: TypeScript (strict mode)
|
|
||||||
- **Styling**: Tailwind CSS v4
|
|
||||||
- **Database**: PostgreSQL + Drizzle ORM v1 beta (`drizzle-orm/postgres-js`, RQBv2)
|
|
||||||
- **State**: TanStack Query v5
|
|
||||||
- **RPC**: ORPC (contract-first, type-safe)
|
|
||||||
- **Build**: Vite + Nitro
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Development
|
|
||||||
bun run dev # Vite dev server (localhost:3000)
|
|
||||||
bun run db:studio # Drizzle Studio GUI
|
|
||||||
|
|
||||||
# Build
|
|
||||||
bun run build # Production build → .output/
|
|
||||||
bun run compile # Compile to standalone binary (current platform, depends on build)
|
|
||||||
bun run compile:darwin # Compile for macOS (arm64 + x64)
|
|
||||||
bun run compile:darwin:arm64 # Compile for macOS arm64
|
|
||||||
bun run compile:darwin:x64 # Compile for macOS x64
|
|
||||||
bun run compile:linux # Compile for Linux (x64 + arm64)
|
|
||||||
bun run compile:linux:arm64 # Compile for Linux arm64
|
|
||||||
bun run compile:linux:x64 # Compile for Linux x64
|
|
||||||
bun run compile:windows # Compile for Windows (default: x64)
|
|
||||||
bun run compile:windows:x64 # Compile for Windows x64
|
|
||||||
|
|
||||||
# Code Quality
|
|
||||||
bun run fix # Biome auto-fix
|
|
||||||
bun run typecheck # TypeScript check
|
|
||||||
|
|
||||||
# Database
|
|
||||||
bun run db:generate # Generate migrations from schema
|
|
||||||
bun run db:migrate # Run migrations
|
|
||||||
bun run db:push # Push schema directly (dev only)
|
|
||||||
|
|
||||||
# Testing (not yet configured)
|
|
||||||
bun test path/to/test.ts # Run single test
|
|
||||||
bun test -t "pattern" # Run tests matching pattern
|
|
||||||
```
|
|
||||||
|
|
||||||
## Directory Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
src/
|
|
||||||
├── client/ # Client-side code
|
|
||||||
│ └── orpc.ts # ORPC client + TanStack Query utils (single entry point)
|
|
||||||
├── components/ # React components
|
|
||||||
├── routes/ # TanStack Router file routes
|
|
||||||
│ ├── __root.tsx # Root layout
|
|
||||||
│ ├── index.tsx # Home page
|
|
||||||
│ └── api/
|
|
||||||
│ ├── $.ts # OpenAPI handler + Scalar docs
|
|
||||||
│ ├── health.ts # Health check endpoint
|
|
||||||
│ └── rpc.$.ts # ORPC RPC handler
|
|
||||||
├── server/ # Server-side code
|
|
||||||
│ ├── api/ # ORPC layer
|
|
||||||
│ │ ├── contracts/ # Input/output schemas (Zod)
|
|
||||||
│ │ ├── middlewares/ # Middleware (db provider, auth)
|
|
||||||
│ │ ├── routers/ # Handler implementations
|
|
||||||
│ │ ├── interceptors.ts # Shared error interceptors
|
|
||||||
│ │ ├── context.ts # Request context
|
|
||||||
│ │ ├── server.ts # ORPC server instance
|
|
||||||
│ │ └── types.ts # Type exports
|
|
||||||
│ └── db/
|
|
||||||
│ ├── schema/ # Drizzle table definitions
|
|
||||||
│ ├── fields.ts # Shared field builders (id, createdAt, updatedAt)
|
|
||||||
│ ├── relations.ts # Drizzle relations (defineRelations, RQBv2)
|
|
||||||
│ └── index.ts # Database instance (postgres-js driver)
|
|
||||||
├── env.ts # Environment variable validation
|
|
||||||
├── router.tsx # Router configuration
|
|
||||||
├── routeTree.gen.ts # Auto-generated (DO NOT EDIT)
|
|
||||||
└── styles.css # Tailwind entry
|
|
||||||
```
|
|
||||||
|
|
||||||
## ORPC Pattern
|
|
||||||
|
|
||||||
### 1. Define Contract (`src/server/api/contracts/feature.contract.ts`)
|
|
||||||
```typescript
|
|
||||||
import { oc } from '@orpc/contract'
|
|
||||||
import { createSelectSchema } from 'drizzle-orm/zod'
|
|
||||||
import { z } from 'zod'
|
|
||||||
import { featureTable } from '@/server/db/schema'
|
|
||||||
|
|
||||||
const selectSchema = createSelectSchema(featureTable)
|
|
||||||
|
|
||||||
export const list = oc.input(z.void()).output(z.array(selectSchema))
|
|
||||||
export const create = oc.input(insertSchema).output(selectSchema)
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Implement Router (`src/server/api/routers/feature.router.ts`)
|
|
||||||
```typescript
|
|
||||||
import { ORPCError } from '@orpc/server'
|
|
||||||
import { db } from '../middlewares'
|
|
||||||
import { os } from '../server'
|
|
||||||
|
|
||||||
export const list = os.feature.list.use(db).handler(async ({ context }) => {
|
|
||||||
return await context.db.query.featureTable.findMany({
|
|
||||||
orderBy: { createdAt: 'desc' },
|
|
||||||
})
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Register in Index Files
|
|
||||||
```typescript
|
|
||||||
// src/server/api/contracts/index.ts
|
|
||||||
import * as feature from './feature.contract'
|
|
||||||
export const contract = { feature }
|
|
||||||
|
|
||||||
// src/server/api/routers/index.ts
|
|
||||||
import * as feature from './feature.router'
|
|
||||||
export const router = os.router({ feature })
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. Use in Components
|
|
||||||
```typescript
|
|
||||||
import { useSuspenseQuery, useMutation } from '@tanstack/react-query'
|
|
||||||
import { orpc } from '@/client/orpc'
|
|
||||||
|
|
||||||
const { data } = useSuspenseQuery(orpc.feature.list.queryOptions())
|
|
||||||
const mutation = useMutation(orpc.feature.create.mutationOptions())
|
|
||||||
```
|
|
||||||
|
|
||||||
## Database (Drizzle ORM v1 beta)
|
|
||||||
|
|
||||||
- **Driver**: `drizzle-orm/postgres-js` (NOT `bun-sql`)
|
|
||||||
- **Validation**: `drizzle-orm/zod` (built-in, NOT separate `drizzle-zod` package)
|
|
||||||
- **Relations**: Defined via `defineRelations()` in `src/server/db/relations.ts`
|
|
||||||
- **Query**: RQBv2 — use `db.query.tableName.findMany()` with object-style `orderBy` and `where`
|
|
||||||
|
|
||||||
### Schema Definition
|
|
||||||
```typescript
|
|
||||||
import { pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
|
|
||||||
import { sql } from 'drizzle-orm'
|
|
||||||
|
|
||||||
export const myTable = pgTable('my_table', {
|
|
||||||
id: uuid().primaryKey().default(sql`uuidv7()`),
|
|
||||||
name: text().notNull(),
|
|
||||||
createdAt: timestamp({ withTimezone: true }).notNull().defaultNow(),
|
|
||||||
updatedAt: timestamp({ withTimezone: true }).notNull().defaultNow().$onUpdateFn(() => new Date()),
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
### Relations (RQBv2)
|
|
||||||
```typescript
|
|
||||||
// src/server/db/relations.ts
|
|
||||||
import { defineRelations } from 'drizzle-orm'
|
|
||||||
import * as schema from './schema'
|
|
||||||
|
|
||||||
export const relations = defineRelations(schema, (r) => ({
|
|
||||||
// Define relations here using r.one / r.many / r.through
|
|
||||||
}))
|
|
||||||
```
|
|
||||||
|
|
||||||
### DB Instance
|
|
||||||
```typescript
|
|
||||||
// src/server/db/index.ts
|
|
||||||
import { drizzle } from 'drizzle-orm/postgres-js'
|
|
||||||
import { relations } from '@/server/db/relations'
|
|
||||||
// In RQBv2, relations already contain schema info — no separate schema import needed
|
|
||||||
|
|
||||||
const db = drizzle({
|
|
||||||
connection: env.DATABASE_URL,
|
|
||||||
relations,
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
### RQBv2 Query Examples
|
|
||||||
```typescript
|
|
||||||
// Object-style orderBy (NOT callback style)
|
|
||||||
const todos = await db.query.todoTable.findMany({
|
|
||||||
orderBy: { createdAt: 'desc' },
|
|
||||||
})
|
|
||||||
|
|
||||||
// Object-style where
|
|
||||||
const todo = await db.query.todoTable.findFirst({
|
|
||||||
where: { id: someId },
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## Code Style
|
|
||||||
|
|
||||||
### Formatting (Biome)
|
|
||||||
- **Indent**: 2 spaces
|
|
||||||
- **Quotes**: Single `'`
|
|
||||||
- **Semicolons**: Omit (ASI)
|
|
||||||
- **Arrow parens**: Always `(x) => x`
|
|
||||||
|
|
||||||
### Imports
|
|
||||||
Biome auto-organizes:
|
|
||||||
1. External packages
|
|
||||||
2. Internal `@/*` aliases
|
|
||||||
3. Type imports (`import type { ... }`)
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
|
||||||
import { z } from 'zod'
|
|
||||||
import { db } from '@/server/db'
|
|
||||||
import type { ReactNode } from 'react'
|
|
||||||
```
|
|
||||||
|
|
||||||
### TypeScript
|
|
||||||
- `strict: true`
|
|
||||||
- `noUncheckedIndexedAccess: true` - array access returns `T | undefined`
|
|
||||||
- Use `@/*` path aliases (maps to `src/*`)
|
|
||||||
|
|
||||||
### Naming
|
|
||||||
| Type | Convention | Example |
|
|
||||||
|------|------------|---------|
|
|
||||||
| Files (utils) | kebab-case | `auth-utils.ts` |
|
|
||||||
| Files (components) | PascalCase | `UserProfile.tsx` |
|
|
||||||
| Components | PascalCase arrow | `const Button = () => {}` |
|
|
||||||
| Functions | camelCase | `getUserById` |
|
|
||||||
| Types | PascalCase | `UserProfile` |
|
|
||||||
|
|
||||||
### React
|
|
||||||
- Use arrow functions for components (Biome enforced)
|
|
||||||
- Use `useSuspenseQuery` for guaranteed data
|
|
||||||
- Let React Compiler handle memoization (no manual `useMemo`/`useCallback`)
|
|
||||||
|
|
||||||
## Environment Variables
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// src/env.ts - using @t3-oss/env-core
|
|
||||||
import { createEnv } from '@t3-oss/env-core'
|
|
||||||
import { z } from 'zod'
|
|
||||||
|
|
||||||
export const env = createEnv({
|
|
||||||
server: {
|
|
||||||
DATABASE_URL: z.string().url(),
|
|
||||||
},
|
|
||||||
clientPrefix: 'VITE_',
|
|
||||||
client: {
|
|
||||||
VITE_API_URL: z.string().optional(),
|
|
||||||
},
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development Principles
|
|
||||||
|
|
||||||
> **These principles apply to ALL code changes. Agents MUST follow them on every task.**
|
|
||||||
|
|
||||||
1. **No backward compatibility** — This project is in rapid iteration. Always use the latest API and patterns. Never keep deprecated code paths or old API fallbacks.
|
|
||||||
2. **Always sync documentation** — When code changes, immediately update all related documentation (`AGENTS.md`, `README.md`, inline code examples). Code and docs must never drift apart.
|
|
||||||
3. **Forward-only migration** — When upgrading dependencies, fully adopt the new API. Don't mix old and new patterns.
|
|
||||||
|
|
||||||
## Critical Rules
|
|
||||||
|
|
||||||
**DO:**
|
|
||||||
- Run `bun run fix` before committing
|
|
||||||
- Use `@/*` path aliases
|
|
||||||
- Include `createdAt`/`updatedAt` on all tables
|
|
||||||
- Use `ORPCError` with proper codes
|
|
||||||
- Use `drizzle-orm/zod` (NOT `drizzle-zod`) for schema validation
|
|
||||||
- Use RQBv2 object syntax for `orderBy` and `where`
|
|
||||||
- Update `AGENTS.md` and other docs whenever code patterns change
|
|
||||||
|
|
||||||
**DON'T:**
|
|
||||||
- Use `npm`, `npx`, `node`, `yarn`, `pnpm` — always use `bun` / `bunx`
|
|
||||||
- Edit `src/routeTree.gen.ts` (auto-generated)
|
|
||||||
- Use `as any`, `@ts-ignore`, `@ts-expect-error`
|
|
||||||
- Commit `.env` files
|
|
||||||
- Use empty catch blocks
|
|
||||||
- Import from `drizzle-zod` (use `drizzle-orm/zod` instead)
|
|
||||||
- Use RQBv1 callback-style `orderBy` / old `relations()` API
|
|
||||||
- Use `drizzle-orm/bun-sql` driver (use `drizzle-orm/postgres-js`)
|
|
||||||
- Pass `schema` to `drizzle()` constructor (only `relations` is needed in RQBv2)
|
|
||||||
- Import `os` from `@orpc/server` in middleware — use `@/server/api/server` (the local typed instance)
|
|
||||||
- Leave docs out of sync with code changes
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "../../node_modules/@biomejs/biome/configuration_schema.json",
|
|
||||||
"extends": "//",
|
|
||||||
"files": {
|
|
||||||
"includes": ["**", "!**/routeTree.gen.ts"]
|
|
||||||
},
|
|
||||||
"css": {
|
|
||||||
"parser": {
|
|
||||||
"tailwindDirectives": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
import { mkdir, rm } from 'node:fs/promises'
|
|
||||||
import { parseArgs } from 'node:util'
|
|
||||||
|
|
||||||
const ENTRYPOINT = '.output/server/index.mjs'
|
|
||||||
const OUTDIR = 'out'
|
|
||||||
|
|
||||||
const SUPPORTED_TARGETS: readonly Bun.Build.CompileTarget[] = [
|
|
||||||
'bun-windows-x64',
|
|
||||||
'bun-darwin-arm64',
|
|
||||||
'bun-darwin-x64',
|
|
||||||
'bun-linux-x64',
|
|
||||||
'bun-linux-arm64',
|
|
||||||
]
|
|
||||||
|
|
||||||
const isSupportedTarget = (value: string): value is Bun.Build.CompileTarget =>
|
|
||||||
(SUPPORTED_TARGETS as readonly string[]).includes(value)
|
|
||||||
|
|
||||||
const { values } = parseArgs({
|
|
||||||
options: { target: { type: 'string' } },
|
|
||||||
strict: true,
|
|
||||||
allowPositionals: false,
|
|
||||||
})
|
|
||||||
|
|
||||||
const resolveTarget = (): Bun.Build.CompileTarget => {
|
|
||||||
if (values.target !== undefined) {
|
|
||||||
if (!isSupportedTarget(values.target)) {
|
|
||||||
throw new Error(`Invalid target: ${values.target}\nAllowed: ${SUPPORTED_TARGETS.join(', ')}`)
|
|
||||||
}
|
|
||||||
return values.target
|
|
||||||
}
|
|
||||||
|
|
||||||
const os = process.platform === 'win32' ? 'windows' : process.platform
|
|
||||||
const candidate = `bun-${os}-${process.arch}`
|
|
||||||
if (!isSupportedTarget(candidate)) {
|
|
||||||
throw new Error(`Unsupported host: ${process.platform}-${process.arch}`)
|
|
||||||
}
|
|
||||||
return candidate
|
|
||||||
}
|
|
||||||
|
|
||||||
const main = async () => {
|
|
||||||
const target = resolveTarget()
|
|
||||||
const suffix = target.replace('bun-', '')
|
|
||||||
const outfile = `server-${suffix}`
|
|
||||||
|
|
||||||
await mkdir(OUTDIR, { recursive: true })
|
|
||||||
await Promise.all([rm(`${OUTDIR}/${outfile}`, { force: true }), rm(`${OUTDIR}/${outfile}.exe`, { force: true })])
|
|
||||||
|
|
||||||
const result = await Bun.build({
|
|
||||||
entrypoints: [ENTRYPOINT],
|
|
||||||
outdir: OUTDIR,
|
|
||||||
compile: { outfile, target },
|
|
||||||
})
|
|
||||||
|
|
||||||
if (!result.success) {
|
|
||||||
throw new Error(result.logs.map(String).join('\n'))
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`✓ ${target} → ${OUTDIR}/${outfile}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
main().catch((err) => {
|
|
||||||
console.error('❌', err instanceof Error ? err.message : err)
|
|
||||||
process.exit(1)
|
|
||||||
})
|
|
||||||
@@ -1,59 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@furtherverse/server",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"private": true,
|
|
||||||
"type": "module",
|
|
||||||
"scripts": {
|
|
||||||
"build": "bunx --bun vite build",
|
|
||||||
"compile": "bun compile.ts",
|
|
||||||
"compile:darwin": "bun run compile:darwin:arm64 && bun run compile:darwin:x64",
|
|
||||||
"compile:darwin:arm64": "bun compile.ts --target bun-darwin-arm64",
|
|
||||||
"compile:darwin:x64": "bun compile.ts --target bun-darwin-x64",
|
|
||||||
"compile:linux": "bun run compile:linux:x64 && bun run compile:linux:arm64",
|
|
||||||
"compile:linux:arm64": "bun compile.ts --target bun-linux-arm64",
|
|
||||||
"compile:linux:x64": "bun compile.ts --target bun-linux-x64",
|
|
||||||
"compile:windows": "bun run compile:windows:x64",
|
|
||||||
"compile:windows:x64": "bun compile.ts --target bun-windows-x64",
|
|
||||||
"db:generate": "drizzle-kit generate",
|
|
||||||
"db:migrate": "drizzle-kit migrate",
|
|
||||||
"db:push": "drizzle-kit push",
|
|
||||||
"db:studio": "drizzle-kit studio",
|
|
||||||
"dev": "bunx --bun vite dev",
|
|
||||||
"fix": "biome check --write",
|
|
||||||
"typecheck": "tsc --noEmit"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"@orpc/client": "catalog:",
|
|
||||||
"@orpc/contract": "catalog:",
|
|
||||||
"@orpc/openapi": "catalog:",
|
|
||||||
"@orpc/server": "catalog:",
|
|
||||||
"@orpc/tanstack-query": "catalog:",
|
|
||||||
"@orpc/zod": "catalog:",
|
|
||||||
"@t3-oss/env-core": "catalog:",
|
|
||||||
"@tanstack/react-query": "catalog:",
|
|
||||||
"@tanstack/react-router": "catalog:",
|
|
||||||
"@tanstack/react-router-ssr-query": "catalog:",
|
|
||||||
"@tanstack/react-start": "catalog:",
|
|
||||||
"drizzle-orm": "catalog:",
|
|
||||||
"postgres": "catalog:",
|
|
||||||
"react": "catalog:",
|
|
||||||
"react-dom": "catalog:",
|
|
||||||
"uuid": "catalog:",
|
|
||||||
"zod": "catalog:"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@furtherverse/tsconfig": "workspace:*",
|
|
||||||
"@tailwindcss/vite": "catalog:",
|
|
||||||
"@tanstack/devtools-vite": "catalog:",
|
|
||||||
"@tanstack/react-devtools": "catalog:",
|
|
||||||
"@tanstack/react-query-devtools": "catalog:",
|
|
||||||
"@tanstack/react-router-devtools": "catalog:",
|
|
||||||
"@types/bun": "catalog:",
|
|
||||||
"@vitejs/plugin-react": "catalog:",
|
|
||||||
"babel-plugin-react-compiler": "catalog:",
|
|
||||||
"drizzle-kit": "catalog:",
|
|
||||||
"nitro": "catalog:",
|
|
||||||
"tailwindcss": "catalog:",
|
|
||||||
"vite": "catalog:"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
import { OpenAPIHandler } from '@orpc/openapi/fetch'
|
|
||||||
import { OpenAPIReferencePlugin } from '@orpc/openapi/plugins'
|
|
||||||
import { onError } from '@orpc/server'
|
|
||||||
import { ZodToJsonSchemaConverter } from '@orpc/zod/zod4'
|
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
|
||||||
import { name, version } from '@/../package.json'
|
|
||||||
import { handleValidationError, logError } from '@/server/api/interceptors'
|
|
||||||
import { router } from '@/server/api/routers'
|
|
||||||
|
|
||||||
const handler = new OpenAPIHandler(router, {
|
|
||||||
plugins: [
|
|
||||||
new OpenAPIReferencePlugin({
|
|
||||||
docsProvider: 'scalar',
|
|
||||||
schemaConverters: [new ZodToJsonSchemaConverter()],
|
|
||||||
specGenerateOptions: {
|
|
||||||
info: {
|
|
||||||
title: name,
|
|
||||||
version,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
docsPath: '/docs',
|
|
||||||
specPath: '/spec.json',
|
|
||||||
}),
|
|
||||||
],
|
|
||||||
interceptors: [onError(logError)],
|
|
||||||
clientInterceptors: [onError(handleValidationError)],
|
|
||||||
})
|
|
||||||
|
|
||||||
export const Route = createFileRoute('/api/$')({
|
|
||||||
server: {
|
|
||||||
handlers: {
|
|
||||||
ANY: async ({ request }) => {
|
|
||||||
const { response } = await handler.handle(request, {
|
|
||||||
prefix: '/api',
|
|
||||||
context: {
|
|
||||||
headers: request.headers,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
return response ?? new Response('Not Found', { status: 404 })
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
import { createFileRoute } from '@tanstack/react-router'
|
|
||||||
import { name, version } from '@/../package.json'
|
|
||||||
|
|
||||||
const createHealthResponse = (): Response =>
|
|
||||||
Response.json(
|
|
||||||
{
|
|
||||||
status: 'ok',
|
|
||||||
service: name,
|
|
||||||
version,
|
|
||||||
timestamp: new Date().toISOString(),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
status: 200,
|
|
||||||
headers: {
|
|
||||||
'cache-control': 'no-store',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
export const Route = createFileRoute('/api/health')({
|
|
||||||
server: {
|
|
||||||
handlers: {
|
|
||||||
GET: async () => createHealthResponse(),
|
|
||||||
HEAD: async () => new Response(null, { status: 200 }),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
import { onError } from '@orpc/server'
|
|
||||||
import { RPCHandler } from '@orpc/server/fetch'
|
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
|
||||||
import { handleValidationError, logError } from '@/server/api/interceptors'
|
|
||||||
import { router } from '@/server/api/routers'
|
|
||||||
|
|
||||||
const handler = new RPCHandler(router, {
|
|
||||||
interceptors: [onError(logError)],
|
|
||||||
clientInterceptors: [onError(handleValidationError)],
|
|
||||||
})
|
|
||||||
|
|
||||||
export const Route = createFileRoute('/api/rpc/$')({
|
|
||||||
server: {
|
|
||||||
handlers: {
|
|
||||||
ANY: async ({ request }) => {
|
|
||||||
const { response } = await handler.handle(request, {
|
|
||||||
prefix: '/api/rpc',
|
|
||||||
context: {
|
|
||||||
headers: request.headers,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
return response ?? new Response('Not Found', { status: 404 })
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
import type { DB } from '@/server/db'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 基础 Context - 所有请求都包含的上下文
|
|
||||||
*/
|
|
||||||
export interface BaseContext {
|
|
||||||
headers: Headers
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 数据库 Context - 通过 db middleware 扩展
|
|
||||||
*/
|
|
||||||
export interface DBContext extends BaseContext {
|
|
||||||
db: DB
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 认证 Context - 通过 auth middleware 扩展(未来使用)
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* export interface AuthContext extends DBContext {
|
|
||||||
* userId: string
|
|
||||||
* user: User
|
|
||||||
* }
|
|
||||||
*/
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
import * as todo from './todo.contract'
|
|
||||||
|
|
||||||
export const contract = {
|
|
||||||
todo,
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Contract = typeof contract
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
import { ORPCError, ValidationError } from '@orpc/server'
|
|
||||||
import { z } from 'zod'
|
|
||||||
|
|
||||||
export const logError = (error: unknown) => {
|
|
||||||
console.error(error)
|
|
||||||
}
|
|
||||||
|
|
||||||
export const handleValidationError = (error: unknown) => {
|
|
||||||
if (error instanceof ORPCError && error.code === 'BAD_REQUEST' && error.cause instanceof ValidationError) {
|
|
||||||
// If you only use Zod you can safely cast to ZodIssue[] (per ORPC official docs)
|
|
||||||
const zodError = new z.ZodError(error.cause.issues as z.core.$ZodIssue[])
|
|
||||||
|
|
||||||
throw new ORPCError('INPUT_VALIDATION_FAILED', {
|
|
||||||
status: 422,
|
|
||||||
message: z.prettifyError(zodError),
|
|
||||||
data: z.flattenError(zodError),
|
|
||||||
cause: error.cause,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
if (error instanceof ORPCError && error.code === 'INTERNAL_SERVER_ERROR' && error.cause instanceof ValidationError) {
|
|
||||||
throw new ORPCError('OUTPUT_VALIDATION_FAILED', {
|
|
||||||
cause: error.cause,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
import { os } from '@/server/api/server'
|
|
||||||
import { getDB } from '@/server/db'
|
|
||||||
|
|
||||||
export const db = os.middleware(async ({ context, next }) => {
|
|
||||||
return next({
|
|
||||||
context: {
|
|
||||||
...context,
|
|
||||||
db: getDB(),
|
|
||||||
},
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
export * from './db.middleware'
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
import { os } from '../server'
|
|
||||||
import * as todo from './todo.router'
|
|
||||||
|
|
||||||
export const router = os.router({
|
|
||||||
todo,
|
|
||||||
})
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
import { ORPCError } from '@orpc/server'
|
|
||||||
import { eq } from 'drizzle-orm'
|
|
||||||
import { todoTable } from '@/server/db/schema'
|
|
||||||
import { db } from '../middlewares'
|
|
||||||
import { os } from '../server'
|
|
||||||
|
|
||||||
export const list = os.todo.list.use(db).handler(async ({ context }) => {
|
|
||||||
const todos = await context.db.query.todoTable.findMany({
|
|
||||||
orderBy: { createdAt: 'desc' },
|
|
||||||
})
|
|
||||||
return todos
|
|
||||||
})
|
|
||||||
|
|
||||||
export const create = os.todo.create.use(db).handler(async ({ context, input }) => {
|
|
||||||
const [newTodo] = await context.db.insert(todoTable).values(input).returning()
|
|
||||||
|
|
||||||
if (!newTodo) {
|
|
||||||
throw new ORPCError('INTERNAL_SERVER_ERROR', { message: 'Failed to create todo' })
|
|
||||||
}
|
|
||||||
|
|
||||||
return newTodo
|
|
||||||
})
|
|
||||||
|
|
||||||
export const update = os.todo.update.use(db).handler(async ({ context, input }) => {
|
|
||||||
const [updatedTodo] = await context.db.update(todoTable).set(input.data).where(eq(todoTable.id, input.id)).returning()
|
|
||||||
|
|
||||||
if (!updatedTodo) {
|
|
||||||
throw new ORPCError('NOT_FOUND')
|
|
||||||
}
|
|
||||||
|
|
||||||
return updatedTodo
|
|
||||||
})
|
|
||||||
|
|
||||||
export const remove = os.todo.remove.use(db).handler(async ({ context, input }) => {
|
|
||||||
const [deleted] = await context.db.delete(todoTable).where(eq(todoTable.id, input.id)).returning({ id: todoTable.id })
|
|
||||||
|
|
||||||
if (!deleted) {
|
|
||||||
throw new ORPCError('NOT_FOUND')
|
|
||||||
}
|
|
||||||
})
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
import { implement } from '@orpc/server'
|
|
||||||
import type { BaseContext } from './context'
|
|
||||||
import { contract } from './contracts'
|
|
||||||
|
|
||||||
export const os = implement(contract).$context<BaseContext>()
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
import type { ContractRouterClient, InferContractRouterInputs, InferContractRouterOutputs } from '@orpc/contract'
|
|
||||||
import type { Contract } from './contracts'
|
|
||||||
|
|
||||||
export type RouterClient = ContractRouterClient<Contract>
|
|
||||||
export type RouterInputs = InferContractRouterInputs<Contract>
|
|
||||||
export type RouterOutputs = InferContractRouterOutputs<Contract>
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
import { sql } from 'drizzle-orm'
|
|
||||||
import { timestamp, uuid } from 'drizzle-orm/pg-core'
|
|
||||||
import { v7 as uuidv7 } from 'uuid'
|
|
||||||
|
|
||||||
// id
|
|
||||||
|
|
||||||
const id = (name: string) => uuid(name)
|
|
||||||
export const pk = (name: string, strategy?: 'native' | 'extension') => {
|
|
||||||
switch (strategy) {
|
|
||||||
// PG 18+
|
|
||||||
case 'native':
|
|
||||||
return id(name).primaryKey().default(sql`uuidv7()`)
|
|
||||||
|
|
||||||
// PG 13+ with extension
|
|
||||||
case 'extension':
|
|
||||||
return id(name).primaryKey().default(sql`uuid_generate_v7()`)
|
|
||||||
|
|
||||||
// Any PG version
|
|
||||||
default:
|
|
||||||
return id(name)
|
|
||||||
.primaryKey()
|
|
||||||
.$defaultFn(() => uuidv7())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// timestamp
|
|
||||||
|
|
||||||
export const createdAt = (name = 'created_at') => timestamp(name, { withTimezone: true }).notNull().defaultNow()
|
|
||||||
|
|
||||||
export const updatedAt = (name = 'updated_at') =>
|
|
||||||
timestamp(name, { withTimezone: true })
|
|
||||||
.notNull()
|
|
||||||
.defaultNow()
|
|
||||||
.$onUpdateFn(() => new Date())
|
|
||||||
|
|
||||||
// generated fields
|
|
||||||
|
|
||||||
export const generatedFields = {
|
|
||||||
id: pk('id'),
|
|
||||||
createdAt: createdAt('created_at'),
|
|
||||||
updatedAt: updatedAt('updated_at'),
|
|
||||||
}
|
|
||||||
|
|
||||||
// Helper to create omit keys from generatedFields
|
|
||||||
const createGeneratedFieldKeys = <T extends Record<string, unknown>>(fields: T): Record<keyof T, true> => {
|
|
||||||
return Object.keys(fields).reduce(
|
|
||||||
(acc, key) => {
|
|
||||||
acc[key as keyof T] = true
|
|
||||||
return acc
|
|
||||||
},
|
|
||||||
{} as Record<keyof T, true>,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
export const generatedFieldKeys = createGeneratedFieldKeys(generatedFields)
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
import { drizzle } from 'drizzle-orm/postgres-js'
|
|
||||||
import { env } from '@/env'
|
|
||||||
import { relations } from '@/server/db/relations'
|
|
||||||
|
|
||||||
export const createDB = () =>
|
|
||||||
drizzle({
|
|
||||||
connection: env.DATABASE_URL,
|
|
||||||
relations,
|
|
||||||
})
|
|
||||||
|
|
||||||
export type DB = ReturnType<typeof createDB>
|
|
||||||
|
|
||||||
export const getDB = (() => {
|
|
||||||
let db: DB | null = null
|
|
||||||
|
|
||||||
return (singleton = true): DB => {
|
|
||||||
if (!singleton) {
|
|
||||||
return createDB()
|
|
||||||
}
|
|
||||||
|
|
||||||
db ??= createDB()
|
|
||||||
return db
|
|
||||||
}
|
|
||||||
})()
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
import { defineRelations } from 'drizzle-orm'
|
|
||||||
import * as schema from './schema'
|
|
||||||
|
|
||||||
export const relations = defineRelations(schema, (_r) => ({}))
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
import { boolean, pgTable, text } from 'drizzle-orm/pg-core'
|
|
||||||
import { generatedFields } from '../fields'
|
|
||||||
|
|
||||||
export const todoTable = pgTable('todo', {
|
|
||||||
...generatedFields,
|
|
||||||
title: text('title').notNull(),
|
|
||||||
completed: boolean('completed').notNull().default(false),
|
|
||||||
})
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
@import "tailwindcss";
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "@furtherverse/tsconfig/react.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"baseUrl": ".",
|
|
||||||
"paths": {
|
|
||||||
"@/*": ["./src/*"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "../../node_modules/turbo/schema.json",
|
|
||||||
"extends": ["//"],
|
|
||||||
"tasks": {
|
|
||||||
"build": {
|
|
||||||
"env": ["NODE_ENV", "VITE_*"],
|
|
||||||
"inputs": ["src/**", "public/**", "package.json", "tsconfig.json", "vite.config.ts"],
|
|
||||||
"outputs": [".output/**"]
|
|
||||||
},
|
|
||||||
"compile": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"compile:darwin": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"compile:darwin:arm64": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"compile:darwin:x64": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"compile:linux": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"compile:linux:arm64": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"compile:linux:x64": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"compile:windows": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
|
||||||
"compile:windows:x64": {
|
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -6,13 +6,13 @@
|
|||||||
"useIgnoreFile": true
|
"useIgnoreFile": true
|
||||||
},
|
},
|
||||||
"files": {
|
"files": {
|
||||||
|
"includes": ["**", "!**/routeTree.gen.ts"],
|
||||||
"ignoreUnknown": false
|
"ignoreUnknown": false
|
||||||
},
|
},
|
||||||
"formatter": {
|
"formatter": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"indentStyle": "space",
|
"indentStyle": "space",
|
||||||
"lineEnding": "lf",
|
"lineEnding": "lf"
|
||||||
"lineWidth": 120
|
|
||||||
},
|
},
|
||||||
"linter": {
|
"linter": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
|
|||||||
289
build.ts
Normal file
@@ -0,0 +1,289 @@
|
|||||||
|
import { Schema } from '@effect/schema'
|
||||||
|
import { $ } from 'bun'
|
||||||
|
import { Console, Context, Data, Effect, Layer } from 'effect'
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Domain Models & Schema
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
const targetMap = {
|
||||||
|
'bun-windows-x64': 'x86_64-pc-windows-msvc',
|
||||||
|
'bun-darwin-arm64': 'aarch64-apple-darwin',
|
||||||
|
'bun-darwin-x64': 'x86_64-apple-darwin',
|
||||||
|
'bun-linux-x64': 'x86_64-unknown-linux-gnu',
|
||||||
|
'bun-linux-arm64': 'aarch64-unknown-linux-gnu',
|
||||||
|
} as const
|
||||||
|
|
||||||
|
const BunTargetSchema = Schema.Literal(
|
||||||
|
'bun-windows-x64',
|
||||||
|
'bun-darwin-arm64',
|
||||||
|
'bun-darwin-x64',
|
||||||
|
'bun-linux-x64',
|
||||||
|
'bun-linux-arm64',
|
||||||
|
)
|
||||||
|
|
||||||
|
type BunTarget = Schema.Schema.Type<typeof BunTargetSchema>
|
||||||
|
|
||||||
|
const BuildConfigSchema = Schema.Struct({
|
||||||
|
entrypoint: Schema.String.pipe(Schema.nonEmptyString()),
|
||||||
|
outputDir: Schema.String.pipe(Schema.nonEmptyString()),
|
||||||
|
targets: Schema.Array(BunTargetSchema).pipe(Schema.minItems(1)),
|
||||||
|
})
|
||||||
|
|
||||||
|
type BuildConfig = Schema.Schema.Type<typeof BuildConfigSchema>
|
||||||
|
|
||||||
|
const BuildResultSchema = Schema.Struct({
|
||||||
|
target: BunTargetSchema,
|
||||||
|
outputs: Schema.Array(Schema.String),
|
||||||
|
})
|
||||||
|
|
||||||
|
type BuildResult = Schema.Schema.Type<typeof BuildResultSchema>
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Error Models (使用 Data.TaggedError)
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
class CleanError extends Data.TaggedError('CleanError')<{
|
||||||
|
readonly dir: string
|
||||||
|
readonly cause: unknown
|
||||||
|
}> {}
|
||||||
|
|
||||||
|
class BuildError extends Data.TaggedError('BuildError')<{
|
||||||
|
readonly target: BunTarget
|
||||||
|
readonly cause: unknown
|
||||||
|
}> {}
|
||||||
|
|
||||||
|
class ConfigError extends Data.TaggedError('ConfigError')<{
|
||||||
|
readonly message: string
|
||||||
|
readonly cause: unknown
|
||||||
|
}> {}
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Services
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 配置服务
|
||||||
|
*/
|
||||||
|
class BuildConfigService extends Context.Tag('BuildConfigService')<
|
||||||
|
BuildConfigService,
|
||||||
|
BuildConfig
|
||||||
|
>() {
|
||||||
|
/**
|
||||||
|
* 从原始数据创建并验证配置
|
||||||
|
*/
|
||||||
|
static fromRaw = (raw: unknown) =>
|
||||||
|
Effect.gen(function* () {
|
||||||
|
const decoded = yield* Schema.decodeUnknown(BuildConfigSchema)(raw)
|
||||||
|
return decoded
|
||||||
|
}).pipe(
|
||||||
|
Effect.catchAll((error) =>
|
||||||
|
Effect.fail(
|
||||||
|
new ConfigError({
|
||||||
|
message: '配置验证失败',
|
||||||
|
cause: error,
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 默认配置 Layer
|
||||||
|
*/
|
||||||
|
static readonly Live = Layer.effect(
|
||||||
|
BuildConfigService,
|
||||||
|
BuildConfigService.fromRaw({
|
||||||
|
entrypoint: '.output/server/index.mjs',
|
||||||
|
// outputDir: 'out',
|
||||||
|
outputDir: 'src-tauri/binaries',
|
||||||
|
targets: ['bun-windows-x64', 'bun-darwin-arm64', 'bun-linux-x64'],
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 文件系统服务
|
||||||
|
*/
|
||||||
|
class FileSystemService extends Context.Tag('FileSystemService')<
|
||||||
|
FileSystemService,
|
||||||
|
{
|
||||||
|
readonly cleanDir: (dir: string) => Effect.Effect<void, CleanError>
|
||||||
|
}
|
||||||
|
>() {
|
||||||
|
static readonly Live = Layer.succeed(FileSystemService, {
|
||||||
|
cleanDir: (dir: string) =>
|
||||||
|
Effect.tryPromise({
|
||||||
|
try: async () => {
|
||||||
|
await $`rm -rf ${dir}`
|
||||||
|
},
|
||||||
|
catch: (cause: unknown) =>
|
||||||
|
new CleanError({
|
||||||
|
dir,
|
||||||
|
cause,
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 构建服务
|
||||||
|
*/
|
||||||
|
class BuildService extends Context.Tag('BuildService')<
|
||||||
|
BuildService,
|
||||||
|
{
|
||||||
|
readonly buildForTarget: (
|
||||||
|
config: BuildConfig,
|
||||||
|
target: BunTarget,
|
||||||
|
) => Effect.Effect<BuildResult, BuildError>
|
||||||
|
readonly buildAll: (
|
||||||
|
config: BuildConfig,
|
||||||
|
) => Effect.Effect<ReadonlyArray<BuildResult>, BuildError>
|
||||||
|
}
|
||||||
|
>() {
|
||||||
|
static readonly Live = Layer.succeed(BuildService, {
|
||||||
|
buildForTarget: (config: BuildConfig, target: BunTarget) =>
|
||||||
|
Effect.gen(function* () {
|
||||||
|
yield* Console.log(`🔨 开始构建: ${target}`)
|
||||||
|
|
||||||
|
const output = yield* Effect.tryPromise({
|
||||||
|
try: () =>
|
||||||
|
Bun.build({
|
||||||
|
entrypoints: [config.entrypoint],
|
||||||
|
compile: {
|
||||||
|
outfile: `app-${targetMap[target]}`,
|
||||||
|
target: target,
|
||||||
|
},
|
||||||
|
outdir: config.outputDir,
|
||||||
|
}),
|
||||||
|
catch: (cause: unknown) =>
|
||||||
|
new BuildError({
|
||||||
|
target,
|
||||||
|
cause,
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
|
||||||
|
const paths = output.outputs.map((item: { path: string }) => item.path)
|
||||||
|
|
||||||
|
return {
|
||||||
|
target,
|
||||||
|
outputs: paths,
|
||||||
|
} satisfies BuildResult
|
||||||
|
}),
|
||||||
|
|
||||||
|
buildAll: (config: BuildConfig) =>
|
||||||
|
Effect.gen(function* () {
|
||||||
|
const effects = config.targets.map((target) =>
|
||||||
|
Effect.gen(function* () {
|
||||||
|
yield* Console.log(`🔨 开始构建: ${target}`)
|
||||||
|
|
||||||
|
const output = yield* Effect.tryPromise({
|
||||||
|
try: () =>
|
||||||
|
Bun.build({
|
||||||
|
entrypoints: [config.entrypoint],
|
||||||
|
compile: {
|
||||||
|
outfile: `app-${targetMap[target]}`,
|
||||||
|
target: target,
|
||||||
|
},
|
||||||
|
outdir: config.outputDir,
|
||||||
|
}),
|
||||||
|
catch: (cause: unknown) =>
|
||||||
|
new BuildError({
|
||||||
|
target,
|
||||||
|
cause,
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
|
||||||
|
const paths = output.outputs.map(
|
||||||
|
(item: { path: string }) => item.path,
|
||||||
|
)
|
||||||
|
|
||||||
|
return {
|
||||||
|
target,
|
||||||
|
outputs: paths,
|
||||||
|
} satisfies BuildResult
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
return yield* Effect.all(effects, { concurrency: 'unbounded' })
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 报告服务
|
||||||
|
*/
|
||||||
|
class ReporterService extends Context.Tag('ReporterService')<
|
||||||
|
ReporterService,
|
||||||
|
{
|
||||||
|
readonly printSummary: (
|
||||||
|
results: ReadonlyArray<BuildResult>,
|
||||||
|
) => Effect.Effect<void>
|
||||||
|
}
|
||||||
|
>() {
|
||||||
|
static readonly Live = Layer.succeed(ReporterService, {
|
||||||
|
printSummary: (results: ReadonlyArray<BuildResult>) =>
|
||||||
|
Effect.gen(function* () {
|
||||||
|
yield* Console.log('\n📦 构建完成:')
|
||||||
|
for (const result of results) {
|
||||||
|
yield* Console.log(` ${result.target}:`)
|
||||||
|
for (const path of result.outputs) {
|
||||||
|
yield* Console.log(` - ${path}`)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Main Program
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
const program = Effect.gen(function* () {
|
||||||
|
const config = yield* BuildConfigService
|
||||||
|
const fs = yield* FileSystemService
|
||||||
|
const builder = yield* BuildService
|
||||||
|
const reporter = yield* ReporterService
|
||||||
|
|
||||||
|
// 1. 清理输出目录
|
||||||
|
yield* fs.cleanDir(config.outputDir)
|
||||||
|
yield* Console.log(`✓ 已清理输出目录: ${config.outputDir}`)
|
||||||
|
|
||||||
|
// 2. 并行构建所有目标
|
||||||
|
const results = yield* builder.buildAll(config)
|
||||||
|
|
||||||
|
// 3. 输出构建摘要
|
||||||
|
yield* reporter.printSummary(results)
|
||||||
|
|
||||||
|
return results
|
||||||
|
})
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Layer Composition
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
const MainLayer = Layer.mergeAll(
|
||||||
|
BuildConfigService.Live,
|
||||||
|
FileSystemService.Live,
|
||||||
|
BuildService.Live,
|
||||||
|
ReporterService.Live,
|
||||||
|
)
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// Runner
|
||||||
|
// ============================================================================
|
||||||
|
|
||||||
|
const runnable = program.pipe(
|
||||||
|
Effect.provide(MainLayer),
|
||||||
|
Effect.catchTags({
|
||||||
|
CleanError: (error) =>
|
||||||
|
Console.error(`❌ 清理目录失败: ${error.dir}`, error.cause),
|
||||||
|
BuildError: (error) =>
|
||||||
|
Console.error(`❌ 构建失败 [${error.target}]:`, error.cause),
|
||||||
|
ConfigError: (error) =>
|
||||||
|
Console.error(`❌ 配置错误: ${error.message}`, error.cause),
|
||||||
|
}),
|
||||||
|
Effect.tapErrorCause((cause) => Console.error('❌ 未预期的错误:', cause)),
|
||||||
|
)
|
||||||
|
|
||||||
|
Effect.runPromise(runnable).catch(() => {
|
||||||
|
process.exit(1)
|
||||||
|
})
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
[install]
|
|
||||||
publicHoistPattern = ["@types/*", "bun-types", "nitro*"]
|
|
||||||
@@ -3,7 +3,7 @@ import { env } from '@/env'
|
|||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
out: './drizzle',
|
out: './drizzle',
|
||||||
schema: './src/server/db/schema/index.ts',
|
schema: './src/db/schema/index.ts',
|
||||||
dialect: 'postgresql',
|
dialect: 'postgresql',
|
||||||
dbCredentials: {
|
dbCredentials: {
|
||||||
url: env.DATABASE_URL,
|
url: env.DATABASE_URL,
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
[tools]
|
[tools]
|
||||||
bun = "1"
|
|
||||||
node = "24"
|
node = "24"
|
||||||
|
bun = "1"
|
||||||
|
rust = 'latest'
|
||||||
|
|||||||
105
package.json
@@ -1,69 +1,64 @@
|
|||||||
{
|
{
|
||||||
"name": "@furtherverse/monorepo",
|
"name": "fullstack-starter",
|
||||||
"version": "1.0.0",
|
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"workspaces": [
|
|
||||||
"apps/*",
|
|
||||||
"packages/*"
|
|
||||||
],
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "turbo run build",
|
"build": "turbo build:tauri",
|
||||||
"compile": "turbo run compile",
|
"build:compile": "bun build.ts",
|
||||||
"compile:darwin": "turbo run compile:darwin",
|
"build:tauri": "NO_STRIP=1 tauri build",
|
||||||
"compile:linux": "turbo run compile:linux",
|
"build:vite": "vite build",
|
||||||
"compile:windows": "turbo run compile:windows",
|
"db:generate": "drizzle-kit generate",
|
||||||
"dev": "turbo run dev",
|
"db:migrate": "drizzle-kit migrate",
|
||||||
"dist": "turbo run dist",
|
"db:push": "drizzle-kit push",
|
||||||
"dist:linux": "turbo run dist:linux",
|
"db:studio": "drizzle-kit studio",
|
||||||
"dist:mac": "turbo run dist:mac",
|
"dev": "turbo dev:tauri",
|
||||||
"dist:win": "turbo run dist:win",
|
"dev:tauri": "tauri dev",
|
||||||
"fix": "turbo run fix",
|
"dev:vite": "vite dev",
|
||||||
"typecheck": "turbo run typecheck"
|
"fix": "biome check --write",
|
||||||
|
"typecheck": "tsc -b"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"dependencies": {
|
||||||
"@biomejs/biome": "^2.4.8",
|
"@orpc/client": "^1.13.4",
|
||||||
"turbo": "^2.8.20",
|
"@orpc/contract": "^1.13.4",
|
||||||
"typescript": "^5.9.3"
|
"@orpc/server": "^1.13.4",
|
||||||
},
|
"@orpc/tanstack-query": "^1.13.4",
|
||||||
"catalog": {
|
"@orpc/zod": "^1.13.4",
|
||||||
"@orpc/client": "^1.13.9",
|
|
||||||
"@orpc/contract": "^1.13.9",
|
|
||||||
"@orpc/openapi": "^1.13.9",
|
|
||||||
"@orpc/server": "^1.13.9",
|
|
||||||
"@orpc/tanstack-query": "^1.13.9",
|
|
||||||
"@orpc/zod": "^1.13.9",
|
|
||||||
"@t3-oss/env-core": "^0.13.10",
|
"@t3-oss/env-core": "^0.13.10",
|
||||||
"@tailwindcss/vite": "^4.2.2",
|
"@tanstack/react-query": "^5.90.20",
|
||||||
"@tanstack/devtools-vite": "^0.5.5",
|
"@tanstack/react-router": "^1.158.1",
|
||||||
"@tanstack/react-devtools": "^0.9.13",
|
"@tanstack/react-router-ssr-query": "^1.158.1",
|
||||||
"@tanstack/react-query": "^5.94.4",
|
"@tanstack/react-start": "^1.158.3",
|
||||||
"@tanstack/react-query-devtools": "^5.94.4",
|
"@tauri-apps/api": "^2.10.1",
|
||||||
"@tanstack/react-router": "^1.168.1",
|
"drizzle-orm": "^0.45.1",
|
||||||
"@tanstack/react-router-devtools": "^1.166.10",
|
"drizzle-zod": "^0.8.3",
|
||||||
"@tanstack/react-router-ssr-query": "^1.166.10",
|
|
||||||
"@tanstack/react-start": "^1.167.2",
|
|
||||||
"@types/bun": "^1.3.11",
|
|
||||||
"@types/node": "^24.12.0",
|
|
||||||
"@vitejs/plugin-react": "^5.2.0",
|
|
||||||
"babel-plugin-react-compiler": "^1.0.0",
|
|
||||||
"drizzle-kit": "1.0.0-beta.15-859cf75",
|
|
||||||
"drizzle-orm": "1.0.0-beta.15-859cf75",
|
|
||||||
"electron": "^34.0.0",
|
|
||||||
"electron-builder": "^26.8.1",
|
|
||||||
"electron-vite": "^5.0.0",
|
|
||||||
"motion": "^12.38.0",
|
|
||||||
"nitro": "npm:nitro-nightly@3.0.1-20260320-182900-2218d454",
|
|
||||||
"postgres": "^3.4.8",
|
"postgres": "^3.4.8",
|
||||||
"react": "^19.2.4",
|
"react": "^19.2.4",
|
||||||
"react-dom": "^19.2.4",
|
"react-dom": "^19.2.4",
|
||||||
"tailwindcss": "^4.2.2",
|
|
||||||
"tree-kill": "^1.2.2",
|
|
||||||
"uuid": "^13.0.0",
|
|
||||||
"vite": "^8.0.1",
|
|
||||||
"zod": "^4.3.6"
|
"zod": "^4.3.6"
|
||||||
},
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@biomejs/biome": "^2.3.14",
|
||||||
|
"@effect/platform": "^0.94.3",
|
||||||
|
"@effect/schema": "^0.75.5",
|
||||||
|
"@tailwindcss/vite": "^4.1.18",
|
||||||
|
"@tanstack/devtools-vite": "^0.4.1",
|
||||||
|
"@tanstack/react-devtools": "^0.9.4",
|
||||||
|
"@tanstack/react-query-devtools": "^5.91.3",
|
||||||
|
"@tanstack/react-router-devtools": "^1.158.1",
|
||||||
|
"@tauri-apps/cli": "^2.10.0",
|
||||||
|
"@types/bun": "^1.3.8",
|
||||||
|
"@vitejs/plugin-react": "^5.1.3",
|
||||||
|
"babel-plugin-react-compiler": "^1.0.0",
|
||||||
|
"drizzle-kit": "^0.31.8",
|
||||||
|
"effect": "^3.19.16",
|
||||||
|
"nitro": "npm:nitro-nightly@latest",
|
||||||
|
"tailwindcss": "^4.1.18",
|
||||||
|
"turbo": "^2.8.3",
|
||||||
|
"typescript": "^5.9.3",
|
||||||
|
"vite": "^8.0.0-beta.13",
|
||||||
|
"vite-tsconfig-paths": "^6.0.5"
|
||||||
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"@types/node": "catalog:"
|
"@tanstack/query-core": "^5.90.20"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://json.schemastore.org/tsconfig",
|
|
||||||
"display": "Base",
|
|
||||||
"compilerOptions": {
|
|
||||||
"target": "esnext",
|
|
||||||
"lib": ["ESNext"],
|
|
||||||
"module": "preserve",
|
|
||||||
"skipLibCheck": true,
|
|
||||||
|
|
||||||
"moduleResolution": "bundler",
|
|
||||||
"allowImportingTsExtensions": true,
|
|
||||||
"verbatimModuleSyntax": true,
|
|
||||||
"moduleDetection": "force",
|
|
||||||
"noEmit": true,
|
|
||||||
|
|
||||||
"strict": true,
|
|
||||||
"noUnusedLocals": false,
|
|
||||||
"noUnusedParameters": false,
|
|
||||||
"erasableSyntaxOnly": true,
|
|
||||||
"noFallthroughCasesInSwitch": true,
|
|
||||||
"noUncheckedSideEffectImports": true,
|
|
||||||
"noUncheckedIndexedAccess": true,
|
|
||||||
"noImplicitOverride": true
|
|
||||||
},
|
|
||||||
"exclude": ["node_modules"]
|
|
||||||
}
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://json.schemastore.org/tsconfig",
|
|
||||||
"display": "Bun",
|
|
||||||
"extends": "./base.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"types": ["bun-types"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@furtherverse/tsconfig",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"private": true,
|
|
||||||
"type": "module",
|
|
||||||
"exports": {
|
|
||||||
"./base.json": "./base.json",
|
|
||||||
"./bun.json": "./bun.json",
|
|
||||||
"./react.json": "./react.json"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://json.schemastore.org/tsconfig",
|
|
||||||
"display": "React",
|
|
||||||
"extends": "./base.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"lib": ["ESNext", "DOM", "DOM.Iterable"],
|
|
||||||
"jsx": "react-jsx"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
10
src-tauri/.gitignore
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Generated by Cargo
|
||||||
|
# will have compiled files and executables
|
||||||
|
/target/
|
||||||
|
|
||||||
|
# Generated by Tauri
|
||||||
|
# will have schema files for capabilities auto-completion
|
||||||
|
/gen/schemas
|
||||||
|
|
||||||
|
# Tauri Sidecar
|
||||||
|
binaries/
|
||||||
357
src-tauri/AGENTS.md
Normal file
@@ -0,0 +1,357 @@
|
|||||||
|
# AGENTS.md - Tauri Shell 项目开发指南
|
||||||
|
|
||||||
|
本文档为 AI 编程助手和开发者提供项目规范、构建命令和代码风格指南。
|
||||||
|
|
||||||
|
## 项目概览
|
||||||
|
|
||||||
|
- **项目类型**: Tauri v2 桌面应用(轻量级壳子)
|
||||||
|
- **后端**: Rust (Edition 2021)
|
||||||
|
- **架构**: Sidecar 模式 - Sidecar App 承载主要业务逻辑
|
||||||
|
- **设计理念**: Tauri 仅提供原生桌面能力(文件对话框、系统通知等),Web 逻辑全部由 Sidecar App 处理
|
||||||
|
- **开发模式**: 使用 localhost:3000(需手动启动开发服务器)
|
||||||
|
- **生产模式**: 自动启动 Sidecar 二进制
|
||||||
|
- **异步运行时**: Tokio
|
||||||
|
- **Rust 版本**: 1.92.0+
|
||||||
|
- **工具管理**: 使用 mise 管理 Rust 和 Tauri CLI 版本(见 `mise.toml`)
|
||||||
|
|
||||||
|
## 构建、测试、运行命令
|
||||||
|
|
||||||
|
### 开发运行
|
||||||
|
```bash
|
||||||
|
# 开发模式运行 (需要先启动开发服务器)
|
||||||
|
# 终端 1: 启动前端开发服务器
|
||||||
|
bun run dev
|
||||||
|
|
||||||
|
# 终端 2: 启动 Tauri 应用
|
||||||
|
tauri dev
|
||||||
|
|
||||||
|
# 或者使用单命令并行启动(需要配置 package.json)
|
||||||
|
bun run dev:tauri
|
||||||
|
```
|
||||||
|
|
||||||
|
**开发模式说明**:
|
||||||
|
- 开发模式下,Tauri 直接连接到 `localhost:3000`(不启动 sidecar 二进制)
|
||||||
|
- 需要手动运行 `bun run dev` 来启动开发服务器
|
||||||
|
- 支持热重载(HMR),无需重启 Tauri 应用
|
||||||
|
|
||||||
|
### 构建
|
||||||
|
```bash
|
||||||
|
# 开发构建 (debug mode)
|
||||||
|
cargo build
|
||||||
|
|
||||||
|
# 生产构建
|
||||||
|
cargo build --release
|
||||||
|
|
||||||
|
# Tauri 应用打包 (生成安装程序)
|
||||||
|
tauri build
|
||||||
|
```
|
||||||
|
|
||||||
|
### 代码检查
|
||||||
|
```bash
|
||||||
|
# 编译检查 (不生成二进制)
|
||||||
|
cargo check
|
||||||
|
|
||||||
|
# Clippy 代码质量检查
|
||||||
|
cargo clippy
|
||||||
|
|
||||||
|
# Clippy 严格模式 (所有警告视为错误)
|
||||||
|
cargo clippy -- -D warnings
|
||||||
|
|
||||||
|
# 代码格式化检查
|
||||||
|
cargo fmt -- --check
|
||||||
|
|
||||||
|
# 自动格式化代码
|
||||||
|
cargo fmt
|
||||||
|
```
|
||||||
|
|
||||||
|
### 测试
|
||||||
|
```bash
|
||||||
|
# 运行所有测试
|
||||||
|
cargo test
|
||||||
|
|
||||||
|
# 运行单个测试 (按名称过滤)
|
||||||
|
cargo test test_function_name
|
||||||
|
|
||||||
|
# 运行特定模块的测试
|
||||||
|
cargo test module_name::
|
||||||
|
|
||||||
|
# 显示测试输出 (包括 println!)
|
||||||
|
cargo test -- --nocapture
|
||||||
|
|
||||||
|
# 运行单个测试并显示输出
|
||||||
|
cargo test test_name -- --nocapture
|
||||||
|
```
|
||||||
|
|
||||||
|
### 清理
|
||||||
|
```bash
|
||||||
|
# 清理构建产物
|
||||||
|
cargo clean
|
||||||
|
```
|
||||||
|
|
||||||
|
## 项目结构
|
||||||
|
|
||||||
|
```
|
||||||
|
app-desktop/
|
||||||
|
├── src/
|
||||||
|
│ ├── main.rs # 入口文件 (仅调用 lib::run)
|
||||||
|
│ ├── lib.rs # 核心应用逻辑 (注册插件、命令、状态)
|
||||||
|
│ ├── commands/
|
||||||
|
│ │ └── mod.rs # 原生桌面功能命令 (文件对话框、通知等)
|
||||||
|
│ └── sidecar.rs # Sidecar 进程管理 (启动、端口扫描、清理)
|
||||||
|
├── binaries/ # Sidecar 二进制文件
|
||||||
|
│ └── app-* # Sidecar App 可执行文件 (示例: app)
|
||||||
|
├── capabilities/ # Tauri v2 权限配置
|
||||||
|
│ └── default.json
|
||||||
|
├── icons/ # 应用图标资源
|
||||||
|
├── gen/schemas/ # 自动生成的 Schema (不要手动编辑)
|
||||||
|
├── Cargo.toml # Rust 项目配置
|
||||||
|
├── tauri.conf.json # Tauri 应用配置
|
||||||
|
├── build.rs # Rust 构建脚本
|
||||||
|
└── mise.toml # 开发工具版本管理
|
||||||
|
```
|
||||||
|
|
||||||
|
## Rust 代码风格指南
|
||||||
|
|
||||||
|
### 导入 (Imports)
|
||||||
|
|
||||||
|
- 使用标准库、外部 crate、当前 crate 的顺序,用空行分隔
|
||||||
|
- 按字母顺序排列
|
||||||
|
- 优先使用具体导入而非通配符 `*`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
use std::sync::Mutex;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use tauri::Manager;
|
||||||
|
use tauri_plugin_shell::ShellExt;
|
||||||
|
use tauri_plugin_shell::process::{CommandEvent, CommandChild};
|
||||||
|
|
||||||
|
// ❌ 避免
|
||||||
|
use tauri::*;
|
||||||
|
```
|
||||||
|
|
||||||
|
### 命名规范
|
||||||
|
|
||||||
|
- **函数和变量**: `snake_case`
|
||||||
|
- **类型、结构体、枚举、Trait**: `PascalCase`
|
||||||
|
- **常量和静态变量**: `SCREAMING_SNAKE_CASE`
|
||||||
|
- **生命周期参数**: 简短小写字母,如 `'a`, `'b`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||||
|
const DEFAULT_PORT: u16 = 3000;
|
||||||
|
async fn find_available_port(start: u16) -> u16 { }
|
||||||
|
|
||||||
|
// ❌ 避免
|
||||||
|
struct sidecar_process { }
|
||||||
|
const defaultPort: u16 = 3000;
|
||||||
|
```
|
||||||
|
|
||||||
|
### 类型注解
|
||||||
|
|
||||||
|
- 函数参数必须有类型注解
|
||||||
|
- 函数返回值必须明确声明 (除非返回 `()`)
|
||||||
|
- 优先使用具体类型而非 `impl Trait` (除非必要)
|
||||||
|
- 使用 `&str` 而非 `String` 作为只读字符串参数
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
#[tauri::command]
|
||||||
|
fn greet(name: &str) -> String {
|
||||||
|
format!("Hello, {}!", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn is_port_available(port: u16) -> bool {
|
||||||
|
tokio::net::TcpListener::bind(format!("127.0.0.1:{}", port))
|
||||||
|
.await
|
||||||
|
.is_ok()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 错误处理
|
||||||
|
|
||||||
|
- 使用 `Result<T, E>` 返回可能失败的操作
|
||||||
|
- 使用 `expect()` 时提供有意义的错误消息 (中文)
|
||||||
|
- 避免 `unwrap()` 在生产代码中,除非逻辑上保证不会 panic
|
||||||
|
- 使用 `?` 操作符传播错误
|
||||||
|
- 记录关键错误信息到控制台
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
let sidecar = app_handle
|
||||||
|
.shell()
|
||||||
|
.sidecar("app")
|
||||||
|
.expect("无法找到 app sidecar");
|
||||||
|
|
||||||
|
let (mut rx, child) = sidecar.spawn().expect("启动 sidecar 失败");
|
||||||
|
|
||||||
|
// 日志记录
|
||||||
|
eprintln!("✗ Sidecar App 启动失败");
|
||||||
|
println!("✓ Sidecar App 启动成功!");
|
||||||
|
|
||||||
|
// ❌ 避免
|
||||||
|
let data = read_file().unwrap(); // 无上下文信息
|
||||||
|
```
|
||||||
|
|
||||||
|
### 异步代码
|
||||||
|
|
||||||
|
- 使用 `async/await` 而非手动创建 Future
|
||||||
|
- Tauri 内部使用 `tauri::async_runtime::spawn` 启动异步任务
|
||||||
|
- 使用 Tokio 的异步 API (如 `tokio::net::TcpListener`)
|
||||||
|
- 避免阻塞异步运行时 (使用 `tokio::task::spawn_blocking`)
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
tauri::async_runtime::spawn(async move {
|
||||||
|
let port = find_available_port(3000).await;
|
||||||
|
// ...
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### 格式化
|
||||||
|
|
||||||
|
- 使用 `cargo fmt` 自动格式化
|
||||||
|
- 缩进: 4 空格
|
||||||
|
- 行宽: 100 字符 (rustfmt 默认)
|
||||||
|
- 结构体和枚举的字段每行一个 (如果超过一定长度)
|
||||||
|
- 链式调用适当换行提高可读性
|
||||||
|
|
||||||
|
### 注释
|
||||||
|
|
||||||
|
- 使用中文注释说明复杂逻辑
|
||||||
|
- 代码块前添加简短说明注释
|
||||||
|
- 避免显而易见的注释
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// ✅ 推荐
|
||||||
|
// 全局状态:存储 Sidecar App 进程句柄
|
||||||
|
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||||
|
|
||||||
|
// 检查端口是否可用
|
||||||
|
async fn is_port_available(port: u16) -> bool { }
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tauri 特定规范
|
||||||
|
|
||||||
|
### 模块组织
|
||||||
|
|
||||||
|
- **`lib.rs`**: 主入口,负责注册插件、命令、状态管理
|
||||||
|
- **`commands/mod.rs`**: 所有 Tauri 命令集中定义,命令必须是 `pub fn`
|
||||||
|
- **`sidecar.rs`**: Sidecar 进程管理逻辑,导出公共 API(`spawn_sidecar`, `cleanup_sidecar_process`)
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// lib.rs - 模块声明
|
||||||
|
mod commands;
|
||||||
|
mod sidecar;
|
||||||
|
|
||||||
|
use sidecar::SidecarProcess;
|
||||||
|
|
||||||
|
// 注册命令时使用模块路径
|
||||||
|
.invoke_handler(tauri::generate_handler![commands::greet])
|
||||||
|
```
|
||||||
|
|
||||||
|
### 命令定义
|
||||||
|
|
||||||
|
- 使用 `#[tauri::command]` 宏标记命令
|
||||||
|
- 命令函数必须是公开的或在 `invoke_handler` 中注册
|
||||||
|
- 参数类型必须实现 `serde::Deserialize`
|
||||||
|
- 返回类型必须实现 `serde::Serialize`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
#[tauri::command]
|
||||||
|
fn greet(name: &str) -> String {
|
||||||
|
format!("Hello, {}!", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 在 Builder 中注册
|
||||||
|
.invoke_handler(tauri::generate_handler![greet])
|
||||||
|
```
|
||||||
|
|
||||||
|
### 状态管理
|
||||||
|
|
||||||
|
- 使用 `app.manage()` 注册全局状态
|
||||||
|
- 状态必须实现 `Send + Sync`
|
||||||
|
- 使用 `Mutex` 或 `RwLock` 保证线程安全
|
||||||
|
|
||||||
|
```rust
|
||||||
|
struct SidecarProcess(Mutex<Option<CommandChild>>);
|
||||||
|
|
||||||
|
// 注册状态
|
||||||
|
app.manage(SidecarProcess(Mutex::new(None)));
|
||||||
|
|
||||||
|
// 访问状态
|
||||||
|
if let Some(state) = app_handle.try_state::<SidecarProcess>() {
|
||||||
|
*state.0.lock().unwrap() = Some(child);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sidecar 进程管理
|
||||||
|
|
||||||
|
- Sidecar 二进制必须在 `tauri.conf.json` 的 `bundle.externalBin` 中声明
|
||||||
|
- 使用 `app.shell().sidecar()` 启动 sidecar
|
||||||
|
- 在应用退出时清理子进程 (监听 `RunEvent::ExitRequested`)
|
||||||
|
|
||||||
|
```rust
|
||||||
|
// 启动 sidecar
|
||||||
|
let sidecar = app_handle
|
||||||
|
.shell()
|
||||||
|
.sidecar("app")
|
||||||
|
.expect("无法找到 app sidecar")
|
||||||
|
.env("PORT", port.to_string());
|
||||||
|
|
||||||
|
// 清理进程
|
||||||
|
match event {
|
||||||
|
tauri::RunEvent::ExitRequested { .. } | tauri::RunEvent::Exit => {
|
||||||
|
if let Some(child) = process.take() {
|
||||||
|
let _ = child.kill();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ => {}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 依赖管理
|
||||||
|
|
||||||
|
- 在 `Cargo.toml` 中明确声明依赖版本
|
||||||
|
- 使用语义化版本 (如 `"2"` 表示兼容 2.x.x)
|
||||||
|
- 仅启用需要的 feature 以减少编译时间和二进制大小
|
||||||
|
|
||||||
|
```toml
|
||||||
|
tauri = { version = "2", features = [] }
|
||||||
|
tauri-plugin-opener = "2"
|
||||||
|
tauri-plugin-shell = "2"
|
||||||
|
serde = { version = "1", features = ["derive"] }
|
||||||
|
tokio = { version = "1", features = ["net"] }
|
||||||
|
```
|
||||||
|
|
||||||
|
## 开发工具
|
||||||
|
|
||||||
|
推荐安装以下 VSCode 扩展:
|
||||||
|
- `tauri-apps.tauri-vscode` - Tauri 官方支持
|
||||||
|
- `rust-lang.rust-analyzer` - Rust 语言服务器
|
||||||
|
|
||||||
|
## 最佳实践
|
||||||
|
|
||||||
|
1. **开发环境配置**:
|
||||||
|
- 开发模式下需先启动前端开发服务器(`bun run dev`),再启动 Tauri(`tauri dev`)
|
||||||
|
- 生产构建自动打包 sidecar 二进制,无需额外配置
|
||||||
|
2. **进程生命周期**: 始终在应用退出时清理子进程和资源
|
||||||
|
3. **端口管理**:
|
||||||
|
- 开发模式固定使用 3000 端口(与开发服务器匹配)
|
||||||
|
- 生产模式使用端口扫描避免硬编码端口冲突
|
||||||
|
4. **超时处理**: 异步操作设置合理的超时时间 (如 5 秒)
|
||||||
|
5. **日志**: 使用表情符号 (✓/✗/🔧/🚀) 和中文消息提供清晰的状态反馈
|
||||||
|
6. **错误退出**: 关键错误时调用 `std::process::exit(1)`
|
||||||
|
7. **窗口配置**: 使用 `WebviewWindowBuilder` 动态创建窗口
|
||||||
|
|
||||||
|
## 提交代码前检查清单
|
||||||
|
|
||||||
|
- [ ] `cargo fmt` 格式化通过
|
||||||
|
- [ ] `cargo clippy` 无警告
|
||||||
|
- [ ] `cargo check` 编译通过
|
||||||
|
- [ ] `cargo test` 测试通过
|
||||||
|
- [ ] 更新相关注释和文档
|
||||||
|
- [ ] 检查是否有 `unwrap()` 需要替换为 `expect()`
|
||||||
|
- [ ] 验证 Tauri 应用正常启动和退出
|
||||||
4753
src-tauri/Cargo.lock
generated
Normal file
24
src-tauri/Cargo.toml
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
[package]
|
||||||
|
name = "app-desktop"
|
||||||
|
version = "0.1.0"
|
||||||
|
description = "A Tauri App"
|
||||||
|
authors = ["imbytecat"]
|
||||||
|
edition = "2021"
|
||||||
|
|
||||||
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
|
[lib]
|
||||||
|
# The `_lib` suffix may seem redundant but it is necessary
|
||||||
|
# to make the lib name unique and wouldn't conflict with the bin name.
|
||||||
|
# This seems to be only an issue on Windows, see https://github.com/rust-lang/cargo/issues/8519
|
||||||
|
name = "app_desktop_lib"
|
||||||
|
crate-type = ["staticlib", "cdylib", "rlib"]
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
tauri-build = { version = "2", features = [] }
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
tauri = { version = "2", features = [] }
|
||||||
|
tauri-plugin-shell = "2"
|
||||||
|
serde = { version = "1", features = ["derive"] }
|
||||||
|
tokio = { version = "1", features = ["net"] }
|
||||||
3
src-tauri/build.rs
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
fn main() {
|
||||||
|
tauri_build::build()
|
||||||
|
}
|
||||||
27
src-tauri/capabilities/default.json
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"$schema": "../gen/schemas/desktop-schema.json",
|
||||||
|
"identifier": "default",
|
||||||
|
"description": "Capability for the main window",
|
||||||
|
"windows": ["main"],
|
||||||
|
"local": true,
|
||||||
|
"remote": {
|
||||||
|
"urls": [
|
||||||
|
"http://localhost:*",
|
||||||
|
"http://127.0.0.1:*",
|
||||||
|
"http{s}?://localhost(:\\d+)?/*"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"permissions": [
|
||||||
|
"core:default",
|
||||||
|
"core:window:allow-set-title",
|
||||||
|
{
|
||||||
|
"identifier": "shell:allow-execute",
|
||||||
|
"allow": [
|
||||||
|
{
|
||||||
|
"name": "binaries/app",
|
||||||
|
"sidecar": true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
BIN
src-tauri/icons/128x128.png
Normal file
|
After Width: | Height: | Size: 3.4 KiB |
BIN
src-tauri/icons/128x128@2x.png
Normal file
|
After Width: | Height: | Size: 6.8 KiB |
BIN
src-tauri/icons/32x32.png
Normal file
|
After Width: | Height: | Size: 974 B |
BIN
src-tauri/icons/Square107x107Logo.png
Normal file
|
After Width: | Height: | Size: 2.8 KiB |
BIN
src-tauri/icons/Square142x142Logo.png
Normal file
|
After Width: | Height: | Size: 3.8 KiB |
BIN
src-tauri/icons/Square150x150Logo.png
Normal file
|
After Width: | Height: | Size: 3.9 KiB |
BIN
src-tauri/icons/Square284x284Logo.png
Normal file
|
After Width: | Height: | Size: 7.6 KiB |
BIN
src-tauri/icons/Square30x30Logo.png
Normal file
|
After Width: | Height: | Size: 903 B |
BIN
src-tauri/icons/Square310x310Logo.png
Normal file
|
After Width: | Height: | Size: 8.4 KiB |
BIN
src-tauri/icons/Square44x44Logo.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
BIN
src-tauri/icons/Square71x71Logo.png
Normal file
|
After Width: | Height: | Size: 2.0 KiB |
BIN
src-tauri/icons/Square89x89Logo.png
Normal file
|
After Width: | Height: | Size: 2.4 KiB |
BIN
src-tauri/icons/StoreLogo.png
Normal file
|
After Width: | Height: | Size: 1.5 KiB |
BIN
src-tauri/icons/icon.icns
Normal file
BIN
src-tauri/icons/icon.ico
Normal file
|
After Width: | Height: | Size: 85 KiB |
BIN
src-tauri/icons/icon.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
8
src-tauri/src/commands/mod.rs
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
// 原生桌面功能命令
|
||||||
|
// 未来可能包含: 文件对话框、系统通知、剪贴板等
|
||||||
|
|
||||||
|
// 示例命令 (可根据需要删除或替换)
|
||||||
|
#[tauri::command]
|
||||||
|
pub fn greet(name: &str) -> String {
|
||||||
|
format!("Hello, {}! You've been greeted from Rust!", name)
|
||||||
|
}
|
||||||
33
src-tauri/src/lib.rs
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
use tauri::Manager;
|
||||||
|
|
||||||
|
// 模块声明
|
||||||
|
mod commands;
|
||||||
|
mod sidecar;
|
||||||
|
|
||||||
|
use sidecar::SidecarProcess;
|
||||||
|
|
||||||
|
#[cfg_attr(mobile, tauri::mobile_entry_point)]
|
||||||
|
pub fn run() {
|
||||||
|
tauri::Builder::default()
|
||||||
|
.plugin(tauri_plugin_shell::init())
|
||||||
|
.setup(|app| {
|
||||||
|
// 注册全局状态
|
||||||
|
app.manage(SidecarProcess(std::sync::Mutex::new(None)));
|
||||||
|
|
||||||
|
// 启动 Sidecar 进程
|
||||||
|
let app_handle = app.handle().clone();
|
||||||
|
sidecar::spawn_sidecar(app_handle);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
})
|
||||||
|
.invoke_handler(tauri::generate_handler![commands::greet])
|
||||||
|
.build(tauri::generate_context!())
|
||||||
|
.expect("error while building tauri application")
|
||||||
|
.run(|app_handle, event| {
|
||||||
|
// 监听应用退出事件,清理 Sidecar 进程
|
||||||
|
if let tauri::RunEvent::Exit = event {
|
||||||
|
// 只在 Exit 事件时清理,避免重复执行
|
||||||
|
sidecar::cleanup_sidecar_process(app_handle);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
6
src-tauri/src/main.rs
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
// Prevents additional console window on Windows in release, DO NOT REMOVE!!
|
||||||
|
#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
app_desktop_lib::run()
|
||||||
|
}
|
||||||
166
src-tauri/src/sidecar.rs
Normal file
@@ -0,0 +1,166 @@
|
|||||||
|
use std::sync::Mutex;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use tauri::Manager;
|
||||||
|
use tauri_plugin_shell::process::{CommandChild, CommandEvent};
|
||||||
|
use tauri_plugin_shell::ShellExt;
|
||||||
|
|
||||||
|
// ===== 配置常量 =====
|
||||||
|
|
||||||
|
/// Sidecar App 启动超时时间(秒)
|
||||||
|
const STARTUP_TIMEOUT_SECS: u64 = 5;
|
||||||
|
|
||||||
|
/// 默认起始端口
|
||||||
|
const DEFAULT_PORT: u16 = 3000;
|
||||||
|
|
||||||
|
/// 端口扫描范围(从起始端口开始扫描的端口数量)
|
||||||
|
const PORT_SCAN_RANGE: u16 = 100;
|
||||||
|
|
||||||
|
/// 窗口默认宽度
|
||||||
|
const DEFAULT_WINDOW_WIDTH: f64 = 1200.0;
|
||||||
|
|
||||||
|
/// 窗口默认高度
|
||||||
|
const DEFAULT_WINDOW_HEIGHT: f64 = 800.0;
|
||||||
|
|
||||||
|
/// 窗口标题
|
||||||
|
const WINDOW_TITLE: &str = "Tauri App";
|
||||||
|
|
||||||
|
// ===== 数据结构 =====
|
||||||
|
|
||||||
|
/// 全局状态:存储 Sidecar 进程句柄
|
||||||
|
pub struct SidecarProcess(pub Mutex<Option<CommandChild>>);
|
||||||
|
|
||||||
|
// 检查端口是否可用(未被占用)
|
||||||
|
async fn is_port_available(port: u16) -> bool {
|
||||||
|
tokio::net::TcpListener::bind(format!("127.0.0.1:{}", port))
|
||||||
|
.await
|
||||||
|
.is_ok()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 查找可用端口
|
||||||
|
async fn find_available_port(start: u16) -> u16 {
|
||||||
|
for port in start..start + PORT_SCAN_RANGE {
|
||||||
|
if is_port_available(port).await {
|
||||||
|
return port;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
start // 回退到起始端口
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 启动 Sidecar 进程并创建主窗口
|
||||||
|
pub fn spawn_sidecar(app_handle: tauri::AppHandle) {
|
||||||
|
// 检测是否为开发模式
|
||||||
|
let is_dev = cfg!(debug_assertions);
|
||||||
|
|
||||||
|
if is_dev {
|
||||||
|
// 开发模式:直接创建窗口连接到 Vite 开发服务器
|
||||||
|
println!("🔧 开发模式");
|
||||||
|
|
||||||
|
match tauri::WebviewWindowBuilder::new(
|
||||||
|
&app_handle,
|
||||||
|
"main",
|
||||||
|
tauri::WebviewUrl::External("http://localhost:3000".parse().unwrap()),
|
||||||
|
)
|
||||||
|
.title(WINDOW_TITLE)
|
||||||
|
.inner_size(DEFAULT_WINDOW_WIDTH, DEFAULT_WINDOW_HEIGHT)
|
||||||
|
.center()
|
||||||
|
.build()
|
||||||
|
{
|
||||||
|
Ok(_) => println!("✓ 开发窗口创建成功"),
|
||||||
|
Err(e) => {
|
||||||
|
eprintln!("✗ 窗口创建失败: {}", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 生产模式:启动 sidecar 二进制
|
||||||
|
tauri::async_runtime::spawn(async move {
|
||||||
|
println!("🚀 生产模式");
|
||||||
|
|
||||||
|
// 查找可用端口
|
||||||
|
let port = find_available_port(DEFAULT_PORT).await;
|
||||||
|
println!("使用端口: {}", port);
|
||||||
|
|
||||||
|
// 启动 sidecar
|
||||||
|
let sidecar = app_handle
|
||||||
|
.shell()
|
||||||
|
.sidecar("app")
|
||||||
|
.expect("无法找到 app")
|
||||||
|
.env("PORT", port.to_string());
|
||||||
|
|
||||||
|
let (mut rx, child) = sidecar.spawn().expect("启动 sidecar 失败");
|
||||||
|
|
||||||
|
// 保存进程句柄到全局状态
|
||||||
|
if let Some(state) = app_handle.try_state::<SidecarProcess>() {
|
||||||
|
*state.0.lock().unwrap() = Some(child);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 监听 stdout,等待服务器就绪信号
|
||||||
|
let start_time = std::time::Instant::now();
|
||||||
|
let timeout = Duration::from_secs(STARTUP_TIMEOUT_SECS);
|
||||||
|
let mut app_ready = false;
|
||||||
|
|
||||||
|
while let Some(event) = rx.recv().await {
|
||||||
|
if let CommandEvent::Stdout(line) = event {
|
||||||
|
let output = String::from_utf8_lossy(&line);
|
||||||
|
println!("App: {}", output);
|
||||||
|
|
||||||
|
// 检测 App 启动成功的标志
|
||||||
|
if output.contains("Listening on:") || output.contains("localhost") {
|
||||||
|
app_ready = true;
|
||||||
|
println!("✓ App 启动成功!");
|
||||||
|
|
||||||
|
// 创建主窗口
|
||||||
|
let url = format!("http://localhost:{}", port);
|
||||||
|
tauri::WebviewWindowBuilder::new(
|
||||||
|
&app_handle,
|
||||||
|
"main",
|
||||||
|
tauri::WebviewUrl::External(url.parse().unwrap()),
|
||||||
|
)
|
||||||
|
.title(WINDOW_TITLE)
|
||||||
|
.inner_size(DEFAULT_WINDOW_WIDTH, DEFAULT_WINDOW_HEIGHT)
|
||||||
|
.center()
|
||||||
|
.build()
|
||||||
|
.expect("创建窗口失败");
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 超时检查
|
||||||
|
if start_time.elapsed() > timeout {
|
||||||
|
eprintln!("✗ 启动超时: App 未能在 {} 秒内启动", STARTUP_TIMEOUT_SECS);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !app_ready {
|
||||||
|
eprintln!("✗ App 启动失败");
|
||||||
|
std::process::exit(1);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 清理 Sidecar 进程 (在应用退出时调用)
|
||||||
|
pub fn cleanup_sidecar_process(app_handle: &tauri::AppHandle) {
|
||||||
|
let is_dev = cfg!(debug_assertions);
|
||||||
|
|
||||||
|
if is_dev {
|
||||||
|
// 开发模式:退出时发送异常信号(exit 1),让 Turbo 停止 Vite 服务器
|
||||||
|
println!("🔧 开发模式退出,终止所有依赖任务...");
|
||||||
|
std::process::exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 生产模式:正常清理 sidecar 进程
|
||||||
|
println!("应用退出,正在清理 Sidecar 进程...");
|
||||||
|
if let Some(state) = app_handle.try_state::<SidecarProcess>() {
|
||||||
|
if let Ok(mut process) = state.0.lock() {
|
||||||
|
if let Some(child) = process.take() {
|
||||||
|
let _ = child.kill();
|
||||||
|
println!("✓ Sidecar 进程已终止");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
25
src-tauri/tauri.conf.json
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://schema.tauri.app/config/2",
|
||||||
|
"productName": "app-desktop",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"identifier": "com.imbytecat.app-desktop",
|
||||||
|
"app": {
|
||||||
|
"withGlobalTauri": true,
|
||||||
|
"windows": [],
|
||||||
|
"security": {
|
||||||
|
"csp": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"bundle": {
|
||||||
|
"active": true,
|
||||||
|
"targets": "all",
|
||||||
|
"icon": [
|
||||||
|
"icons/32x32.png",
|
||||||
|
"icons/128x128.png",
|
||||||
|
"icons/128x128@2x.png",
|
||||||
|
"icons/icon.icns",
|
||||||
|
"icons/icon.ico"
|
||||||
|
],
|
||||||
|
"externalBin": ["binaries/app"]
|
||||||
|
}
|
||||||
|
}
|
||||||
13
src/db/index.ts
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
import { drizzle } from 'drizzle-orm/postgres-js'
|
||||||
|
import * as schema from '@/db/schema'
|
||||||
|
import { env } from '@/env'
|
||||||
|
|
||||||
|
export function createDb() {
|
||||||
|
return drizzle({
|
||||||
|
connection: {
|
||||||
|
url: env.DATABASE_URL,
|
||||||
|
prepare: true,
|
||||||
|
},
|
||||||
|
schema,
|
||||||
|
})
|
||||||
|
}
|
||||||
15
src/db/schema/todo.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { sql } from 'drizzle-orm'
|
||||||
|
import { boolean, pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
|
||||||
|
|
||||||
|
export const todoTable = pgTable('todo', {
|
||||||
|
id: uuid('id').primaryKey().default(sql`uuidv7()`),
|
||||||
|
title: text('title').notNull(),
|
||||||
|
completed: boolean('completed').notNull().default(false),
|
||||||
|
createdAt: timestamp('created_at', { withTimezone: true })
|
||||||
|
.notNull()
|
||||||
|
.defaultNow(),
|
||||||
|
updatedAt: timestamp('updated_at', { withTimezone: true })
|
||||||
|
.notNull()
|
||||||
|
.defaultNow()
|
||||||
|
.$onUpdateFn(() => new Date()),
|
||||||
|
})
|
||||||
7
src/integrations/tanstack-query/devtools.tsx
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
import type { TanStackDevtoolsReactPlugin } from '@tanstack/react-devtools'
|
||||||
|
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
|
||||||
|
|
||||||
|
export const devtools = {
|
||||||
|
name: 'TanStack Query',
|
||||||
|
render: <ReactQueryDevtoolsPanel />,
|
||||||
|
} satisfies TanStackDevtoolsReactPlugin
|
||||||
1
src/integrations/tanstack-query/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export * from './devtools'
|
||||||
7
src/integrations/tanstack-router/devtools.tsx
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
import type { TanStackDevtoolsReactPlugin } from '@tanstack/react-devtools'
|
||||||
|
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
|
||||||
|
|
||||||
|
export const devtools = {
|
||||||
|
name: 'TanStack Router',
|
||||||
|
render: <TanStackRouterDevtoolsPanel />,
|
||||||
|
} satisfies TanStackDevtoolsReactPlugin
|
||||||
1
src/integrations/tanstack-router/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export * from './devtools'
|
||||||
0
src/lib/utils.ts
Normal file
@@ -4,8 +4,8 @@ import { createRouterClient } from '@orpc/server'
|
|||||||
import { createTanstackQueryUtils } from '@orpc/tanstack-query'
|
import { createTanstackQueryUtils } from '@orpc/tanstack-query'
|
||||||
import { createIsomorphicFn } from '@tanstack/react-start'
|
import { createIsomorphicFn } from '@tanstack/react-start'
|
||||||
import { getRequestHeaders } from '@tanstack/react-start/server'
|
import { getRequestHeaders } from '@tanstack/react-start/server'
|
||||||
import { router } from '@/server/api/routers'
|
import { router } from './router'
|
||||||
import type { RouterClient } from '@/server/api/types'
|
import type { RouterClient } from './types'
|
||||||
|
|
||||||
const getORPCClient = createIsomorphicFn()
|
const getORPCClient = createIsomorphicFn()
|
||||||
.server(() =>
|
.server(() =>
|
||||||
5
src/orpc/contract.ts
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
import * as todo from './contracts/todo'
|
||||||
|
|
||||||
|
export const contract = {
|
||||||
|
todo,
|
||||||
|
}
|
||||||
@@ -1,14 +1,25 @@
|
|||||||
import { oc } from '@orpc/contract'
|
import { oc } from '@orpc/contract'
|
||||||
import { createInsertSchema, createSelectSchema, createUpdateSchema } from 'drizzle-orm/zod'
|
import {
|
||||||
|
createInsertSchema,
|
||||||
|
createSelectSchema,
|
||||||
|
createUpdateSchema,
|
||||||
|
} from 'drizzle-zod'
|
||||||
import { z } from 'zod'
|
import { z } from 'zod'
|
||||||
import { generatedFieldKeys } from '@/server/db/fields'
|
import { todoTable } from '@/db/schema'
|
||||||
import { todoTable } from '@/server/db/schema'
|
|
||||||
|
|
||||||
const selectSchema = createSelectSchema(todoTable)
|
const selectSchema = createSelectSchema(todoTable)
|
||||||
|
|
||||||
const insertSchema = createInsertSchema(todoTable).omit(generatedFieldKeys)
|
const insertSchema = createInsertSchema(todoTable).omit({
|
||||||
|
id: true,
|
||||||
|
createdAt: true,
|
||||||
|
updatedAt: true,
|
||||||
|
})
|
||||||
|
|
||||||
const updateSchema = createUpdateSchema(todoTable).omit(generatedFieldKeys)
|
const updateSchema = createUpdateSchema(todoTable).omit({
|
||||||
|
id: true,
|
||||||
|
createdAt: true,
|
||||||
|
updatedAt: true,
|
||||||
|
})
|
||||||
|
|
||||||
export const list = oc.input(z.void()).output(z.array(selectSchema))
|
export const list = oc.input(z.void()).output(z.array(selectSchema))
|
||||||
|
|
||||||
48
src/orpc/handlers/todo.ts
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
import { ORPCError } from '@orpc/server'
|
||||||
|
import { eq } from 'drizzle-orm'
|
||||||
|
import { todoTable } from '@/db/schema'
|
||||||
|
import { baseProcedure } from '@/orpc/procedures'
|
||||||
|
|
||||||
|
export const list = baseProcedure.todo.list.handler(async ({ context }) => {
|
||||||
|
const todos = await context.db.query.todoTable.findMany({
|
||||||
|
orderBy: (todos, { desc }) => [desc(todos.createdAt)],
|
||||||
|
})
|
||||||
|
return todos
|
||||||
|
})
|
||||||
|
|
||||||
|
export const create = baseProcedure.todo.create.handler(
|
||||||
|
async ({ context, input }) => {
|
||||||
|
const [newTodo] = await context.db
|
||||||
|
.insert(todoTable)
|
||||||
|
.values(input)
|
||||||
|
.returning()
|
||||||
|
|
||||||
|
if (!newTodo) {
|
||||||
|
throw new ORPCError('NOT_FOUND')
|
||||||
|
}
|
||||||
|
|
||||||
|
return newTodo
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
export const update = baseProcedure.todo.update.handler(
|
||||||
|
async ({ context, input }) => {
|
||||||
|
const [updatedTodo] = await context.db
|
||||||
|
.update(todoTable)
|
||||||
|
.set(input.data)
|
||||||
|
.where(eq(todoTable.id, input.id))
|
||||||
|
.returning()
|
||||||
|
|
||||||
|
if (!updatedTodo) {
|
||||||
|
throw new ORPCError('NOT_FOUND')
|
||||||
|
}
|
||||||
|
|
||||||
|
return updatedTodo
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
export const remove = baseProcedure.todo.remove.handler(
|
||||||
|
async ({ context, input }) => {
|
||||||
|
await context.db.delete(todoTable).where(eq(todoTable.id, input.id))
|
||||||
|
},
|
||||||
|
)
|
||||||