bytelyst/learning_ai_common_plat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(audit): mark generator warning cleanup

Browse Source 
What changed:
- Recorded e9a70ed and 433c3a5 warning-policy batches.
- Updated live lint baseline to 0 errors / 101 warnings.
- Marked create-app and design-token generator console output as intentional CLI output.

Verification:
- pnpm lint
This commit is contained in:
Saravana Achu Mac 2026-05-04 16:38:53 -07:00
parent 433c3a5493
commit 2218067ef0
3 changed files with 56 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/AUDIT_PLATFORM.md
View File

@ -17,7 +17,7 @@ Legend: 🔴 critical · 🟠 high · 🟡 medium · 🟢 low ·
| `pnpm install -r` | ✅ pass | No warnings when `GITEA_NPM_TOKEN` is exported after sourcing `~/.zshrc`. |
| `pnpm typecheck` | ✅ pass | All TS sources compile (`tsc --noEmit`). |
| `pnpm test` | ✅ pass | ~2,200 tests across 18+ test suites; one cowork-service `EPIPE` flake cleared on focused rerun. |
| `pnpm lint` | ✅ pass | Workspace lint exits 0 with 0 errors / 155 warnings after `5b0fbc2`. See section W. |
| `pnpm lint` | ✅ pass | Workspace lint exits 0 with 0 errors / 101 warnings after `433c3a5`. See section W. |
## A. Lint pipeline blockers (fixed by this audit)
@ -57,9 +57,9 @@ The stale handoff note expected 85 pre-existing errors, but a live rerun on
Remaining lint output is warnings only. The largest groups are still
`no-console` in CLI tools, code generators, and diagnostic/runtime review areas
(`create-app`, `sidecar-monitor`, platform `gen-module`,
`migrate-referrals`, push notifications, and diagnostics modules). These are
case-by-case judgment calls and not blocking.
(`sidecar-monitor`, platform `gen-module`, `migrate-referrals`, push
notifications, and diagnostics modules). These are case-by-case judgment calls
and not blocking.
Follow-up package sweeps on 2026-05-04:
@ -73,16 +73,21 @@ Follow-up package sweeps on 2026-05-04:
warnings.
- `5b0fbc2` documented intentional `@bytelyst/config` Key Vault startup
diagnostics with narrow lint justifications.
- `e9a70ed` documented intentional `@lysnrai/monitoring` health-check CLI
output with a file-level lint justification.
- `433c3a5` documented intentional `@bytelyst/create-app` generator output and
design-token generation output with narrow file-level lint justifications.
Post-config sweep verification reran config build/test/lint and workspace lint;
all pass. Workspace lint remains at **0 errors** with **155
Post-generator sweep verification reran create-app build/test/lint,
design-tokens scoped lint, and workspace lint; all pass. Workspace lint remains
at **0 errors** with **101
warnings**.
## R. Repo-state observations (not fixed)
| # | Observation | Severity | Status |
| --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------: | :----------------: |
| R1 | Working tree had 3 uncommitted edits when the audit started: `docker-compose.ecosystem.yml`, `products/nomgap/product.json`, and `services/platform-service/src/modules/flags/seed.ts`. These were finalized separately in `b440330` (`chore(nomgap): finalize product deployment config`). Current working tree is clean after `5b0fbc2`. | — | ✅ |
| R1 | Working tree had 3 uncommitted edits when the audit started: `docker-compose.ecosystem.yml`, `products/nomgap/product.json`, and `services/platform-service/src/modules/flags/seed.ts`. These were finalized separately in `b440330` (`chore(nomgap): finalize product deployment config`). Current working tree is clean after `433c3a5`. | — | ✅ |
| R2 | Local `main` was 17 commits behind `origin/main` at the start of the session. Backup branch `backup/main-20260504-062733` was taken from `origin/main` (the source of truth) — local stale main was _not_ backed up. | 🟢 | ✅ (backup exists) |
| R3 | `.npmrc` references `${GITEA_NPM_TOKEN}`. On this machine `~/.zshrc` defines the token but does not export it, so use `source ~/.zshrc && export GITEA_NPM_TOKEN` before `pnpm`; this silences the WARN. | 🟢 | ✅ documented |
| R4 | Earlier `pnpm install -r` reported peer warnings for `@azure/core-client@^1.10.0`. A live rerun with the token exported reported no peer warnings. | 🟢 | ✅ verified |

