fix: Keep V3 CLI JSON output compatible with V2#1391
Merged
Conversation
Keep V3 CLI responses aligned with the V2 public JSON shape, and remove the migration skill guidance that told agents to rewrite first-party output fields to camelCase. - Restore PascalCase response serialization on the Unity side and native CLI output structs - Update first-party skill docs and generated skill copies to reference PascalCase fields - Rename find-game-objects response DTO properties instead of using per-property JsonProperty aliases
Treat leftover migration skill directories without SKILL.md as missing so the migration wizard shows Install instead of Remove when the skill is not actually present. Also remove stale AI prompt guidance that still mentioned first-party JSON output field migration.
Update release and smoke scripts to read the restored PascalCase CLI response fields, and refresh the simulate-mouse-ui skill guidance so agents use the emitted annotated-element property names.
Update the Unity-side CLI installation detector to parse the restored PascalCase --version --json contract so setup compatibility checks keep seeing the installed protocol version.
Add a skill-focused markdownlint-cli2 configuration and apply the safe formatting fixes to source skill files. Regenerate the installed Claude and Agents skill copies so the checked-in skills lint cleanly together.
Tighten the temporary migration skill so agents only edit option tokens inside confirmed uloop invocations and preserve unrelated formatting, commands, and non-uloop arguments.
Clarify that Markdownlint is not required validation for the temporary V3 CLI option migration and must not block completion when it reports existing or unrelated formatting issues.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (11)
✅ Files skipped from review due to trivial changes (7)
🚧 Files skipped from review as they are similar to previous changes (4)
📝 WalkthroughWalkthroughThis PR changes many documented and serialized JSON fields from camelCase to PascalCase across Unity responses, CLI outputs, error envelopes, tests, and scripts. It also narrows the temporary v3 migration skill guidance and adds install-state handling for missing ChangesPascalCase JSON contract migration
V3 migration skill scope tightening
Estimated code review effort🎯 4 (Complex) | ⏱️ ~70 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
Drop the local markdownlint-cli2 configuration because the PR should not add project-level Markdownlint tooling for skill documentation.
There was a problem hiding this comment.
2 issues found and verified against the latest diff
Note: This PR contains a large number of files. cubic only reviews up to 100 files per PR, so some files may not have been reviewed. cubic prioritizes the most important files to review.
On a pro plan you can use ultrareview for larger PRs.
Re-trigger cubic
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
Packages/src/Editor/FirstPartyTools/SimulateMouseUi/Skill/SKILL.md (1)
72-73: 🧹 Nitpick | 🔵 Trivial | 💤 Low valueMinor: Simplify redundant "empty space" phrasing for readability.
The static analysis tool flagged "empty space (no UI element)" as redundant. Consider simplifying to just "space" or "empty space" without the parenthetical. This applies to lines 72, 73, and 139.
Examples:
- Line 72: "Clicking or long-pressing on empty space still succeeds with a message indicating no element was hit"
- Line 139: "Click and LongPress on empty space (no UI element) still return
Success = true"Also applies to: 139-139
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@Packages/src/Editor/FirstPartyTools/SimulateMouseUi/Skill/SKILL.md` around lines 72 - 73, Remove the redundant parenthetical explanations from the "empty space" phrases in the SKILL.md documentation file. Specifically, delete "(no UI element)" from the phrase on line 72, delete "(no draggable UI element)" from the phrase on line 73, and delete "(no UI element)" from the phrase on line 139. This will simplify the text to just "empty space" or "space" without the clarifying parentheticals, improving readability while maintaining the intended meaning.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/uloop-hello-world/SKILL.md:
- Around line 43-51: The changes were made to the generated copy file in
`.claude/skills/uloop-hello-world/SKILL.md` instead of the canonical source.
Revert all changes to the `.claude/skills/uloop-hello-world/SKILL.md` file, then
apply those same changes to the canonical source file at
`Assets/Editor/CustomCommandSamples/HelloWorld/Skill/SKILL.md`, and regenerate
the copy through the standard workflow to ensure consistency between the source
and generated files.
In `@Assets/Editor/CustomCommandSamples/HelloWorld/Skill/SKILL.md`:
- Around line 44-46: Update the field name documentation in the SKILL.md file to
use PascalCase instead of lowercase to match the JSON contract migration. Change
the three documented field names from `message`, `language`, and `timestamp` to
`Message`, `Language`, and `Timestamp` respectively in the documentation lines
that describe the greeting message, language, and current timestamp parameters.
In `@cli/internal/cli/busy_status.go`:
- Line 43: The code at line 43 only checks for the capitalized "Data" key in
err.Details map, which causes busy-status details to be dropped when upstream
versions send the lowercase "data" key instead. Modify the key lookup to first
attempt "Data", and if that fails or returns nil/false, fall back to checking
the lowercase "data" key as a legacy fallback. This ensures backward
compatibility by handling both capitalized and lowercase key formats from
different upstream versions.
In `@cli/internal/cli/run.go`:
- Around line 165-168: The JSON key casing changes in the writeVersionJSON
function (changing "cliVersion" to "CliVersion" and "protocolVersion" to
"CliVersion") and the similar change at line 410 ("Success" to "success")
represent incompatible wire-format changes. To comply with coding guidelines,
increment the protocolVersion value in cli/contract.json and update
CliConstants.REQUIRED_CLI_PROTOCOL_VERSION from 2 to 3 (or the next appropriate
version number) to reflect these breaking changes and prevent interoperability
issues between old and new CLI versions.
---
Nitpick comments:
In `@Packages/src/Editor/FirstPartyTools/SimulateMouseUi/Skill/SKILL.md`:
- Around line 72-73: Remove the redundant parenthetical explanations from the
"empty space" phrases in the SKILL.md documentation file. Specifically, delete
"(no UI element)" from the phrase on line 72, delete "(no draggable UI element)"
from the phrase on line 73, and delete "(no UI element)" from the phrase on line
139. This will simplify the text to just "empty space" or "space" without the
clarifying parentheticals, improving readability while maintaining the intended
meaning.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: a4b597d2-606b-4e5d-a563-64365efc1135
⛔ Files ignored due to path filters (3)
scripts/refresh-neighbor-game-skills-windows.ps1is excluded by none and included by nonescripts/run-windows-e2e.ps1is excluded by none and included by nonescripts/test-simulate-mouse-demo.ps1is excluded by none and included by none
📒 Files selected for processing (118)
.agents/skills/uloop-clear-console/SKILL.md.agents/skills/uloop-compile/SKILL.md.agents/skills/uloop-control-play-mode/SKILL.md.agents/skills/uloop-execute-dynamic-code/SKILL.md.agents/skills/uloop-find-game-objects/SKILL.md.agents/skills/uloop-focus-window/SKILL.md.agents/skills/uloop-get-hierarchy/SKILL.md.agents/skills/uloop-get-logs/SKILL.md.agents/skills/uloop-hello-world/SKILL.md.agents/skills/uloop-launch/SKILL.md.agents/skills/uloop-record-input/SKILL.md.agents/skills/uloop-replay-input/SKILL.md.agents/skills/uloop-run-tests/SKILL.md.agents/skills/uloop-screenshot/SKILL.md.agents/skills/uloop-screenshot/references/annotated-elements.md.agents/skills/uloop-simulate-keyboard/SKILL.md.agents/skills/uloop-simulate-mouse-input/SKILL.md.agents/skills/uloop-simulate-mouse-ui/SKILL.md.agents/skills/uloop-wait-for-pause-point/SKILL.md.claude/skills/uloop-clear-console/SKILL.md.claude/skills/uloop-compile/SKILL.md.claude/skills/uloop-control-play-mode/SKILL.md.claude/skills/uloop-execute-dynamic-code/SKILL.md.claude/skills/uloop-find-game-objects/SKILL.md.claude/skills/uloop-focus-window/SKILL.md.claude/skills/uloop-get-hierarchy/SKILL.md.claude/skills/uloop-get-logs/SKILL.md.claude/skills/uloop-hello-world/SKILL.md.claude/skills/uloop-launch/SKILL.md.claude/skills/uloop-record-input/SKILL.md.claude/skills/uloop-replay-input/SKILL.md.claude/skills/uloop-run-tests/SKILL.md.claude/skills/uloop-screenshot/SKILL.md.claude/skills/uloop-screenshot/references/annotated-elements.md.claude/skills/uloop-simulate-keyboard/SKILL.md.claude/skills/uloop-simulate-mouse-input/SKILL.md.claude/skills/uloop-simulate-mouse-ui/SKILL.md.claude/skills/uloop-wait-for-pause-point/SKILL.mdAssets/Editor/CustomCommandSamples/GetProjectInfo/Skill/SKILL.mdAssets/Editor/CustomCommandSamples/HelloWorld/Skill/SKILL.mdAssets/Editor/FindGameObjects/FindGameObjectsTestMenu.csAssets/Tests/Editor/CliInstallationDetectorTests.csAssets/Tests/Editor/CompileSessionResultServiceTests.csAssets/Tests/Editor/CompileStatusBridgeCommandTests.csAssets/Tests/Editor/DynamicCodeToolTests/ExecuteDynamicCodeUseCaseTests.csAssets/Tests/Editor/FindGameObjectsToolTests.csAssets/Tests/Editor/GetHierarchyToolTests.csAssets/Tests/Editor/JsonRpcProcessorCliVersionGateTests.csAssets/Tests/Editor/ThirdPartyToolMigrationWizardWindowTests.csAssets/Tests/Editor/ToolSkillSynchronizerTests.csPackages/src/Editor/CliOnlyTools~/FocusWindow/Skill/SKILL.mdPackages/src/Editor/CliOnlyTools~/GetProjectInfo/Skill/SKILL.mdPackages/src/Editor/CliOnlyTools~/GetVersion/Skill/SKILL.mdPackages/src/Editor/CliOnlyTools~/Launch/Skill/SKILL.mdPackages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/ClearConsole/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/Compile/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/ControlPlayMode/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/ExecuteDynamicCode/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/FindGameObjects/ComponentInfo.csPackages/src/Editor/FirstPartyTools/FindGameObjects/FindGameObjectsResponse.csPackages/src/Editor/FirstPartyTools/FindGameObjects/FindGameObjectsTool.csPackages/src/Editor/FirstPartyTools/FindGameObjects/GameObjectFinder/ComponentPropertySerializer.csPackages/src/Editor/FirstPartyTools/FindGameObjects/GameObjectFinder/ComponentSerializer.csPackages/src/Editor/FirstPartyTools/FindGameObjects/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/FindGameObjects/UnityCliLoopGameObjectSearchTypes.csPackages/src/Editor/FirstPartyTools/GetHierarchy/GetHierarchyResponse.csPackages/src/Editor/FirstPartyTools/GetHierarchy/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/GetLogs/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/RecordInput/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/ReplayInput/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/RunTests/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/Screenshot/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/Screenshot/Skill/references/annotated-elements.mdPackages/src/Editor/FirstPartyTools/SimulateKeyboard/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/SimulateMouseInput/Skill/SKILL.mdPackages/src/Editor/FirstPartyTools/SimulateMouseUi/Skill/SKILL.mdPackages/src/Editor/Infrastructure/Api/CompileStatusBridgeCommand.csPackages/src/Editor/Infrastructure/Api/JsonRpcResponseSerializer.csPackages/src/Editor/Infrastructure/CLI/CliInstallationDetector.csPackages/src/Editor/Infrastructure/SkillSetup/SkillInstallLayout.csPackages/src/Editor/Presentation/Setup/ThirdPartyToolMigrationWizardText.csPackages/src/TemporarySkills~/v3-cli-invocation-migration/Skill/SKILL.mdPackages/src/TemporarySkills~/v3-cli-invocation-migration/Skill/references/first-party-v2-to-v3.mdcli/internal/cli/argument_error.gocli/internal/cli/busy_status.gocli/internal/cli/compile_wait.gocli/internal/cli/compile_wait_test.gocli/internal/cli/control_play_mode_wait.gocli/internal/cli/control_play_mode_wait_test.gocli/internal/cli/debug_timing.gocli/internal/cli/debug_timing_test.gocli/internal/cli/dynamic_code_wait.gocli/internal/cli/error_editor_unresponsive.gocli/internal/cli/error_envelope.gocli/internal/cli/error_envelope_test.gocli/internal/cli/focus.gocli/internal/cli/help_test.gocli/internal/cli/install.gocli/internal/cli/install_test.gocli/internal/cli/launch_process_exit_timeout_error.gocli/internal/cli/launch_ready.gocli/internal/cli/launch_startup_timeout_error.gocli/internal/cli/launch_test.gocli/internal/cli/list_output.gocli/internal/cli/pause_point_errors.gocli/internal/cli/pause_point_logs.gocli/internal/cli/pause_point_wait.gocli/internal/cli/pause_point_wait_test.gocli/internal/cli/run.gocli/internal/cli/tool_readiness.gocli/internal/cli/uninstall.gocli/internal/cli/update.goscripts/refresh-neighbor-game-skills-macos.shscripts/refresh-neighbor-game-skills-windows.shscripts/smoke-cli-recovery-readiness.goscripts/test-simulate-mouse-demo.shscripts/test-smoke-cli-recovery-readiness.sh
💤 Files with no reviewable changes (2)
- Packages/src/Editor/Infrastructure/Api/JsonRpcResponseSerializer.cs
- Packages/src/Editor/FirstPartyTools/FindGameObjects/UnityCliLoopGameObjectSearchTypes.cs
Update skill output docs to describe PascalCase nested pause-point and sample fields, and keep busy-status details readable when lower-camel legacy data is present.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
User Impact
Changes
uloop --version --jsonand migration skill install detection.Verification
cli/dist/darwin-arm64/uloop compile --project-path "$(git rev-parse --show-toplevel)"cli/dist/darwin-arm64/uloop run-tests --project-path "$(git rev-parse --show-toplevel)" --test-mode EditMode --filter-type regex --filter-value ".*CliInstallationDetectorTests\\..*"scripts/test-smoke-cli-recovery-readiness.shscripts/test-simulate-mouse-demo.sh --project-path "$(git rev-parse --show-toplevel)" --uloop-path cli/dist/darwin-arm64/uloopscripts/check-go-cli.sh/Users/a12115/dotfiles/.claude/skills/autoreview/scripts/autoreview --mode branch --base v3-beta(reported one protocol-bump recommendation; reviewed and rejected because this PR intentionally restores public PascalCase output while the JSON-RPC envelope and Go decoding remain compatible)