Cursor rule

1---
2description: When naming things - files, functions, urls, etc
3alwaysApply: false
4version: 1.1.0
5---
6 
7# Naming Conventions
8 
9When in doubt, take time to name things well. It's one of the hardest problems in
10computer science.
11 
12## Importance
13 
14- Names are a form of documentation that never goes out of date
15- Good names reduce cognitive load and make code self-documenting
16- Names should reveal intent and provide context
17- Time spent on naming is an investment in future understanding
18 
19## When to Pause and Consider Naming Carefully
20 
21The more permanent/harder to change, the more time to spend on naming:
22 
23- Creating new models or database tables
24- Defining core functions or classes
25- Establishing API endpoints or URLs
26- Naming background jobs or tasks
27- Creating new features or components
28- Defining key variables that appear throughout codebase
29 
30Notably, don't spend excessive time on naming for simple things that are easy to change.
31 
32## Naming Signals
33 
34Names that accurately describe their contents:
35 
36- `string-helpers.ts` over a generic catch-all name
37- `user-profile.tsx` matching the directory's casing convention
38- `auth.ts` as the final name, not a migration artifact with version suffixes
39 
40Names that belong in their context:
41 
42- Files matching their directory's established convention (kebab-case, PascalCase, etc.)
43- Consistent suffixes where the project uses them (`.service.ts`, `.controller.ts`)
44- Singular vs plural matching sibling files in the same directory
45 
46Names that stay current:
47 
48- Rename when the original purpose changes rather than letting name drift from contents
49- Remove temporary prefixes/suffixes once migration is complete
50- Consolidate when a file has outgrown its original name
51 
52## When Names Aren't Obvious
53 
54When a name for a new file, function, class, etc. isn't immediately obvious:
55 
56- Pause and ask what we should name it. It's better to ask than to guess and have to
57  rename later.
58- Consider multiple alternatives
59- Evaluate options based on:
60  - Clarity and intuitiveness
61  - Technical accuracy
62  - Future flexibility
63  - Project context
64