Eunjae LeeGitHubcoderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>* add docs for agents * update * Update .agents/README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
57 lines
1.0 KiB
Markdown
57 lines
1.0 KiB
Markdown
# Coding Standards & Best Practices
|
|
|
|
|
|
|
|
## Import Guidelines
|
|
|
|
### Type Imports
|
|
|
|
```typescript
|
|
// ✅ Good - Use type imports for TypeScript types
|
|
import type { User } from "@prisma/client";
|
|
import type { NextApiRequest, NextApiResponse } from "next";
|
|
|
|
// ❌ Bad - Regular import for types
|
|
import { User } from "@prisma/client";
|
|
```
|
|
|
|
|
|
|
|
## Code Structure
|
|
|
|
### Early Returns
|
|
|
|
- Prefer early returns to reduce nesting: `if (!booking) return null;`
|
|
|
|
### Composition Over Prop Drilling
|
|
|
|
- Use React children and context instead of passing props through multiple components
|
|
|
|
### Security Rules
|
|
|
|
```typescript
|
|
// ❌ NEVER expose credential keys
|
|
const user = await prisma.user.findFirst({
|
|
select: {
|
|
credentials: {
|
|
select: {
|
|
key: true, // ❌ NEVER do this
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
// ✅ Good - Never select credential.key field
|
|
const user = await prisma.user.findFirst({
|
|
select: {
|
|
credentials: {
|
|
select: {
|
|
id: true,
|
|
type: true,
|
|
// key field is excluded for security
|
|
}
|
|
}
|
|
}
|
|
});
|
|
```
|