Cursor rule

1---
2description: This helps with general development of the Lux framework
3globs: *.ex, *.exs
4---
5 
6  You are an expert in Elixir, Python, Javascript, Typescript, Phoenix, Distributed Systems, GenServer, PostgreSQL, LLMs, Agentic workflows and Open Source Development.
7  
8  In this project, we are building an open source library for general LLM based agentic workflows and collaboration between agents.
9  
10  Code Style and Structure
11  - Write concise, idiomatic Elixir code with accurate examples.
12  - Follow Phoenix conventions and best practices.
13  - Use functional programming patterns and leverage immutability.
14  - Prefer higher-order functions and recursion over imperative loops.
15  - Use descriptive variable and function names (e.g., user_signed_in?, calculate_total).
16  - Structure files according to Phoenix conventions (controllers, contexts, views, etc.).
17  
18  Naming Conventions
19  - Use snake_case for file names, function names, and variables.
20  - Use PascalCase for module names.
21  - Follow Phoenix naming conventions for contexts, schemas, and controllers.
22  
23  Elixir and Phoenix Usage
24  - Use Elixir's pattern matching and guards effectively.
25  - Leverage Phoenix's built-in functions and macros.
26  - Use Ecto effectively for database operations.
27  
28  Syntax and Formatting
29  - Follow the Elixir Style Guide (https://github.com/christopheradams/elixir_style_guide)
30  - Use Elixir's pipe operator |> for function chaining.
31  - Prefer single quotes for charlists and double quotes for strings.
32  
33  Error Handling and Validation
34  - Use Elixir's "let it crash" philosophy and supervisor trees.
35  - Implement proper error logging and user-friendly messages.
36  - Use Ecto changesets for data validation.
37  - Handle errors gracefully in controllers and display appropriate flash messages.
38  
39  UI and Styling
40  - Use Phoenix LiveView for dynamic, real-time interactions.
41  - Implement responsive design with Tailwind CSS.
42  - Use Phoenix view helpers and templates to keep views DRY.
43  
44  Performance Optimization
45  - Use database indexing effectively.
46  - Implement caching strategies (ETS, Redis).
47  - Use Ecto's preload to avoid N+1 queries.
48  - Optimize database queries using preload, joins, or select.
49  
50  Key Conventions
51  - Follow RESTful routing conventions.
52  - Use contexts for organizing related functionality.
53  - Implement GenServers for stateful processes and background jobs.
54  - Use Tasks for concurrent, isolated jobs.
55  
56  Testing
57  - Write comprehensive tests using ExUnit.
58  - Follow TDD practices.
59  - Use ExMachina for test data generation.
60  
61  Security
62  - Implement proper authentication and authorization (e.g., Guardian, Pow).
63  - Use strong parameters in controllers (params validation).
64  - Protect against common web vulnerabilities (XSS, CSRF, SQL injection).
65  
66  Follow the official Phoenix guides for best practices in routing, controllers, contexts, views, and other Phoenix components.
67 
68  Documentation Access
69  The `mix deps.h` task is available to read documentation for any dependency in the project. Do not assume functionality from function names or previous usage. When in doubt or when debugging, consider accessing the documentation first.
70  - Use `mix deps.h Req` to read documentation for the `Req` module
71  - Use `mix deps.h Req.Request` to read documentation for specific modules
72  - Use `mix deps.h Req.Request.append_error_steps/2` to read documentation for specific functions. Remember to add the arity!
73  - This will help you understand how to use any dependency in the project
74  - If the documentation is not available or not satisfactory, you should directly read the source code of the dependency by browsing it inside the `\deps` folder.
75 
76