Cursor rule

1---
2description: 
3globs: **/*.ts,**/*.tsx
4alwaysApply: false
5---
6## Technologies used
7 
8- **React & Astro** - Build interactive UIs with React components in Astro
9- **tRPC** - End-to-end type-safe APIs without schemas or code generation
10- **Tailwind CSS** - Utility-first CSS framework for rapid UI development
11- **TypeScript** - Full type safety across all packages
12- **Turborepo** - High-performance build system for JavaScript/TypeScript monorepos
13- **PNPM Workspaces** - Fast, disk-efficient package management
14- **ESLint & Prettier** - Code quality tools configured and ready to use
15- **Renovate** - Automated dependency updates
16- **Auth** - We use better-auth
17- **DB** - We use postgres and kysely as the client.
18 
19# Code Conventions
20 
21When writing or modifying code in this project, please adhere to the following conventions:
22 
231.  **TypeScript Best Practices**: Follow standard, idiomatic TypeScript coding practices for structure, naming, and types, unless otherwise overridden.
242.  **Minimal Comments**: Avoid adding comments unless they explain complex logic or non-obvious decisions. Well-written, self-explanatory code is preferred. Do not add comments that merely restate what the code does.
253.  **Tests as Documentation**: Rely on comprehensive tests (which will be added later if not present) to document the behavior and usage of the code, rather than extensive comments within the code itself.
264. **File naming conventions**: Use kebab-case when naming directories, TypeScript, and other files. 
275. **Type checking**: after major modifications run `pnpm typecheck` and fix any errors.
286. **UX/UI** We are using Tailwind CSS, React, shadcn/ui components and Lucide React icons. Generate responsive designs. Provide default props for React Components. Check to see if a shadcn component exists under `apps/webs/src/components/ui` before installing it.
297. **Models/db/tables** When pulling in a database type, use:
30 
31```typescript
32import type { Conversation } from '@app/db/types'
33import type { Selectable } from 'kysely'
34 
35interface ConversationItemProps {
36  conversation: Selectable<Conversation>
37}
38```
39 
408. **Installing packages**. We are using a pnpm Monorepo or Workspace. Typically when you install a pnpm package, you'll want to install it either in an app or you'll install it inside of a package. For example `pnpm add uuid --filter @app/web && pnpm add -D @types/uuid --filter @app/web`
41 
429. **Actions Pattern**: Organize server-side logic in the `packages/api/src/actions` directory following this structure:
43   - **Getters** (`getters.ts`) - Functions that retrieve data from the database
44   - **Setters** (`setters.ts`) - Functions that create or update data
45   - **Validators** (`validators.ts`) - Functions that validate input data
46   - **Checkers** (`checkers.ts`) - Functions that check permissions and authorization
47   - **Domain-specific logic** - Additional files for complex business logic (e.g., `process-inbound.ts`)
48   
49   Example structure:
50```
51   packages/api/src/actions/emails/
52   ├── getters.ts     # getProjectInboundEmailAddress()
53   ├── setters.ts     # createProjectInboundEmailToken()
54   ├── validators.ts  # validateMailgunWebhook()
55   ├── checkers.ts    # assertProjectEmailPermission()
56   └── process-inbound.ts  # processInboundEmail()
57```
58 
5910. **API Exports for apps/web**: To make functions and types from `packages/api` available in `apps/web`, you MUST export them in `packages/api/src/index.ts`:
60 
61```typescript
62    // packages/api/src/index.ts
63    
64    // Export functions
65    export { processInboundEmail } from './actions/emails/process-inbound'
66    export { getProjectInboundEmailAddress } from './actions/emails/getters'
67    
68    // Export types
69    export type { MailgunWebhookSchema } from './actions/emails/process-inbound'
70```
71 
72    Then in `apps/web`, import from `@app/api`:
73```typescript
74    // ✅ Correct - imports from the package export
75    import { processInboundEmail, MailgunWebhookSchema } from '@app/api'
76    
77    // ❌ Wrong - direct file imports will fail
78    import { processInboundEmail } from '@app/api/src/actions/emails/process-inbound'
79```
80 
81    **Important**: If you forget to export in `index.ts`, the import will fail with linting/type errors.
82 
83 
84Only make the exact changes I request—do not modify, remove, or alter any other code, styling, or page elements unless explicitly instructed. If my request conflicts with existing code, styling, or functionality, or if you anticipate any issues, pause execution and notify me for confirmation before proceeding. Always follow this rule for every modification. If in doubt, ask before making any change.
85