GeezerVison is showing github.com — docs: complete v5 package targeting migration guidance by mikolalysenko · Pull Request #1296 · SocketDev/socket-patch
Conversation
The runtime targeting fix is already on main via #1034, but the v5 migration guide does not explain the intentional change from fuzzy selection. This completes the remaining documentation for #1280 and aligns the usage guide and CLI contract with the merged behavior.
- Explain exact package matching, all installed versions (including nested copies), full-name precedence, and actionable ambiguity refusals.
- Document names, versioned/versionless PURLs, UUIDs and the root shortcut, advisory IDs, rollback paths, and
--ecosystems filtering.
- Describe
no_match, no_packages, and out-of-scope UUID not_found results; correct the ambiguity JSON example to error.code and the undo-command syntax to include names.
Validation:
- CLI integration/parsing suites:
in_process_get, in_process_target_ambiguity, in_process_get_uuid_fallback, cli_parse_get, cli_parse_remove, cli_parse_rollback (125 passed).
- Core
utils::target unit tests (11 passed).
- CLI UUID-shortcut, exact-name, remove-by-name/versionless-PURL, and rollback-classification unit tests (18 passed).
git diff --check; 33 relative documentation links and the new targeting anchors verified.
Fixes #1280.
Note Low Risk
Documentation-only changes; no runtime or API behavior is modified in this PR.
Overview
Documents v5 package targeting behavior that already shipped in #1034, closing the gap for #1280 across the CLI contract, migration guide, and usage docs.
CLI_CONTRACT.md expands target grammar: full-name precedence over last-segment matches, unified ambiguous_target JSON (error.code), get outcomes (no_match / no_packages / ecosystem-scoped not_found for UUIDs), and when rollback treats slash-containing tokens as package vs path (with explicit path/glob escape hatches).
docs/migrating-to-v5.md adds a Package targeting section with a target-type table, exact-name vs fuzzy migration notes, ambiguity and --ecosystems filtering, rollback path rules, and example commands.
docs/usage.md points readers at the migration anchor, notes near-name suggestions and ecosystem scoping for get, and updates remove / rollback syntax tables to include NAME and version-spanning removal semantics.
Reviewed by Cursor Bugbot for commit 4f6746b. Configure here.
Generated by Claude Code
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Ready for review (burn-down agent).
Generated by Claude Code
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
# Conflicts:
# crates/socket-patch-cli/CLI_CONTRACT.md
# docs/migrating-to-v5.md
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Labels
Ready for review
Agent-verified: mergeable, CI green, Bugbot clean — awaiting human review
Milestone
No milestone
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.
|