From 58b0f7777adbbe5aba1cffc891e58af64d587ae7 Mon Sep 17 00:00:00 2001 From: Evandro Fonseca Junior Date: Sat, 10 Oct 2026 04:02:21 -0300 Subject: [PATCH] docs: refresh README file counts and document the Windows test baseline and issue #1 --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index aac9413..fed0af7 100644 --- a/README.md +++ b/README.md @@ -202,7 +202,7 @@ There is no build step: `omp` loads the TypeScript sources directly, and `npm pa ```bash npm run validate # the gate: typecheck + tests + audit + pack:check -npm run pack:check # npm pack --dry-run, 87 files, no secrets +npm run pack:check # npm pack --dry-run, 89 files, no secrets ``` Release flow: bump `package.json` version, add a matching `## ` section to `CHANGELOG.md`, then push the tag. @@ -219,9 +219,9 @@ git tag v0.22.0-evandro.2 && git push origin v0.22.0-evandro.2 ``` index.ts extension entrypoint: composition root and runtime wiring api/ public package subpaths (inbound, outbound, delivery, ...) -lib/ 54 domain modules: config, paths, polling, queue, routing, +lib/ 56 domain modules: config, paths, polling, queue, routing, rendering, outbound, bus leader/follower, locks, voice, menus -tests/ 55 node:test suites (unit + integration, no network) +tests/ 57 node:test suites (unit + integration, no network) docs/ architecture and per-surface contracts .agents/skills/ project-local agent skills (Telegram Bot API reference, domain DAG) AGENTS.md engineering and runtime conventions (project context, not docs) @@ -238,7 +238,7 @@ Everything below was executed in this repository on Node 24.20.0 / npm 11.19.0 ( | Command | Result | | --- | --- | | `npm ci` | exit 0, lockfile consistent, `found 0 vulnerabilities` | -| `npm run typecheck` | exit 0, `tsc --noEmit` | +| `npm run typecheck` | exit 0, `tsc --noEmit` (TypeScript pinned to 7.0.2 in `devDependencies`) | | `npm test` | exit 0, `tests 1230 / pass 1229 / fail 0 / skipped 1` (the skip is a Windows-only case) | | `npm run audit` | exit 0, `found 0 vulnerabilities` | | `npm run pack:check` | exit 0, tarball `evandrodevbr-oh-my-pi-telegram-0.22.0-evandro.1.tgz` | @@ -256,7 +256,8 @@ The test suite is deterministic and offline: transport calls are injected, so no - **Not published to npm**: `@evandrodevbr/oh-my-pi-telegram` returns 404 on the registry. Install from a local checkout; on top of that, `omp` 18.1.20's plugin source resolver rejects `npm` sources (`npm plugin sources are not yet supported. Use git-based sources instead.`). - **No GitHub release yet**: the only tag, `v0.22.0-evandro.1`, produced a failed `Release` run (`CHANGELOG.md has no section for 0.22.0-evandro.1`, because the fork section was a level-3 heading). The heading is fixed in this commit, but the existing tag still points at the pre-fix commit, so the release must be created manually or the tag moved. - **Fork lags upstream**: this fork stays on upstream `0.22.0` (SHA `afe09c5`), while `@llblab/pi-telegram` has since published 0.51.6. Upstream changes after 0.22.0 are not included. Upstream 0.51.6 loads in `omp` 18.4.8 but subscribes to five events `omp` never emits (`agent_settled`, `model_select`, `session_compact_failed`, `ui_prompt_start`, `ui_prompt_end`), so it is not a drop-in replacement. -- **Verified on one platform only**: Linux with Node 24.20.0. The suite contains Windows-specific cases (and the single skipped test is one of them), but Windows/macOS were not run here. +- **Verified on Linux (Node 24.20.0) and, partly, Windows (Node 26.7.0)**. On Windows `npm test` currently reports about 57 failures out of roughly 1270 tests: Unix-domain-socket bus tests (`listen EACCES` on `.sock` paths) and POSIX path assertions (`\tmp` vs `/tmp`). Typecheck, audit and pack:check pass there. macOS was not run. +- **Model menu on `omp`**: `settingsManager.reload is not a function` can break the `/start` and model menus on hosts whose settings object lacks `reload` ([issue #1](https://github.com/evandrodevbr/oh-my-pi-telegram/issues/1)); a fix is proposed in [PR #2](https://github.com/evandrodevbr/oh-my-pi-telegram/pull/2). - **Requires a live `omp` instance and a real bot token** for end-to-end use; the repository suite does not cover the Telegram API surface, and the `omp` 18.4.8 checks above used a fake Bot API, so live Telegram behavior (Rich Messages, Threaded Mode, voice, files) is unverified on `omp`. - **LLM/token cost applies**: a Telegram prompt is a normal model turn in the active session, so it inherits that session's post-compaction context. - **Single-owner by design**: the first Telegram user to message the bot is the owner; other users are ignored. No multi-user or group-chat support.