fix: The hot-reload warning about edits outside method bodies now says it counts edits since the last compile

[hatayama]

Summary

• The hot-reload warning about edits outside method bodies now says that it covers edits made since the last compile.
• New tests pin that comment-only edits (line, block, and XML documentation comments) never raise this warning.

User Impact

• Before: after a reload of a file whose only change was an XML documentation comment, a user saw

  Edits outside method bodies in .cs (fields, initializers, or attributes) are not applied by hot reload; run uloop compile to pick them up.

  and read it as being about the comment, so they had to check each time whether a compile was really needed.

• After:

  Edits outside method bodies in .cs (fields, initializers, or attributes) since the last compile are not applied by hot reload; run uloop compile to pick them up.

  The named form changes the same way, for example Edits outside method bodies in <File>.cs (field initializer: _value) since the last compile are not applied by hot reload; ....

Cause

• The check compares the edited file with the source of the last compile (the snapshot whose checksum matches the loaded assembly's PDB), not with the file as it was before the current edit. A field, initializer, or attribute edit made earlier and not compiled yet therefore keeps the warning on every later reload, including one that only changes a comment. The old wording did not say which baseline it used.
• Comments themselves never count: every comparison in the check uses SyntaxFactory.AreEquivalent, which ignores trivia. All new tests passed on their first run against the unchanged check, so the check's logic is not changed.

Changes

• Both forms of the warning (the file-level one and the one that names members) now include "since the last compile". The test copies of the wording follow: 2 constants and 14 literals that compare the whole sentence.
• The skill reference (scope-and-limits.md) and docs/hot-reload.md say what the warning compares against and that comment-only edits do not count. The generated skill copies are regenerated from the source.
• The Known Limits section of docs/hot-reload.md no longer says that other outside-body edits stay silent. As the skill reference already says, they are reported when a verified source baseline is available and stay silent only without one.

Tests

New tests

Each one adds a comment that reaches one comparison of the check and expects no warning:

Test	Where the comment goes	Comparison it reaches
TransformWorkerClientTests.Run_WithXmlDocCommentOnlyEditOnAMethod_DoesNotEmitOutsideMethodBodyWarning	XML documentation comment above an existing method	member declarations
TransformWorkerClientTests.Run_WithBlockCommentOnlyEditInsideAFieldInitializer_DoesNotEmitOutsideMethodBodyWarning	block comment inside a field initializer	field declarators
TransformWorkerClientTests.Run_WithLineCommentOnlyEditAboveAField_DoesNotEmitOutsideMethodBodyWarning	line comment on its own line above a field	field modifier tokens
TransformWorkerClientTests.Run_WithBlockCommentOnlyEditAfterAFieldType_DoesNotEmitOutsideMethodBodyWarning	block comment between a field's type and its name	field type
TransformWorkerAddedFieldTests.Drift_LineCommentOnlyEditAboveAFieldAttribute_DoesNotWarn	line comment above a field's attribute	field attribute lists
TransformWorkerClientTests.Run_WithXmlDocCommentOnlyEditOnTheType_DoesNotEmitOutsideMethodBodyWarning	reworded XML documentation comment of the type	residual tree
TransformWorkerAddedFieldTests.Drift_DuplicateFieldSyntaxKeyWithCommentOnlyEdit_DoesNotWarn	line comment above a duplicated field	whole-tree compare used when a duplicate field syntax key makes pairing ambiguous

• The five client tests check both that the file-level warning is absent and that the drift warnings are empty, because the existing helper only matches the file-level sentence.
• The attribute test adds the attribute to the snapshot as well, because no field of the compiled host has one. The comment is the only difference between the snapshot and the edited source.
• The duplicate in the last test repeats a field the compiled type has. A name the compiled type lacks counts as an added field of the edited source and is stripped from that tree only, so that setup warns even when the edited source equals the snapshot (checked locally).

Mutation check

Each comparison was replaced by an ordinal comparison of ToFullString(), which includes trivia, and then reverted.

Mutated comparison	Failing tests
Member declarations, field declarators, field modifier tokens, and residual tree at once (TransformWorkerClientTests|TransformWorkerAddedFieldTests, 176 tests)	The 5 tests that existed then and Run_WithSnapshotDifferingOnlyByEol_TreatsAllMethodsUnchanged; 170 passed
Member declarations (OutsideMethodBodyDeclarationDiff)	Method doc-comment test, EOL test
Field declarators (OutsideMethodBodyFieldGroupDiff)	Initializer test
Field modifier tokens (OutsideMethodBodyFieldGroupDiff)	Field line-comment test, EOL test
Residual tree (OutsideMethodBodyDriftChecker)	Type doc-comment test, duplicate-key test, EOL test
Field type (OutsideMethodBodyFieldGroupDiff, both classes, 180 tests)	Field type test only; 179 passed
Field attribute lists (OutsideMethodBodyFieldGroupDiff, both classes, 180 tests)	Field attribute test only; 179 passed

• The single-comparison rows for member declarations, field declarators, field modifier tokens, and the residual tree ran those 5 tests and the EOL test only.
• The EOL test is expected to fail under these mutations: its snapshot differs from the file only by line endings.
• The failure messages named the expected path:
  • (method: VisibleSibling) for the method doc-comment test
  • (field initializer: _secret) for the initializer test
  • (field: _secret) for both the field line-comment test and the field type test
  • (field attributes: PublicSeed) for the field attribute test
  • the file-level warning for the type doc-comment and duplicate-key tests
• The first five mutation rows ran before this branch was moved onto fix: Hot reload applies edits to methods using types from another file's global using, and names unresolved signature types #3179 and chore: Align two hot-reload test pins with the unresolved signature type skip reason #3180, and neither of those changes the files of the compared code. The last two rows ran after the move.

Local runs

• Unity EditMode, filtered:
  • TransformWorkerClientTests|TransformWorkerAddedFieldTests with the first 5 new tests, before the wording change: 176 tests, 176 passed.
  • TransformWorkerClientTests|TransformWorkerAddedFieldTests|TransformWorkerAddedPropertyTests|TransformWorkerAddedMemberTests|HotReloadOrchestratorTests after the wording change: 477 tests (the expected count from the five classes), 475 passed, 2 failed.
    • Both failures were TransformWorkerAddedMemberTests pins of the unresolved signature type skip reason, which fix: Hot reload applies edits to methods using types from another file's global using, and names unresolved signature types #3179 had changed. chore: Align two hot-reload test pins with the unresolved signature type skip reason #3180 updated them.
    • That class then ran 73 of 73. The tree it ran on is identical to this branch without its last two commits, which touch neither that class nor the skip reason.
  • TransformWorkerClientTests|TransformWorkerAddedFieldTests with all 7 new tests: 180 tests, 180 passed.
• uloop compile: 0 errors. uloop compile-check on the head: 0 errors. Its 7 warnings are in test files this PR does not change.
• rg "are not applied by hot reload; run uloop compile" finds 18 lines, and all of them say "since the last compile".
• check-skill-size: no SKILL.md over the limit. The generated copies of scope-and-limits.md are byte-identical to the source (cmp).
• This PR targets an integration branch, so the build-and-test workflow does not run on it. Code Complexity, File Length, and Dead Code do.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository: hatayama/unity-cli-loop/.coderabbit.yaml
• Review profile: CHILL
• Plan: Advanced
• Run ID: 88ba1b39-8c6e-4175-9f85-69ded5bd0b6c

📥 Commits

Reviewing files that changed from the base of the PR and between f3d6399 and 9424573.

📒 Files selected for processing (3)

• Assets/Tests/Editor/HotReload/TransformWorkerAddedFieldTests.cs
• Assets/Tests/Editor/HotReload/TransformWorkerClientTests.cs
• docs/hot-reload.md

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/hot-reload.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

Outside-method-body drift warnings now specify that edits occurred since the last compile. Tests cover comment-only edits, and the hot-reload guidance describes the comparison source and warning behavior across reloads.

Changes

Outside-method-body drift warnings

Layer / File(s)

Summary

Warning wording, tests, and documentation Packages/src/Editor/FirstPartyTools/HotReload/TransformWorker~/OutsideMethodBodyDriftChecker.cs, Assets/Tests/Editor/HotReload/TransformWorker*Tests.cs, .agents/skills/uloop-hot-reload/references/scope-and-limits.md, .claude/skills/uloop-hot-reload/references/scope-and-limits.md, Packages/src/Editor/FirstPartyTools/HotReload/Skill/references/scope-and-limits.md, docs/hot-reload.md

Warning messages and expected text specify “since the last compile.” Regression tests check that comment-only edits do not produce declaration-drift warnings. The guidance says warnings compare against the source used to compile the loaded assembly and persist until uloop compile.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 94245

The warning, documentation, and regression tests align with the checker’s last-compile baseline and comment-only behavior. No actionable merge risk remains.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	Docstring coverage is 88.46% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 26 functions across 3 files. (1 skipped: 1 …
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.
Title check	✅ Passed	The title clearly describes the main change: clarifying that hot-reload warnings cover edits since the last compile. It is somewhat long, but remains specific and readable.
Description check	✅ Passed	The description explains the warning wording change, comment-only edit behavior, related tests, documentation updates, and validation results.

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}