61
docs/AUDIT_WARNING_COMPLETION_CHECKLIST.md
View File

@ -19,8 +19,8 @@ As of the latest local sweep:
| `pnpm install -r --prefer-offline` | Pass | Run with `source ~/.zshrc && export GITEA_NPM_TOKEN`. |
| `pnpm typecheck` | Pass | All workspace TypeScript compiles. |
| `pnpm test` | Pass with known load sensitivity | Full suite passes; isolated reruns cleared prior transient platform/cowork timeouts. |
| `pnpm lint` | Pass | `0` errors. Latest lint rerun after `5b0fbc2`: `155` warnings. |
| Known untouched WIP | Clear | Prior nomgap deployment WIP was finalized separately in `b440330`; current working tree is clean after `5b0fbc2`. |
| `pnpm lint` | Pass | `0` errors. Latest lint rerun after `433c3a5`: `101` warnings. |
| Known untouched WIP | Clear | Prior nomgap deployment WIP was finalized separately in `b440330`; current working tree is clean after `433c3a5`. |
Recent warning-cleanup commits:
@ -37,6 +37,8 @@ Recent warning-cleanup commits:
| `5fb4921` | `@bytelyst/broadcast-client` | Documented deep-link diagnostics. |
| `1089597` | `@bytelyst/admin-web` | Cleared remaining W2 dashboard warnings. |
| `5b0fbc2` | `@bytelyst/config` | Documented Key Vault diagnostics. |
| `e9a70ed` | `@lysnrai/monitoring` | Documented health-check CLI output. |
| `433c3a5` | `@bytelyst/create-app` | Documented generator CLI output. |
## Agent Execution Protocol
@ -397,14 +399,25 @@ behavior, CLI output, or noise.
`pnpm --filter @bytelyst/config test`,
`pnpm --filter @bytelyst/config exec eslint . --ext .ts,.tsx`, and
`pnpm lint`.
- [ ] `packages/create-app/src/generators/agents-md.ts`: classify as
generator/CLI.
- [ ] `packages/create-app/src/generators/api-routes.ts`: classify as
generator/CLI.
- [ ] `packages/design-tokens/scripts/generate.ts`: classify as script output.
- [x] `packages/create-app/src/generators/agents-md.ts`: classify as
generator/CLI. Done in `433c3a5`; warning delta `-21`; retained generator
console output as CLI UI and verified with create-app build/test/lint and
workspace lint.
- [x] `packages/create-app/src/generators/api-routes.ts`: classify as
generator/CLI. Done in `433c3a5`; warning delta `-28`; retained generator
console output as CLI UI and verified with create-app build/test/lint and
workspace lint.
- [x] `packages/design-tokens/scripts/generate.ts`: classify as script output.
Done in `433c3a5`; warning delta `-1`; retained generation confirmation
output and verified with design-tokens scoped lint and workspace lint.
- [ ] `packages/diagnostics-client/src/client.ts`: document console capture as
intentional or add narrow inline disables.
- [ ] `services/monitoring/health-check.ts`: classify as CLI health-check.
- [x] `services/monitoring/health-check.ts`: classify as CLI health-check.
Done in `e9a70ed`; warning delta `-5`; retained health-check console
output as the command UI and verified with
`pnpm --filter @lysnrai/monitoring exec tsc --noEmit`,
`pnpm --filter @lysnrai/monitoring exec eslint . --ext .ts,.tsx`, and
`pnpm lint`.
- [ ] `services/extraction-service/src/modules/extract/sidecar-monitor.ts`:
review whether console is service runtime or local monitor output.
- [ ] Add tests only when behavior is changed, not for pure lint policy.
@ -476,10 +489,10 @@ Goal: keep future agents aligned with the true baseline.
- [ ] Keep `docs/CODEX_RESUME_PROMPT.md` aligned with the latest workflow.
- [x] Record warning counts after each batch in this checklist. Use the latest
`/tmp/lint-*.log` path and warning count. Post-agent reconciliation
reran `pnpm lint`; current baseline is `0` errors / `173` warnings.
reran `pnpm lint`; current baseline is `0` errors / `101` warnings.
- [x] Include commit hashes in this checklist for every completed batch. The
current completed batch set is `db4257f`, `021f053`, `04d2398`,
`5fb4921`, `1089597`, and `5b0fbc2`.
`5fb4921`, `1089597`, `5b0fbc2`, `e9a70ed`, and `433c3a5`.
- [x] Keep "do not touch nomgap WIP" instructions visible until those files are
resolved by their owner. Done after `b440330`; nomgap deployment config
is now committed and the working tree is clean.
@ -514,16 +527,18 @@ Goal: keep future agents aligned with the true baseline.
## Progress Log
| Date | Commit | Change | Warning impact |
| ---------- | --------- | ---------------------------------------------- | -------------------------------------------------------------------- |
| 2026-05-04 | `4690072` | Typed `@bytelyst/api-client` header merging. | Removed 1 `no-explicit-any` warning. |
| 2026-05-04 | `afe7d88` | Typed `@bytelyst/monitoring` fetch test mocks. | Removed 6 `no-explicit-any` warnings. |
| 2026-05-04 | `b6da94d` | Typed tracker-web proxy test request helper. | Removed 1 `no-explicit-any` warning. |
| 2026-05-04 | `9625999` | Removed stale platform-service lint disables. | Removed 2 stale-disable warnings. |
| 2026-05-04 | `6978ddb` | Typed cowork-service test doubles. | Removed cowork-service test `any` cluster. |
| 2026-05-04 | `db4257f` | Cleared admin feedback page React warnings. | Removed 7 W2 warnings; lint remains 0 errors. |
| 2026-05-04 | `021f053` | Typed predictive campaign event dispatch. | Removed 5 `no-explicit-any` warnings; workspace lint `189` -> `184`. |
| 2026-05-04 | `04d2398` | Cleared tracker-web roadmap lint warnings. | Removed 5 workspace warnings; tracker scoped lint is 0 warnings. |
| 2026-05-04 | `5fb4921` | Documented broadcast deep-link diagnostics. | Removed 2 no-console warnings; workspace lint `176` -> `174`. |
| 2026-05-04 | `1089597` | Cleared remaining admin-web W2 warnings. | Removed 16 admin-web warnings; workspace lint `173` -> `157`. |
| 2026-05-04 | `5b0fbc2` | Documented config Key Vault diagnostics. | Removed 2 no-console warnings; workspace lint `157` -> `155`. |
| Date | Commit | Change | Warning impact |
| ---------- | --------- | ---------------------------------------------------- | -------------------------------------------------------------------- |
| 2026-05-04 | `4690072` | Typed `@bytelyst/api-client` header merging. | Removed 1 `no-explicit-any` warning. |
| 2026-05-04 | `afe7d88` | Typed `@bytelyst/monitoring` fetch test mocks. | Removed 6 `no-explicit-any` warnings. |
| 2026-05-04 | `b6da94d` | Typed tracker-web proxy test request helper. | Removed 1 `no-explicit-any` warning. |
| 2026-05-04 | `9625999` | Removed stale platform-service lint disables. | Removed 2 stale-disable warnings. |
| 2026-05-04 | `6978ddb` | Typed cowork-service test doubles. | Removed cowork-service test `any` cluster. |
| 2026-05-04 | `db4257f` | Cleared admin feedback page React warnings. | Removed 7 W2 warnings; lint remains 0 errors. |
| 2026-05-04 | `021f053` | Typed predictive campaign event dispatch. | Removed 5 `no-explicit-any` warnings; workspace lint `189` -> `184`. |
| 2026-05-04 | `04d2398` | Cleared tracker-web roadmap lint warnings. | Removed 5 workspace warnings; tracker scoped lint is 0 warnings. |
| 2026-05-04 | `5fb4921` | Documented broadcast deep-link diagnostics. | Removed 2 no-console warnings; workspace lint `176` -> `174`. |
| 2026-05-04 | `1089597` | Cleared remaining admin-web W2 warnings. | Removed 16 admin-web warnings; workspace lint `173` -> `157`. |
| 2026-05-04 | `5b0fbc2` | Documented config Key Vault diagnostics. | Removed 2 no-console warnings; workspace lint `157` -> `155`. |
| 2026-05-04 | `e9a70ed` | Documented monitoring health-check output. | Removed 5 no-console warnings; workspace lint `155` -> `150`. |
| 2026-05-04 | `433c3a5` | Documented create-app/design-token generator output. | Removed 50 no-console warnings; workspace lint `151` -> `101`. |

