Compare commits
41 Commits
backup/ux
...
8c0ea632d7
| Author | SHA1 | Date | |
|---|---|---|---|
| 8c0ea632d7 | |||
| db23ee42fc | |||
| 0784546e50 | |||
| 2fe3e15659 | |||
| ed02993350 | |||
| e4e5ff2211 | |||
| d69a573a33 | |||
| 6cc1bc6834 | |||
| 894fd17d1a | |||
| 888f20fdab | |||
| 7318600e20 | |||
| e8e473b357 | |||
| 41d97ca312 | |||
| cfe7de2a70 | |||
| b87de26e17 | |||
| b8d38872ad | |||
| 7450c685d3 | |||
| 2048f73155 | |||
| 70b5d27493 | |||
| 5d5d3a51f6 | |||
| 3306e18395 | |||
| 14bcdb33af | |||
| cc81d95178 | |||
| 55d45e6a49 | |||
| b7a6a793a3 | |||
| 6b12745e50 | |||
| 989d8973f5 | |||
| 41e79449ce | |||
| 4bbb0c4a16 | |||
| 2b3026cf69 | |||
| adb14cff77 | |||
| 44ca7a0f5e | |||
| 59b4edc2d2 | |||
| 9d0e9a6aac | |||
| f758fd5947 | |||
| 26f9421130 | |||
| 29969550ed | |||
| 9aa3b46ee5 | |||
| f3ea0f0789 | |||
| bde325d9ae | |||
| e41c4e4515 |
183
AGENTS.md
Normal file
@@ -0,0 +1,183 @@
|
|||||||
|
# AGENTS.md - AI Coding Agent Guidelines
|
||||||
|
|
||||||
|
Guidelines for AI agents working in this Bun monorepo.
|
||||||
|
|
||||||
|
## 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` / `bun <script>` for scripts. Never use `npm`, `npx`, or `node`.**
|
||||||
|
|
||||||
|
- **Monorepo**: Bun workspaces + Turborepo orchestration
|
||||||
|
- **Runtime**: Bun (see `mise.toml` for version) — **NOT Node.js**
|
||||||
|
- **Package Manager**: Bun — **NOT npm / yarn / pnpm**
|
||||||
|
- **Apps**:
|
||||||
|
- `apps/server` - TanStack Start fullstack web app (see `apps/server/AGENTS.md`)
|
||||||
|
- `apps/desktop` - Electron desktop shell, sidecar server pattern (see `apps/desktop/AGENTS.md`)
|
||||||
|
- **Packages**: `packages/utils`, `packages/tsconfig` (shared configs)
|
||||||
|
|
||||||
|
## Build / Lint / Test Commands
|
||||||
|
|
||||||
|
### Root Commands (via Turbo)
|
||||||
|
```bash
|
||||||
|
bun dev # Start all apps in dev mode
|
||||||
|
bun build # Build all apps
|
||||||
|
bun fix # Lint + format (Biome auto-fix)
|
||||||
|
bun typecheck # TypeScript check across monorepo
|
||||||
|
```
|
||||||
|
|
||||||
|
### Server App (`apps/server`)
|
||||||
|
```bash
|
||||||
|
bun dev # Vite dev server (localhost:3000)
|
||||||
|
bun build # Production build -> .output/
|
||||||
|
bun compile # Compile to standalone binary
|
||||||
|
bun fix # Biome auto-fix
|
||||||
|
bun typecheck # TypeScript check
|
||||||
|
|
||||||
|
# Database (Drizzle)
|
||||||
|
bun db:generate # Generate migrations from schema
|
||||||
|
bun db:migrate # Run migrations
|
||||||
|
bun db:push # Push schema (dev only)
|
||||||
|
bun db:studio # Open Drizzle Studio
|
||||||
|
```
|
||||||
|
|
||||||
|
### Desktop App (`apps/desktop`)
|
||||||
|
```bash
|
||||||
|
bun dev # electron-vite dev mode (requires server dev running)
|
||||||
|
bun build # electron-vite build (main + preload)
|
||||||
|
bun build:win # Build + package for Windows
|
||||||
|
bun build:mac # Build + package for macOS
|
||||||
|
bun build:linux # Build + package for Linux
|
||||||
|
bun fix # Biome auto-fix
|
||||||
|
bun 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
|
||||||
|
Biome auto-organizes. Order: 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 Strictness
|
||||||
|
- `strict: true`, `noUncheckedIndexedAccess: true`, `noImplicitOverride: true`, `verbatimModuleSyntax: true`
|
||||||
|
- Use `@/*` path aliases (maps to `src/*`)
|
||||||
|
|
||||||
|
### Naming Conventions
|
||||||
|
| Type | Convention | Example |
|
||||||
|
|------|------------|---------|
|
||||||
|
| Files (utils) | kebab-case | `auth-utils.ts` |
|
||||||
|
| Files (components) | PascalCase | `UserProfile.tsx` |
|
||||||
|
| Components | PascalCase arrow | `const Button = () => {}` |
|
||||||
|
| Functions | camelCase | `getUserById` |
|
||||||
|
| Constants | UPPER_SNAKE | `MAX_RETRIES` |
|
||||||
|
| Types/Interfaces | PascalCase | `UserProfile` |
|
||||||
|
|
||||||
|
### 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)
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
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()),
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment Variables
|
||||||
|
|
||||||
|
- Use `@t3-oss/env-core` with Zod validation in `src/env.ts`
|
||||||
|
- Server vars: no prefix | Client vars: `VITE_` prefix required
|
||||||
|
- Never commit `.env` files
|
||||||
|
|
||||||
|
## Dependency Management
|
||||||
|
|
||||||
|
- All versions centralized in root `package.json` `catalog` field
|
||||||
|
- Workspace packages use `"catalog:"` — never hardcode versions
|
||||||
|
- Internal packages use `"workspace:*"` references
|
||||||
|
|
||||||
|
## Critical Rules
|
||||||
|
|
||||||
|
**DO:**
|
||||||
|
- Run `bun fix` before committing
|
||||||
|
- Use `@/*` path aliases (not relative imports)
|
||||||
|
- Include `createdAt`/`updatedAt` on all tables
|
||||||
|
- Use `catalog:` for dependency versions
|
||||||
|
|
||||||
|
**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
|
||||||
|
|
||||||
|
## Git Workflow
|
||||||
|
|
||||||
|
1. Make changes following style guide
|
||||||
|
2. `bun fix` - auto-format and lint
|
||||||
|
3. `bun typecheck` - verify types
|
||||||
|
4. `bun dev` - test locally
|
||||||
|
5. Commit with descriptive message
|
||||||
|
|
||||||
|
## Directory Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── apps/
|
||||||
|
│ ├── server/ # TanStack Start fullstack app
|
||||||
|
│ │ ├── src/
|
||||||
|
│ │ │ ├── client/ # ORPC client, Query client
|
||||||
|
│ │ │ ├── components/
|
||||||
|
│ │ │ ├── routes/ # File-based routing
|
||||||
|
│ │ │ └── server/ # API layer + database
|
||||||
|
│ │ │ ├── api/ # ORPC contracts, routers, middlewares
|
||||||
|
│ │ │ └── db/ # Drizzle schema
|
||||||
|
│ │ └── AGENTS.md
|
||||||
|
│ └── desktop/ # Electron desktop shell
|
||||||
|
│ ├── src/
|
||||||
|
│ │ ├── main/
|
||||||
|
│ │ │ └── index.ts # Main process entry
|
||||||
|
│ │ └── preload/
|
||||||
|
│ │ └── index.ts # Preload script
|
||||||
|
│ ├── electron.vite.config.ts
|
||||||
|
│ ├── electron-builder.yml # Packaging config
|
||||||
|
│ └── AGENTS.md
|
||||||
|
├── packages/
|
||||||
|
│ ├── tsconfig/ # Shared TS configs
|
||||||
|
│ └── utils/ # Shared utilities
|
||||||
|
├── biome.json # Linting/formatting config
|
||||||
|
├── turbo.json # Turbo task orchestration
|
||||||
|
└── package.json # Workspace root + dependency catalog
|
||||||
|
```
|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
- `apps/server/AGENTS.md` - Detailed TanStack Start / ORPC patterns
|
||||||
|
- `apps/desktop/AGENTS.md` - Electron desktop development guide
|
||||||
29
apps/desktop/.gitignore
vendored
@@ -1,24 +1,7 @@
|
|||||||
# Logs
|
# Electron-vite build output
|
||||||
logs
|
out/
|
||||||
*.log
|
dist/
|
||||||
npm-debug.log*
|
|
||||||
yarn-debug.log*
|
|
||||||
yarn-error.log*
|
|
||||||
pnpm-debug.log*
|
|
||||||
lerna-debug.log*
|
|
||||||
|
|
||||||
node_modules
|
# Sidecar binary (copied from apps/server build)
|
||||||
dist
|
resources/server
|
||||||
dist-ssr
|
resources/server.exe
|
||||||
*.local
|
|
||||||
|
|
||||||
# Editor directories and files
|
|
||||||
.vscode/*
|
|
||||||
!.vscode/extensions.json
|
|
||||||
.idea
|
|
||||||
.DS_Store
|
|
||||||
*.suo
|
|
||||||
*.ntvs*
|
|
||||||
*.njsproj
|
|
||||||
*.sln
|
|
||||||
*.sw?
|
|
||||||
|
|||||||
75
apps/desktop/AGENTS.md
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
# 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). 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 dev # electron-vite dev (requires server dev running)
|
||||||
|
bun build # electron-vite build (main + preload)
|
||||||
|
bun build:win # Build + package for Windows
|
||||||
|
bun build:mac # Build + package for macOS
|
||||||
|
bun build:linux # Build + package for Linux
|
||||||
|
bun fix # Biome auto-fix
|
||||||
|
bun 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 dev` in `apps/server` (or use root `bun dev` via Turbo).
|
||||||
|
2. **Start desktop**: `bun dev` in `apps/desktop`.
|
||||||
|
3. **Connection**: Main process polls `localhost:3000` until responsive, then opens BrowserWindow.
|
||||||
|
|
||||||
|
## Production Build Workflow
|
||||||
|
|
||||||
|
1. **Build server**: `bun build` in `apps/server` → `.output/`
|
||||||
|
2. **Compile server**: `bun compile` in `apps/server` → `out/server-{platform}`
|
||||||
|
3. **Copy binary**: Copy the platform-appropriate binary to `apps/desktop/resources/server`
|
||||||
|
4. **Package desktop**: `bun build:linux` (or `:mac` / `:win`) in `apps/desktop`
|
||||||
|
|
||||||
|
## 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`.
|
||||||
9
apps/desktop/biome.json
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"$schema": "../../node_modules/@biomejs/biome/configuration_schema.json",
|
||||||
|
"extends": "//",
|
||||||
|
"css": {
|
||||||
|
"parser": {
|
||||||
|
"tailwindDirectives": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,470 +0,0 @@
|
|||||||
import * as path from 'node:path'
|
|
||||||
import { Schema } from '@effect/schema'
|
|
||||||
import { $ } from 'bun'
|
|
||||||
import { Console, Context, Data, Effect, Layer } from 'effect'
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// Domain Models & Schema
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Bun 构建目标后缀
|
|
||||||
*/
|
|
||||||
const BunTargetSuffixSchema = Schema.Literal(
|
|
||||||
'windows-x64',
|
|
||||||
'darwin-arm64',
|
|
||||||
'darwin-x64',
|
|
||||||
'linux-x64',
|
|
||||||
'linux-arm64',
|
|
||||||
)
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Tauri sidecar 目标三元组
|
|
||||||
*/
|
|
||||||
const TauriTargetSchema = Schema.Literal(
|
|
||||||
'x86_64-pc-windows-msvc',
|
|
||||||
'aarch64-apple-darwin',
|
|
||||||
'x86_64-apple-darwin',
|
|
||||||
'x86_64-unknown-linux-gnu',
|
|
||||||
'aarch64-unknown-linux-gnu',
|
|
||||||
)
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 目标映射配置
|
|
||||||
*/
|
|
||||||
const TargetMappingSchema = Schema.Struct({
|
|
||||||
bunSuffix: BunTargetSuffixSchema,
|
|
||||||
tauriTarget: TauriTargetSchema,
|
|
||||||
})
|
|
||||||
|
|
||||||
type TargetMapping = Schema.Schema.Type<typeof TargetMappingSchema>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 复制配置
|
|
||||||
*/
|
|
||||||
const CopyConfigSchema = Schema.Struct({
|
|
||||||
sourceDir: Schema.String.pipe(Schema.nonEmptyString()),
|
|
||||||
targetDir: Schema.String.pipe(Schema.nonEmptyString()),
|
|
||||||
baseName: Schema.String.pipe(Schema.nonEmptyString()),
|
|
||||||
mappings: Schema.Array(TargetMappingSchema).pipe(Schema.minItems(1)),
|
|
||||||
})
|
|
||||||
|
|
||||||
type CopyConfig = Schema.Schema.Type<typeof CopyConfigSchema>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 复制结果
|
|
||||||
*/
|
|
||||||
const CopyResultSchema = Schema.Struct({
|
|
||||||
bunSuffix: BunTargetSuffixSchema,
|
|
||||||
tauriTarget: TauriTargetSchema,
|
|
||||||
sourceFile: Schema.String,
|
|
||||||
targetFile: Schema.String,
|
|
||||||
success: Schema.Boolean,
|
|
||||||
})
|
|
||||||
|
|
||||||
type CopyResult = Schema.Schema.Type<typeof CopyResultSchema>
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// Error Models
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
class ConfigError extends Data.TaggedError('ConfigError')<{
|
|
||||||
readonly message: string
|
|
||||||
readonly cause: unknown
|
|
||||||
}> {}
|
|
||||||
|
|
||||||
class FileSystemError extends Data.TaggedError('FileSystemError')<{
|
|
||||||
readonly operation: string
|
|
||||||
readonly path: string
|
|
||||||
readonly cause: unknown
|
|
||||||
}> {}
|
|
||||||
|
|
||||||
class CopyError extends Data.TaggedError('CopyError')<{
|
|
||||||
readonly source: string
|
|
||||||
readonly target: string
|
|
||||||
readonly cause: unknown
|
|
||||||
}> {}
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// Services
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 配置服务
|
|
||||||
*/
|
|
||||||
class CopyConfigService extends Context.Tag('CopyConfigService')<
|
|
||||||
CopyConfigService,
|
|
||||||
CopyConfig
|
|
||||||
>() {
|
|
||||||
/**
|
|
||||||
* 从原始数据创建并验证配置
|
|
||||||
*/
|
|
||||||
static fromRaw = (raw: unknown) =>
|
|
||||||
Effect.gen(function* () {
|
|
||||||
const decoded = yield* Schema.decodeUnknown(CopyConfigSchema)(raw)
|
|
||||||
return decoded
|
|
||||||
}).pipe(
|
|
||||||
Effect.catchAll((error) =>
|
|
||||||
Effect.fail(
|
|
||||||
new ConfigError({
|
|
||||||
message: '配置验证失败',
|
|
||||||
cause: error,
|
|
||||||
}),
|
|
||||||
),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 默认配置 Layer
|
|
||||||
*/
|
|
||||||
static readonly Live = Layer.effect(
|
|
||||||
CopyConfigService,
|
|
||||||
CopyConfigService.fromRaw({
|
|
||||||
sourceDir: path.join(__dirname, '..', 'server', 'out'),
|
|
||||||
targetDir: path.join(__dirname, 'src-tauri', 'binaries'),
|
|
||||||
baseName: 'server',
|
|
||||||
mappings: [
|
|
||||||
{
|
|
||||||
bunSuffix: 'windows-x64',
|
|
||||||
tauriTarget: 'x86_64-pc-windows-msvc',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
bunSuffix: 'darwin-arm64',
|
|
||||||
tauriTarget: 'aarch64-apple-darwin',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
bunSuffix: 'darwin-x64',
|
|
||||||
tauriTarget: 'x86_64-apple-darwin',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
bunSuffix: 'linux-x64',
|
|
||||||
tauriTarget: 'x86_64-unknown-linux-gnu',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
bunSuffix: 'linux-arm64',
|
|
||||||
tauriTarget: 'aarch64-unknown-linux-gnu',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
} satisfies CopyConfig),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 文件系统服务
|
|
||||||
*/
|
|
||||||
class FileSystemService extends Context.Tag('FileSystemService')<
|
|
||||||
FileSystemService,
|
|
||||||
{
|
|
||||||
readonly ensureDir: (dir: string) => Effect.Effect<void, FileSystemError>
|
|
||||||
readonly fileExists: (
|
|
||||||
filePath: string,
|
|
||||||
) => Effect.Effect<boolean, FileSystemError>
|
|
||||||
readonly dirExists: (
|
|
||||||
dirPath: string,
|
|
||||||
) => Effect.Effect<boolean, FileSystemError>
|
|
||||||
readonly copyFile: (
|
|
||||||
source: string,
|
|
||||||
target: string,
|
|
||||||
) => Effect.Effect<void, CopyError>
|
|
||||||
}
|
|
||||||
>() {
|
|
||||||
static readonly Live = Layer.succeed(FileSystemService, {
|
|
||||||
ensureDir: (dir: string) =>
|
|
||||||
Effect.tryPromise({
|
|
||||||
try: async () => {
|
|
||||||
await $`mkdir -p ${dir}`
|
|
||||||
},
|
|
||||||
catch: (cause: unknown) =>
|
|
||||||
new FileSystemError({
|
|
||||||
operation: 'ensureDir',
|
|
||||||
path: dir,
|
|
||||||
cause,
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
|
|
||||||
fileExists: (filePath: string) =>
|
|
||||||
Effect.tryPromise({
|
|
||||||
try: async () => {
|
|
||||||
const file = Bun.file(filePath)
|
|
||||||
return await file.exists()
|
|
||||||
},
|
|
||||||
catch: (cause: unknown) =>
|
|
||||||
new FileSystemError({
|
|
||||||
operation: 'fileExists',
|
|
||||||
path: filePath,
|
|
||||||
cause,
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
|
|
||||||
dirExists: (dirPath: string) =>
|
|
||||||
Effect.tryPromise({
|
|
||||||
try: async () => {
|
|
||||||
const { default: fs } = await import('node:fs/promises')
|
|
||||||
try {
|
|
||||||
const stat = await fs.stat(dirPath)
|
|
||||||
return stat.isDirectory()
|
|
||||||
} catch {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
catch: (cause: unknown) =>
|
|
||||||
new FileSystemError({
|
|
||||||
operation: 'dirExists',
|
|
||||||
path: dirPath,
|
|
||||||
cause,
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
|
|
||||||
copyFile: (source: string, target: string) =>
|
|
||||||
Effect.tryPromise({
|
|
||||||
try: async () => {
|
|
||||||
await $`cp ${source} ${target}`
|
|
||||||
},
|
|
||||||
catch: (cause: unknown) =>
|
|
||||||
new CopyError({
|
|
||||||
source,
|
|
||||||
target,
|
|
||||||
cause,
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 复制服务
|
|
||||||
*/
|
|
||||||
class CopyService extends Context.Tag('CopyService')<
|
|
||||||
CopyService,
|
|
||||||
{
|
|
||||||
readonly copyBinary: (
|
|
||||||
config: CopyConfig,
|
|
||||||
mapping: TargetMapping,
|
|
||||||
) => Effect.Effect<CopyResult, CopyError | FileSystemError>
|
|
||||||
readonly copyAllBinaries: (
|
|
||||||
config: CopyConfig,
|
|
||||||
) => Effect.Effect<ReadonlyArray<CopyResult>, CopyError | FileSystemError>
|
|
||||||
}
|
|
||||||
>() {
|
|
||||||
static readonly Live = Layer.effect(
|
|
||||||
CopyService,
|
|
||||||
Effect.gen(function* () {
|
|
||||||
const fs = yield* FileSystemService
|
|
||||||
|
|
||||||
return {
|
|
||||||
copyBinary: (config: CopyConfig, mapping: TargetMapping) =>
|
|
||||||
Effect.gen(function* () {
|
|
||||||
const { sourceDir, targetDir, baseName } = config
|
|
||||||
const { bunSuffix, tauriTarget } = mapping
|
|
||||||
|
|
||||||
// 确定文件扩展名(Windows 需要 .exe)
|
|
||||||
const ext = tauriTarget.includes('windows') ? '.exe' : ''
|
|
||||||
|
|
||||||
// 构建源文件和目标文件路径
|
|
||||||
const sourceFile = path.join(
|
|
||||||
sourceDir,
|
|
||||||
`${baseName}-${bunSuffix}${ext}`,
|
|
||||||
)
|
|
||||||
const targetFile = path.join(
|
|
||||||
targetDir,
|
|
||||||
`${baseName}-${tauriTarget}${ext}`,
|
|
||||||
)
|
|
||||||
|
|
||||||
// 检查源文件是否存在
|
|
||||||
const exists = yield* fs.fileExists(sourceFile)
|
|
||||||
if (!exists) {
|
|
||||||
yield* Console.log(`⚠️ 跳过 ${bunSuffix}: 源文件不存在`)
|
|
||||||
return {
|
|
||||||
bunSuffix,
|
|
||||||
tauriTarget,
|
|
||||||
sourceFile,
|
|
||||||
targetFile,
|
|
||||||
success: false,
|
|
||||||
} satisfies CopyResult
|
|
||||||
}
|
|
||||||
|
|
||||||
// 复制文件
|
|
||||||
yield* fs.copyFile(sourceFile, targetFile)
|
|
||||||
|
|
||||||
yield* Console.log(`✓ ${bunSuffix} → ${tauriTarget}`)
|
|
||||||
yield* Console.log(` ${sourceFile}`)
|
|
||||||
yield* Console.log(` → ${targetFile}\n`)
|
|
||||||
|
|
||||||
return {
|
|
||||||
bunSuffix,
|
|
||||||
tauriTarget,
|
|
||||||
sourceFile,
|
|
||||||
targetFile,
|
|
||||||
success: true,
|
|
||||||
} satisfies CopyResult
|
|
||||||
}),
|
|
||||||
|
|
||||||
copyAllBinaries: (config: CopyConfig) =>
|
|
||||||
Effect.gen(function* () {
|
|
||||||
const effects = config.mappings.map((mapping) =>
|
|
||||||
Effect.gen(function* () {
|
|
||||||
const { sourceDir, targetDir, baseName } = config
|
|
||||||
const { bunSuffix, tauriTarget } = mapping
|
|
||||||
|
|
||||||
const ext = tauriTarget.includes('windows') ? '.exe' : ''
|
|
||||||
const sourceFile = path.join(
|
|
||||||
sourceDir,
|
|
||||||
`${baseName}-${bunSuffix}${ext}`,
|
|
||||||
)
|
|
||||||
const targetFile = path.join(
|
|
||||||
targetDir,
|
|
||||||
`${baseName}-${tauriTarget}${ext}`,
|
|
||||||
)
|
|
||||||
|
|
||||||
const exists = yield* fs.fileExists(sourceFile)
|
|
||||||
if (!exists) {
|
|
||||||
yield* Console.log(`⚠️ 跳过 ${bunSuffix}: 源文件不存在`)
|
|
||||||
return {
|
|
||||||
bunSuffix,
|
|
||||||
tauriTarget,
|
|
||||||
sourceFile,
|
|
||||||
targetFile,
|
|
||||||
success: false,
|
|
||||||
} satisfies CopyResult
|
|
||||||
}
|
|
||||||
|
|
||||||
yield* fs.copyFile(sourceFile, targetFile)
|
|
||||||
|
|
||||||
yield* Console.log(`✓ ${bunSuffix} → ${tauriTarget}`)
|
|
||||||
yield* Console.log(` ${sourceFile}`)
|
|
||||||
yield* Console.log(` → ${targetFile}\n`)
|
|
||||||
|
|
||||||
return {
|
|
||||||
bunSuffix,
|
|
||||||
tauriTarget,
|
|
||||||
sourceFile,
|
|
||||||
targetFile,
|
|
||||||
success: true,
|
|
||||||
} satisfies CopyResult
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
return yield* Effect.all(effects, { concurrency: 'unbounded' })
|
|
||||||
}),
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 报告服务
|
|
||||||
*/
|
|
||||||
class ReporterService extends Context.Tag('ReporterService')<
|
|
||||||
ReporterService,
|
|
||||||
{
|
|
||||||
readonly printSummary: (
|
|
||||||
results: ReadonlyArray<CopyResult>,
|
|
||||||
) => Effect.Effect<void>
|
|
||||||
}
|
|
||||||
>() {
|
|
||||||
static readonly Live = Layer.succeed(ReporterService, {
|
|
||||||
printSummary: (results: ReadonlyArray<CopyResult>) =>
|
|
||||||
Effect.gen(function* () {
|
|
||||||
const successful = results.filter((r) => r.success)
|
|
||||||
const failed = results.filter((r) => !r.success)
|
|
||||||
|
|
||||||
yield* Console.log('\n📦 复制摘要:')
|
|
||||||
yield* Console.log(` ✅ 成功: ${successful.length}`)
|
|
||||||
yield* Console.log(` ⚠️ 跳过: ${failed.length}`)
|
|
||||||
|
|
||||||
if (successful.length > 0) {
|
|
||||||
yield* Console.log('\n成功复制的文件:')
|
|
||||||
for (const result of successful) {
|
|
||||||
yield* Console.log(
|
|
||||||
` • ${result.bunSuffix} → ${result.tauriTarget}`,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (failed.length > 0) {
|
|
||||||
yield* Console.log('\n跳过的文件:')
|
|
||||||
for (const result of failed) {
|
|
||||||
yield* Console.log(` • ${result.bunSuffix} (源文件不存在)`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// Main Program
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
const program = Effect.gen(function* () {
|
|
||||||
const config = yield* CopyConfigService
|
|
||||||
const fs = yield* FileSystemService
|
|
||||||
const copier = yield* CopyService
|
|
||||||
const reporter = yield* ReporterService
|
|
||||||
|
|
||||||
yield* Console.log('📦 开始复制二进制文件到 Tauri sidecar 目录...\n')
|
|
||||||
|
|
||||||
// 1. 检查源目录
|
|
||||||
const sourceExists = yield* fs.dirExists(config.sourceDir)
|
|
||||||
if (!sourceExists) {
|
|
||||||
yield* Console.error(`❌ 源目录不存在: ${config.sourceDir}`)
|
|
||||||
yield* Console.log(
|
|
||||||
'💡 提示: 请先在 apps/server 中运行 bun run compile 构建服务器二进制文件',
|
|
||||||
)
|
|
||||||
return yield* Effect.fail(
|
|
||||||
new FileSystemError({
|
|
||||||
operation: 'checkSourceDir',
|
|
||||||
path: config.sourceDir,
|
|
||||||
cause: '源目录不存在',
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// 2. 创建目标目录
|
|
||||||
yield* fs.ensureDir(config.targetDir)
|
|
||||||
yield* Console.log(`✓ 目标目录: ${config.targetDir}\n`)
|
|
||||||
|
|
||||||
// 3. 并行复制所有二进制文件
|
|
||||||
const results = yield* copier.copyAllBinaries(config)
|
|
||||||
|
|
||||||
// 4. 输出摘要
|
|
||||||
yield* reporter.printSummary(results)
|
|
||||||
|
|
||||||
return results
|
|
||||||
})
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// Layer Composition
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
const MainLayer = Layer.mergeAll(
|
|
||||||
CopyConfigService.Live,
|
|
||||||
FileSystemService.Live,
|
|
||||||
CopyService.Live.pipe(Layer.provide(FileSystemService.Live)),
|
|
||||||
ReporterService.Live,
|
|
||||||
)
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// Runner
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
const runnable = program.pipe(
|
|
||||||
Effect.provide(MainLayer),
|
|
||||||
Effect.catchTags({
|
|
||||||
ConfigError: (error) =>
|
|
||||||
Console.error(`❌ 配置错误: ${error.message}`, error.cause),
|
|
||||||
FileSystemError: (error) =>
|
|
||||||
Console.error(
|
|
||||||
`❌ 文件系统错误 [${error.operation}]: ${error.path}`,
|
|
||||||
error.cause,
|
|
||||||
),
|
|
||||||
CopyError: (error) =>
|
|
||||||
Console.error(
|
|
||||||
`❌ 复制失败: ${error.source} → ${error.target}`,
|
|
||||||
error.cause,
|
|
||||||
),
|
|
||||||
}),
|
|
||||||
Effect.tapErrorCause((cause) => Console.error('❌ 未预期的错误:', cause)),
|
|
||||||
)
|
|
||||||
|
|
||||||
Effect.runPromise(runnable).catch(() => {
|
|
||||||
process.exit(1)
|
|
||||||
})
|
|
||||||
41
apps/desktop/electron-builder.yml
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
appId: com.furtherverse.app
|
||||||
|
productName: Furtherverse
|
||||||
|
directories:
|
||||||
|
buildResources: build
|
||||||
|
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}'
|
||||||
|
asarUnpack:
|
||||||
|
- resources/**
|
||||||
|
win:
|
||||||
|
executableName: Furtherverse
|
||||||
|
extraResources:
|
||||||
|
- from: ../server/out/server-windows-x64.exe
|
||||||
|
to: server.exe
|
||||||
|
nsis:
|
||||||
|
artifactName: ${productName}-${version}-setup.${ext}
|
||||||
|
shortcutName: ${productName}
|
||||||
|
uninstallDisplayName: ${productName}
|
||||||
|
createDesktopShortcut: always
|
||||||
|
mac:
|
||||||
|
category: public.app-category.productivity
|
||||||
|
extraResources:
|
||||||
|
- from: ../server/out/server-darwin-arm64
|
||||||
|
to: server
|
||||||
|
dmg:
|
||||||
|
artifactName: ${productName}-${version}.${ext}
|
||||||
|
linux:
|
||||||
|
target:
|
||||||
|
- AppImage
|
||||||
|
maintainer: furtherverse.com
|
||||||
|
category: Utility
|
||||||
|
extraResources:
|
||||||
|
- from: ../server/out/server-linux-x64
|
||||||
|
to: server
|
||||||
|
appImage:
|
||||||
|
artifactName: ${productName}-${version}.${ext}
|
||||||
|
npmRebuild: false
|
||||||
10
apps/desktop/electron.vite.config.ts
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
import tailwindcss from '@tailwindcss/vite'
|
||||||
|
import { defineConfig } from 'electron-vite'
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
main: {},
|
||||||
|
preload: {},
|
||||||
|
renderer: {
|
||||||
|
plugins: [tailwindcss()],
|
||||||
|
},
|
||||||
|
})
|
||||||
@@ -2,18 +2,27 @@
|
|||||||
"name": "@furtherverse/desktop",
|
"name": "@furtherverse/desktop",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"description": "Furtherverse desktop app",
|
||||||
|
"homepage": "https://furtherverse.com",
|
||||||
|
"author": "Furtherverse",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
"main": "out/main/index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "bun run copy && tauri build",
|
"build": "electron-vite build",
|
||||||
"copy": "rm -rf binaries && bun --bun copy.ts",
|
"build:linux": "electron-vite build && electron-builder --linux --config",
|
||||||
"dev": "bun run copy && tauri dev"
|
"build:mac": "electron-vite build && electron-builder --mac --config",
|
||||||
|
"build:win": "electron-vite build && electron-builder --win --config",
|
||||||
|
"dev": "electron-vite dev",
|
||||||
|
"fix": "biome check --write",
|
||||||
|
"typecheck": "tsc --noEmit"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@effect/schema": "catalog:",
|
|
||||||
"@furtherverse/tsconfig": "workspace:*",
|
"@furtherverse/tsconfig": "workspace:*",
|
||||||
"@tauri-apps/cli": "catalog:",
|
"@tailwindcss/vite": "catalog:",
|
||||||
"@types/bun": "catalog:",
|
"@types/node": "catalog:",
|
||||||
"effect": "catalog:",
|
"electron": "catalog:",
|
||||||
"typescript": "catalog:"
|
"electron-builder": "catalog:",
|
||||||
|
"electron-vite": "catalog:",
|
||||||
|
"tailwindcss": "catalog:"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
10
apps/desktop/src-tauri/.gitignore
vendored
@@ -1,10 +0,0 @@
|
|||||||
# 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/
|
|
||||||
@@ -1,357 +0,0 @@
|
|||||||
# 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
|
|
||||||
```
|
|
||||||
|
|
||||||
## 项目结构
|
|
||||||
|
|
||||||
```
|
|
||||||
server-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 应用正常启动和退出
|
|
||||||
4773
apps/desktop/src-tauri/Cargo.lock
generated
@@ -1,24 +0,0 @@
|
|||||||
[package]
|
|
||||||
name = "server-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 = "server_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"] }
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
fn main() {
|
|
||||||
tauri_build::build()
|
|
||||||
}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{
|
|
||||||
"$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
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
Before Width: | Height: | Size: 3.4 KiB |
|
Before Width: | Height: | Size: 6.8 KiB |
|
Before Width: | Height: | Size: 974 B |
|
Before Width: | Height: | Size: 2.8 KiB |
|
Before Width: | Height: | Size: 3.8 KiB |
|
Before Width: | Height: | Size: 3.9 KiB |
|
Before Width: | Height: | Size: 7.6 KiB |
|
Before Width: | Height: | Size: 903 B |
|
Before Width: | Height: | Size: 8.4 KiB |
|
Before Width: | Height: | Size: 1.3 KiB |
|
Before Width: | Height: | Size: 2.0 KiB |
|
Before Width: | Height: | Size: 2.4 KiB |
|
Before Width: | Height: | Size: 1.5 KiB |
|
Before Width: | Height: | Size: 85 KiB |
|
Before Width: | Height: | Size: 14 KiB |
@@ -1,8 +0,0 @@
|
|||||||
// 原生桌面功能命令
|
|
||||||
// 未来可能包含: 文件对话框、系统通知、剪贴板等
|
|
||||||
|
|
||||||
// 示例命令 (可根据需要删除或替换)
|
|
||||||
#[tauri::command]
|
|
||||||
pub fn greet(name: &str) -> String {
|
|
||||||
format!("Hello, {}! You've been greeted from Rust!", name)
|
|
||||||
}
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
// Prevents additional console window on Windows in release, DO NOT REMOVE!!
|
|
||||||
#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
|
|
||||||
|
|
||||||
fn main() {
|
|
||||||
server_desktop_lib::run()
|
|
||||||
}
|
|
||||||
@@ -1,166 +0,0 @@
|
|||||||
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("server")
|
|
||||||
.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 进程已终止");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://schema.tauri.app/config/2",
|
|
||||||
"productName": "server-desktop",
|
|
||||||
"version": "0.1.0",
|
|
||||||
"identifier": "com.imbytecat.server-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/server"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
143
apps/desktop/src/main/index.ts
Normal file
@@ -0,0 +1,143 @@
|
|||||||
|
import { spawn } from 'node:child_process'
|
||||||
|
import { createServer } from 'node:net'
|
||||||
|
import { join } from 'node:path'
|
||||||
|
import { app, BrowserWindow, shell } from 'electron'
|
||||||
|
|
||||||
|
const DEV_SERVER_URL = 'http://localhost:3000'
|
||||||
|
|
||||||
|
let mainWindow: BrowserWindow | null = null
|
||||||
|
let serverProcess: ReturnType<typeof spawn> | null = null
|
||||||
|
|
||||||
|
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> => {
|
||||||
|
try {
|
||||||
|
const response = await fetch(url, { method: 'HEAD' })
|
||||||
|
return response.ok
|
||||||
|
} catch {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const waitForServer = async (
|
||||||
|
url: string,
|
||||||
|
timeoutMs = 15_000,
|
||||||
|
): Promise<boolean> => {
|
||||||
|
const start = Date.now()
|
||||||
|
while (Date.now() - start < timeoutMs) {
|
||||||
|
if (await isServerReady(url)) return true
|
||||||
|
await new Promise<void>((resolve) => setTimeout(resolve, 200))
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
const spawnServer = (port: number): string => {
|
||||||
|
const binaryName = process.platform === 'win32' ? 'server.exe' : 'server'
|
||||||
|
const binaryPath = join(process.resourcesPath, binaryName)
|
||||||
|
|
||||||
|
serverProcess = spawn(binaryPath, [], {
|
||||||
|
env: {
|
||||||
|
...process.env,
|
||||||
|
PORT: String(port),
|
||||||
|
HOST: '127.0.0.1',
|
||||||
|
},
|
||||||
|
stdio: 'pipe',
|
||||||
|
})
|
||||||
|
|
||||||
|
serverProcess.stdout?.on('data', (data: Buffer) => {
|
||||||
|
console.log(`[server] ${data.toString().trim()}`)
|
||||||
|
})
|
||||||
|
|
||||||
|
serverProcess.stderr?.on('data', (data: Buffer) => {
|
||||||
|
console.error(`[server] ${data.toString().trim()}`)
|
||||||
|
})
|
||||||
|
|
||||||
|
serverProcess.on('error', (err) => {
|
||||||
|
console.error('Failed to start server:', err)
|
||||||
|
})
|
||||||
|
|
||||||
|
return `http://127.0.0.1:${port}`
|
||||||
|
}
|
||||||
|
|
||||||
|
const getServerUrl = async (): Promise<string> => {
|
||||||
|
if (!app.isPackaged) {
|
||||||
|
return DEV_SERVER_URL
|
||||||
|
}
|
||||||
|
const port = await getAvailablePort()
|
||||||
|
return spawnServer(port)
|
||||||
|
}
|
||||||
|
|
||||||
|
const createWindow = async () => {
|
||||||
|
mainWindow = new BrowserWindow({
|
||||||
|
width: 1200,
|
||||||
|
height: 800,
|
||||||
|
show: false,
|
||||||
|
webPreferences: {
|
||||||
|
preload: join(__dirname, '../preload/index.mjs'),
|
||||||
|
sandbox: true,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
mainWindow.webContents.setWindowOpenHandler(({ url }) => {
|
||||||
|
shell.openExternal(url)
|
||||||
|
return { action: 'deny' }
|
||||||
|
})
|
||||||
|
|
||||||
|
if (process.env.ELECTRON_RENDERER_URL) {
|
||||||
|
mainWindow.loadURL(process.env.ELECTRON_RENDERER_URL)
|
||||||
|
} else {
|
||||||
|
mainWindow.loadFile(join(__dirname, '../renderer/index.html'))
|
||||||
|
}
|
||||||
|
mainWindow.show()
|
||||||
|
|
||||||
|
const serverUrl = await getServerUrl()
|
||||||
|
|
||||||
|
console.log(`Waiting for server at ${serverUrl}...`)
|
||||||
|
const ready = await waitForServer(serverUrl)
|
||||||
|
if (!ready) {
|
||||||
|
console.error(
|
||||||
|
app.isPackaged
|
||||||
|
? 'Server binary did not start in time.'
|
||||||
|
: 'Dev server not responding. Run `bun dev` in apps/server first.',
|
||||||
|
)
|
||||||
|
app.quit()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`Loading ${serverUrl}`)
|
||||||
|
mainWindow.loadURL(serverUrl)
|
||||||
|
}
|
||||||
|
|
||||||
|
app.whenReady().then(createWindow)
|
||||||
|
|
||||||
|
app.on('window-all-closed', () => {
|
||||||
|
if (process.platform !== 'darwin') {
|
||||||
|
app.quit()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
app.on('activate', () => {
|
||||||
|
if (BrowserWindow.getAllWindows().length === 0) {
|
||||||
|
createWindow()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
app.on('before-quit', () => {
|
||||||
|
if (serverProcess) {
|
||||||
|
serverProcess.kill()
|
||||||
|
serverProcess = null
|
||||||
|
}
|
||||||
|
})
|
||||||
1
apps/desktop/src/preload/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export {}
|
||||||
18
apps/desktop/src/renderer/index.html
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Furtherverse</title>
|
||||||
|
<link rel="stylesheet" href="./styles.css" />
|
||||||
|
</head>
|
||||||
|
<body class="bg-white h-screen w-screen flex flex-col items-center justify-center overflow-hidden select-none cursor-default font-sans antialiased m-0">
|
||||||
|
<div class="flex flex-col items-center gap-8 animate-fade-in">
|
||||||
|
<h1 class="text-3xl font-medium tracking-tight text-zinc-900">Furtherverse</h1>
|
||||||
|
<div class="w-24 h-[2px] bg-zinc-100 rounded-full overflow-hidden relative">
|
||||||
|
<div class="h-full w-full bg-zinc-800 origin-left animate-loading-bar"></div>
|
||||||
|
</div>
|
||||||
|
<div class="text-[10px] uppercase tracking-widest text-zinc-400 font-medium animate-pulse-slow">Starting</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
40
apps/desktop/src/renderer/styles.css
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
@import "tailwindcss";
|
||||||
|
|
||||||
|
@theme {
|
||||||
|
--animate-fade-in: fade-in 1.2s cubic-bezier(0.16, 1, 0.3, 1) forwards;
|
||||||
|
--animate-pulse-slow: pulse-slow 3s ease-in-out infinite;
|
||||||
|
--animate-loading-bar: loading-bar 2s cubic-bezier(0.4, 0, 0.2, 1) infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes fade-in {
|
||||||
|
from {
|
||||||
|
opacity: 0;
|
||||||
|
transform: translateY(4px);
|
||||||
|
}
|
||||||
|
to {
|
||||||
|
opacity: 1;
|
||||||
|
transform: translateY(0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes pulse-slow {
|
||||||
|
0%,
|
||||||
|
100% {
|
||||||
|
opacity: 0.4;
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
opacity: 0.8;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes loading-bar {
|
||||||
|
0% {
|
||||||
|
transform: translateX(-100%);
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
transform: translateX(0);
|
||||||
|
}
|
||||||
|
100% {
|
||||||
|
transform: translateX(100%);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,7 @@
|
|||||||
{
|
{
|
||||||
"extends": "@furtherverse/tsconfig/bun.json",
|
"extends": "@furtherverse/tsconfig/base.json",
|
||||||
"exclude": ["node_modules", "src-tauri"]
|
"compilerOptions": {
|
||||||
|
"types": ["node"]
|
||||||
|
},
|
||||||
|
"include": ["src/main/**/*", "src/preload/**/*", "electron.vite.config.ts"]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,12 +3,7 @@
|
|||||||
"extends": ["//"],
|
"extends": ["//"],
|
||||||
"tasks": {
|
"tasks": {
|
||||||
"build": {
|
"build": {
|
||||||
"dependsOn": ["@furtherverse/server#compile"],
|
"outputs": ["out/**"]
|
||||||
"outputs": ["src-tauri/target/release/**"]
|
|
||||||
},
|
|
||||||
"dev": {
|
|
||||||
"dependsOn": ["@furtherverse/server#compile"],
|
|
||||||
"with": ["@furtherverse/server#dev"]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,155 +1,124 @@
|
|||||||
# AGENTS.md - AI Coding Agent Guidelines
|
# AGENTS.md - Server App Guidelines
|
||||||
|
|
||||||
本文档为 AI 编程助手提供此 TanStack Start 全栈项目的开发规范和指南。
|
TanStack Start fullstack web app with ORPC (contract-first RPC).
|
||||||
|
|
||||||
## 项目概览
|
## Tech Stack
|
||||||
|
|
||||||
- **框架**: TanStack Start (React SSR 框架,文件路由)
|
> **⚠️ This project uses Bun — NOT Node.js / npm. All commands use `bun`. Never use `npm`, `npx`, or `node`.**
|
||||||
- **运行时**: Bun
|
|
||||||
- **语言**: TypeScript (strict mode, ESNext)
|
|
||||||
- **样式**: Tailwind CSS v4
|
|
||||||
- **数据库**: PostgreSQL + Drizzle ORM
|
|
||||||
- **状态管理**: TanStack Query
|
|
||||||
- **路由**: TanStack Router (文件路由)
|
|
||||||
- **RPC**: ORPC (类型安全 RPC,契约优先)
|
|
||||||
- **构建工具**: Vite + Turbo
|
|
||||||
- **代码质量**: Biome (格式化 + Lint)
|
|
||||||
- **桌面壳** (可选): Tauri v2 (详见 `src-tauri/AGENTS.md`)
|
|
||||||
|
|
||||||
## 构建、Lint 和测试命令
|
- **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
|
||||||
|
- **State**: TanStack Query v5
|
||||||
|
- **RPC**: ORPC (contract-first, type-safe)
|
||||||
|
- **Build**: Vite + Nitro
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
### 开发
|
|
||||||
```bash
|
```bash
|
||||||
bun dev # 使用 Turbo 并行启动 Tauri + Vite 开发服务器
|
# Development
|
||||||
bun dev:vite # 仅启动 Vite 开发服务器 (localhost:3000)
|
bun dev # Vite dev server (localhost:3000)
|
||||||
bun dev:tauri # 启动 Tauri 桌面应用
|
bun db:studio # Drizzle Studio GUI
|
||||||
bun db:studio # 打开 Drizzle Studio 数据库管理界面
|
|
||||||
|
# Build
|
||||||
|
bun build # Production build → .output/
|
||||||
|
bun compile # Compile to standalone binary
|
||||||
|
|
||||||
|
# Code Quality
|
||||||
|
bun fix # Biome auto-fix
|
||||||
|
bun typecheck # TypeScript check
|
||||||
|
|
||||||
|
# Database
|
||||||
|
bun db:generate # Generate migrations from schema
|
||||||
|
bun db:migrate # Run migrations
|
||||||
|
bun 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
|
||||||
```bash
|
|
||||||
bun build # 完整构建 (Vite → 编译 → Tauri 打包)
|
```
|
||||||
bun build:vite # 仅构建 Vite (输出到 .output/)
|
src/
|
||||||
bun build:compile # 编译为独立可执行文件 (使用 build.ts)
|
├── client/ # Client-side code
|
||||||
bun build:tauri # 构建 Tauri 桌面安装包
|
│ ├── orpc.client.ts # ORPC isomorphic client
|
||||||
|
│ └── query-client.ts # TanStack Query client
|
||||||
|
├── components/ # React components
|
||||||
|
├── routes/ # TanStack Router file routes
|
||||||
|
│ ├── __root.tsx # Root layout
|
||||||
|
│ ├── index.tsx # Home page
|
||||||
|
│ └── api/
|
||||||
|
│ └── rpc.$.ts # ORPC HTTP endpoint
|
||||||
|
├── server/ # Server-side code
|
||||||
|
│ ├── api/ # ORPC layer
|
||||||
|
│ │ ├── contracts/ # Input/output schemas (Zod)
|
||||||
|
│ │ ├── middlewares/ # Middleware (db provider, auth)
|
||||||
|
│ │ ├── routers/ # Handler implementations
|
||||||
|
│ │ ├── context.ts # Request context
|
||||||
|
│ │ ├── server.ts # ORPC server instance
|
||||||
|
│ │ └── types.ts # Type exports
|
||||||
|
│ └── db/
|
||||||
|
│ ├── schema/ # Drizzle table definitions
|
||||||
|
│ └── index.ts # Database instance
|
||||||
|
├── env.ts # Environment variable validation
|
||||||
|
├── router.tsx # Router configuration
|
||||||
|
├── routeTree.gen.ts # Auto-generated (DO NOT EDIT)
|
||||||
|
└── styles.css # Tailwind entry
|
||||||
```
|
```
|
||||||
|
|
||||||
### 代码质量
|
## ORPC Pattern
|
||||||
```bash
|
|
||||||
bun typecheck # 运行 TypeScript 编译器检查 (tsc -b)
|
|
||||||
bun fix # 运行 Biome 自动修复格式和 Lint 问题
|
|
||||||
biome check . # 检查但不自动修复
|
|
||||||
biome format --write . # 仅格式化代码
|
|
||||||
```
|
|
||||||
|
|
||||||
### 数据库
|
### 1. Define Contract (`src/server/api/contracts/feature.contract.ts`)
|
||||||
```bash
|
|
||||||
bun db:generate # 从 schema 生成迁移文件
|
|
||||||
bun db:migrate # 执行数据库迁移
|
|
||||||
bun db:push # 直接推送 schema 变更 (仅开发环境)
|
|
||||||
```
|
|
||||||
|
|
||||||
### 测试
|
|
||||||
**注意**: 当前未配置测试框架。添加测试时:
|
|
||||||
- 使用 Vitest 或 Bun 内置测试运行器
|
|
||||||
- 运行单个测试文件: `bun test path/to/test.ts`
|
|
||||||
- 运行特定测试: `bun test -t "测试名称模式"`
|
|
||||||
|
|
||||||
## 代码风格指南
|
|
||||||
|
|
||||||
### 格式化 (Biome)
|
|
||||||
|
|
||||||
**缩进**: 2 空格 (不使用 tab)
|
|
||||||
**换行符**: LF (Unix 风格)
|
|
||||||
**引号**: 单引号 `'string'`
|
|
||||||
**分号**: 按需 (ASI - 自动分号插入)
|
|
||||||
**箭头函数括号**: 始终使用 `(x) => x`
|
|
||||||
|
|
||||||
示例:
|
|
||||||
```typescript
|
```typescript
|
||||||
const myFunc = (value: string) => {
|
|
||||||
return value.toUpperCase()
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 导入组织
|
|
||||||
|
|
||||||
Biome 自动组织导入。顺序:
|
|
||||||
1. 外部依赖
|
|
||||||
2. 内部导入 (使用 `@/*` 别名)
|
|
||||||
3. 类型导入 (仅导入类型时使用 `type` 关键字)
|
|
||||||
|
|
||||||
示例:
|
|
||||||
```typescript
|
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
|
||||||
import { oc } from '@orpc/contract'
|
import { oc } from '@orpc/contract'
|
||||||
|
import { createSelectSchema } from 'drizzle-zod'
|
||||||
import { z } from 'zod'
|
import { z } from 'zod'
|
||||||
import { db } from '@/db'
|
import { featureTable } from '@/server/db/schema'
|
||||||
import { todoTable } from '@/db/schema'
|
|
||||||
import type { ReactNode } from 'react'
|
const selectSchema = createSelectSchema(featureTable)
|
||||||
|
|
||||||
|
export const list = oc.input(z.void()).output(z.array(selectSchema))
|
||||||
|
export const create = oc.input(insertSchema).output(selectSchema)
|
||||||
```
|
```
|
||||||
|
|
||||||
### TypeScript
|
### 2. Implement Router (`src/server/api/routers/feature.router.ts`)
|
||||||
|
|
||||||
**严格模式**: 启用了额外的严格检查
|
|
||||||
- `strict: true`
|
|
||||||
- `noUncheckedIndexedAccess: true` - 数组/对象索引返回 `T | undefined`
|
|
||||||
- `noImplicitOverride: true`
|
|
||||||
- `noFallthroughCasesInSwitch: true`
|
|
||||||
|
|
||||||
**模块解析**: `bundler` 模式 + `verbatimModuleSyntax`
|
|
||||||
- 导入时始终使用 `.ts`/`.tsx` 扩展名
|
|
||||||
- 使用 `@/*` 路径别名指向 `src/*`
|
|
||||||
|
|
||||||
**类型注解**:
|
|
||||||
- 公共 API 的函数参数和返回类型必须注解
|
|
||||||
- 优先使用显式类型而非 `any`
|
|
||||||
- 对象形状用 `type`,可扩展契约用 `interface`
|
|
||||||
- 不可变 props 使用 `Readonly<T>`
|
|
||||||
|
|
||||||
### 命名规范
|
|
||||||
|
|
||||||
- **文件**: 工具函数用 kebab-case,组件用 PascalCase
|
|
||||||
- `utils.ts`, `todo.tsx`, `NotFound.tsx`
|
|
||||||
- **路由**: 遵循 TanStack Router 约定
|
|
||||||
- `routes/index.tsx` → `/`
|
|
||||||
- `routes/__root.tsx` → 根布局
|
|
||||||
- **组件**: PascalCase 箭头函数 (Biome 规则 `useArrowFunction` 强制)
|
|
||||||
- **函数**: camelCase
|
|
||||||
- **常量**: 真常量用 UPPER_SNAKE_CASE,配置对象用 camelCase
|
|
||||||
- **类型/接口**: PascalCase
|
|
||||||
|
|
||||||
### React 模式
|
|
||||||
|
|
||||||
**组件**: 使用箭头函数
|
|
||||||
```typescript
|
```typescript
|
||||||
const MyComponent = ({ title }: { title: string }) => {
|
import { ORPCError } from '@orpc/server'
|
||||||
return <div>{title}</div>
|
import { db } from '../middlewares'
|
||||||
}
|
import { os } from '../server'
|
||||||
```
|
|
||||||
|
|
||||||
**路由**: 使用 `createFileRoute` 定义路由
|
export const list = os.feature.list.use(db).handler(async ({ context }) => {
|
||||||
```typescript
|
return await context.db.query.featureTable.findMany()
|
||||||
export const Route = createFileRoute('/')({
|
|
||||||
component: Home,
|
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
**数据获取**: 使用 TanStack Query hooks
|
### 3. Register in Index Files
|
||||||
- `useSuspenseQuery` - 保证有数据
|
```typescript
|
||||||
- `useQuery` - 数据可能为空
|
// src/server/api/contracts/index.ts
|
||||||
|
import * as feature from './feature.contract'
|
||||||
|
export const contract = { feature }
|
||||||
|
|
||||||
**Props**: 禁止直接修改 props (Biome 规则 `noReactPropAssignments`)
|
// src/server/api/routers/index.ts
|
||||||
|
import * as feature from './feature.router'
|
||||||
|
export const router = os.router({ feature })
|
||||||
|
```
|
||||||
|
|
||||||
### 数据库 Schema (Drizzle)
|
### 4. Use in Components
|
||||||
|
```typescript
|
||||||
|
import { useSuspenseQuery, useMutation } from '@tanstack/react-query'
|
||||||
|
import { orpc } from '@/client/orpc.client'
|
||||||
|
|
||||||
- 在 `src/db/schema/*.ts` 定义 schema
|
const { data } = useSuspenseQuery(orpc.feature.list.queryOptions())
|
||||||
- 从 `src/db/schema/index.ts` 导出
|
const mutation = useMutation(orpc.feature.create.mutationOptions())
|
||||||
- 使用 `drizzle-orm/pg-core` 的 PostgreSQL 类型
|
```
|
||||||
- 主键使用 `uuidv7()` (需要 PostgreSQL 扩展)
|
|
||||||
- 始终包含 `createdAt` 和 `updatedAt` 时间戳
|
## Database Schema (Drizzle)
|
||||||
|
|
||||||
示例:
|
|
||||||
```typescript
|
```typescript
|
||||||
import { pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
|
import { pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
|
||||||
import { sql } from 'drizzle-orm'
|
import { sql } from 'drizzle-orm'
|
||||||
@@ -162,116 +131,75 @@ export const myTable = pgTable('my_table', {
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
### 环境变量
|
## Code Style
|
||||||
|
|
||||||
- 使用 `@t3-oss/env-core` 进行类型安全的环境变量验证
|
### Formatting (Biome)
|
||||||
- 在 `src/env.ts` 定义 schema
|
- **Indent**: 2 spaces
|
||||||
- 服务端变量: 无前缀
|
- **Quotes**: Single `'`
|
||||||
- 客户端变量: 必须有 `VITE_` 前缀
|
- **Semicolons**: Omit (ASI)
|
||||||
- 使用 Zod schema 验证
|
- **Arrow parens**: Always `(x) => x`
|
||||||
|
|
||||||
### 错误处理
|
### Imports
|
||||||
|
Biome auto-organizes:
|
||||||
|
1. External packages
|
||||||
|
2. Internal `@/*` aliases
|
||||||
|
3. Type imports (`import type { ... }`)
|
||||||
|
|
||||||
- 异步操作使用 try-catch
|
|
||||||
- 抛出带有描述性消息的错误
|
|
||||||
- 用户界面错误优先使用 Result 类型或错误边界
|
|
||||||
- 适当记录错误 (避免记录敏感数据)
|
|
||||||
|
|
||||||
### 样式 (Tailwind CSS)
|
|
||||||
|
|
||||||
- 使用 Tailwind v4 工具类
|
|
||||||
- 通过 `@/styles.css?url` 导入样式
|
|
||||||
- 优先使用组合而非自定义 CSS
|
|
||||||
- 响应式修饰符: `sm:`, `md:`, `lg:`
|
|
||||||
- UI 文本适当使用中文
|
|
||||||
|
|
||||||
## 目录结构
|
|
||||||
|
|
||||||
```
|
|
||||||
src/
|
|
||||||
├── components/ # 可复用 React 组件
|
|
||||||
├── db/
|
|
||||||
│ ├── schema/ # Drizzle schema 定义
|
|
||||||
│ └── index.ts # 数据库实例
|
|
||||||
├── integrations/ # 第三方集成 (TanStack Query/Router)
|
|
||||||
├── lib/ # 工具函数
|
|
||||||
├── orpc/ # ORPC (RPC 层)
|
|
||||||
│ ├── contracts/ # 契约定义 (input/output schemas)
|
|
||||||
│ ├── handlers/ # 服务端过程实现
|
|
||||||
│ ├── middlewares/ # 中间件 (如 DB provider)
|
|
||||||
│ ├── contract.ts # 契约聚合
|
|
||||||
│ ├── router.ts # 路由组合
|
|
||||||
│ ├── server.ts # 服务端实例
|
|
||||||
│ └── client.ts # 同构客户端
|
|
||||||
├── routes/ # TanStack Router 文件路由
|
|
||||||
│ ├── __root.tsx # 根布局
|
|
||||||
│ ├── index.tsx # 首页
|
|
||||||
│ └── api/rpc.$.ts # ORPC HTTP 端点
|
|
||||||
├── env.ts # 环境变量验证
|
|
||||||
└── router.tsx # 路由配置
|
|
||||||
```
|
|
||||||
|
|
||||||
## 重要提示
|
|
||||||
|
|
||||||
- **禁止** 编辑 `src/routeTree.gen.ts` - 自动生成
|
|
||||||
- **禁止** 提交 `.env` 文件 - 使用 `.env.example` 作为模板
|
|
||||||
- **必须** 在提交前运行 `bun fix`
|
|
||||||
- **必须** 使用 `@/*` 路径别名而非相对导入
|
|
||||||
- **必须** 利用 React Compiler (babel-plugin-react-compiler) - 避免手动 memoization
|
|
||||||
|
|
||||||
## Git 工作流
|
|
||||||
|
|
||||||
1. 按照上述风格指南进行修改
|
|
||||||
2. 运行 `bun fix` 自动格式化和 lint
|
|
||||||
3. 运行 `bun typecheck` 确保类型安全
|
|
||||||
4. 使用 `bun dev` 本地测试变更
|
|
||||||
5. 使用清晰的描述性消息提交
|
|
||||||
|
|
||||||
## 常见模式
|
|
||||||
|
|
||||||
### 创建 ORPC 过程
|
|
||||||
|
|
||||||
**步骤 1: 定义契约** (`src/orpc/contracts/my-feature.ts`)
|
|
||||||
```typescript
|
```typescript
|
||||||
import { oc } from '@orpc/contract'
|
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'
|
import { z } from 'zod'
|
||||||
|
|
||||||
export const myContract = {
|
export const env = createEnv({
|
||||||
get: oc.input(z.object({ id: z.uuid() })).output(mySchema),
|
server: {
|
||||||
create: oc.input(createSchema).output(mySchema),
|
DATABASE_URL: z.string().url(),
|
||||||
}
|
},
|
||||||
|
clientPrefix: 'VITE_',
|
||||||
|
client: {
|
||||||
|
VITE_API_URL: z.string().optional(),
|
||||||
|
},
|
||||||
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
**步骤 2: 实现处理器** (`src/orpc/handlers/my-feature.ts`)
|
## Critical Rules
|
||||||
```typescript
|
|
||||||
import { os } from '@/orpc/server'
|
|
||||||
import { dbProvider } from '@/orpc/middlewares'
|
|
||||||
|
|
||||||
export const get = os.myFeature.get
|
**DO:**
|
||||||
.use(dbProvider)
|
- Run `bun fix` before committing
|
||||||
.handler(async ({ context, input }) => {
|
- Use `@/*` path aliases
|
||||||
return await context.db.query.myTable.findFirst(...)
|
- Include `createdAt`/`updatedAt` on all tables
|
||||||
})
|
- Use `ORPCError` with proper codes
|
||||||
```
|
|
||||||
|
|
||||||
**步骤 3: 注册到契约和路由**
|
**DON'T:**
|
||||||
```typescript
|
- Use `npm`, `npx`, `node`, `yarn`, `pnpm` — always use `bun` / `bunx`
|
||||||
// src/orpc/contract.ts
|
- Edit `src/routeTree.gen.ts` (auto-generated)
|
||||||
export const contract = { myFeature: myContract }
|
- Use `as any`, `@ts-ignore`, `@ts-expect-error`
|
||||||
|
- Commit `.env` files
|
||||||
// src/orpc/router.ts
|
- Use empty catch blocks
|
||||||
import * as myFeature from './handlers/my-feature'
|
|
||||||
export const router = os.router({ myFeature })
|
|
||||||
```
|
|
||||||
|
|
||||||
**步骤 4: 在组件中使用**
|
|
||||||
```typescript
|
|
||||||
import { orpc } from '@/orpc'
|
|
||||||
const query = useSuspenseQuery(orpc.myFeature.get.queryOptions({ id }))
|
|
||||||
const mutation = useMutation(orpc.myFeature.create.mutationOptions())
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**最后更新**: 2026-01-18
|
|
||||||
**项目版本**: 基于 package.json 依赖版本
|
|
||||||
|
|||||||
@@ -3,5 +3,10 @@
|
|||||||
"extends": "//",
|
"extends": "//",
|
||||||
"files": {
|
"files": {
|
||||||
"includes": ["**", "!**/routeTree.gen.ts"]
|
"includes": ["**", "!**/routeTree.gen.ts"]
|
||||||
|
},
|
||||||
|
"css": {
|
||||||
|
"parser": {
|
||||||
|
"tailwindDirectives": true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,289 +0,0 @@
|
|||||||
import { Schema } from '@effect/schema'
|
|
||||||
import { $ } from 'bun'
|
|
||||||
import { Console, Context, Data, Effect, Layer } from 'effect'
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// Domain Models & Schema
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
const BunTargetSchema = Schema.Literal(
|
|
||||||
'bun-windows-x64',
|
|
||||||
'bun-darwin-arm64',
|
|
||||||
'bun-darwin-x64',
|
|
||||||
'bun-linux-x64',
|
|
||||||
'bun-linux-arm64',
|
|
||||||
)
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 将 bun target 转换为文件后缀 (去掉 'bun-' 前缀)
|
|
||||||
*/
|
|
||||||
const getTargetSuffix = (target: BunTarget): string => {
|
|
||||||
return target.replace('bun-', '')
|
|
||||||
}
|
|
||||||
|
|
||||||
type BunTarget = Schema.Schema.Type<typeof BunTargetSchema>
|
|
||||||
|
|
||||||
const BuildConfigSchema = Schema.Struct({
|
|
||||||
entrypoint: Schema.String.pipe(Schema.nonEmptyString()),
|
|
||||||
outputDir: Schema.String.pipe(Schema.nonEmptyString()),
|
|
||||||
outfile: 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',
|
|
||||||
outfile: 'server',
|
|
||||||
targets: ['bun-windows-x64', 'bun-darwin-arm64', 'bun-linux-x64'],
|
|
||||||
} satisfies BuildConfig),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 文件系统服务
|
|
||||||
*/
|
|
||||||
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: `${config.outfile}-${getTargetSuffix(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: `${config.outfile}-${getTargetSuffix(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)
|
|
||||||
})
|
|
||||||
111
apps/server/compile.ts
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
import { rm } from 'node:fs/promises'
|
||||||
|
import path from 'node:path'
|
||||||
|
import process from 'node:process'
|
||||||
|
|
||||||
|
const ALL_TARGETS = [
|
||||||
|
'bun-windows-x64',
|
||||||
|
'bun-darwin-arm64',
|
||||||
|
'bun-darwin-x64',
|
||||||
|
'bun-linux-x64',
|
||||||
|
'bun-linux-arm64',
|
||||||
|
] as const
|
||||||
|
|
||||||
|
type BunTarget = (typeof ALL_TARGETS)[number]
|
||||||
|
|
||||||
|
const ENTRYPOINT = '.output/server/index.mjs'
|
||||||
|
const OUTDIR = 'out'
|
||||||
|
const OUTFILE_BASE = 'server'
|
||||||
|
|
||||||
|
const DEFAULT_TARGETS: BunTarget[] = [
|
||||||
|
'bun-windows-x64',
|
||||||
|
'bun-darwin-arm64',
|
||||||
|
'bun-linux-x64',
|
||||||
|
]
|
||||||
|
|
||||||
|
const suffixFor = (target: BunTarget) => target.replace('bun-', '')
|
||||||
|
|
||||||
|
const isTarget = (value: string): value is BunTarget =>
|
||||||
|
(ALL_TARGETS as readonly string[]).includes(value)
|
||||||
|
|
||||||
|
const parseTargets = (): BunTarget[] => {
|
||||||
|
const args = process.argv.slice(2)
|
||||||
|
const targets: string[] = []
|
||||||
|
|
||||||
|
for (let i = 0; i < args.length; i++) {
|
||||||
|
const arg = args[i]
|
||||||
|
const next = args[i + 1]
|
||||||
|
if (arg === '--target' && next) {
|
||||||
|
targets.push(next)
|
||||||
|
i++
|
||||||
|
} else if (arg === '--targets' && next) {
|
||||||
|
targets.push(...next.split(','))
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (targets.length === 0) return DEFAULT_TARGETS
|
||||||
|
|
||||||
|
const invalid = targets.filter((t) => !isTarget(t))
|
||||||
|
if (invalid.length) {
|
||||||
|
throw new Error(
|
||||||
|
`Unknown target(s): ${invalid.join(', ')}\nAllowed: ${ALL_TARGETS.join(', ')}`,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return targets as BunTarget[]
|
||||||
|
}
|
||||||
|
|
||||||
|
const buildOne = async (target: BunTarget) => {
|
||||||
|
const suffix = suffixFor(target)
|
||||||
|
const outfile = `${OUTFILE_BASE}-${suffix}`
|
||||||
|
|
||||||
|
const result = await Bun.build({
|
||||||
|
entrypoints: [ENTRYPOINT],
|
||||||
|
outdir: OUTDIR,
|
||||||
|
compile: {
|
||||||
|
outfile,
|
||||||
|
target,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if (!result.success) {
|
||||||
|
throw new Error(
|
||||||
|
`Build failed for ${target}:\n${result.logs.map(String).join('\n')}`,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
target,
|
||||||
|
outputs: result.outputs.map((o) => path.relative('.', o.path)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const main = async () => {
|
||||||
|
const targets = parseTargets()
|
||||||
|
|
||||||
|
await rm(OUTDIR, { recursive: true, force: true })
|
||||||
|
console.log(`✓ 已清理输出目录: ${OUTDIR}`)
|
||||||
|
|
||||||
|
// Bun cross-compile 不支持真正并行,逐目标串行构建
|
||||||
|
const results: Awaited<ReturnType<typeof buildOne>>[] = []
|
||||||
|
for (const target of targets) {
|
||||||
|
const start = Date.now()
|
||||||
|
process.stdout.write(`🔨 构建 ${target}... `)
|
||||||
|
const result = await buildOne(target)
|
||||||
|
results.push(result)
|
||||||
|
console.log(`完成 (${Date.now() - start}ms)`)
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log('\n📦 构建完成:')
|
||||||
|
for (const r of results) {
|
||||||
|
console.log(` ${r.target}:`)
|
||||||
|
for (const p of r.outputs) {
|
||||||
|
console.log(` - ${p}`)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
main().catch((err) => {
|
||||||
|
console.error('\n❌ 构建失败:')
|
||||||
|
console.error(err instanceof Error ? err.message : err)
|
||||||
|
process.exit(1)
|
||||||
|
})
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "vite build",
|
"build": "vite build",
|
||||||
"compile": "bun build.ts",
|
"compile": "bun compile.ts",
|
||||||
"db:generate": "drizzle-kit generate",
|
"db:generate": "drizzle-kit generate",
|
||||||
"db:migrate": "drizzle-kit migrate",
|
"db:migrate": "drizzle-kit migrate",
|
||||||
"db:push": "drizzle-kit push",
|
"db:push": "drizzle-kit push",
|
||||||
@@ -27,7 +27,6 @@
|
|||||||
"@tanstack/react-router": "catalog:",
|
"@tanstack/react-router": "catalog:",
|
||||||
"@tanstack/react-router-ssr-query": "catalog:",
|
"@tanstack/react-router-ssr-query": "catalog:",
|
||||||
"@tanstack/react-start": "catalog:",
|
"@tanstack/react-start": "catalog:",
|
||||||
"@tauri-apps/api": "catalog:",
|
|
||||||
"drizzle-orm": "catalog:",
|
"drizzle-orm": "catalog:",
|
||||||
"drizzle-zod": "catalog:",
|
"drizzle-zod": "catalog:",
|
||||||
"postgres": "catalog:",
|
"postgres": "catalog:",
|
||||||
@@ -37,8 +36,6 @@
|
|||||||
"zod": "catalog:"
|
"zod": "catalog:"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@effect/platform": "catalog:",
|
|
||||||
"@effect/schema": "catalog:",
|
|
||||||
"@furtherverse/tsconfig": "workspace:*",
|
"@furtherverse/tsconfig": "workspace:*",
|
||||||
"@tailwindcss/vite": "catalog:",
|
"@tailwindcss/vite": "catalog:",
|
||||||
"@tanstack/devtools-vite": "catalog:",
|
"@tanstack/devtools-vite": "catalog:",
|
||||||
@@ -49,10 +46,8 @@
|
|||||||
"@vitejs/plugin-react": "catalog:",
|
"@vitejs/plugin-react": "catalog:",
|
||||||
"babel-plugin-react-compiler": "catalog:",
|
"babel-plugin-react-compiler": "catalog:",
|
||||||
"drizzle-kit": "catalog:",
|
"drizzle-kit": "catalog:",
|
||||||
"effect": "catalog:",
|
|
||||||
"nitro": "catalog:",
|
"nitro": "catalog:",
|
||||||
"tailwindcss": "catalog:",
|
"tailwindcss": "catalog:",
|
||||||
"typescript": "catalog:",
|
|
||||||
"vite": "catalog:",
|
"vite": "catalog:",
|
||||||
"vite-tsconfig-paths": "catalog:"
|
"vite-tsconfig-paths": "catalog:"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,9 +1,7 @@
|
|||||||
import { useMutation, useSuspenseQuery } from '@tanstack/react-query'
|
import { useMutation, useSuspenseQuery } from '@tanstack/react-query'
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
import { createFileRoute } from '@tanstack/react-router'
|
||||||
import { isTauri } from '@tauri-apps/api/core'
|
|
||||||
import { getCurrentWindow } from '@tauri-apps/api/window'
|
|
||||||
import type { ChangeEventHandler, FormEventHandler } from 'react'
|
import type { ChangeEventHandler, FormEventHandler } from 'react'
|
||||||
import { useEffect, useState } from 'react'
|
import { useState } from 'react'
|
||||||
import { orpc } from '@/client/query-client'
|
import { orpc } from '@/client/query-client'
|
||||||
|
|
||||||
export const Route = createFileRoute('/')({
|
export const Route = createFileRoute('/')({
|
||||||
@@ -21,11 +19,6 @@ function Todos() {
|
|||||||
const updateMutation = useMutation(orpc.todo.update.mutationOptions())
|
const updateMutation = useMutation(orpc.todo.update.mutationOptions())
|
||||||
const deleteMutation = useMutation(orpc.todo.remove.mutationOptions())
|
const deleteMutation = useMutation(orpc.todo.remove.mutationOptions())
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
if (!isTauri()) return
|
|
||||||
getCurrentWindow().setTitle('待办事项')
|
|
||||||
}, [])
|
|
||||||
|
|
||||||
const handleCreateTodo: FormEventHandler<HTMLFormElement> = (e) => {
|
const handleCreateTodo: FormEventHandler<HTMLFormElement> = (e) => {
|
||||||
e.preventDefault()
|
e.preventDefault()
|
||||||
if (newTodoTitle.trim()) {
|
if (newTodoTitle.trim()) {
|
||||||
|
|||||||
@@ -2,8 +2,11 @@
|
|||||||
"$schema": "../../node_modules/turbo/schema.json",
|
"$schema": "../../node_modules/turbo/schema.json",
|
||||||
"extends": ["//"],
|
"extends": ["//"],
|
||||||
"tasks": {
|
"tasks": {
|
||||||
|
"build": {
|
||||||
|
"env": ["NODE_ENV", "VITE_*"],
|
||||||
|
"outputs": [".output/**"]
|
||||||
|
},
|
||||||
"compile": {
|
"compile": {
|
||||||
"dependsOn": ["build"],
|
|
||||||
"outputs": ["out/**"]
|
"outputs": ["out/**"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,24 +10,21 @@ export default defineConfig({
|
|||||||
clearScreen: false,
|
clearScreen: false,
|
||||||
plugins: [
|
plugins: [
|
||||||
tanstackDevtools(),
|
tanstackDevtools(),
|
||||||
nitro({
|
|
||||||
preset: 'bun',
|
|
||||||
serveStatic: 'inline',
|
|
||||||
}),
|
|
||||||
tsconfigPaths(),
|
|
||||||
tailwindcss(),
|
tailwindcss(),
|
||||||
|
tsconfigPaths(),
|
||||||
tanstackStart(),
|
tanstackStart(),
|
||||||
react({
|
react({
|
||||||
babel: {
|
babel: {
|
||||||
plugins: ['babel-plugin-react-compiler'],
|
plugins: ['babel-plugin-react-compiler'],
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
|
nitro({
|
||||||
|
preset: 'bun',
|
||||||
|
serveStatic: 'inline',
|
||||||
|
}),
|
||||||
],
|
],
|
||||||
server: {
|
server: {
|
||||||
port: 3000,
|
port: 3000,
|
||||||
strictPort: true,
|
strictPort: true,
|
||||||
watch: {
|
|
||||||
ignored: ['**/src-tauri/**'],
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
[tools]
|
[tools]
|
||||||
node = "latest"
|
|
||||||
bun = "1"
|
bun = "1"
|
||||||
rust = 'latest'
|
node = "24"
|
||||||
|
|||||||
50
package.json
@@ -10,19 +10,17 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "turbo run build",
|
"build": "turbo run build",
|
||||||
"compile": "turbo run compile",
|
"compile": "turbo run compile",
|
||||||
"deploy": "turbo run deploy",
|
|
||||||
"dev": "turbo run dev",
|
"dev": "turbo run dev",
|
||||||
"fix": "turbo run fix",
|
"fix": "turbo run fix",
|
||||||
"typecheck": "turbo run typecheck"
|
"typecheck": "turbo run typecheck"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@biomejs/biome": "^2.3.11",
|
"@biomejs/biome": "^2.3.14",
|
||||||
"turbo": "^2.7.5"
|
"turbo": "^2.8.3",
|
||||||
|
"typescript": "^5.9.3"
|
||||||
},
|
},
|
||||||
"catalog": {
|
"catalog": {
|
||||||
"@biomejs/biome": "^2.3.11",
|
"@biomejs/biome": "^2.3.11",
|
||||||
"@effect/platform": "^0.94.2",
|
|
||||||
"@effect/schema": "^0.75.5",
|
|
||||||
"@orpc/client": "^1.13.4",
|
"@orpc/client": "^1.13.4",
|
||||||
"@orpc/contract": "^1.13.4",
|
"@orpc/contract": "^1.13.4",
|
||||||
"@orpc/openapi": "^1.13.4",
|
"@orpc/openapi": "^1.13.4",
|
||||||
@@ -31,35 +29,39 @@
|
|||||||
"@orpc/zod": "^1.13.4",
|
"@orpc/zod": "^1.13.4",
|
||||||
"@t3-oss/env-core": "^0.13.10",
|
"@t3-oss/env-core": "^0.13.10",
|
||||||
"@tailwindcss/vite": "^4.1.18",
|
"@tailwindcss/vite": "^4.1.18",
|
||||||
"@tanstack/devtools-vite": "^0.4.1",
|
"@tanstack/devtools-vite": "^0.5.1",
|
||||||
"@tanstack/react-devtools": "^0.9.2",
|
"@tanstack/react-devtools": "^0.9.5",
|
||||||
"@tanstack/react-query": "^5.90.19",
|
"@tanstack/react-query": "^5.90.20",
|
||||||
"@tanstack/react-query-devtools": "^5.91.2",
|
"@tanstack/react-query-devtools": "^5.91.3",
|
||||||
"@tanstack/react-router": "^1.154.12",
|
"@tanstack/react-router": "^1.158.4",
|
||||||
"@tanstack/react-router-devtools": "^1.154.12",
|
"@tanstack/react-router-devtools": "^1.158.4",
|
||||||
"@tanstack/react-router-ssr-query": "^1.154.12",
|
"@tanstack/react-router-ssr-query": "^1.158.4",
|
||||||
"@tanstack/react-start": "^1.154.12",
|
"@tanstack/react-start": "^1.159.0",
|
||||||
"@tauri-apps/api": "^2.9.1",
|
"@types/bun": "^1.3.8",
|
||||||
"@tauri-apps/cli": "^2.9.6",
|
"@types/node": "^24.3.0",
|
||||||
"@types/bun": "^1.3.6",
|
"@vitejs/plugin-react": "^5.1.3",
|
||||||
"@vitejs/plugin-react": "^5.1.2",
|
|
||||||
"babel-plugin-react-compiler": "^1.0.0",
|
"babel-plugin-react-compiler": "^1.0.0",
|
||||||
"drizzle-kit": "^0.31.8",
|
"drizzle-kit": "^0.31.8",
|
||||||
"drizzle-orm": "^0.45.1",
|
"drizzle-orm": "^0.45.1",
|
||||||
"drizzle-zod": "^0.8.3",
|
"drizzle-zod": "^0.8.3",
|
||||||
"effect": "^3.19.15",
|
"electron": "^34.0.0",
|
||||||
"nitro": "npm:nitro-nightly@3.0.1-20260122-201913-dfdff9e9",
|
"electron-builder": "^26.0.0",
|
||||||
|
"electron-vite": "^5.0.0",
|
||||||
|
"nitro": "npm:nitro-nightly@3.0.1-20260206-171553-bc737c0c",
|
||||||
"ohash": "^2.0.11",
|
"ohash": "^2.0.11",
|
||||||
"postgres": "^3.4.8",
|
"postgres": "^3.4.8",
|
||||||
"react": "^19.2.3",
|
"react": "^19.2.4",
|
||||||
"react-dom": "^19.2.3",
|
"react-dom": "^19.2.4",
|
||||||
|
"systeminformation": "^5.30.7",
|
||||||
"tailwindcss": "^4.1.18",
|
"tailwindcss": "^4.1.18",
|
||||||
"turbo": "^2.7.5",
|
"turbo": "^2.7.5",
|
||||||
"typescript": "^5.9.3",
|
"typescript": "^5.9.3",
|
||||||
"uuid": "^13.0.0",
|
"uuid": "^13.0.0",
|
||||||
"systeminformation": "^5.30.5",
|
"vite": "^8.0.0-beta.13",
|
||||||
"vite": "^8.0.0-beta.9",
|
"vite-tsconfig-paths": "^6.1.0",
|
||||||
"vite-tsconfig-paths": "^6.0.4",
|
|
||||||
"zod": "^4.3.6"
|
"zod": "^4.3.6"
|
||||||
|
},
|
||||||
|
"overrides": {
|
||||||
|
"@types/node": "catalog:"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,7 +15,6 @@
|
|||||||
"systeminformation": "catalog:"
|
"systeminformation": "catalog:"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@furtherverse/tsconfig": "workspace:*",
|
"@furtherverse/tsconfig": "workspace:*"
|
||||||
"typescript": "catalog:"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
22
turbo.json
@@ -1,30 +1,28 @@
|
|||||||
{
|
{
|
||||||
"$schema": "./node_modules/turbo/schema.json",
|
"$schema": "./node_modules/turbo/schema.json",
|
||||||
"dangerouslyDisablePackageManagerCheck": true,
|
"dangerouslyDisablePackageManagerCheck": true,
|
||||||
"globalDependencies": [
|
"globalDependencies": ["bun.lock"],
|
||||||
"package.json",
|
|
||||||
"bun.lock",
|
|
||||||
"turbo.json",
|
|
||||||
"biome.json"
|
|
||||||
],
|
|
||||||
"tasks": {
|
"tasks": {
|
||||||
"build": {
|
"build": {
|
||||||
"outputs": ["dist/**", ".output/**"]
|
"dependsOn": ["^build"]
|
||||||
},
|
},
|
||||||
"compile": {
|
"compile": {
|
||||||
"dependsOn": ["build"],
|
"dependsOn": ["build"]
|
||||||
"outputs": ["out/**"]
|
|
||||||
},
|
},
|
||||||
"dev": {
|
"dev": {
|
||||||
"cache": false,
|
"cache": false,
|
||||||
"persistent": true
|
"persistent": true
|
||||||
},
|
},
|
||||||
"fix": {
|
"fix": {
|
||||||
"outputs": []
|
"cache": false
|
||||||
},
|
},
|
||||||
"typecheck": {
|
"typecheck": {
|
||||||
"dependsOn": ["^typecheck"],
|
"inputs": [
|
||||||
"inputs": ["tsconfig.json", "tsconfig.*.json", "**/*.{ts,tsx}"],
|
"package.json",
|
||||||
|
"tsconfig.json",
|
||||||
|
"tsconfig.*.json",
|
||||||
|
"**/*.{ts,tsx,d.ts}"
|
||||||
|
],
|
||||||
"outputs": []
|
"outputs": []
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||