docs: add README for the npm example plugin (#15)#33
Merged
Conversation
examples/plugins/npm/main.ts is already functionally complete — it implements the full op set (info, discover, read-version, write-version, update-dependency, get-dependencies, release, finalize), targets package.json, and finalize runs `npm install --package-lock-only`. `dv plugin verify run:deno run -A .../npm/main.ts` reports 4 passed, 0 failed, 5 skipped (the skips are side-effectful ops, matching every other plugin). The only gap vs the deno example was a missing README. Add one modeled on examples/plugins/deno/README.md: wiring via the run: arm, per-op descriptions (incl. info / get-dependencies / finalize that the deno README predates), and npm-specific adaptation notes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.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.
Closes #15.
examples/plugins/npm/main.tsis already functionally complete: it implements the full op set —info,discover,read-version,write-version,update-dependency,get-dependencies,release,finalize— targetspackage.json, andfinalizerunsnpm install --package-lock-onlysopackage-lock.jsonrefreshes in the same commit (reported inadditionalChangedFilesonly when it differs from HEAD). The only gap vs thedenoexample was a missing README.This PR adds
examples/plugins/npm/README.md, modeled onexamples/plugins/deno/README.md: wiring via therun:arm, per-op descriptions (includinginfo,get-dependencies, andfinalize, which the deno README predates), and npm-specific adaptation notes (Node rewrite,--package-lock-only, permissions).Verification
(The skipped ops are side-effectful — verify can't safely auto-run them — identical to the
denoexample's verify profile.)🤖 Generated with Claude Code