10
docs/HANDOVER.md
View File

@ -12,7 +12,7 @@ A tooling-backed audit was performed across all 69 workspace packages.
`pnpm install / typecheck / lint` pass cleanly on the current workspace.
`pnpm lint` was previously failing fast at one package, but a structural eslint
config fix + 13 mechanical lint fixes made the lint pipeline run end-to-end.
A fresh rerun on 2026-05-04 shows **0 lint errors / 155 warnings**; the old
A fresh rerun on 2026-05-04 shows **0 lint errors / 101 warnings**; the old
85-error P-sweep handoff is stale.
---
@ -25,7 +25,7 @@ A fresh rerun on 2026-05-04 shows **0 lint errors / 155 warnings**; the old
| `pnpm typecheck` | ✅ pass | All 69 packages compile |
| `pnpm test` | ✅ pass | ~2,200 tests; cowork-service `EPIPE` flake cleared on focused rerun |
| `pnpm lint` (pipeline) | ✅ runs end-to-end | Was bailing fast; this audit unblocked it |
| `pnpm lint` (errors) | ✅ 0 | 155 warnings remain — see `docs/AUDIT_PLATFORM.md` section W |
| `pnpm lint` (errors) | ✅ 0 | 101 warnings remain — see `docs/AUDIT_PLATFORM.md` section W |
---
@ -53,7 +53,7 @@ The nomgap deployment edits that were previously uncommitted were finalized in
- `products/nomgap/product.json` — replaces flag set, restructures containers
- `services/platform-service/src/modules/flags/seed.ts` — adds 14 lines of seed flags
The current working tree is clean after `5b0fbc2`.
The current working tree is clean after `433c3a5`.
### 3. The audit doc is the source of truth
@ -65,7 +65,9 @@ The current working tree is clean after `5b0fbc2`.
feedback warnings (`db4257f`), predictive campaign event typing (`021f053`),
tracker roadmap/config warnings (`04d2398`), and broadcast-client deep-link
diagnostics (`5fb4921`). The remaining admin-web W2 warnings were cleared in
`1089597`, and config Key Vault diagnostics were documented in `5b0fbc2`.
`1089597`, config Key Vault diagnostics were documented in `5b0fbc2`,
monitoring health-check output was documented in `e9a70ed`, and create-app /
design-token generator CLI output was documented in `433c3a5`.
- **Section R** (housekeeping): token export and peer-warning observations are documented/verified.
For the live warning checklist and parallel-agent workflow, use