Compartilhar via


Gerenciar pacotes npm no Visual Studio

O npm permite que você instale e gerencie pacotes para uso em aplicativos Node.js e ASP.NET Core. O Visual Studio facilita a interação com comandos npm e npm por meio da interface do usuário ou diretamente. Se você não estiver familiarizado com o npm e quiser saber mais, acesse a documentação do npm.

A integração do Visual Studio com o npm é diferente dependendo do tipo de projeto.

Importante

O npm espera a pasta node_modules e package.json na raiz do projeto. Se a estrutura de pastas do aplicativo for diferente, você deverá modificar sua estrutura de pastas se quiser gerenciar pacotes npm usando o Visual Studio.

Projeto baseado em CLI (.esproj)

A partir do Visual Studio 2022, o gerenciador de pacotes npm está disponível para projetos baseados em CLI, portanto, agora você pode baixar módulos npm de forma semelhante à maneira como você baixa pacotes NuGet para projetos do ASP.NET Core. Em seguida, você pode usar package.json para modificar e excluir pacotes.

Para abrir o gerenciador de pacotes, no Gerenciador de Soluções, clique com o botão direito do mouse no nó npm em seu projeto e escolha Adicionar pacote npm.

Abrir o gerenciador de pacotes no Gerenciador de Soluções

Em seguida, você pode pesquisar pacotes npm, selecionar um e instalar selecionando Instalar Pacote.

Instalar novo pacote npm para esproj

projetos Node.js

Para projetos Node.js (.njsproj), você pode executar as seguintes tarefas:

Esses recursos funcionam em conjunto e sincronizam com o sistema de projetos e o arquivo package.json no projeto.

Pré-requisitos

Você precisa da carga de trabalho de desenvolvimentoNode.js e do runtime Node.js instalado para adicionar suporte ao npm ao seu projeto. Para obter etapas detalhadas, consulte Criar um aplicativo Node.js e Express.

Observação

Para projetos de Node.js existentes, use o modelo de solução de código de Node.js existente ou o tipo de projeto Abrir pasta (Node.js) para habilitar o npm em seu projeto.

Instalar pacotes do Gerenciador de Soluções (Node.js)

Para projetos Node.js, a maneira mais fácil de instalar pacotes npm é por meio da janela de instalação do pacote npm. Para acessar essa janela, clique com o botão direito do mouse no nó npm no projeto e selecione Instalar Novos Pacotes npm.

Instalar novo pacote npm para Node.js

Nesta janela, você pode pesquisar um pacote, especificar opções e instalar.

Captura de tela da caixa de diálogo Instalar Novos Pacotes npm.

  • Tipo de dependência – escolhido entre pacotes padrão, de desenvolvimento e opcionais . O Standard especifica que o pacote é uma dependência de runtime, enquanto o Desenvolvimento especifica que o pacote só é necessário durante o desenvolvimento.
  • Adicionar a package.json – Recomendado. Essa opção configurável foi preterida.
  • Versão selecionada – selecione a versão do pacote que você deseja instalar.
  • Outros argumentos npm – especifique outros argumentos npm padrão. Por exemplo, você pode inserir um valor de versão, como @~0.8 instalar uma versão específica que não está disponível na lista de versões.

Você pode ver o progresso da instalação na saída npm na janela Saída (para abrir a janela, escolha Exibir>Saída ou pressione Ctrl + Alt + O). Isso pode levar algum tempo.

saída do npm

Dica

Você pode pesquisar pacotes com escopo anexando a consulta de pesquisa com o escopo em que você está interessado, por exemplo, digite @types/mocha para procurar arquivos de definição typeScript para mocha. Além disso, ao instalar definições de tipo para TypeScript, você pode especificar a versão typeScript que você está direcionando especificando uma versão, como @ts2.6, no campo de argumento npm.

Gerenciar pacotes instalados no Gerenciador de Soluções (Node.js)

Os pacotes npm são mostrados no Gerenciador de Soluções. As entradas no nó npm imitam as dependências no arquivo package.json .

Captura de tela do nó npm no Gerenciador de Soluções mostrando o status da instalação dos pacotes npm.

Status do pacote

  • Pacote instalado – Instalado e listado no package.json
  • Pacote desnecessário – Instalado, mas não explicitamente listado no package.json
  • Pacote ausente – Não instalado, mas listado em package.json

Clique com o botão direito do mouse no nó npm para executar uma das seguintes ações:

  • Instalar novos pacotes npm Abre a interface do usuário para instalar novos pacotes.
  • Instalar pacotes npm Executa o comando de instalação do npm para instalar todos os pacotes listados em package.json. (Executa npm install.)
  • Atualizar pacotes npm Atualiza pacotes para as versões mais recentes, de acordo com o intervalo semântico de controle de versão (SemVer) especificado em package.json. (Executa npm update --save.). Os intervalos SemVer normalmente são especificados usando "~" ou "^". Para obter mais informações, package.json configuração.

