Skip to content

docs: note on roslyn-tools (harness, not analysis) + the extractor CLI direction#25

Merged
PhysShell merged 1 commit into
mainfrom
claude/zen-pasteur-76hfs1
Jun 17, 2026
Merged

docs: note on roslyn-tools (harness, not analysis) + the extractor CLI direction#25
PhysShell merged 1 commit into
mainfrom
claude/zen-pasteur-76hfs1

Conversation

@PhysShell

@PhysShell PhysShell commented Jun 17, 2026

Copy link
Copy Markdown
Owner

A scoping note: roslyn-tools is harness, not analysis

While the oracle run churns, recording a verdict so we don't re-open it later.

dotnet/roslyn-tools is infrastructure tooling around Roslyn — its own README is terse ("A set of tools used by Roslyn"), builds in an Azure feed, full of insertion/release/signing/VSIX plumbing. It is not a ready-made C# ownership frontend. The real C# sources are dotnet/roslyn + the Roslyn SDK/APIs, which OwnSharp.Extractor already uses.

The new note (docs/notes/roslyn-tools-and-cli.md) captures:

  • Verdict — donor of engineering scaffolding (CLI shape, packaging, repo tooling, CI), not of analysis; and what's actually in the repo so nobody spelunks it again.
  • Our seam is already rightC# extractor → OwnIR facts → Python Own.Core → diagnostics mapped back to C#; the C# side is a fact extractor, not a second checker (per P-001).
  • What to borrow — CLI-first as a dotnet tool (not VSIX first); repo-tooling layer separation (Own.Core / OwnSharp.Extractor / Own.Cli / Own.Tests / Own.Corpus); the project-graph as a future category for DI-lifetime work.
  • What NOT to do — don't take roslyn-tools as a dependency; don't reimplement the checker in C#.
  • Next PR.csproj → facts.ownir.json CLI + a golden, no scope creep.
  • WPF track priority orderevent += without -= → DispatcherTimer → IDisposable fields → Subscribe()→IDisposable → region/lifetime (OWN014).

Docs-only; no code or workflow changes.

🤖 Generated with Claude Code


Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Added architectural guidance clarifying the approach to Roslyn-based extraction and tooling strategy, including CLI design patterns, fact generation workflows, and engineering considerations for future enhancements.

…I direction

Records a scoping verdict so we don't re-open it: `dotnet/roslyn-tools` is
infrastructure tooling around Roslyn (CLI/packaging/VSIX/signing/insertion), not
a ready-made C# ownership frontend. The real C# sources are dotnet/roslyn + the
Roslyn SDK/APIs, which OwnSharp.Extractor already uses.

Captures what to borrow (CLI-first as a `dotnet tool`; repo-tooling layer
separation; project-graph as a future category), what to avoid (don't depend on
roslyn-tools; don't reimplement the checker in C# — P-001's seam stands), a
concrete next PR (`.csproj -> facts.ownir.json` CLI + golden), and the WPF track
priority order. Docs-only.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Rg8kSk1YT14x7A1vo5zgED
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bdf55348-0bf7-4807-9f13-eade3b6e619b

📥 Commits

Reviewing files that changed from the base of the PR and between 4e91af7 and de4a4ec.

📒 Files selected for processing (1)
  • docs/notes/roslyn-tools-and-cli.md

📝 Walkthrough

Walkthrough

Adds docs/notes/roslyn-tools-and-cli.md, a 152-line documentation note establishing that dotnet/roslyn-tools is engineering/infra tooling only, defining the OwnSharp.Extractorfacts.ownir.json → Python Own.Core pipeline boundary, listing what to borrow and what to avoid, providing a sample OwnIR JSON schema, and outlining WPF track priorities.

Changes

Roslyn-tools vs. extractor architecture note

Layer / File(s) Summary
Core verdict and pipeline boundary
docs/notes/roslyn-tools-and-cli.md
Introduces the note, declares dotnet/roslyn-tools as infrastructure-only, and defines the established C# extractor → OwnIR facts JSON → Python Own.Core → diagnostics pipeline seam.
Borrow/avoid guidance
docs/notes/roslyn-tools-and-cli.md
Lists items to borrow from roslyn-tools (CLI-first dotnet tool shape, repo-tooling separation, project dependency graph category) and records explicit constraints (no roslyn-tools dependency, no C# re-implementation of the ownership checker).
Next-PR contract, OwnIR schema, and WPF priorities
docs/notes/roslyn-tools-and-cli.md
Specifies the OwnSharp.Extractor CLI contract producing facts.ownir.json with a sample OwnIR JSON schema, outlines WPF track priorities under the "one pattern / one schema / one golden / one CI step" approach, and closes with future engineering-layer uses of roslyn-tools.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • PhysShell/Own.NET#12: Both docs specify the C# extractor → OwnIR facts → Python Own.Core pipeline seam and guide how extraction outputs should be structured for event-leak/ownership analysis checks.

Poem

A rabbit read the docs and said with glee,
"The seam is clear — C# emits facts, you see!
No reimplementing checkers in the wrong tongue,
Just OwnIR JSON flows, sharp and young.
The roslyn-tools? Infra only, dear!
One schema, one golden, one CI — crystal clear." 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures the main change: a documentation note clarifying that roslyn-tools is infrastructure/harness tooling (not analysis) and establishing the extractor CLI direction.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/zen-pasteur-76hfs1

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants