pnpm link

Aliases: ln

Torna o pacote local atual acessível em todo o sistema, ou em outro local.

pnpm link <dir>
pnpm link --global
pnpm link --global <pkg>

Opções

--dir <dir>, -C

• Padrão: Diretório de trabalho atual
• Tipo: string com o caminho

Altera a localização do link para <dir>.

pnpm link <dir>

Vincula o pacote da pasta <dir> ao node_modules do pacote de onde você está executando este comando ou especificado através da opção --dir.

Por exemplo, se você estiver dentro de ~/projects/foo e executar pnpm link --dir ../bar, então foo será vinculado a bar/node_modules/foo.

pnpm link --global

Vincula o pacote do local onde este comando foi executado ou especificado por meio da opção --dir para global node_modules, para que possa ser referenciado por outro pacote com pnpm link --global <pkg>. Além disso, se o pacote tiver um campo bin, os binários do pacote ficarão disponíveis em todo o sistema.

pnpm link --global <pkg>

Vincula o pacote especificado (<pkg>) do global node_modules aos node_modules do pacote de onde este comando foi executado ou especificado por meio da opção --dir.

Diferença entre pnpm link <dir> e pnpm link --dir <dir>

pnpm link <dir> vincula o pacote de <dir> ao node_modules do pacote onde o comando foi executado. pnpm link --dir <dir> vincula o pacote do diretório de trabalho atual a <dir>.

# O diretório atual é foo
pnpm link ../bar

- foo
  - node_modules
    - bar -> ../../bar
- bar

# O diretório atual é bar
pnpm link --dir ../foo

- foo
  - node_modules
    - bar -> ../../bar
- bar

Casos de uso

Substitua um pacote instalado por sua versão local

Digamos que você tenha um projeto que usa o pacote foo. Você deseja fazer alterações em foo e testá-las em seu projeto. Neste cenário, você pode usar pnpm link para vincular a versão local de foo ao seu projeto, enquanto package.json não será modificado.

cd ~/projects/foo
pnpm install # iinstala dependências de foo
pnpm link --global # vincula foo globalmente
cd ~/projects/my-project
pnpm link --global foo # vincula foo à my-project

Você também pode vincular um pacote de um diretório a outro diretório, sem usar a pasta global node_modules:

cd ~/projects/foo
pnpm install # instala dependências de foo
cd ~/projects/my-project
pnpm link ~/projects/foo # vincula foo à my-project

Adicione um binário globalmente

Se você estiver desenvolvendo um pacote que possui um binário, por exemplo, uma ferramenta CLI, poderá usar pnpm link --global para disponibilizar o binário em todo o sistema. Isso é o mesmo que usar pnpm install -g foo, mas usará a versão local de foo em vez de baixá-la do registro.

Lembre-se que o binário estará disponível somente se o pacote tiver um campo bin em seu package.json.

cd ~/projects/foo
pnpm install # instala dependências de foo
pnpm link --global # vincula foo globalmente

Qual é a diferença entre pnpm link e usar o protocolo file:?

Quando você usa pnpm link, o pacote é vinculado simbolicamente ao código-fonte. Você pode modificar o código-fonte do pacote vinculado e as alterações serão refletidas em seu projeto. Com este método o pnpm não instalará as dependências do pacote vinculado, você terá que instalá-las manualmente no código-fonte. Isso pode ser útil quando você precisar usar um gerenciar de pacotes específico para o pacote vinculado, por exemplo, se quiser usar npm para o pacote vinculado, mas pnpm para o seu projeto.

Quando você usa o protocolo file: em dependencies, o pacote é vinculado fisicamente ao seu projeto node_modules, você pode modificar o código-fonte do pacote vinculado e as alterações serão refletidas em seu projeto. Com este método o pnpm também instalará as dependências do projeto vinculado, substituindo o node_modules do pacote vinculado.

informação

When dealing with peer dependencies it is recommended to use the file: protocol. It better resolves the peer dependencies from the project dependencies, ensuring that the linked dependency correctly uses the versions of the dependencies specified in your main project, leading to more consistent and expected behaviors.

Recurso	pnpm link	file: Protocol
Symlink/Hard-link	Symlink	Hard-link
Reflects source code modifications	Yes	Yes
Installs dependencies of the linked package	No (manual installation required)	Yes (overrides node_modules of the linked package)
Use different package manager for dependency	Possible (e.g., use npm for linked pkg)	No, it will use pnpm