스크립트

이 페이지에서는 pnpm이 package.json의 scripts 필드를 처리하는 방법을 설명합니다.

Hidden scripts#

추가된 버전: v11.0.0

이름이 .으로 시작하는 스크립트는 숨겨집니다. 이러한 스크립트는 pnpm run으로 직접 실행할 수 없으며 pnpm run 목록에서 생략됩니다. 숨겨진 스크립트는 다른 스크립트에서만 호출할 수 있습니다.

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

이 예시에서 pnpm run .helper는 실패하지만, .helper가 다른 스크립트에서 호출되므로 pnpm run build는 성공합니다.

환경 변수#

pnpm은 라이프사이클 스크립트 실행 중에 다음 환경 변수를 설정합니다:

  • npm_package_name: the package name
  • npm_package_version: the package version
  • npm_package_config_*, npm_package_engines_*, npm_package_bin_*: the config, engines, and bin fields of the manifest, one variable per entry (for example, npm_package_config_port). A string bin sets npm_package_bin.
  • npm_package_json: the path to the package's package.json
  • npm_lifecycle_event: the name of the running script (e.g., postinstall)
  • npm_lifecycle_script: the command of the running script
  • npm_node_execpath and NODE: the path to the Node.js executable
  • npm_execpath: the path to the running pnpm
  • npm_config_user_agent: pnpm's user agent string
  • npm_config_node_gyp: the path to the bundled node-gyp, unless the environment already sets it
  • INIT_CWD: the directory where pnpm was started
  • PNPM_SCRIPT_SRC_DIR: the directory of the package whose script runs
  • TMPDIR: node_modules/.tmp in the package, unless unsafePerm is true

참고

Apart from the variables above, pnpm does not set npm_config_* variables from its configuration. Other npm_config_* variables in the environment reach the script unchanged, except auth, scope-registry, and per-registry settings (names starting with _, /, or @, or containing :_).

Built-in command and script name conflicts#

추가된 버전: v11.0.0

다음 내장 명령은 사용자 스크립트를 우선합니다: clean, setup, deploy, rebuild. package.json에 이러한 이름 중 하나로 스크립트가 정의되어 있으면, pnpm <name>은 내장 명령 대신 해당 스크립트를 실행합니다.

내장 명령을 강제로 실행하려면 pnpm pm <name>을 사용하세요.

Lifecycle scripts#

pnpm:devPreinstall#

Runs when pnpm install runs in the project itself, including in CI. It does not run when the package is installed as a dependency of another project.

의존성이 설치되기 전에 실행됩니다.

이 스크립트는 루트 프로젝트의 package.json에 설정된 경우에만 실행됩니다.

Since v11.28.0, installs that skip devDependencies, such as pnpm install --prod, do not run it.

preinstall of the root project#

Since v11.28.0, the root project's preinstall script runs before dependencies are resolved and linked. A guard such as npx only-allow pnpm can therefore stop the install before pnpm populates node_modules.

prepare#

The root project's prepare script runs after pnpm install. It is skipped, since v11.28.0, by installs that skip devDependencies (such as pnpm install --prod), by pnpm install given package arguments, and for the project that pnpm deploy deploys.

Uninstall scripts#

Added in: v11.28.0

pnpm remove runs the project's own preuninstall, uninstall, and postuninstall scripts. preuninstall and uninstall run before dependencies are unlinked, and a failure in either aborts the removal. postuninstall runs after unlinking completes. The ignoreScripts setting and --lockfile-only skip all three.