-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy path.cursorrules
More file actions
361 lines (245 loc) · 14.1 KB
/
Copy path.cursorrules
File metadata and controls
361 lines (245 loc) · 14.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
# Android & AI Style Rules
> **מתי להשתמש:** בכל שינוי/PR – כללי סגנון ותשובות
> **ראו גם:** Commit/PR
---
## כללי כתיבה
- **תחשוב ותענה תמיד בעברית**
- **כתוב בשפה פשוטה** ומובנת לכולם, הימנע ממילים גבוהות
- **שמור על טון עניו** – הסבר כאילו אתה מדבר עם חבר טוב
- **כשיש כמה אפשרויות** – הצג קודם את הפתרון הפשוט והאמין ביותר
---
## פורמטור HTML/Jinja
> **מתי להשתמש:** בעת עבודה עם קבצי תבניות Jinja ב־`webapp/templates/**/*.html`
- **אל תריצו Prettier** (או כל פורמטור אוטומטי אחר) על קבצי Jinja, כי הוא שובר בלוקים של `{% ... %}`/`{{ ... }}`. אם צריך יישור קוסמטי – ערכו ידנית.
- אם חייבים להריץ Prettier על קבצים אחרים, **הוסיפו** את התיקייה `webapp/templates/` לקובץ `.prettierignore` כדי למנוע הרצה בטעות.
---
## הימנעות ממחיקות קבצים בטסטים ובסקריפטים
> **מתי להשתמש:** טסטים/סקריפטים שנוגעים לקבצים או ניקוי
> **ראו גם:** CI / Required Checks, מעטפת Bash למחיקה בטוחה
### 1. עבוד רק על תיקיות זמניות
- השתמש ב-`tmp` לכל קלט/פלט בטסטים (pytest: `tmp_path`)
- **אל תכתוב או תמחק** ב-root של הפרויקט או בתיקיות קוד מקור
### 2. קבע ENV/קונפיג למסלולי tmp בלבד
- ודא ש-ENV כמו `OUTPUT_DIR`/`WORKDIR` מוגדרים לתיקיות tmp
- בדוק שהם לא ריקים לפני שימוש (`assert` ולא default ל-`"."`)
### 3. אל תשתמש בגלובים גורפים
- הימנע מ-`rm -rf */*` או תבניות כמו `build*`
- העדף allowlist שמיועד לתת-תיקיה אחת ספציפית
### 4. סורגי בטיחות לפני מחיקה
- **אל תמחק** אם הנתיב לא מתחת ל-allowlist
- **אל תמחק** נתיבים מסוכנים: `/`, `.`, ספריית הפרויקט
### דוגמת Python למחיקה בטוחה
```python
from pathlib import Path
import shutil
def safe_rmtree(path: Path, allow_under: Path) -> None:
p = path.resolve()
base = allow_under.resolve()
if not str(p).startswith(str(base)) or p in (Path('/'), base.parent, Path.cwd()):
raise RuntimeError(f"Refusing to delete unsafe path: {p}")
shutil.rmtree(p)
```
### 5. הימנע משינוי cwd
- אם חייב, שמור/שחזר cwd, והשתמש בנתיבים מוחלטים למחיקה
### 6. נטרל ניקוי מסוכן ב-CI
- הימנע מ-`git clean`/`reset` על ה-workspace
- אם חייב, עבוד על clone זמני בלבד
### 7. במקביליות – הפרד תיקיות עבודה
- לכל טסט UUID ייחודי (לדוגמה: `/tmp/app-test-<uuid>`)
- או סדר טסטים שנוגעים לקבצים לריצה סריאלית
### 8. בדוק תקלות מוקדם
- הרחק הרשאות כתיבה מ-src בתקופת הטסטים (`chmod -w`)
- כרוך קריאות מחיקה ב-wrapper בטוח כדי להעלות חריגה מוקדם
### בדיקת קוד לאיתור מחיקות לא בטוחות
```bash
rg -n "(shutil.rmtree|os.remove|Path.unlink|rm -rf|rimraf)" -S
```
### שחזור לאחר מחיקה בטעות
- **אל תבצע** merge/PR כדי לא לדרוס היסטוריה
- בצע `git restore`/`git checkout` לקבצים או `git revert` לקומיטים
- אם אין היסטוריה מקומית: שחזר מ-CI artifacts/ענף גיבוי/מכונה אחרת
---
## קישור לתיעוד והקשר
> **מתי להשתמש:** בכל PR/מסמך – מדיניות וקישורים רלוונטיים
- קרא והסתמך על התיעוד: [CodeBot – Project Docs](https://amirbiron.github.io/CodeBot/)
- קובץ זה הוא מדיניות מחייבת לצוות; יש להפנות אליו ב-PRs ובתיעוד
- ⚠️ **לפני כל תיקון טסטים פתח את [CodeBot Docs](https://amirbiron.github.io/CodeBot/) וקרא את הנחיות הטסטים הרלוונטיות (async, aiohttp, cleanup וכו') לפני ביצוע שינוי**
---
## ChatOps – מודעות ושילוב
> **מתי להשתמש:** בכל משימה שדורשת מידע בזמן אמת (request_id, מצב שירות, תקלות פעילות, דיוק חיזוי)
- קיימת מערכת ChatOps פעילה עם פקודות כמו `/triage`, `/predict`, `/status`, `/errors` ועוד
- **כשנדרש מידע כזה:** אל תסיק מתוך הקוד. בקש מהמשתמש להריץ את הפקודה המתאימה בבוט ושתף את הפלט
- **פלט הבוט הוא מקור האמת** (Source of Truth) עבור החלטות ותשובות
### דוגמה כהנחיה פורמלית
```yaml
# 🤖 ChatOps Awareness
- name: ChatOps Integration
description: |
דע כי קיימת מערכת ChatOps פעילה עם פקודות כמו /triage, /predict, /status, /errors ועוד.
כאשר נדרש מידע בזמן אמת (כגון request_id, מצב שירות, תקלות פעילות, או דיוק חיזוי),
**אל תסיק מתוך הקוד** – התייעץ עם המשתמש ובקש ממנו להריץ את הפקודה המתאימה בבוט ושתף את הפלט.
המידע שיחזור מהבוט נחשב למקור האמת.
```
---
## כללי שימוש ב-AI/CodeBot
> **מתי להשתמש:** בכל שימוש ב-AI/אוטומציה בקוד וב-PRים
- כל שינוי שמוצע על ידי AI עובר code review אנושי לפני merge
- **אין להזין** סודות, מפתחות או PII לפרומפטים או קבצי הקשר
- פקודות שמורצות אוטומטית: ללא `sudo`, לא אינטראקטיביות, ורק בתיקיות tmp
- תעד ב-PR החלטות אוטומציה: מקור ההצעה, שיקולים ובדיקות שבוצעו
---
## Android/Kotlin/Compose
> **מתי להשתמש:** בפיתוח Android/Kotlin/Compose – סגנון, ארכיטקטורה וטסטים
> **ראו גם:** CI / Required Checks
### Kotlin
- העדף `val` על `var`, אי-שינוי, `data`/`sealed` classes
- Null-safety ברורה
### Concurrency
- Coroutines עם Structured Concurrency
- שימוש ב-`viewModelScope`/`CoroutineScope` נכון
### זרימות נתונים
- העדף `Flow`
- מיפוי ב-Repository
- Dispatchers מתאימים (IO/Default)
### ארכיטקטורה
- MVVM
- Single Source of Truth
- Repository/UseCases
- DI עם Hilt
### Compose
- State hoisting
- `remember`/`derivedStateOf`
- הימנע מ-side effects בתוך Composables
- שימוש ב-`LaunchedEffect`/`DisposableEffect`
- בדיקות עם compose-ui-test
---
## Commit/PR
> **מתי להשתמש:** כשכותבים קומיטים או פותחים Pull Request
> **ראו גם:** CI / Required Checks, קישור לתיעוד והקשר
### שמות ענפים
`fix/...`, `chore/...`, `feat/...`
### Conventional Commits
`feat`/`fix`/`chore`/`docs`/`refactor`/`test`/`build`
### תיאור PR
- תיאור קצר ב-HTML: What / Why / Tests
- כולל לינק ל-RTD build/preview אם יש
- מלא PR לפי התבנית שב-`.github/pull_request_template.md`
- צרף Docs Preview, בדיקות, צ'קליסט ו-Rollback
- **ציין מפורשות** האם עיינת ב-[CodeBot – Project Docs](https://amirbiron.github.io/CodeBot/)
### לפני merge
- תיאור ברור
- תוכנית בדיקות
- סיכוני Rollback
- עדכון docs
### UI
צרף צילום/וידאו תוצאות אם רלוונטי
**הערה:** טבלת דוגמאות ל-Conventional Commits והצ'קליסט לפני merge נשמרים בתבנית ה-PR
---
## CI / Required Checks
> **מתי להשתמש:** לפני merge ובבדיקת סטטוסי CI
> **ראו גם:** הימנעות ממחיקות קבצים בטסטים ובסקריפטים
### חובות
- מעבר ירוק: `./gradlew test detekt ktlintCheck`
- **אין להריץ** `git clean`/`reset` על ה-workspace
- עבודה רק על תיקיות זמניות
- טסטים שנוגעים לקבצים ירוצו בסביבה מבודדת לכל טסט
### סטטוסים נדרשים ב-PR
- "🔍 Code Quality & Security"
- "Unit Tests (3.11)"
- "Unit Tests (3.12)"
### נוספים
- אין `paths-ignore` על `.cursorrules` – שינוי בו מריץ CI
- שמור דיווח סטטוסים גם בגרסת legacy/plain אם נדרש למדיניות
---
## סודות ולוגים
> **מתי להשתמש:** בעת לוגים/קונפיג/אינטגרציות – מניעת דליפת מידע רגיש
- **אין לשמור** סודות בקוד או בלוגים; השתמש ב-ENV/Secret Manager
- **אל תרשום** PII; בצע השחרה (redaction) לערכים רגישים בלוגים
---
## מעטפת Bash למחיקה בטוחה
> **מתי להשתמש:** כשכותבים סקריפטי Bash שמבצעים מחיקות/ניקוי
```bash
set -euo pipefail
IFS=$'\n\t'
safe_rmrf() {
local target="${1:-}"
local allow_under="${2:-}"
[[ -z "$target" || -z "$allow_under" ]] && { echo "empty path"; exit 1; }
local rp_target rp_base
rp_target="$(readlink -f -- "$target")"
rp_base="$(readlink -f -- "$allow_under")"
[[ "$rp_target" == "/" || "$rp_target" == "$HOME" || "$rp_target" == "$PWD" ]] && {
echo "unsafe"; exit 1;
}
[[ "$rp_target" != "$rp_base"/* ]] && { echo "outside allowlist"; exit 1; }
rm -rf -- "$rp_target"
}
```
---
## Sphinx/RTD (תיעוד)
> **מתי להשתמש:** בעת בנייה/עדכון תיעוד Sphinx/RTD
### כללים
- **אין להריץ** קוד בטופ-לבל בזמן build (importים חייבים להיות בטוחים)
- RTD נחשב נכשל על אזהרות (`fail_on_warning: true`) – שמור 0 warnings
- השתמש ב-`:noindex:` בעמודי סקירה חופפים: api, database, handlers, services, configuration
### הגדרות
- `autodoc_mock_imports`: cairosvg, aiohttp, textstat, langdetect, pytest, search_engine, code_processor, integrations
- `docs/examples.rst` מוחרג עד שהעמוד יתווסף ל-toctree (ואז הסר מה-exclude)
---
## Telegram Bot – מניעת "Message is not modified"
> **מתי להשתמש:** בפיתוח/תחזוקת בוט Telegram בעת עריכת הודעות
### כללים
- כשנערכת רק המקלדת: השתמש ב-`safe_edit_message_reply_markup` (אותו טיפול חריגים)
- תמיד קרא `query.answer()` לפני עריכה
- עטוף `edit_message_text`/`edit_message_reply_markup` ב-wrapper שמתעלם מהשגיאה הזו בלבד
- **לא משתיקים** `BadRequest` אחרים; רק המקרה "message is not modified" נבלם
### דוגמה
```python
import telegram.error
async def safe_edit(query, text, reply_markup=None, parse_mode=None):
try:
await query.edit_message_text(
text=text,
reply_markup=reply_markup,
parse_mode=parse_mode
)
except telegram.error.BadRequest as e:
if "message is not modified" in str(e).lower():
return
raise
```
---
## GitHub – "📥 הורד קובץ מריפו"
> **מתי להשתמש:** בפלואו הורדת קבצים מהריפו – התנהגות UI בטוחה
### כללים
- בכניסה לפלואו: `browse_action=download`, אפס `multi_mode`/`safe_delete`
- במצב הורדה **לא מציגים** כפתורי מחיקה או מצב מחיקה
- חזרה לתפריט בלבד מחזירה את המצב לעריכה/מחיקה (אם נדרש)
---
## Gists/קישורים חיצוניים בהנחיות משתמש
> **מתי להשתמש:** כשהמשתמש מצרף Gist/קישור בבקשה הנדסית
### כללים
- בכל פעם שהמשתמש מצרף Gist/קישור קוד: **עיין בתוכן** לפני מימוש
- יישם בהתאם לרוח ההצעה
- מותר לסטות בפרטים אם יש שיקולי אבטחה/פשטות, **אבל ציין זאת**
- אם יש פער: הצע התאמה או שאל במידת הצורך
---
## Performance & Optimization Architecture
> **מתי להשתמש:** בכל פיתוח של Endpoint חדש, שאילתת DB, או דף ב־Webapp
### 1. חוק ה־Smart Projection (החרגת שדות כבדים)
- **לעולם אל תמשוך** את השדות `code`, `content`, או `raw_data` בשאילתות שמחזירות רשימה/אוסף של קבצים.
- השתמש תמיד בקבוע `HEAVY_FIELDS_EXCLUDE_PROJECTION` (מתוך `database/repository.py`).
- משיכת תוכן מלא תתבצע **רק** בבקשה מפורשת (Explicit Fetch) עבור צפייה או עריכה של קובץ בודד.
### 2. מטא־דאטה במקום חישובים בזיכרון
- העדף שימוש בשדות מחושבים ב־DB כמו `file_size` ו־`lines_count`.
- אם הוספת שדה תוכן חדש, ודא שהוא מתעדכן ב־`save_code_snippet` כך שלא נצטרך לספור שורות או בייטים בפייתון בזמן שליפת רשימות.
### 3. אופטימיזציית חיפוש (The Snippet Pattern)
- בחיפוש קוד, **אל תחזיר את כל הקובץ** מה־API.
- השתמש ב־Aggregation של MongoDB (`$regexFind`) כדי לחתוך רק את קטע הקוד הרלוונטי (Snippet) כבר ברמת בסיס הנתונים.
### 4. אינדקסים כחלק מהפיתוח
- כל שאילתה חדשה חייבת לעבור בדיקת אינדקסים ב־`database/repository.py`.
- העדף אינדקסים מורכבים (Compound Indexes) הכוללים את ה־`user_id` יחד עם סטטוס המחיקה/מועדפים.
### 5. טעינה אסינכרונית ב־Webapp (Lazy Loading)
- דפים כבדים ב־Webapp צריכים להחזיר HTML ראשוני מהר (< 200ms).
- השתמש ב־**Skeleton Loaders** ובשליפת נתונים מה־API דרך JavaScript ברקע.
- עטוף חישובים כבדים ב־`await asyncio.to_thread(...)` כדי לא לחסום את ה־Event Loop.