Guardrails / nodejs

One package manager owns the tree

nodejs/single-package-manager@v1

The project commits at most one lock file, so two package managers don't both try to manage the dependency tree.

Id	nodejs/single-package-manager
Version	v1
Category	nodejs
Default severity	warning
Interpreter	python3
Timeout	30 seconds
Violations tolerated	0
Collects	nodejs

Collectors

This guardrail doesn't gather anything itself. It relies on the collectors below, which the CLI runs once per build before any check, and reads what they found from GUARDRAIL_FACTS. If a collector collects nothing, this guardrail is skipped, not failed.

Collector	Gathers	Inputs it is given
nodejs	The Node.js project in the project directory: its manifest, the Node version and package manager it asks for, every workspace it declares, the dependencies each manifest names and which of them are pinned, and the lock files committed beside them.	projectDir

The inputs above are this guardrail's own inputs, passed straight through to the collector. Setting one in buildnote.json changes what is collected, and two guardrails configured the same way share a single collection.

Configuration

{
  "guardrails": {
      "failOn": "error",
      "checks": [
          {
              "use": "nodejs/single-package-manager@v1",
              "severity": "warning",
              "with": {
                  "projectDir": "."
              },
              "exemptions": []
          }
      ]
  }
}

Inputs

Input	Description	Default	Environment variable
projectDir	Directory holding the project, relative to the directory the CLI runs in.	.	GUARDRAIL_INPUT_PROJECTDIR

How to fix

Pick the package manager the project actually uses and delete the other lock files. A checkout with both package-lock.json and pnpm-lock.yaml installs different versions depending on which command the developer or CI step runs. The lock file nobody uses drifts silently until someone does use it.

More in nodejs

• nodejs/lockfile-committed. The project commits a lock file, so an install of the same commit resolves the same versions.
• nodejs/package-manager-pinned. The manifest names the package manager and the exact version Corepack should install.
• nodejs/version-declared. The project declares the Node.js version it is built and run against, and that version is no older than the configured floor.

All 4 nodejs guardrails