Repository navigation
Conversation
…g, review matrix refresh)
Add a second bin entry pointing at dist/main.js so Gaze's tier-3 convention (gaze-analyzer-<language> on $PATH) discovers Reading Stone after `npm i -g reading-stone` or `npm link` with zero configuration, mirroring snake-eyes' dual entry points. npm's bin-link also sets the exec bit tsc leaves unset. - package.json: add "gaze-analyzer-typescript": "dist/main.js" - README: fix the .gaze.yaml example (args: ["--stdio"] is required because Gaze passes tier-2 args verbatim) and document the --language typescript trigger for PATH discovery - tests: update the package-manifest snapshot and add a dedicated bin-alias test - remove stale gaze v1.8.0 scaffold markers from gaze-reporter.md and gaze.md Assisted-by: glm-5 Generated with AI assistance (glm-5)
jflowers
left a comment
There was a problem hiding this comment.
Review Summary
Verdict: APPROVE WITH ADVISORIES — 4 LOW advisories, no blocking findings.
The Divisor review council (5 personas) reviewed this PR; all five approved, with the architect and sre noting advisories:
- divisor-adversary (heavy): APPROVE — no findings
- divisor-architect (standard): APPROVE WITH ADVISORIES — 3 LOW findings
- divisor-curator (standard): APPROVE — no findings
- divisor-guard (standard): APPROVE — no findings
- divisor-sre (lightweight): APPROVE WITH ADVISORIES — 1 LOW finding
CI: test (22) and test (24) both pass at head b7133d19. Pre-flight: all CI commands covered by green CI (ci-aware; no local execution needed).
Advisories (4, all LOW)
- tests/cli.test.ts:110 — the dedicated bin-alias test duplicates the bin-map assertions the updated metadata snapshot test already makes (CS-004); its value is documentation via the test name.
- README.md:120 — the
.gaze.yamlconfiguration section omits the--language typescriptrequirement for tier-2 discovery; a reader following only that section receives Go analysis instead of the configured analyzer. - package.json:17 — the README/AGENTS structure-tree annotations still name a single bin now that the bin surface doubled (DR-002); deferred to #7 in the PR body.
- .uf/review-matrix.yaml:44 — the divisor-testing → divisor-gaze-testing registration leaves inert referents (triage membership plus a capabilities entry for a persona with no agent file here); triage dispatches run without a testing persona.
Three of the four advisories are acknowledged in the PR body's Known Issues; the inline comments carry the details.
This review was generated by /uf.review-pr (AI-assisted).
|
|
||
| it("ships the gaze-analyzer-typescript bin alias for PATH auto-discovery", () => { | ||
| // Gaze's zero-config discovery tier spawns whatever | ||
| // gaze-analyzer-<language> binary it finds on PATH (the snake-eyes |
There was a problem hiding this comment.
[LOW · testing-conventions] This test duplicates the bin-map assertions the preceding metadata test already makes. The updated expect(pkg.bin).toEqual({...}) in "contains the exact package metadata" asserts the complete bin map — both keys, both targets, no extras — so the two assertions here add no coverage (CS-004: two assertion sites must now stay in sync). The test's value is its name and comment documenting the Gaze PATH-discovery convention; if it stays as living documentation, consider dropping the redundant assertions or folding the convention comment into the snapshot test.
| without the flag it falls back to its built-in Go analysis. The | ||
| global install puts the alias on PATH alongside `reading-stone`. | ||
|
|
||
| To name the analyzer explicitly in `.gaze.yaml`, point it at the |
There was a problem hiding this comment.
[LOW · operational-documentation] This section omits the --language typescript requirement for tier-2 discovery. The --language flag selects the language key Gaze looks up in both .gaze.yaml (tier 2) and the PATH convention (tier 3); without it, Gaze falls back to its built-in Go analysis even when .gaze.yaml names the analyzer. The flag requirement appears only in the PATH-discovery paragraph above (lines 112–118), so a reader who jumps to this section can follow the steps exactly and receive Go analysis of a TypeScript project. Stating the flag requirement here closes the gap the PR body lists as a known issue.
| "bin": { | ||
| "reading-stone": "dist/main.js" | ||
| "reading-stone": "dist/main.js", | ||
| "gaze-analyzer-typescript": "dist/main.js" |
There was a problem hiding this comment.
[LOW · documentation] The structure-tree annotations in README.md (~line 144) and AGENTS.md still describe a single bin ("Entry point (reading-stone --stdio)") now that the bin map ships two entry points (DR-002: README/AGENTS reflect the public surface). The PR body defers this to #7; recording the drift here so the release tracking issue captures both files.
| - divisor-sre | ||
| - divisor-testing | ||
| - divisor-gaze-testing | ||
| triage: |
There was a problem hiding this comment.
[LOW · configuration-consistency] The persona-rename registration is partial in this repo. The triage membership list still references divisor-testing, and .uf/reviewer-capabilities.yaml keeps its pre-existing divisor-testing entry — but .opencode/agents/divisor-testing.md does not exist here, so those referents are inert: triage dispatches run without a testing persona, and the capabilities file declares two test-quality reviewers, one of which cannot run. The swap matches the upstream gaze repo's diff; adapting it to this repo's inventory (or dropping the dead entries) completes the migration. No functional regression versus the pre-PR state.
Summary
Reading Stone now ships a second bin name,
gaze-analyzer-typescript, mappingto the same
dist/main.jsentry point asreading-stone— mirroringsnake-eyes' dual
gaze-analyzer-pythonscript precedent. With the alias onPATH (
npm i -g reading-stonefor consumers,npm linkfor dogfooding),Gaze's tier-3 analyzer discovery auto-discovers Reading Stone for TypeScript
projects with no
.gaze.yamlneeded — which is what makes the/gazeslashcommand work against this repository without altering it.
The README Installation and Configuration sections were rewritten to document
both bin names, the PATH-discovery flow with its
--language typescriptinvocation trigger, and a corrected
.gaze.yamlexample(
command: gaze-analyzer-typescriptwithargs: ["--stdio"]— Gaze's configtier passes args verbatim, while the CLI-flag and PATH-convention tiers append
--stdioautomatically). A dedicated test in tests/cli.test.ts pins the binmap alongside the existing manifest snapshot, and two stale
gaze v1.8.0scaffold markers were removed from
.opencode/agents/gaze-reporter.mdand.opencode/commands/gaze.md.This PR carries two concerns (called out explicitly per review advisory):
b7133d1— the feature: bin alias, README docs, bin-map test, stalemarker removal.
8e61d24— a scaffold chore that rode main ahead of the branch: ufscaffolding update (reviewer-testing → divisor-gaze-testing rename, review
matrix refresh, 9 files). Its content was verified by the review council;
it is unchanged by this PR.
End-to-end dogfooding verified live: after
npm link,gaze crap --language typescript ./src/...reports "Using external analyzer:reading-stone (language: typescript)". Related: #7 (v0.2.0 release — the bin
alias is a named deliverable), #19 (blog announcement tracking).
How to Test
Run the CI checks (derived from
.github/workflows/ci.yml):Dogfood the analyzer through Gaze's tier-3 PATH discovery (the
/gazecommand's backend path):
Expect
Using external analyzer: reading-stone (language: typescript)onstderr, exit 0, and ~360 analyzed functions at ~94.8% average line coverage.
In opencode,
/gaze ./src/...now exercises the full dogfooding pathunchanged.
How to Demo
Trivial packaging/docs change — no runtime demo required. The dogfood command
above doubles as the demo if you want to see the analyzer picked up live.
Key Files Changed
Feature (
b7133d1):package.json— second bin entrygaze-analyzer-typescript→dist/main.jsREADME.md— Installation/Configuration rewritten for PATH discovery + corrected.gaze.yamlexampletests/cli.test.ts— manifest snapshot updated + dedicated bin-alias test.opencode/agents/gaze-reporter.md,.opencode/commands/gaze.md— stale scaffold markers removedScaffold chore (
8e61d24, rode in from main):.opencode/agents/divisor-gaze-testing.md(new),.opencode/agents/reviewer-testing.md(deleted),.opencode/agents/gaze-test-generator.md.opencode/commands/gaze-fix.md,.opencode/commands/speckit.testreview.md.opencode/references/doc-scoring-model.md,.opencode/references/example-report.md.uf/review-matrix.yaml,.uf/reviewer-capabilities.yamlKnown Issues
README.mdandAGENTS.mdstill describesrc/main.tsas the"Entry point (reading-stone --stdio)" only; they should mention both bin
names.
.gaze.yamlsubsectioncould state that Gaze resolves a tier-2 config entry only when invoked with
--language typescript.the v0.2.0 release (Release v0.2.0: bin alias, README completion, end-to-end conformance #7) will need a release-notes strategy (blog tracking
already filed as Blog: announce Reading Stone v0.2.0 (zero-config Gaze PATH discovery + protocol v1.2.0) #19).
This PR was generated by /uf.finale (AI-assisted).