Skip to content

Commit 04bd5af

Browse files
docs(server): document both OpenCode status-check functions
CodeRabbit docstring coverage on PR #14575 stayed at 50% after the status-check comment moved onto the Effect.fn generator. That comment documents the generator, and the exported binding needs its own JSDoc immediately above the declaration. No runtime behavior change. Verification (Node v24.13.1, linux): ./node_modules/.bin/vp test run apps/server/src/provider/Layers/ProviderRegistry.test.ts apps/server/src/provider/Layers/OpenCodeProvider.test.ts Test Files 2 passed (2) Tests 79 passed (79) Duration 3.25s ./node_modules/.bin/vp lint --report-unused-disable-directives apps/server/src/provider/Layers/OpenCodeProvider.ts apps/server/src/provider/Layers/ProviderRegistry.ts exit 0 ./node_modules/.bin/vp fmt --check apps/server/src/provider/Layers/OpenCodeProvider.ts exit 0 (all matched files use the correct format) ./node_modules/.bin/vp run --filter t3 typecheck exit 0 (pre-existing suggestions only in CodexInstallation.ts, CodexAdapter.test.ts, CodexProvider.ts, and ws.ts; none in these files) Model: Grok 4.7 via Cursor cloud agent Co-authored-by: maco <[email protected]>
1 parent ab0b36c commit 04bd5af

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

‎apps/server/src/provider/Layers/OpenCodeProvider.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -488,9 +488,15 @@ export const makePendingOpenCodeProvider = (
488488
});
489489
});
490490

491+
/**
492+
* Checks OpenCode once and returns its provider snapshot. A local install
493+
* runs `--version` under `resolveOpenCodeVersionProbeTimeout` before loading
494+
* inventory; a timeout is reported with `openCodeVersionProbeTimeoutDetail`.
495+
* A configured server URL skips that CLI probe and connects directly.
496+
*/
491497
export const checkOpenCodeProviderStatus = Effect.fn("checkOpenCodeProviderStatus")(
492498
/**
493-
* Checks OpenCode once and returns its provider snapshot. A local install
499+
* Generator passed to `Effect.fn` for that status check. A local install
494500
* runs `--version` under `resolveOpenCodeVersionProbeTimeout` before loading
495501
* inventory; a timeout is reported with `openCodeVersionProbeTimeoutDetail`.
496502
* A configured server URL skips that CLI probe and connects directly.

0 commit comments

Comments
 (0)