Skip to content

feat(enrichment): Doc-comment-vs-signature drift #1519

Description

@JSONbored

Context

A REES (review-enrichment service) analyzer. Tier: solid.

Detects: The PR changed a function's signature (params/return/throws) but the adjacent JSDoc/docstring still describes the old shape, or references a parameter that no longer exists — a verifiable mismatch.

Data source: Fetch the full changed file at headSha via contents API (the hunk often splits doc-block from signature), parse doc + signature with a light TS/Python parser, diff the sets. Pure compute after one authed fetch.

This is heavy/external/historical analysis the no-checkout headless claude --print reviewer cannot do; the REES returns it as a brief block the engine splices into the review (additive + fail-safe).

Implementation (established pattern, all inside review-enrichment/)

  1. Finding type + BriefFindings key in src/types.ts
  2. src/analyzers/<name>.ts — pure, inject fetch for tests
  3. Register in src/brief.ts ANALYZERS registry
  4. Render a public-safe block in src/render.ts
  5. node:test units against dist/ + a live smoke against the real data source

Deliverables

  • The analyzer + wiring + tests + a verifiable brief block (file:line or package@version)
  • Clean PR off main (zero engine conflict; outside the engine tsc/vitest/codecov scope)

Parent: #1499

Metadata

Metadata

Assignees

No one assigned

    Labels

    gittensor:featureGittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.

    Projects

    Status
    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions