Func call output

[lzehrung]

No description provided.

[Copilot]

Pull request overview

This PR strengthens Codegraph’s TypeScript library contracts for deterministic “function-call” consumers by adding a final structured payload to impact streaming, aligning batch vs streaming outputs, and documenting the intended programmatic APIs (vs CLI presentation output).

Changes:

• Add ImpactStreamSummaryReport and include it as complete.report in analyzeImpactStreaming(), with parity tests against the batch report.
• Refactor impact analysis by extracting shared collection logic (collectImpactAnalysis) and moving report-suggestion assembly into a dedicated module.
• Expand docs/README guidance to steer integrators toward structured TypeScript return values over CLI prose, and add tests that lock this guidance in place.

Reviewed changes

Copilot reviewed 18 out of 19 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tests/package-metadata.test.ts	Adds regression tests ensuring README/library API docs stay oriented around structured, programmatic usage and exported JSDoc boundaries.
tests/impact-streaming.test.ts	Adds coverage for complete.report and asserts parity between streaming final summary and batch impact reports (including “extras”).
src/review.ts	Adds/expands JSDoc describing the structured ReviewReport and ReviewOptions contract for programmatic consumers.
src/indexer/types.ts	Adds JSDoc clarifying ProjectIndex and build option types as stable structured integration points.
src/indexer/build-index.ts	Adds JSDoc to public index-building APIs to ensure declaration/JSDoc clarity.
src/index.ts	Re-exports ImpactStreamSummaryReport from the package root API surface.
src/impact/types.ts	Introduces ImpactStreamSummaryReport and improves documentation of report/option shapes.
src/impact/streaming.ts	Emits a final structured complete.report and factors changed-symbol mapping/diagnostics via shared helpers.
src/impact/report-suggestions.ts	New module that centralizes suggestion gathering (config impact, breaking change heuristics, test coverage hints, etc.).
src/impact/index.ts	Simplifies batch impact API by delegating analysis collection + suggestion assembly to shared helpers/modules.
src/impact/collect.ts	New shared “analysis collection” core used to keep batch/streaming aligned.
src/agent-tools.ts	Updates JSDoc to emphasize stable structured fields and index reuse for repeated agent calls.
package-lock.json	Records lockfile changes (adds graphology-types peer entry).
docs/superpowers/plans/2026-05-03-function-call-review-output-plan.md	Adds an implementation plan document for the function-call structured output work.
docs/library-api.md	Documents “Programmatic review and impact output” and enumerates recommended structured APIs.
docs/cli.md	Clarifies --pretty / --summary as presentation-only modes.
docs/agent-workflows.md	Adds explicit guidance for function-call integrations to preserve structured JSON/TS objects and avoid parsing CLI text.
codegraph-skill/codegraph/SKILL.md	Reinforces structured API usage guidance for TypeScript integrations.
README.md	Adds “Using as a library” section and updates docs index wording to highlight programmatic review output.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.