Scripts

本篇介紹 pnpm 如何處理 package.json 的 scripts 欄位。

Hidden Scripts

Added in: v11.0.0

Scripts with names starting with . are hidden. They cannot be run directly via pnpm run and are omitted from the pnpm run listing. Hidden scripts can only be called from other scripts.

{
  "scripts": {
    ".helper": "echo 'I am hidden'",
    "build": "pnpm run .helper && tsc"
  }
}

In this example, pnpm run .helper would fail, but pnpm run build would succeed because .helper is called from another script.

Environment Variables

pnpm sets the following environment variables during lifecycle script execution:

• npm_package_name — the package name
• npm_package_version — the package version
• npm_lifecycle_event — the name of the running script (e.g., postinstall)

注意事項

Since v11, pnpm no longer populates npm_config_* environment variables from the pnpm configuration. Only the well-known npm_* variables above are set, matching Yarn's behavior.

Built-in Command and Script Name Conflicts

Added in: v11.0.0

The following built-in commands prefer user scripts: clean, setup, deploy, and rebuild. If your package.json defines a script with one of these names, pnpm <name> will execute the script instead of the built-in command.

To force the built-in command, use pnpm pm <name>.

Lifecycle Scripts

pnpm:devPreinstall

只在本機 pnpm install 時執行。

會在安裝任何依賴套件之前執行。

此指令檔僅在根專案的 package.json 有設定時執行。