tauri-template AGENTS.md

AI Agent Instructions

Overview

This repository is a template with sensible defaults for building Tauri React apps.

Core Rules

New Sessions

• Read @docs/tasks.md for task management
• Review docs/developer/architecture-guide.md for high-level patterns
• Check docs/developer/README.md for the full documentation index
• Check git status and project structure

Development Practices

CRITICAL: Follow these strictly:

1. Use npm only: This project uses npm, NOT pnpm. Always use npm install, npm run, etc.
2. Read Before Editing: Always read files first to understand context
3. Follow Established Patterns: Use patterns from this file and docs/developer
4. Senior Architect Mindset: Consider performance, maintainability, testability
5. Batch Operations: Use multiple tool calls in single responses
6. Match Code Style: Follow existing formatting and patterns
7. Test Coverage: Write comprehensive tests for business logic
8. Quality Gates: Run npm run check:all after significant changes
9. No Dev Server: Ask user to run and report back
10. No Unsolicited Commits: Only when explicitly requested
11. Documentation: Update relevant docs/developer/ files for new patterns
12. Removing files: Always use rm -f

CRITICAL: Use Tauri v2 docs only. Always use modern Rust formatting: format!("{variable}")

Architecture Patterns (CRITICAL)

State Management Onion

useState (component) → Zustand (global UI) → TanStack Query (persistent data)

Decision: Is data needed across components? → Does it persist between sessions?

Performance Pattern (CRITICAL)

// ✅ GOOD: Selector syntax - only re-renders when specific value changes
const leftSidebarVisible = useUIStore(state => state.leftSidebarVisible)

// ❌ BAD: Destructuring causes render cascades (caught by ast-grep)
const { leftSidebarVisible } = useUIStore()

// ✅ GOOD: Use getState() in callbacks for current state
const handleAction = () => {
  const { data, setData } = useStore.getState()
  setData(newData)
}