Skip to content

docs: document npm overrides + standardize npm registry#6

Merged
Wenjix merged 2 commits into
mainfrom
docs/dependency-overrides
Jun 14, 2026
Merged

docs: document npm overrides + standardize npm registry#6
Wenjix merged 2 commits into
mainfrom
docs/dependency-overrides

Conversation

@Wenjix

@Wenjix Wenjix commented Jun 14, 2026

Copy link
Copy Markdown
Owner

What

Documents the npm overrides introduced 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 (clean npm ci on Node 26 builds sqlite3 with tar@7; npm audit → 0), and the analysis that undici 5→6 is runtime-inert on Node ≥18.
  • .npmrc (new) — pins registry=https://registry.npmjs.org/. registry.npmmirror.com's advisory endpoint returns NOT_IMPLEMENTED, so npm audit silently can't run there; pinning also prevents the mixed-registry lockfile drift seen in chore: reduce npm audit vulnerabilities #2.
  • CLAUDE.md — symlink to AGENTS.md.

Notes

🤖 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 rewrites package-lock.json so tarball URLs no longer mix in registry.npmmirror.com (which breaks npm audit).

Adds docs/dependencies.md and AGENTS.md explaining the intentional package.json overrides (tar, undici, @tootallnate/once) for @cursor/sdk transitive audit findings, plus guardrails not to loosen them or regenerate the lockfile against npmmirror. CLAUDE.md now points agents at AGENTS.md, and overridesNote in package.json links 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.

devin-ai-integration[bot]

This comment was marked as resolved.

@cursor

cursor Bot commented Jun 14, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot 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)

Wenjix added 2 commits June 14, 2026 14:40
- 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.
@Wenjix Wenjix force-pushed the docs/dependency-overrides branch from bc9b55b to f2d8a15 Compare June 14, 2026 21:43
@Wenjix Wenjix merged commit 26fe230 into main Jun 14, 2026
3 checks passed
@Wenjix Wenjix deleted the docs/dependency-overrides branch June 16, 2026 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant