pnpm run

Aliases: run-script

Executa um script definido no arquivo de manifesto do pacote.

Exemplos

Digamos que você tenha um script watch configurado em seu package.json, da seguinte forma:

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

Agora você pode executar esse script usando pnpm run watch! Simples, certo? Outra coisa a notar para aqueles que gostam de economizar teclas e tempo é que todos os scripts possuem um alias de comando pnpm, por isso, no fim das contas, pnpm watch é apenas uma abreviação para pnpm run watch (SOMENTE para scripts que não compartilham o mesmo nome de comandos existentes do pnpm).

Executando múltiplos scripts

Você pode executar múltiplos scripts ao mesmo tempo usando expressões regulares (regex) em vez do nome do script.

pnpm run "/<regex>/"

Rode todos os scripts que comecem com watch::

pnpm run "/^watch:.*/"

Detalhes

Em adição ao PATH pré-existente do shell, o pnpm run incluí também o diretório node_modules/.bin no PATH usado pelos scripts. Isso significa que desde que você tenha um pacote instalado, você pode usá-lo em um script como um comando comum. Por exemplo, se você tiver eslint instalado, poderá escrever um script da seguinte forma:

"lint": "eslint src --fix"

E mesmo que eslint não esteja instalado globalmente em seu shell, ele será executado.

Em workspaces o diretório /node_modules/.bin também é adicionado ao PATH, então qualquer ferramenta instalada na raiz do workspace pode ser chamada nos scripts dos projetos daquele workspace.

Diferenças com o npm run

Por padrão, o pnpm não roda arbitrariamente os hooks pre e post para scrips de usuário pré-definidos (como o prestart). Esse comportamento, herdado do npm, faz com que os scripts sejam mais implícitos do que explícitos, ofuscando o fluxo de execução. Isso também causa execuções surpresas com o pnpm serve e também com o pnpm preserve.

Se por alguma razão você precisar do comportamento de pre/post scripts do npm, use a opção de enable-pre-post-scripts.

Environment

Há algumas variáveis de ambiente que o pnpm automaticamente cria para os scripts executados. Essas variáveis de ambiente podem ser usadas para obter informação contextual sobre os processos que estão rodando.

Essas são as variáveis de ambiente criadas pelo pnpm:

• npm_command - contém o nome do comando executado. Se o comando executado é pnpm run, então o valor dessa variável será "run-script".

Opções

Quaisquer opções para o comando run devem ser listadas antes do nome do script. Opções passadas após o nome do script serão passadas para o script executado.

Nesses casos, o comando run do pnpm CLI vai ser executado com a opção --silent:

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

Qualquer argumento passado após o nome do comando é adicionado ao script executado. Logo, se watch executa webpack --watch, então esse comando:

pnpm run watch --no-color

vai executar:

webpack --watch --no-color

script-shell

• Padrão: null
• Tipo: caminho

O shell a ser usado para scripts executados com o comando pnpm run.

Por exemplo, para forçar o uso do Git Bash no Windows:

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

shell-emulator

• Padrão: false
• Tipo: Boolean

Quando true, o pnpm usará uma implementação JavaScript de um shell bash para executar os scripts.

Essa opção simplifica o uso de scripts em cross-platform. Por exemplo, por padrão, o próximo script falhará em sistemas não compatíveis com POSIX:

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

Mas se a configuração shell-emulator estiver definida como true, isso vai funcionar em todas as plataformas.

--recursive, -r

Isso executa um comando arbitrário do objeto "scripts" em cada um dos projetos. Se o comando não existir naquele projeto, ele é pulado. Se nenhum dos projetos tiver esse comando, o comando falha.

--if-present

Você pode usar a flag --if-present para prevenir sair de um script não definido com um valor não zero. Isso permite que você execute scripts potencialmente indefinidos sem quebrar a ordem de execução.

--parallel

Ignora completamente a concorrência e a classificação topológica, executando um determinado script imediatamente em todos os projetos correspondentes com saída de streaming prefixada. Essa opção é preferível para processos com uma longa duração que atinge muitos projetos, como, por exemplo, um processo de compilação muito demorado.

--stream

Transmite a saída dos processos filhos imediatamente, prefixado com o diretório do pacote de origem. Isso permite que a saída de diferentes pacotes seja intercalada.

--aggregate-output

Agrega a saída dos processos filhos executados em paralelo e só imprime a saída quando o processo filho estiver concluído. Isso torna a leitura de logs grandes após a execução de pnpm -r <command> com --parallel ou com --workspace-concurrency=<number> muito mais fácil (especialmente em CI). Apenas o --reporter=append-only é suportado.

enable-pre-post-scripts

• Padrão: false
• Tipo: Boolean

Quando true, o pnpm executará qualquer script pré/pós automaticamente. Portanto, executar pnpm foo será como executar pnpm prefoo && pnpm foo && pnpm postfoo.

--resume-from <nome_do_pacote>

Filtra a execução a um projeto específico. Este comando pode ser útil se você estiver trabalhando em um grande workspace e deseja reiniciar a compilação em um projeto específico sem precisar compilar todos os outros projetos que o precedem na ordem de compilação.

--report-summary

Registre o resultado das execuções dos scripts em um arquivo pnpm-exec-summary.json.

Um exemplo de um arquivo pnpm-exec-summary.json:

{
  "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
    }
  }

Os valores possíveis de status são: 'passed', 'queued', 'running'.

--reporter-hide-prefix

Hide workspace prefix from output from child processes that are run in parallel, and only print the raw output. This can be useful if you are running on CI and the output must be in a specific format without any prefixes (e.g. GitHub Actions annotations). Only --reporter=append-only is supported.

--filter <package_selector>

Leia mais sobre filtragem.