docs: document npm overrides + standardize npm registry#6
Merged
Conversation
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_94e49344-6813-4e75-9401-36f110aaaf73) |
- AGENTS.md (new): guardrails for humans + coding agents — npmjs registry, and do not remove/loosen the overrides or regenerate the lockfile elsewhere - docs/dependencies.md (new): per-override rationale + consumer chains + remove-when, the Node 26 clean-install verification, and why undici 5->6 is runtime-inert on Node >=18 - .npmrc (new): pin registry to npmjs.org (npmmirror's advisory endpoint is NOT_IMPLEMENTED, which breaks npm audit and caused the mixed-registry lockfile) - CLAUDE.md: symlink to AGENTS.md so Claude Code loads the same notes Documents the overrides added in #2; removal tracked in #5.
- Regenerate package-lock.json against npmjs (.npmrc); no more mixed npmmirror/npmjs resolved URLs (was 133/9, now 0/142). - package.json: add overridesNote pointing at docs/dependencies.md (#5). Verified: overrides intact (tar@7.5.16, undici@6.26.0, @tootallnate/once@2.0.1), npm audit -> 0, tests green.
bc9b55b to
f2d8a15
Compare
This was referenced Jun 14, 2026
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.
What
Documents the npm
overridesintroduced in #2 (security pins for@cursor/sdk's transitive deps) and standardizes the npm registry — so the rationale survives for both humans and future coding agents instead of living only in a review comment.Changes
AGENTS.md(new) — operational guardrails read by Cursor/Devin/Codex/Claude: use the npmjs registry, and don't remove/loosen the overrides or regenerate the lockfile against npmmirror.docs/dependencies.md(new) — per-override rationale + consumer chains + remove-when conditions, the empirical verification (cleannpm cion Node 26 builds sqlite3 withtar@7;npm audit→ 0), and the analysis thatundici5→6 is runtime-inert on Node ≥18..npmrc(new) — pinsregistry=https://registry.npmjs.org/.registry.npmmirror.com's advisory endpoint returnsNOT_IMPLEMENTED, sonpm auditsilently can't run there; pinning also prevents the mixed-registry lockfile drift seen in chore: reduce npm audit vulnerabilities #2.CLAUDE.md— symlink toAGENTS.md.Notes
overridesNoteinpackage.jsonis best added to chore: reduce npm audit vulnerabilities #2 to avoid a conflict here..npmrc, and the overrides already resolve from npmjs). Ifnpmmirrorwas deliberate (network/geo), the.npmrcshould instead be dropped and the--registryworkaround documented.🤖 Generated with Claude Code
Note
Low Risk
Docs and registry/lockfile hygiene only; no application runtime code changes, though install-time native builds still depend on the existing override pins.
Overview
Standardizes npm installs on registry.npmjs.org via a new
.npmrc, and rewritespackage-lock.jsonso tarball URLs no longer mix inregistry.npmmirror.com(which breaksnpm audit).Adds
docs/dependencies.mdandAGENTS.mdexplaining the intentionalpackage.jsonoverrides(tar,undici,@tootallnate/once) for@cursor/sdktransitive audit findings, plus guardrails not to loosen them or regenerate the lockfile against npmmirror.CLAUDE.mdnow points agents atAGENTS.md, andoverridesNoteinpackage.jsonlinks to that doc (#5 for removal).Reviewed by Cursor Bugbot for commit f2d8a15. Bugbot is set up for automated code reviews on this repo. Configure here.