|
1 | | -- **Language:** Use only English for code, including comments, documentation, examples, commits, configurations, errors, and tests. |
2 | | -- **Style**: Prefer self-documenting code over comments. |
3 | | -- **Comments**: DON'T use comments to explain code. |
4 | | -- **Inclusive Terms:** Use allowlist/blocklist instead of whitelist/blacklist, primary/replica instead of master/slave, and so on. |
5 | | -- **Tools**: Use `rg` instead of `grep`, `fd` instead of `find`, and if needed, use `tree` to understand directory structure. |
6 | | -- **Implementations**: On non-test code, using mocks are FORBIDDEN. Create the real implementation like PostgresUserRepository. |
7 | | -# When you need to call tools from the shell, **use this rubric**: |
| 1 | +# Guidelines |
8 | 2 |
|
9 | | -- Find Files: `fd` |
10 | | -- Find Text: `rg` (ripgrep) |
11 | | -- Find Code Structure (TS/TSX): `ast-grep` |
12 | | - - **Default to TypeScript:** |
13 | | - - `.ts` → `ast-grep --lang ts -p '<pattern>'` |
14 | | - - `.tsx` (React) → `ast-grep --lang tsx -p '<pattern>'` |
15 | | - - For other languages, set `--lang` appropriately (e.g., `--lang rust`). |
16 | | -- Select among matches: pipe to `fzf` |
17 | | -- JSON: `jq` |
18 | | -- YAML/XML: `yq` |
| 3 | +- **Language:** English only for code, comments, docs, commits, configs, errors, tests |
| 4 | +- **Style:** Self-documenting code, NO comments to explain code |
| 5 | +- **Terms:** allowlist/blocklist, primary/replica (inclusive alternatives) |
| 6 | +- **Implementations:** Real implementations only, NO mocks in non-test code |
19 | 7 |
|
20 | | -If ast-grep is available avoid tools `rg` or `grep` unless a plain‑text search is explicitly requested. |
| 8 | +# Shell Tools |
| 9 | + |
| 10 | +- **Files:** `fd`, **Text:** `rg`, **Structure:** `tree` |
| 11 | +- **Code Analysis:** `ast-grep --lang ts/tsx/rust -p '<pattern>'` |
| 12 | +- **Processing:** `fzf`, `jq`, `yq` |
| 13 | + |
| 14 | +**Priority:** Use `ast-grep` over `rg`/`grep` unless plain-text search requested |
0 commit comments