Skip to content

chore: standardize pnpm commands #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gringokiwi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: standardize pnpm commands #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ RUN pnpm install --frozen-lockfile

COPY . .
RUN echo "export const gitCommit = '${GIT_COMMIT}'" > src/_gitCommit.ts && \
pnpm build:worker && npx vite build
pnpm build:worker && pnpm exec vite build

FROM nginx:alpine
COPY nginx.conf /etc/nginx/conf.d/default.conf
Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,23 +95,23 @@ pnpm install

## Development

### `pnpm run start`
### `pnpm start`

Runs the app in the development mode.\
Open [http://localhost:3002](http://localhost:3002) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `pnpm run build`
### `pnpm build`

Builds the app for production to the `dist` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

### `pnpm run regtest`
### `pnpm regtest`

Starts the regtest environment and sets up the arkd instance.\
Comment on lines +114 to 116
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 1, 2026

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.

Copy link
Copy Markdown

@Dunsin-cyber Dunsin-cyber May 1, 2026

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

@tiero tiero May 4, 2026

Choose a reason for hiding this comment

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

cc/ @bordalix

Requires Docker to be installed and [Nigiri](https://nigiri.vulpem.com/) to be running with `--ln` flag.
Expand All @@ -128,27 +128,27 @@ nigiri faucet <bcrt-address>
### e2e tests

> note: e2e tests require a regtest environment to be running.
> `pnpm run regtest` to start and setup the regtest environment.
> `pnpm regtest` 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.

Run the tests with:

```bash
pnpm run test:e2e
pnpm test:e2e
```

Run the tests in interactive mode with:

```bash
pnpm run test:e2e --ui
pnpm test:e2e --ui
```

Access the playwright code generator tool with:

```bash
pnpm run test:codegen
pnpm test:codegen
```

## Troubleshooting
Expand Down
Loading