docs: correct Development Guidelines in the beta README
Evidence: spikersoft-angular@master package.json:24 test-all is nx run-many, and package.json:26 is playwright e2e. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
1 parent
3a6c5e92eb
commit
dae128a3e7
1 file changed
+11
-12
@@ -1459,31 +1459,30 @@ All profile forms (Personal, Interests, Travel, Appearance, and Social) are prot
|
||||
- Standalone components (no NgModules)
|
||||
- Signals for state management
|
||||
- OnPush change detection
|
||||
- See `.cursor/rules/spikersoft-angular/` for detailed guidelines
|
||||
- See `spikersoft-angular/.cursor/rules/` for detailed guidelines
|
||||
|
||||
**Backend (C#):**
|
||||
- CQRS pattern with MediatR
|
||||
- Repository pattern for data access
|
||||
- .NET 10 / C# 14 features encouraged
|
||||
- See `.cursor/rules/spikersoft-backend/` for detailed guidelines
|
||||
- See `spikersoft-backend/.cursor/rules/` for detailed guidelines
|
||||
|
||||
### Testing
|
||||
|
||||
**Frontend:**
|
||||
```bash
|
||||
pnpm run test-spikersoft # Unit tests for spikersoft only (Nx → Vitest)
|
||||
pnpm run test-all # All test targets (5 projects: spikersoft, tools, keycloak-admin, spikersoft-theme, wasm-voxel)
|
||||
pnpm run test-all:detect-leaks # Same projects, but with VITEST_DETECT_ASYNC_LEAKS=true → forks pool flags dangling timers / unhandled promises
|
||||
pnpm run test-spikersoft # The spikersoft app only (Nx → Vitest)
|
||||
pnpm run test-all # Every Nx project with a test target (122 projects)
|
||||
pnpm run test-all:detect-leaks # Same run with VITEST_DETECT_ASYNC_LEAKS=true
|
||||
pnpm run e2e # Playwright. e2e:secrets hydrates env from OpenBao first
|
||||
```
|
||||
|
||||
`test-all:detect-leaks` flips every project into Vitest's `forks` pool with `detectAsyncLeaks: true`. Each project's `vitest.config.ts` checks the env var and toggles the pool accordingly so the regular `test-all` keeps the faster `threads` pool. Cross-platform env-var setting uses `cross-env` (devDependency).
|
||||
|
||||
There is no `e2e` script in `spikersoft-angular/package.json`; add an Nx E2E target if you introduce browser E2E.
|
||||
`test-all:detect-leaks` sets `VITEST_DETECT_ASYNC_LEAKS` with `cross-env`. Only `projects/spikersoft/vitest.config.ts` reads that variable and switches the app to the `forks` pool with `detectAsyncLeaks: true`. The other Vitest configs do not. A normal `test-spikersoft` keeps the `threads` pool.
|
||||
|
||||
**Backend:**
|
||||
```bash
|
||||
dotnet test # All tests
|
||||
dotnet test --filter "Category=Unit" # Unit tests only
|
||||
dotnet test # All tests
|
||||
dotnet test --filter "Category!=Integration" # Skip tests tagged Category=Integration. There is no Category=Unit trait.
|
||||
```
|
||||
|
||||
### Where issues live
|
||||
@@ -1537,8 +1536,8 @@ This complements manual use of the Gitea web UI: the same [https://git.spikersof
|
||||
|
||||
- **Logging**: Serilog → Seq (structured logging with correlation IDs)
|
||||
- **Tracing**: OpenTelemetry → Jaeger (OTLP gRPC on port 4317)
|
||||
- **Metrics**: OpenTelemetry exporters → InfluxDB v2.7
|
||||
- **Health**: `/healthz` endpoint with 13 infrastructure checks (see [Health Check & Observability](#health-check--observability))
|
||||
- **Metrics**: OpenTelemetry meters export OTLP to the Jaeger endpoint (`http://jaeger:4317`). InfluxDB 2.7.12 stores health-check history and host metrics.
|
||||
- **Health**: `/healthz` runs 15 checks when TLS checks are enabled (the default): 13 always-on checks plus Certificate Files and TLS Endpoints. `HealthChecks:Tls:Enabled=false` skips those two (see [Health Check & Observability](#health-check--observability))
|
||||
|
||||
All cross-service calls include correlation IDs for distributed tracing.
|
||||
|
||||
|
||||
Reference in new issue
Block a user