Skip to content

Commit eb7178c

Browse files
mrdailey99claude
andcommitted
docs: add Node 18-24 requirement, warn about Node 25+ incompatibility
Node 25 removed SlowBuffer from the buffer module, crashing the transitive dependency buffer-equal-constant-time (via jsonwebtoken). This breaks sf provar auth *, lint, and tests. - package.json engines: cap at <25.0.0 - README: Node version note in Installation section - docs/mcp.md: add Prerequisites section with Node requirement - docs/mcp-pilot-guide.md: update Node row to 18-24 with warning Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 31a262c commit eb7178c

4 files changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The Provar DX CLI is a Salesforce CLI plugin for Provar customers who want to au
1111

1212
# Installation, Update, and Uninstall
1313

14+
**Requires Node.js 18–24 (LTS 22 recommended).** Node 25+ is not yet supported due to a breaking change in a transitive dependency. Check with `node --version`.
15+
1416
Install the plugin
1517

1618
```sh-session

docs/mcp-pilot-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The server runs **locally on your machine**. It does not phone home, transmit yo
2727
| Salesforce CLI (`sf`) | ≥ 2.x | `npm install -g @salesforce/cli` |
2828
| Provar DX CLI plugin | ≥ 1.5.0 | `sf plugins install @provartesting/provardx-cli@beta` |
2929
| An MCP-compatible AI client || Claude Desktop, Claude Code, or Cursor |
30-
| Node.js | ≥ 18 | Installed automatically with the SF CLI |
30+
| Node.js | 18–24 | Installed automatically with the SF CLI. **Node 25+ is not supported** — a transitive dependency crashes on startup. Use Node 22 LTS. |
3131

3232
---
3333

docs/mcp.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ The Provar DX CLI ships with a built-in **Model Context Protocol (MCP) server**
5757

5858
---
5959

60+
## Prerequisites
61+
62+
- **Node.js 18–24** (LTS 22 recommended). Node 25+ is not supported — a transitive dependency (`buffer-equal-constant-time`) crashes on startup. Check with `node --version`.
63+
- **Salesforce CLI** (`sf`) ≥ 2.x
64+
6065
## Starting the server
6166

6267
```sh

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"wireit": "^0.14.0"
3636
},
3737
"engines": {
38-
"node": ">=18.0.0"
38+
"node": ">=18.0.0 <25.0.0"
3939
},
4040
"files": [
4141
"/lib",

0 commit comments

Comments
 (0)