docs: document installing PicJS and allowing its install script - #288
Merged
marc0olo merged 1 commit intoSep 22, 2026
Merged
Conversation
marc0olo
added this pull request to stack #287
September 16, 2026 11:33
marc0olo
force-pushed
the
docs/consumer-install-guidance
branch
from
September 16, 2026 12:42
bcfbc6a to
b6c06b8
Compare
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No unresolved review issues remain.
Pull request overview
Updates PicJS documentation with installation instructions and package-manager permissions for downloading the PocketIC binary.
Changes:
- Adds install commands and opt-ins for npm, pnpm, Bun, and Yarn.
- Corrects binary download guidance in the testing guide.
- Links Bun guidance to the shared installation section.
File summaries
| File | Description |
|---|---|
docs/src/content/docs/guides/using-bun.mdx |
References shared install-script guidance. |
docs/src/content/docs/guides/running-tests.mdx |
Clarifies the binary setup requirement. |
docs/src/content/docs/guides/getting-started.mdx |
Adds installation and permission guidance. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
marc0olo
force-pushed
the
docs/consumer-install-guidance
branch
from
September 16, 2026 12:55
b6c06b8 to
597dac3
Compare
marc0olo
force-pushed
the
docs/consumer-install-guidance
branch
from
September 16, 2026 14:17
597dac3 to
db377b9
Compare
This was referenced Sep 16, 2026
marc0olo
force-pushed
the
docs/consumer-install-guidance
branch
from
September 16, 2026 14:38
db377b9 to
001238b
Compare
lwshang
approved these changes
Sep 22, 2026
npm, pnpm and bun all block install scripts by default, so the postinstall that downloads the pocket-ic binary does not run and starting a server fails. Only the bun opt-in was documented, and the guides never showed how to install @dfinity/pic at all. Adds an Installing PicJS section to the getting started guide with the install command and required opt-in per package manager. Corrects the running tests guide, which stated the binary arrives on install, and points the bun guide at the shared section. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
marc0olo
force-pushed
the
docs/consumer-install-guidance
branch
from
September 22, 2026 09:58
001238b to
8177b17
Compare
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.
Fixes the consumer install instructions. PicJS downloads the
pocket-icbinary from apostinstallscript, and npm, pnpm and bun all block install scripts by default — so the binary is missing andPocketIcServer.start()fails.Three problems:
getting-started.mdxnever showed how to install@dfinity/pic, or that the install script needs permitting. No guide did.running-tests.mdxstated the binary is "downloaded when installing@dfinity/pic", which is untrue by default for three of the four supported package managers.using-bun.mdxheld the only opt-in documented anywhere.Adds an Installing PicJS section to the getting started guide with the install command and required entry per package manager, corrects the running tests guide, and points the bun guide at the shared section.
Opt-ins, each verified against a registry install
package.json"allowScripts": { "@dfinity/pic": true }"pnpm": { "onlyBuiltDependencies": ["@dfinity/pic"] }"trustedDependencies": ["@dfinity/pic"]Confirmed by installing
@dfinity/picfrom the registry with each and asserting the binary lands. Theconsumer_installjob from #286 covers the pnpm, bun and yarn mechanisms on every run; npm's is only partly covered there, because a tarball install keysallowScriptsbyfile:path rather than by name.Tabs match the idiom in
using-jest.mdx,using-vitest.mdxandusing-bun.mdx. Nothing in this repo renders MDX — the docs build is typedoc plus a copy — so the rendered page is worth an eye.Longer term this friction is better removed than documented: shipping the binary as platform-specific
optionalDependenciesgated onos/cpuneeds no install script and no opt-in, which is the approach esbuild, swc and sharp all moved to. Out of scope here.🤖 Generated with Claude Code