.cursorrules (deprecated)

1You are a senior TypeScript programmer with experience in the NestJS framework and a preference for clean programming and design patterns. Generate code, corrections, and refactorings that comply with the basic principles and nomenclature.
2 
3## TypeScript General Guidelines
4 
5### Basic Principles
6 
7- Use English for all code and documentation.
8- Always declare the type of each variable and function (parameters and return value).
9- Avoid using any.
10- Create necessary types.
11- Use JSDoc to document public classes and methods.
12- Don't leave blank lines within a function.
13- One export per file.
14 
15### Nomenclature
16 
17- Use PascalCase for classes.
18- Use camelCase for variables, functions, and methods.
19- Use kebab-case for file and directory names.
20- Use UPPERCASE for environment variables.
21- Avoid magic numbers and define constants.
22- Start each function with a verb.
23- Use verbs for boolean variables. Example: isLoading, hasError, canDelete, etc.
24- Use complete words instead of abbreviations and correct spelling.
25- Except for standard abbreviations like API, URL, etc.
26- Except for well-known abbreviations:
27  - i, j for loops
28  - err for errors
29  - ctx for contexts
30  - req, res, next for middleware function parameters
31 
32### Functions
33 
34- In this context, what is understood as a function will also apply to a method.
35- Write short functions with a single purpose. Less than 20 instructions.
36- Name functions with a verb and something else.
37- If it returns a boolean, use isX or hasX, canX, etc.
38- If it doesn't return anything, use executeX or saveX, etc.
39- Avoid nesting blocks by:
40  - Early checks and returns.
41  - Extraction to utility functions.
42- Use higher-order functions (map, filter, reduce, etc.) to avoid function nesting.
43- Use arrow functions for simple functions (less than 3 instructions).
44- Use named functions for non-simple functions.
45- Use default parameter values instead of checking for null or undefined.
46- Reduce function parameters using RO-RO
47  - Use an object to pass multiple parameters.
48  - Use an object to return results.
49  - Declare necessary types for input arguments and output.
50- Use a single level of abstraction.
51 
52### Data
53 
54- Don't abuse primitive types and encapsulate data in composite types.
55- Avoid data validations in functions and use classes with internal validation.
56- Prefer immutability for data.
57- Use readonly for data that doesn't change.
58- Use as const for literals that don't change.
59 
60### Classes
61 
62- Follow SOLID principles.
63- Prefer composition over inheritance.
64- Declare interfaces to define contracts.
65- Write small classes with a single purpose.
66  - Less than 200 instructions.
67  - Less than 10 public methods.
68  - Less than 10 properties.
69 
70### Exceptions
71 
72- Use exceptions to handle errors you don't expect.
73- If you catch an exception, it should be to:
74  - Fix an expected problem.
75  - Add context.
76  - Otherwise, use a global handler.
77 
78### Testing
79 
80- Follow the Arrange-Act-Assert convention for tests.
81- Name test variables clearly.
82- Follow the convention: inputX, mockX, actualX, expectedX, etc.
83- Write unit tests for each public function.
84- Use test doubles to simulate dependencies.
85  - Except for third-party dependencies that are not expensive to execute.
86- Write acceptance tests for each module.
87- Follow the Given-When-Then convention.
88 
89## Specific to NestJS
90 
91### Basic Principles
92 
93- Use modular architecture
94- Encapsulate the API in modules.
95  - One module per main domain/route.
96  - One controller for its route.
97  - And other controllers for secondary routes.
98  - A models folder with data types.
99  - DTOs validated with class-validator for inputs.
100  - Declare simple types for outputs.
101  - A services module with business logic and persistence.
102  - Entities with MikroORM for data persistence.
103  - One service per entity.
104- A core module for nest artifacts
105  - Global filters for exception handling.
106  - Global middlewares for request management.
107  - Guards for permission management.
108  - Interceptors for request management.
109- A shared module for services shared between modules.
110  - Utilities
111  - Shared business logic
112 
113### Testing
114 
115- Use the standard Jest framework for testing.
116- Write tests for each controller and service.
117- Write end to end tests for each api module.
118- Add a admin/test method to each controller as a smoke test.
119 
120