Repository navigation
docs: document vg lib lockfile pin and failure modes - #423
Merged
Merged
Conversation
Describe lockfile → installed → declared resolution, the lockfiles that lookup reads, and the offline and registry failure text. Signed-off-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: vibgrate-team <vibgrate-team@users.noreply.github.com>
Rewrite the vg lib section so the version label comes from the lockfiles that are read. go.sum is skipped; Go keeps the version declared in go.mod. Signed-off-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: vibgrate-team <vibgrate-team@users.noreply.github.com>
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
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
### vg liblisted the subcommands and stopped there. A reader couldn't tell which version the page describes, which lockfiles are read, or what happens when the lookup fails. The README also showedvg lib express --fn middleware, a flagvg libdoesn't accept.DOCS.mdnow covers:--jsonreports the choice assource(lockfile,installed,declaredorunknown).-Cchanges it):package-lock.json,pnpm-lock.yaml,yarn.lock,poetry.lock,uv.lock,Pipfile.lock,Cargo.lock,Gemfile.lock,composer.lock,packages.lock.json,Package.resolved,pubspec.lockandgradle.lockfile. The lookup skipsgo.sum(Go keeps the version declared ingo.mod),pdm.lock,npm-shrinkwrap.json,bun.lockand Maven lockfiles.version_mismatchon--json),--offlineor--local, and a failed catalog fetch. Each names the next action, and none prints credentials or lockfile contents.vg lib react, and the README matches it and links to the section.Related issues
Closes #281
Checklist
pnpm testpassespnpm lintis cleanpnpm typecheckis cleanHow to verify
Read DOCS.md and the README's
vg libsection, then run:pnpm test pnpm lint pnpm typecheck