[READ ONLY MIRROR] Spark Social AppView Server
github.com/sprksocial/server
atproto
deno
hono
lexicon
1# Agent Guidelines for Spark AppView
2
3## Commands
4
5- **Format**: `deno fmt`
6- **Lint**: `deno lint`
7- **Test all**: `deno test -P`
8- **Test single**: `deno test -P tests/main_test.ts`
9- **Dev**: `deno task dev` (requires MongoDB)
10- **Codegen**: `deno task codegen` (generate types from lexicons)
11
12## Code Style
13
14- **Runtime**: Deno with TypeScript, imports use JSR/npm prefixes
15- **Imports**: Use absolute imports from root (e.g., `../../../lex/index.ts`),
16 group by external/internal
17- **Types**: Explicit interface definitions, use TypeScript interfaces over
18 types. Avoid using `any` type.
19- **Naming**: camelCase for variables/functions, PascalCase for
20 types/interfaces, UPPER_CASE for constants. Always use double quotes.
21- **Error handling**: Use InvalidRequestError from `@atp/xrpc-server`, log
22 errors before throwing
23- **Patterns**: Pipeline pattern (skeleton → hydration → presentation) for
24 endpoints in `api/`, plugin architecture for indexing in
25 `data-plane/indexing/`
26- **Database**: Mongoose models with explicit schemas, use findOneAndUpdate with
27 upsert for idempotency. Only interact with database directly in the
28 `data-plane/` directory, otherwise use the `DataPlane` API.