How can I build and link a custom node with n8n-nodes-starter after the switch to pnpm?

Below is a summary of the recommended approach for the updated pnpm workflow:

---

1. Install with pnpm

• Since the starter now prefers pnpm, run:

BASHCopied
pnpm install

instead of the npm shortcut. This ensures you’re using the correct package manager and dependency resolution.

---

2. Building the custom node

• Use the pnpm command to build your node in the custom node repository. In many cases the same build script is used, so try:

BASHCopied
pnpm run build

• If the build still fails, double-check that:

• Your package’s source files (TypeScript, etc.) meet the requirements (for example, class names and filenames must match).
• The dependencies and configuration (such as the paths described in your package.json’s n8n field) are all correct.
• You are running a supported version of pnpm (consider updating if you’re not on a recent release).

---

3. Linking the custom node

pnpm handles linking a bit differently than npm. If you experienced issues with both “pnpm link” and “npm link”, consider these alternatives:

Option A: Use pnpm’s global linking

• In your custom node package folder, run:

BASHCopied
pnpm link --global

• Then in your n8n installation folder, link it by running:

BASHCopied
pnpm link <your-node-package-name>

Make sure that the package name in your package.json (usually prefixed with “n8n-nodes-”) is exactly what you supply.

Option B: Install the package locally via a file path

Instead of using linking, add your custom node as a dependency using its relative path. In the folder where n8n is installed, run:

BASHCopied
pnpm add ../path/to/n8n-nodes-my-custom-nodes

This installs the package locally without linking issues and is a reliable approach for iterating on your node.

---

4. Additional tips

• After building or linking, restart n8n so it picks up the new custom node.
• Double-check that your package.json in the custom node repository includes the n8n-specific “n8n” field pointing to your built node and credentials (if applicable). This is required for n8n to locate and load your node.
• If build or linking issues persist, review the terminal error messages and confirm that your environment (pnpm version, Node.js version 18 or above, etc.) meets n8n’s requirements.

---

Following this updated workflow should resolve the build and linking issues you encountered when moving from npm to pnpm in the n8n-nodes-starter.