pnpm run

Alias : run-script

Exécute un script défini dans le fichier manifeste du projet.

Exemples

Imaginons que vous avez un script watch configuré dans votre package.json, comme ceci :

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

Vous pouvez maintenant exécuter ce script en utilisant pnpm run watch ! Simple, non ? Une autre chose à noter pour ceux qui aiment économiser du temps est que tous les scripts sont aussi des alias de la commande pnpm, donc finalement pnpm watch est juste un raccourci pour pnpm run watch (UNIQUEMENT pour les scripts qui ne partagent pas le même nom que les commandes pnpm déjà existantes).

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:.*/"

Détails

En plus du PATH préexistant du shell, pnpm run inclus node_modules/.bin dans le PATH fourni aux scripts. Cela a pour conséquence que du moment où vous avez un package installé, vous pouvez l'utiliser dans un script comme une commande classique. Par exemple, si vous avez installé eslint, vous pouvez écrire un script comme celui-ci :

"lint": "eslint src --fix"

Et même si eslint n'est pas installé globalement sur votre machine, la commande sera run.

Pour les workspaces, <workspace root>/node_modules/.bin est aussi ajouté au PATH, donc si un outil est installé à la racine d'un workspace il pourra être utilisé dans tous les scripts du workspace.

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.

Environnent

Pnpm crée automatiquement certaines variables d'environnement pour les scripts, lorsque ceux-ci sont exécutés. Ces variables d'environnement peuvent être utilisées pour obtenir des informations contextuelles sur le processus en cours.

Voici les variables d'environnement créées par pnpm :

• npm_command - contient le nom de la commande exécutée. Si la commande exécutée est pnpm run, alors la valeur de la variable sera "run-script".

Options

Toutes les options pour la commande run devraient être listées avant le nom du script. Les options listées après le nom du script seront transmises au script exécuté.

Toutes ces commandes exécuteront pnpm CLI avec l'option --silent :

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

Tous les arguments situés après le nom de la commande sont ajoutés au script exécuté. Donc si watch exécute webpack --watch, alors cette commande :

pnpm run watch --no-color

exécutera :

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 <nom_du_paquet>

Reprendre l’exécution à partir d’un projet spécifique. Cela peut être utile lorsque l'on travaille avec un workspace de taille conséquente et que l'on souhaite redémarrer une build depuis un projet spécifique sans devoir exécuter tous les projets qui le précèdent dans l’ordre de la build.

--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

Masque le préfixe du workspace dans la sortie des processus enfants exécutés en parallèle, pour afficher uniquement la sortie brute. Cela peut être utile si vous utilisez CI et que la sortie doit être dans un format spécifique sans aucun préfixe (par exemple les annotations GitHub Actions). Only --reporter=append-only is supported.

--filter <selecteur_de_paquet>

En savoir plus sur le filtrage.

Configurer .npmrc

enable-pre-post-scripts

• Par défaut: false
• Type: 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

• Default: null
• Type: chemin

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

• Par défaut: false
• Type: 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.