| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 5 | 12 | 0% |
| Commands | 0 | 0 | 19 | 0% |
| Section tags | 3 | 0 | 11 | 21% |
What each file covers
Sections
0 shared · 5 only in A · 12 only in B- − Contribution & Refactor Guidelines
- − 1. Before Large Changes (Refactors, New Infra, New Domains)
- − 2. Backend Mindset
- − 3. TypeScript Style
- − 4. PR Hygiene
- + Project Coded Agent Guide
- + Tech Stack (by surface)
- + Structure & Responsibilities
- + Key Path Index (what lives where)
- + Commands (pnpm with filters)
- + Dependency Management Rule
- + Styling & Conventions
- + Testing Practices
- + TypeScript / Tooling
- + Refactoring & Comments
- + PR / Workflow Tips
- + Docker + SQL Conventions
Commands
0 shared · 0 only in A · 19 only in B- + eslint.config.ts
- + pnpm-workspace.yaml
- + docker/
- + pnpm -F @tg-search/server dev
- + pnpm run web:dev
- + pnpm run server:dev
- + pnpm run start
- + pnpm run build
- + pnpm run server:build
- + pnpm run test:run
- + pnpm run test:coverage
- + pnpm run lint
- + pnpm run lint:fix
- + pnpm run typecheck
- + pnpm run db:generate
- + pnpm install
- + pnpm install -F <target> <dependency>
- + vitest
- + docker-compose.yml
Section tags
3 shared · 0 only in A · 11 only in B- + setup
- + build
- + test
- + lint-format
- + architecture
- + testing-strategy
- + database
- + ui
- + monorepo
- + agent-behaviour
- + docs
- code-style
- types
- git-pr
Line diff
groupultra/telegram-search · .cursor/rules/contributing.mdc
@@ −1 @@
1---
2globs: apps/**/*, packages/**/*, drizzle/**/*, sql/**/*, config/**/*, Dockerfile, docker-compose.yml
3---
4
5## Contribution & Refactor Guidelines
6
7- **Prime rule**: Code is a liability, functionality is the asset. Any change must pay for its own complexity.
8
9### 1. Before Large Changes (Refactors, New Infra, New Domains)
10
11- Ask yourself, and write down in the PR description if possible:
12 - **Where is the bottleneck?** Latency, throughput, DX, or maintainability? Be concrete.
13 - **What is the simplest change that fixes it?** Prefer removal/cleanup over new systems.
14 - **What is the data flow?** Sketch: entrypoint → adapters → core → DB/Telegram → back.
15 - **What happens on failure?**
16 - If step B fails, does step A need a rollback or can we tolerate partial state?
17 - Is this best modeled as a saga / compensating action, or is “at-least-once” good enough?
18
19### 2. Backend Mindset
20
21- Avoid hidden in-memory state that couples requests:
22 - Session-local state lives in `CoreContext` or explicit stores, never in random globals.
23 - Cross-request state must go into the database or a well-defined cache layer.
24- For multi-step workflows:
25 - Make each step observable (events + logs) and ideally resumable.
26 - Design states explicitly (`pending`, `running`, `failed`, `completed`) rather than boolean flags.
27
28### 3. TypeScript Style
29
30- Strict TS is non-negotiable:
31 - Avoid `any` unless wrapping truly dynamic data, and confine it at the edge.
32 - Prefer small, composable types over giant “god” interfaces.
33- Functional style:
34 - Prefer pure functions and small modules over classes unless there is a clear lifecycle to model.
35 - Keep side effects at the boundary (adapters, services) and core logic pure where possible.
36
37### 4. PR Hygiene
38
39- Keep PRs focused:
40 - One domain behavior or refactor per PR.
41 - Mechanical renames and large formatting should be isolated from behavioral changes.
42- Tests:
43 - Add or update tests alongside behavior changes, especially for core and DB logic.
44 - Do not rely solely on manual E2E verification for critical paths.
45
46
groupultra/telegram-search · AGENTS.md
@@ +1 @@
1# Project Coded Agent Guide
2
3Concise but detailed reference for contributors working in the `groupultra/telegram-search` monorepo. Improve code when you touch it; avoid one-off patterns.
4
5## Tech Stack (by surface)
6
7- **Server (`apps/server`)**: Node.js, TypeScript, Drizzle ORM, Postgres/pgvector, WebSocket + REST, dotenvx.
8- **Web (`apps/web`)**: Vue 3 + Vite, Pinia.
9- **Core/shared (`packages/*`)**: common types, client SDK, schema, core services, bot.
10- **Tooling**: pnpm workspaces, Vitest, ESLint, TypeScript 5.9, tsdown, Drizzle Kit.
11
12## Structure & Responsibilities
13
14- **Apps**
15 - `apps/server`: backend service (runtime entry in `apps/server/src/`).
16 - `apps/web`: web UI (source in `apps/web/src/`).
17- **Packages**
18 - `packages/`: shared libraries and domain logic used by apps.
19- **Root tooling**
20 - Linting: `eslint.config.ts`.
21 - DB tooling: `drizzle/`, `drizzle.config.ts`.
22 - Workspace: `pnpm-workspace.yaml`.
23
24## Key Path Index (what lives where)
25
26- `apps/server/src`: API, WebSocket, and session services.
27- `apps/web/src`: Vue UI and client-side logic.
28- `packages/core`: core domain/services.
29- `packages/schema`: shared types + DB schema.
30- `packages/client`: client SDKs for integration.
31- `docker/`: compose files + init scripts for local/dev.
32- `.env.example`: baseline env config.
33
34## Commands (pnpm with filters)
35
36> Use pnpm workspace filters to scope tasks, e.g. `pnpm -F @tg-search/server dev`.
37
38- **Dev (web only)**: `pnpm run web:dev`
39- **Dev (server only)**: `pnpm run server:dev`
40- **Dev (web + server)**: `pnpm run start`
41- **Build web**: `pnpm run build`
42- **Build server**: `pnpm run server:build`
43- **Run tests**: `pnpm run test:run`
44- **Coverage**: `pnpm run test:coverage`
45- **Lint**: `pnpm run lint` / `pnpm run lint:fix`
46- **Typecheck**: `pnpm run typecheck`
47- **DB generate**: `pnpm run db:generate`
48
49## Dependency Management Rule
50
51- Do not edit `package.json` directly to add/remove deps. Use `pnpm install` so lockfile and manifest stay in sync.
52- For workspace deps: `pnpm install -F <target> <dependency>` (add `-D` for dev deps).
53- Tooling like `typescript`, `vite`, `vitest`, `tsdown`, `@types/node` belongs at the workspace root (`-w`).
54
55## Styling & Conventions
56
57- Favor clear module boundaries; shared logic goes in `packages/`.
58- Keep runtime entrypoints lean; move heavy logic into services/modules.
59- Prefer functional patterns for testability; use DI where helpful. Avoid classes unless required by APIs.
60- Use Valibot for schema validation; keep schemas close to their consumers.
61- Use Eventa (`@moeru/eventa`) for structured IPC/RPC contracts where needed.
62- File names: `kebab-case`.
63- Do not add backward-compatibility guards. If extended support is required, write refactor docs and complete the change in a separate, well-scoped effort.
64- If the refactor scope is small, do a progressive refactor step by step.
65- When modifying code, look for small, safe refactors to reduce duplication or improve clarity.
66- If you need a workaround, add a `// NOTICE:` comment explaining why, the root cause, and any relevant context.
67
68## Testing Practices
69
70- Use Vitest for unit/integration tests.
71- Mock external services and Postgres where practical; keep tests deterministic.
72- When fixing a bug, add a Vitest test that documents the previous failure mode and include a short `//` comment about the cause.
73- For DB interactions, prefer migration-driven integration tests with env guards.
74
75## TypeScript / Tooling
76
77- Stay strict with types; avoid `any` unless absolutely necessary.
78- Prefer small, composable modules; keep exports minimal and intentional.
79
80## Refactoring & Comments
81
82- Prefer progressive, incremental refactors that keep behavior stable.
83- Keep existing comments with the code when moving/refactoring. If a comment becomes obsolete, replace it with a brief note about why it was removed.
84- Use markers consistently: `// TODO:`, `// REVIEW:`, `// NOTICE:`.
85- Add concise comments for complex logic, algorithms, OS-interaction, and shared utilities. Avoid obvious comments.
86
87## PR / Workflow Tips
88
89- Keep changes scoped; use workspace filters for commands.
90- Summarize changes, how tested (commands), and follow-ups.
91- Improve legacy when you touch it; avoid one-off patterns.
92- Maintain structured `README.md` documentation for each `packages/` and `apps/` entry.
93- Always run `pnpm run typecheck` and `pnpm run lint:fix` after finishing a task.
94- Use Conventional Commits (e.g., `feat(server): add session refresh`).
95
96## Docker + SQL Conventions
97
98- Use `docker-compose.yml` as the compose filename.
99- Do not write SQL migration files manually. Always use `drizzle-kit generate` to create migrations, which will be placed in `**/sql/` with descriptive, kebab-case names.
100- Avoid Postgres enums to keep migrations and imports flexible.
101
@@ −1 +1 @@
1−---
2−globs: apps/**/*, packages/**/*, drizzle/**/*, sql/**/*, config/**/*, Dockerfile, docker-compose.yml
3−---
1+# Project Coded Agent Guide
42
5−## Contribution & Refactor Guidelines
3+Concise but detailed reference for contributors working in the `groupultra/telegram-search` monorepo. Improve code when you touch it; avoid one-off patterns.
64
7−- **Prime rule**: Code is a liability, functionality is the asset. Any change must pay for its own complexity.
5+## Tech Stack (by surface)
86
9−### 1. Before Large Changes (Refactors, New Infra, New Domains)
7+- **Server (`apps/server`)**: Node.js, TypeScript, Drizzle ORM, Postgres/pgvector, WebSocket + REST, dotenvx.
8+- **Web (`apps/web`)**: Vue 3 + Vite, Pinia.
9+- **Core/shared (`packages/*`)**: common types, client SDK, schema, core services, bot.
10+- **Tooling**: pnpm workspaces, Vitest, ESLint, TypeScript 5.9, tsdown, Drizzle Kit.
1011
11−- Ask yourself, and write down in the PR description if possible:
12− - **Where is the bottleneck?** Latency, throughput, DX, or maintainability? Be concrete.
13− - **What is the simplest change that fixes it?** Prefer removal/cleanup over new systems.
14− - **What is the data flow?** Sketch: entrypoint → adapters → core → DB/Telegram → back.
15− - **What happens on failure?**
16− - If step B fails, does step A need a rollback or can we tolerate partial state?
17− - Is this best modeled as a saga / compensating action, or is “at-least-once” good enough?
12+## Structure & Responsibilities
1813
19−### 2. Backend Mindset
14+- **Apps**
15+ - `apps/server`: backend service (runtime entry in `apps/server/src/`).
16+ - `apps/web`: web UI (source in `apps/web/src/`).
17+- **Packages**
18+ - `packages/`: shared libraries and domain logic used by apps.
19+- **Root tooling**
20+ - Linting: `eslint.config.ts`.
21+ - DB tooling: `drizzle/`, `drizzle.config.ts`.
22+ - Workspace: `pnpm-workspace.yaml`.
2023
21−- Avoid hidden in-memory state that couples requests:
22− - Session-local state lives in `CoreContext` or explicit stores, never in random globals.
23− - Cross-request state must go into the database or a well-defined cache layer.
24−- For multi-step workflows:
25− - Make each step observable (events + logs) and ideally resumable.
26− - Design states explicitly (`pending`, `running`, `failed`, `completed`) rather than boolean flags.
24+## Key Path Index (what lives where)
2725
28−### 3. TypeScript Style
26+- `apps/server/src`: API, WebSocket, and session services.
27+- `apps/web/src`: Vue UI and client-side logic.
28+- `packages/core`: core domain/services.
29+- `packages/schema`: shared types + DB schema.
30+- `packages/client`: client SDKs for integration.
31+- `docker/`: compose files + init scripts for local/dev.
32+- `.env.example`: baseline env config.
2933
30−- Strict TS is non-negotiable:
31− - Avoid `any` unless wrapping truly dynamic data, and confine it at the edge.
32− - Prefer small, composable types over giant “god” interfaces.
33−- Functional style:
34− - Prefer pure functions and small modules over classes unless there is a clear lifecycle to model.
35− - Keep side effects at the boundary (adapters, services) and core logic pure where possible.
34+## Commands (pnpm with filters)
3635
37−### 4. PR Hygiene
36+> Use pnpm workspace filters to scope tasks, e.g. `pnpm -F @tg-search/server dev`.
3837
39−- Keep PRs focused:
40− - One domain behavior or refactor per PR.
41− - Mechanical renames and large formatting should be isolated from behavioral changes.
42−- Tests:
43− - Add or update tests alongside behavior changes, especially for core and DB logic.
44− - Do not rely solely on manual E2E verification for critical paths.
38+- **Dev (web only)**: `pnpm run web:dev`
39+- **Dev (server only)**: `pnpm run server:dev`
40+- **Dev (web + server)**: `pnpm run start`
41+- **Build web**: `pnpm run build`
42+- **Build server**: `pnpm run server:build`
43+- **Run tests**: `pnpm run test:run`
44+- **Coverage**: `pnpm run test:coverage`
45+- **Lint**: `pnpm run lint` / `pnpm run lint:fix`
46+- **Typecheck**: `pnpm run typecheck`
47+- **DB generate**: `pnpm run db:generate`
4548
49+## Dependency Management Rule
50+
51+- Do not edit `package.json` directly to add/remove deps. Use `pnpm install` so lockfile and manifest stay in sync.
52+- For workspace deps: `pnpm install -F <target> <dependency>` (add `-D` for dev deps).
53+- Tooling like `typescript`, `vite`, `vitest`, `tsdown`, `@types/node` belongs at the workspace root (`-w`).
54+
55+## Styling & Conventions
56+
57+- Favor clear module boundaries; shared logic goes in `packages/`.
58+- Keep runtime entrypoints lean; move heavy logic into services/modules.
59+- Prefer functional patterns for testability; use DI where helpful. Avoid classes unless required by APIs.
60+- Use Valibot for schema validation; keep schemas close to their consumers.
61+- Use Eventa (`@moeru/eventa`) for structured IPC/RPC contracts where needed.
62+- File names: `kebab-case`.
63+- Do not add backward-compatibility guards. If extended support is required, write refactor docs and complete the change in a separate, well-scoped effort.
64+- If the refactor scope is small, do a progressive refactor step by step.
65+- When modifying code, look for small, safe refactors to reduce duplication or improve clarity.
66+- If you need a workaround, add a `// NOTICE:` comment explaining why, the root cause, and any relevant context.
67+
68+## Testing Practices
69+
70+- Use Vitest for unit/integration tests.
71+- Mock external services and Postgres where practical; keep tests deterministic.
72+- When fixing a bug, add a Vitest test that documents the previous failure mode and include a short `//` comment about the cause.
73+- For DB interactions, prefer migration-driven integration tests with env guards.
74+
75+## TypeScript / Tooling
76+
77+- Stay strict with types; avoid `any` unless absolutely necessary.
78+- Prefer small, composable modules; keep exports minimal and intentional.
79+
80+## Refactoring & Comments
81+
82+- Prefer progressive, incremental refactors that keep behavior stable.
83+- Keep existing comments with the code when moving/refactoring. If a comment becomes obsolete, replace it with a brief note about why it was removed.
84+- Use markers consistently: `// TODO:`, `// REVIEW:`, `// NOTICE:`.
85+- Add concise comments for complex logic, algorithms, OS-interaction, and shared utilities. Avoid obvious comments.
86+
87+## PR / Workflow Tips
88+
89+- Keep changes scoped; use workspace filters for commands.
90+- Summarize changes, how tested (commands), and follow-ups.
91+- Improve legacy when you touch it; avoid one-off patterns.
92+- Maintain structured `README.md` documentation for each `packages/` and `apps/` entry.
93+- Always run `pnpm run typecheck` and `pnpm run lint:fix` after finishing a task.
94+- Use Conventional Commits (e.g., `feat(server): add session refresh`).
95+
96+## Docker + SQL Conventions
97+
98+- Use `docker-compose.yml` as the compose filename.
99+- Do not write SQL migration files manually. Always use `drizzle-kit generate` to create migrations, which will be placed in `**/sql/` with descriptive, kebab-case names.
100+- Avoid Postgres enums to keep migrations and imports flexible.
46101
