Skip to content

Commit c772d70

Browse files
committed
Enhance Duron project documentation and guidelines
- Updated CLAUDE.md with comprehensive project overview, key features, and development workflow. - Introduced new rules file for Duron project context and development guidelines. - Emphasized exclusive use of Bun for all operations and provided quick reference commands. - Added details on project structure, key packages, and coding standards.
1 parent c83990a commit c772d70

File tree

3 files changed

+441
-82
lines changed

3 files changed

+441
-82
lines changed

.cursor/rules/duron-project.mdc

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
description: Duron project context and development guidelines
3+
globs: "**/*"
4+
alwaysApply: true
5+
---
6+
7+
# Duron Project Rules
8+
9+
This is the **Duron** monorepo - a type-safe job queue system for Node.js and Bun.
10+
11+
## Primary Context
12+
13+
**Always reference `CLAUDE.md` at the project root for comprehensive project documentation.**
14+
15+
The CLAUDE.md file contains:
16+
- Project overview and architecture
17+
- Monorepo structure and package details
18+
- Code patterns and examples
19+
- Development workflow and commands
20+
- Testing and linting guidelines
21+
- Key files reference
22+
23+
## Quick Reference
24+
25+
### Runtime
26+
27+
**Use Bun exclusively.** Never use Node.js, npm, pnpm, yarn, or vite (except for docs).
28+
29+
```bash
30+
bun install # Install dependencies
31+
bun <file> # Run a file
32+
bun test # Run tests
33+
bun run <script> # Run scripts
34+
```
35+
36+
### Packages
37+
38+
| Package | Description |
39+
|---------|-------------|
40+
| `duron` | Core library (client, actions, server, adapters) |
41+
| `duron-dashboard` | React dashboard UI |
42+
| `docs` | Documentation site |
43+
| `examples` | Example implementations |
44+
45+
### Key Commands
46+
47+
```bash
48+
bun run lint:fix # Fix linting issues
49+
bun test # Run tests
50+
bun run dev:dashboard # Dashboard dev server
51+
bun run typecheck # Type checking
52+
```
53+
54+
### Code Style
55+
56+
- Use Zod for schema validation
57+
- Use `defineAction()` for creating actions
58+
- Use `ctx.step()` for retryable operations
59+
- Use `NonRetriableError` for permanent failures
60+
- Use pino logger (not console.log)
61+
62+
## See Also
63+
64+
- `CLAUDE.md` - Full project documentation
65+
- `.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc` - Bun usage details
66+
- `.cursor/rules/shadcn.md` - Dashboard UI component rules

.cursor/rules/shadcn.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,12 @@ globs: "*.tsx"
44
alwaysApply: false
55
---
66

7+
> **See `CLAUDE.md` for full project context and documentation.**
8+
79
Do not touch any files in the `packages/duron-dashboard/src/components/ui` directory.
8-
These files are managed by Shadcn UI and should not be modified.
10+
These files are managed by Shadcn UI and should not be modified.
11+
12+
When working on the dashboard:
13+
- Use existing UI components from `src/components/ui/`
14+
- Follow established patterns in `src/views/` and `src/components/`
15+
- Use TanStack Query for data fetching

0 commit comments

Comments
 (0)