26 lines
1.3 KiB
Plaintext
26 lines
1.3 KiB
Plaintext
# @bytelyst Common Platform — Windsurf / Codeium Rules
|
|
# Read AGENTS.md for full context. These are the critical rules.
|
|
|
|
Project: @bytelyst Common Platform — Shared packages + microservices for the ByteLyst ecosystem
|
|
Stack: TypeScript, ESM, pnpm workspace, Fastify 5, Vitest, Azure Cosmos DB
|
|
|
|
## Architecture Rules
|
|
- packages/ — @bytelyst/* shared libraries (errors, cosmos, config, auth, api-client, fastify-core, react-auth, logger, testing, blob, extraction, monitoring, design-tokens)
|
|
- services/platform-service/ — consolidated platform service (port 4003)
|
|
- services/extraction-service/ — text extraction + Python sidecar (port 4005)
|
|
- dashboards/admin-web/ — admin console (port 3001)
|
|
- dashboards/tracker-web/ — issue tracker (port 3003)
|
|
|
|
## Conventions
|
|
- Package manager: pnpm — NEVER use npm
|
|
- ESM everywhere: "type": "module", .js extensions in imports
|
|
- Fastify module pattern: types.ts → repository.ts → routes.ts
|
|
- Use req.log / app.log — never console.log
|
|
- Every Cosmos document MUST include a productId field
|
|
- peerDependencies for heavy deps; workspace:* for inter-package deps
|
|
- Services re-export @bytelyst/* in src/lib/ for clean internal imports
|
|
- Commits: feat(scope): description / fix(scope): description
|
|
|
|
## Build Verification
|
|
- pnpm build && pnpm test && pnpm typecheck
|