Clique com o botão direito do mouse em um nó de pacote para executar uma das seguintes ações:

  • Instalar pacotes npm Executa o comando de instalação do npm para instalar a versão do pacote listada no package.json. (Executa npm install.)
  • Atualizar pacotes npm Atualiza o pacote para a versão mais recente, de acordo com o intervalo SemVer especificado em package.json. (Executar npm update --save.) Os intervalos SemVer normalmente são especificados usando "~" ou "^".
  • Desinstalar pacotes npm Desinstala o pacote e o remove de package.json (Execuções npm uninstall --save.)

Observação

Para obter ajuda para resolver problemas com pacotes npm, consulte solução de problemas.

Usar o comando .npm na janela interativa do Node.js (Node.js)

Você também pode usar o .npm comando no Node.js Janela Interativa para executar comandos npm. Para abrir a janela, clique com o botão direito do mouse no projeto no Gerenciador de Soluções e escolha Abrir Node.js Janela Interativa (ou pressione Ctrl + K, N).

Na janela, você pode usar comandos como o seguinte para instalar um pacote:

.npm install azure@4.2.3

Dica

Por padrão, o npm será executado no diretório base do projeto. Se você tiver vários projetos em sua solução, especifique o nome ou o caminho do projeto entre colchetes. .npm [MyProjectNameOrPath] install azure@4.2.3

Dica

Se o projeto não contiver um arquivo package.json, use .npm init -y para criar um novo arquivo package.json com entradas padrão.

projetos do ASP.NET Core

Para projetos como projetos ASP.NET Core, você pode adicionar suporte ao npm em seu projeto e usar o npm para instalar pacotes.

Observação

Para projetos ASP.NET Core, também é possível usar o Gerenciador de Bibliotecas ou yarn em vez de npm para instalar arquivos JavaScript e CSS do lado do cliente. Uma dessas opções poderá ser necessária se você precisar de integração com o MSBuild ou a CLI do dotnet para gerenciamento de pacotes, que não é fornecida pelo npm.

Se o projeto ainda não incluir um arquivo package.json , você poderá adicionar um para habilitar o suporte ao npm adicionando um arquivo package.json ao projeto.

  1. Para adicionar o arquivo package.json , clique com o botão direito do mouse no projeto no Gerenciador de Soluções e escolha Adicionar>Novo Item (ou pressione Ctrl + SHIFT + A). Use a caixa de pesquisa para localizar o arquivo npm, escolha o arquivo de configuração npm, use o nome padrão e clique em Adicionar.

  2. Inclua um ou mais pacotes npm na seção ou dependencies no devDependenciespackage.json. Por exemplo, você pode adicionar o seguinte ao arquivo:

    "devDependencies": {
       "gulp": "4.0.2",
       "@types/jquery": "3.5.29"
    }
    

    Quando você salva o arquivo, o Visual Studio adiciona o pacote no nó Dependências/npm no Gerenciador de Soluções. Se você não vir o nó, clique com o botão direito do mousepackage.json e escolha Restaurar Pacotes. Para exibir o status de instalação do pacote, selecione a saída npm na janela Saída.

    Observação

    O nó npm está disponível para a maioria dos tipos de projeto do ASP.NET Core, incluindo Blazor. Para projetos maui blazor, você deve usar a linha de comando npm porque nenhum nó npm estará presente no Gerenciador de Soluções.

    Você pode configurar pacotes npm usando package.json. package.json Abra diretamente ou clique com o botão direito do mouse no nó npm no Gerenciador de Soluções e escolha Abrir package.json.

Solução de problemas de pacotes npm

  • Se você vir erros ao criar seu aplicativo ou transpilar o código TypeScript, verifique se há incompatibilidades de pacote npm como uma possível fonte de erros. Para ajudar a identificar erros, verifique a janela de saída do npm ao instalar os pacotes, conforme descrito anteriormente neste artigo. Por exemplo, se uma ou mais versões de pacote npm tiverem sido preteridas e resultarem em um erro, talvez seja necessário instalar uma versão mais recente para corrigir erros. Para obter informações sobre como usar package.json para controlar as versões do pacote npm, consulte package.json configuração.

  • Em alguns cenários do ASP.NET Core, o Gerenciador de Soluções pode não mostrar o status correto para pacotes npm instalados devido a um problema conhecido descrito aqui. Por exemplo, o pacote pode aparecer como não instalado quando está instalado. Na maioria dos casos, você pode atualizar o Gerenciador de Soluções excluindo package.json, reiniciando o Visual Studio e adicionando novamente o arquivo package.json conforme descrito anteriormente neste artigo. Ou, ao instalar pacotes, você pode usar a janela de saída do npm para verificar o status da instalação.

  • Em alguns cenários do ASP.NET Core, o nó npm no Gerenciador de Soluções pode não estar visível depois que você compilar o projeto. Para tornar o nó visível novamente, clique com o botão direito do mouse no nó do projeto e escolha Descarregar Projeto. Em seguida, clique com o botão direito do mouse no nó do projeto e escolha Recarregar Projeto.

  • Para projetos de Node.js, você deve ter a carga de trabalho de desenvolvimentoNode.js instalada para suporte ao npm. npm requer Node.js. Se você não tiver Node.js instalado, recomendamos instalar a versão lts do site doNode.js para melhor compatibilidade com estruturas e bibliotecas externas.