pnpm run

Псевдоніми: run-script

Запускає сценарій, визначений у файлі маніфесту пакунка.

Приклади

Припустімо, у вашому package.jsonналаштовано сценарій watch, наприклад:

"scripts": {
    "watch": "webpack --watch"
}

Тепер ви можете запустити скрипт за допомогою pnpm run watch! Просто, чи не так? Ще одна річ, на яку слід звернути увагу тим, хто любить економити натискання клавіш і час: усі скрипти отримують псевдо як команди pnpm, тож, зрештою, pnpm watch — це просто скорочення для pnpm run watch (ТІЛЬКИ для скриптів, які не мають однакового імені з уже наявними командами pnpm).

Running multiple scripts

You may run multiple scripts at the same time by using a regex instead of the script name.

pnpm run "/<regex>/"

Run all scripts that start with watch::

pnpm run "/^watch:.*/"

Деталі

На додаток до вже наявного PATH оболонки, pnpm run включає node_modules/.bin до PATH, наданого для scripts. Це означає, що якщо у вас встановлено пакунок, ви можете використовувати його у скрипті як звичайну команду. Наприклад, якщо у вас встановлено eslint, ви можете написати такий скрипт:

"lint": "eslint src --fix"

І навіть якщо eslint не встановлено глобально у вашій оболонці, він працюватиме.

Для робочих просторів, <workspace root>/node_modules/.bin також додається до PATH, тому якщо інструмент встановлено у корені робочого простору, його можна викликати у scripts будь-якого пакунка робочого простору.

Differences with npm run

By default, pnpm doesn't run arbitrary pre and post hooks for user-defined scripts (such as prestart). This behavior, inherited from npm, caused scripts to be implicit rather than explicit, obfuscating the execution flow. It also led to surprising executions with pnpm serve also running pnpm preserve.

If for some reason you need the pre/post scripts behavior of npm, use the enable-pre-post-scripts option.

Оточення

Існує декілька змінних середовища, які pnpm автоматично створює для виконуваних скриптів. Ці змінні оточення можна використовувати для отримання контекстної інформації про запущений процес.

Це змінні оточення, створені pnpm:

• npm_command — містить назву команди. Якщо виконуваною командою буде pnpm run, то значенням цієї змінної буде "run-script".

Параметри

Будь-які параметри команди run слід вказувати перед назвою скрипта. Параметри, перелічені після імені скрипта, передаються до виконуваного скрипта.

Усе це запускатиме pnpm CLI з параметром --silent:

pnpm run --silent watch
pnpm --silent run watch
pnpm --silent watch

Будь-які аргументи після імені команди додаються до виконуваного скрипта. Отже, якщо watch виконує webpack --watch, то ця команда:

pnpm run watch --no-color

запустить:

webpack --watch --no-color

--recursive, -r

This runs an arbitrary command from each package's "scripts" object. If a package doesn't have the command, it is skipped. If none of the packages have the command, the command fails.

--if-present

You can use the --if-present flag to avoid exiting with a non-zero exit code when the script is undefined. This lets you run potentially undefined scripts without breaking the execution chain.

--parallel

Completely disregard concurrency and topological sorting, running a given script immediately in all matching packages with prefixed streaming output. This is the preferred flag for long-running processes over many packages, for instance, a lengthy build process.

--stream

Stream output from child processes immediately, prefixed with the originating package directory. This allows output from different packages to be interleaved.

--aggregate-output

Aggregate output from child processes that are run in parallel, and only print output when the child process is finished. It makes reading large logs after running pnpm -r <command> with --parallel or with --workspace-concurrency=<number> much easier (especially on CI). Only --reporter=append-only is supported.

--resume-from <package_name>

Поновити виконання з конкретного проєкту. Це може бути корисним, якщо ви працюєте з великим робочим простором і бажаєте перезапустити збірку з певного проєкту без проходження всіх проєктів які йому передують у процесі збирання.

--report-summary

Record the result of the scripts executions into a pnpm-exec-summary.json file.

An example of a pnpm-exec-summary.json file:

{
  "executionStatus": {
    "/Users/zoltan/src/pnpm/pnpm/cli/command": {
      "status": "passed",
      "duration": 1861.143042
    },
    "/Users/zoltan/src/pnpm/pnpm/cli/common-cli-options-help": {
      "status": "passed",
      "duration": 1865.914958
    }
  }

Possible values of status are: 'passed', 'queued', 'running'.

--reporter-hide-prefix

Added in: v8.8.0

Приховати префікс робочого простору від виводу дочірніх процесів, що виконуються паралельно, і виводити тільки необроблений вивід. Це може бути корисно, якщо ви працюєте з CI, і вивід має бути у певному форматі без будь-яких префіксів (наприклад, GitHub Actions annotations). Only --reporter=append-only is supported.

--filter <package_selector>

Читайте більше про використання фільтрів.

Параметри .npmrc

enable-pre-post-scripts

• Стандартно: false
• Тип: Boolean

When true, pnpm will run any pre/post scripts automatically. So running pnpm foo will be like running pnpm prefoo && pnpm foo && pnpm postfoo.

script-shell

• Стандартно: null
• Тип: path

The shell to use for scripts run with the pnpm run command.

For instance, to force usage of Git Bash on Windows:

pnpm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"

shell-emulator

• Стандартно: false
• Тип: Boolean

When true, pnpm will use a JavaScript implementation of a bash-like shell to execute scripts.

This option simplifies cross-platform scripting. For instance, by default, the next script will fail on non-POSIX-compliant systems:

"scripts": {
  "test": "NODE_ENV=test node test.js"
}

But if the shell-emulator setting is set to true, it will work on all platforms.