forked from akai/readest
Huang Xin
956c71cd7b
Replace ESLint with Biome for ~14x faster linting (~360ms vs ~5s). - Add biome.json with rules matching ESLint parity (Next.js, a11y, TypeScript, unused vars/imports) - Remove eslint, @typescript-eslint/*, eslint-config-next, eslint-plugin-jsx-a11y, @eslint/* from deps - Remove eslint.config.mjs - Update lint script to: tsgo --noEmit && biome check . - Fix 11 real code issues caught by Biome (banned types, explicit any, unsafe finally, unreachable code, shadowed names) - Disable Biome formatter (Prettier stays for Tailwind class sorting) Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
92 lines
4.1 KiB
Markdown
92 lines
4.1 KiB
Markdown
## Project Overview
|
|
|
|
Readest is a cross-platform ebook reader built as a **Next.js 16 + Tauri v2** hybrid app. It's part of a pnpm monorepo at `/apps/readest-app/`. The app runs on web (CloudFlare Workers), desktop (macOS/Windows/Linux via Tauri), and mobile (iOS/Android via Tauri).
|
|
|
|
## Common Commands
|
|
|
|
```bash
|
|
# Development
|
|
pnpm dev-web # Web-only dev server (no Rust compilation needed)
|
|
pnpm tauri dev # Desktop dev with Tauri (compiles Rust backend)
|
|
|
|
# Building
|
|
pnpm build # Build Next.js for Tauri
|
|
pnpm build-web # Build Next.js for web deployment
|
|
|
|
# Testing (see [docs/testing.md](docs/testing.md) for full details)
|
|
pnpm test # Unit tests (vitest + jsdom)
|
|
pnpm test -- src/__tests__/utils/misc.test.ts # Run a single test file
|
|
pnpm test -- --watch # Watch mode
|
|
pnpm test:browser # Browser tests (Chromium via Playwright)
|
|
pnpm tauri:dev:test # Start Tauri app with webdriver
|
|
pnpm test:tauri # Run Tauri integration tests
|
|
|
|
# Linting & Formatting
|
|
pnpm lint # Biome (linter) + tsgo (type check)
|
|
pnpm format # Prettier (runs from monorepo root)
|
|
pnpm format:check # Check formatting without writing
|
|
|
|
# Rust
|
|
pnpm fmt:check # Check formatting Rust code (src-tauri)
|
|
pnpm clippy:check # Lint Rust code (src-tauri)
|
|
```
|
|
|
|
### Source Layout
|
|
|
|
| Directory | Purpose |
|
|
| ----------------- | ------------------------------------------------------------- |
|
|
| `src/app/` | Next.js App Router pages and API routes |
|
|
| `src/components/` | React components (reader, settings, library, assistant, etc.) |
|
|
| `src/services/` | Business logic: TTS, translators, OPDS, sync, AI, metadata |
|
|
| `src/store/` | Zustand state stores |
|
|
| `src/hooks/` | Custom React hooks |
|
|
| `src/libs/` | Document loaders, payment, storage, sync |
|
|
| `src/utils/` | Pure utility functions |
|
|
| `src/types/` | TypeScript type definitions |
|
|
| `src/context/` | React Context providers (Auth, Env, Sync, etc.) |
|
|
| `src/workers/` | Web Workers for background tasks |
|
|
| `src-tauri/` | Rust backend: Tauri plugins, platform-specific code |
|
|
|
|
### Path Aliases (tsconfig)
|
|
|
|
- `@/*` → `./src/*`
|
|
- `@/components/ui/*` → `./src/components/primitives/*`
|
|
|
|
### Rust Backend (`src-tauri/`)
|
|
|
|
Platform-specific code lives in `src-tauri/src/{macos,windows,android,ios}/`. Custom Tauri plugins are in `src-tauri/plugins/`.
|
|
|
|
## Project Rules
|
|
|
|
Rules are in `.claude/rules/`: test-first, typescript, verification.
|
|
|
|
### i18n
|
|
|
|
See [docs/i18n.md](docs/i18n.md) for the key-as-content translation approach, `stubTranslation` usage in non-React modules, and extraction workflow.
|
|
|
|
### Safe Area Insets
|
|
|
|
See [docs/safe-area-insets.md](docs/safe-area-insets.md) for rules on handling top/bottom insets for UI elements near screen edges.
|
|
|
|
## Web Browsing & QA (gstack)
|
|
|
|
For all web browsing, QA testing, and site interaction, use the `/browse` skill from gstack. **Never use `mcp__claude-in-chrome__*` tools directly.**
|
|
|
|
Available gstack skills:
|
|
|
|
- `/plan-ceo-review` — CEO/founder-mode plan review
|
|
- `/plan-eng-review` — Eng manager-mode plan review
|
|
- `/plan-design-review` — Designer's eye review of a live site
|
|
- `/design-consultation` — Design system consultation
|
|
- `/review` — Pre-landing PR review
|
|
- `/ship` — Ship workflow (merge, test, review, bump, PR)
|
|
- `/browse` — Fast headless browser for QA and site interaction
|
|
- `/qa` — QA test and fix bugs
|
|
- `/qa-only` — QA report only (no fixes)
|
|
- `/qa-design-review` — Designer's eye QA with fixes
|
|
- `/setup-browser-cookies` — Import cookies for authenticated testing
|
|
- `/retro` — Weekly engineering retrospective
|
|
- `/document-release` — Post-ship documentation update
|
|
|
|
If gstack skills aren't working, run `cd .claude/skills/gstack && ./setup` to build the binary and register skills.
|