Skip to content

Agents.md

Latest commit

 

History

History
171 lines (87 loc) · 2.96 KB

Agents.md

File metadata and controls

171 lines (87 loc) · 2.96 KB

Project Overview

This repository represent:

A desktop application built with Tauri v2, Svelte 5 runes mode, TypeScript, TailwindCSS v4, shadcn-svelte, and lucide for icons.

Bun is used as the runtime, package manager, and task runner across all projects.

Setup / Build & Run

Install dependencies:

bun install

Development:

Desktop App (Tauri v2): bun tauri dev

Production Build:

Desktop App (Tauri v2): bun tauri build

Type-check the project:

bun tsc --noEmit

File-scoped Checks

Type-check a single file:

bun tsc --noEmit <file>

Run ESLint on a single file:

bun eslint --fix <file>

Format a file with Prettier:

bun prettier --write <file>

Run a specific test file:

bun test <path/to/file.test.ts>

Code Style & Conventions

Language: TypeScript in strict mode.

Svelte: use <script lang="ts"> in components.

TailwindCSS v4: prefer utility-first classes over custom CSS.

shadcn-svelte: use provided UI primitives/components consistently.

Icons: use lucide icons.

Formatting: run bun prettier --write . before commits.

Imports:

Prefer absolute imports from src/ over long relative paths.

Naming:

Components: PascalCase (e.g. MyButton.svelte).

Utilities, stores: camelCase or kebab-case as appropriate.

Project Structure

src/ – main application code (Svelte + TypeScript).

src/components/ – reusable Svelte components.

src/routes/ – view/route files (if applicable).

src/lib/ – utilities, hooks, and stores.

src-tauri/ – only present in desktop apps; contains Rust backend and Tauri config.

tests/ – unit/integration tests.

Testing Guidelines

Use Vitest (or compatible runner with Bun).

Add unit tests for new logic.

Run tests before committing:

  ```bash

  bun test

  ```

  ```bash

  bun check

  ```

  ```bash

  bun lint

  ```

Do’s & Don’ts

Do:

  • Use TailwindCSS utilities instead of custom CSS.

  • Use shadcn-svelte components for UI consistency.

  • Keep components small and modular.

  • Use lucide icons consistently.

Don’t:

  • Don’t use any unless unavoidable (add TODO if used).

  • Don’t hardcode secrets; use environment variables or config files.

  • Don’t add dependencies without reviewing size and compatibility.

Security

  • Exclude .env and secrets from version control.

  • For desktop apps, keep secrets in the Tauri (Rust) backend, not the frontend.

  • Never expose private APIs or keys in client-side code.

External References

General project docs: see README.md and/or docs.

Tauri v2 docs: https://tauri.app

Svelte 5 docs: https://svelte.dev

TailwindCSS v4 docs: https://tailwindcss.com/docs/v4

shadcn-svelte docs: https://shadcn-svelte.com

lucide icons: https://lucide.dev