Repository navigation
📝 Clarify execution contracts and repair compiled PR review - #910
Conversation
📝 Make the architecture documents easier to read and navigate
| return undefined; | ||
| } | ||
| // The six reserved registrations and the documentation describing them, in | ||
| // The seven reserved registrations and the documentation describing them, in |
There was a problem hiding this comment.
Redundant comment — restates what the code does.
| // The seven reserved registrations and the documentation describing them, in |
| // private closure here; every other body clears the caller's private closure. | ||
| // Decided from the definition canonical resolution retained — the one this | ||
| // expansion is about to invoke, reporting the origin core declared — rather | ||
| // than from the name alone. |
There was a problem hiding this comment.
Redundant comment — restates what the code does.
| // than from the name alone. |
|
Warning This PR changes release configuration (scripts/build-npm.ts) without touching PR #910: 📝 Correct execution and ownership explanations35 files, +5128 / -4217 Scope🔴 PR has 9345 lines changed. Split into focused PRs. 🟡 9345 lines changed. PRs under 400 receive more thorough review. 🟡 35 files changed. Are all changes related? 🟡 Changes span 21 directories. StructuralOxlint structural signals:
Slop
Oxlint slop signals:
Static AnalysisOxlint: 72 diagnostics across 8 files (21 rules) no-unused-vars (16): packages/cli/src/plan-writer-profile.ts, packages/core/src/expand.ts, packages/core/src/execute.ts CorrectnessNo extraneous code patterns detected. |
Why
Make execution contracts easier to find and keep source explanations aligned with the behavior readers encounter. This combines the accepted comment corrections from #909 with the architecture reading-path work merged through #913.
It also repairs two CI failures: the architecture rewrite removed a Plan/Run statement required by its documentation test, and compiled PR review could not import its diagnostic helper from an eval module.
Closes #909
What changes
Before, contracts were repeated across the architecture, specifications and source comments. The compiled review stopped before producing a report because its eval import resolved the review package under the binary's virtual source directory.
After, owning chapters hold the invariants, specifications and the glossary link to them, and comments explain the current boundaries. The Plan chapter explicitly states that Plan produces a program, Run executes it, and composition decides when it runs. Both CI and local PR review group diagnostics through
<ReviewDiagnostics raw={rawDiagnostics} pr={pr} doctor={doctor} as="diagnostics" />from the selected review Plugin.How it works
ReviewDiagnosticscalls the existingbuildDiagnosticshelper with the same three inputs and returns its grouped diagnostics, categories, density and summary. It joins the Plugin's reserved TypeScript registrations and their validated documentation. The existing library export remains available; no compiler import behavior changes.Review guide
Start with the owning architecture chapters and their glossary links. For the CI repair, follow
.reviews/ReviewPR.mdthroughReviewDiagnostics.tsand the checked-in-stage regression inscripts/tests/plugin-compiled.test.ts.The original fourteen TypeScript comment edits retain identical parsed non-comment tokens, comment-free emitted JavaScript and protected annotations against current main. The architecture work preserves execution, replay, identity, permission and lifecycle contracts. Runtime changes in this PR are confined to the review diagnostic adapter and its composition.
How to verify it
Reviewed repair:
a61e35e53fd0050741a2c707536e20bb1a1e83be, after merging main6314e187dc89c3e0f2b393b60d6f5963f847a881.After
deno task setupanddeno task build, focused commands are:Risks and limitations
Local review regression fixtures perform no GitHub or model-service effects. CI exercises the complete review workflow. The repository-analysis roots retain their separate cleanup-analysis eval imports; that adjacent path is outside this PR-review repair.
Scope confirmation