docs: install the demo with npm ci - #52
Conversation
The demo README told a stranger to install app dependencies through Socket. Swap it for npm ci --prefix app, the exact command CI runs (ci.yml:73), so the public instructions match the command that actually gates the build. Downstream run commands (demo, consumer-demo) now use --prefix app to stay correct after the install step no longer cd's into app/, matching the pattern already used by the revoke-demo section.
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (2)
🔇 Additional comments (1)
📝 WalkthroughWalkthroughThe app README removes the global Socket CLI prerequisite. It documents app installation and demo commands using npm with the app prefix. ChangesApp README commands
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other Merge Risk: ⚪ Minimal · up to The README now installs the app and runs its demos from the repository root using npm; the documented commands follow the existing CI and app-script conventions, with no concrete merge-blocking issue identified. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
A rabbit hops past Socket’s door, Comment |
What changed
The demo app's README told readers to install its dependencies through
Socket. It now uses the same command CI runs to install those
dependencies:
npm ci --prefix app. The two demo-run commands in theREADME (
demo,consumer-demo) now run from the repository root with--prefix app, since the install step no longer changes into thatdirectory first.
How to run it
From a clean checkout:
Verified:
npm --prefix app testpasses (51/51), andtsc -p app/tsconfig.json --noEmitis clean.Summary by CodeRabbit
npm ci --prefix app, removing the global Socket CLI prerequisite from the documented setup.npm --prefix app run, keeping the documented commands consistent with the app’s installation steps.