Skip to content

chore: standardize pnpm commands#591

Open
gringokiwi wants to merge 1 commit into
masterfrom
standardize-pnpm
Open

chore: standardize pnpm commands#591
gringokiwi wants to merge 1 commit into
masterfrom
standardize-pnpm

Conversation

@gringokiwi
Copy link
Copy Markdown
Contributor

@gringokiwi gringokiwi commented May 1, 2026

Summary by CodeRabbit

  • Documentation

    • Simplified command syntax examples in README documentation.
  • Chores

    • Refined Docker build configuration for improved consistency.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 1, 2026

Walkthrough

Dockerfile build process updated to invoke Vite through pnpm exec instead of npx within the builder stage. README documentation examples simplified to use direct PNPM script invocation syntax (e.g., pnpm start vs pnpm run start).

Changes

Cohort / File(s) Summary
Build Configuration
Dockerfile
Modified builder stage to use pnpm exec for Vite invocation instead of npx when executing the build after worker compilation.
Documentation
README.md
Updated command examples across development, production build, regtest, and e2e sections to use simplified PNPM script syntax (pnpm <script> instead of pnpm run <script>).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: standardize pnpm commands' accurately reflects the main change: updating pnpm command invocation syntax across Dockerfile and README for consistency.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch standardize-pnpm

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@arkanaai arkanaai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: chore: standardize pnpm commands

README.md changes ✅

All pnpm run <script>pnpm <script> changes are correct. pnpm run and pnpm are equivalent for running scripts — the shorthand is idiomatic pnpm.

Dockerfile — npx vite buildpnpm dlx vite build

Dockerfile:34 — This change introduces a subtle but real bug.

npx and pnpm dlx are not equivalent when the package is already installed locally:

  • npx vite build — checks node_modules/.bin first, finds the locally installed vite@^7.1.3 (pinned by pnpm-lock.yaml via pnpm install --frozen-lockfile), and runs it. Deterministic.
  • pnpm dlx vite builddownloads the latest vite from the registry into a temp directory and runs it, ignoring the locally installed version. Non-deterministic. Could pull a breaking major version in the future.

The correct pnpm equivalent of npx <local-package> is pnpm exec, not pnpm dlx:

pnpm build:worker && pnpm exec vite build

Or even simpler — just use the build script which already does vite build:

pnpm build

(Though note pnpm build also runs git-info and build:worker, so you'd drop the separate pnpm build:worker call. The Dockerfile already writes _gitCommit.ts manually, so using pnpm build directly would run git-info redundantly but harmlessly.)

TL;DR: Change pnpm dlx vite buildpnpm exec vite build to preserve the current behavior of using the lockfile-pinned vite version.


🤖 Reviewed by Arkana

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 1, 2026

Deploying tmp-boltz-upstream-mainnet-arkade-wallet with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8b03450
Status: ✅  Deploy successful!
Preview URL: https://f6dc5248.tmp-boltz-upstream-mainnet-arkade-wallet.pages.dev
Branch Preview URL: https://standardize-pnpm.tmp-boltz-upstream-mainnet-arkade-wallet.pages.dev

View logs

Copy link
Copy Markdown

@arkanaai arkanaai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous feedback addressed: pnpm dlx vite buildpnpm exec vite build

All changes look correct:

  • Dockerfile:34: pnpm exec vite build correctly uses the lockfile-pinned vite. Good.
  • README.md: All pnpm run <script>pnpm <script> shorthand changes are idiomatic and equivalent.

LGTM.

🤖 Reviewed by Arkana

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying wallet-mutinynet with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8b03450
Status: ✅  Deploy successful!
Preview URL: https://4f096975.arkade-wallet.pages.dev
Branch Preview URL: https://standardize-pnpm.arkade-wallet.pages.dev

View logs

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying wallet-bitcoin with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8b03450
Status: ✅  Deploy successful!
Preview URL: https://6d204043.wallet-bitcoin.pages.dev
Branch Preview URL: https://standardize-pnpm.wallet-bitcoin.pages.dev

View logs

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 114-116: The README mentions a non-existent "pnpm regtest" script;
update the docs to reference the actual npm scripts (regtest:start,
regtest:setup, regtest:stop, regtest:clean) or add a top-level "regtest" script
in package.json that chains the appropriate commands (e.g., run regtest:setup
then regtest:start) so the examples work; also remove the stray blockquote
marker causing the MD028 warning (remove the leading ">" on the affected line)
and apply the same fixes to the other occurrence of the same section.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9314d54e-499f-4882-906f-23bb36e0cc6b

📥 Commits

Reviewing files that changed from the base of the PR and between 0474193 and 8b03450.

📒 Files selected for processing (2)
  • Dockerfile
  • README.md

Comment thread README.md
Comment on lines +114 to 116
### `pnpm regtest`

Starts the regtest environment and sets up the arkd instance.\
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

pnpm regtest is not a defined script in this repo.

Line 114 and Line 131 document pnpm regtest, but package.json defines only regtest:start, regtest:setup, regtest:stop, and regtest:clean. This will fail for readers. This section also has the MD028 blockquote warning (Line 132).

Suggested README fix
-### `pnpm regtest`
+### `pnpm regtest:start && pnpm regtest:setup`

 Starts the regtest environment and sets up the arkd instance.\
 Requires Docker to be installed and [Nigiri](https://nigiri.vulpem.com/) to be running with `--ln` flag.
@@
 > note: e2e tests require a regtest environment to be running.
-> `pnpm regtest` to start and setup the regtest environment.
-
+> `pnpm regtest:start && pnpm regtest:setup` to start and setup the regtest environment.
+>
 > note: e2e tests use playwright for ui testing, you may need to run
 > `pnpm exec playwright install` once to download new browsers.

Also applies to: 130-134

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 114 - 116, The README mentions a non-existent "pnpm
regtest" script; update the docs to reference the actual npm scripts
(regtest:start, regtest:setup, regtest:stop, regtest:clean) or add a top-level
"regtest" script in package.json that chains the appropriate commands (e.g., run
regtest:setup then regtest:start) so the examples work; also remove the stray
blockquote marker causing the MD028 warning (remove the leading ">" on the
affected line) and apply the same fixes to the other occurrence of the same
section.

Comment thread README.md
### `pnpm run regtest`
### `pnpm regtest`

Starts the regtest environment and sets up the arkd instance.\
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @gringokiwi, since you're already updating the docs here, would it be worth adding git submodule update --init --recursive right before the pnpm regtest setups? I noticed on a fresh clone that pnpm run regtest:start fails silently without it. just a thought to save new users some debugging.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc/ @bordalix

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.

3 participants