Adicionar pacotes ao seu projeto Node.js

  • 11 minutos

Node.js tem pacotes internos para tarefas como gerenciamento de arquivos e manipulação HTTP. Mas também há uma vasta gama de pacotes de terceiros oferecidos no registro NPM.

Quando e como selecionar um pacote npm

Como um novo desenvolvedor na Tailwind Traders, você precisa adicionar funcionalidade a um projeto. Você mesmo pode escrever o código, mas decide usar um pacote existente. Esta decisão de desenvolvimento é um cenário comum.

Quando você deve usar um pacote existente? Aqui estão alguns fatores a considerar:

  • Qualidade: Para tarefas como segurança, o uso de pacotes bem estabelecidos garante que você esteja seguindo as práticas recomendadas e lidando com casos de borda.
  • Eficiência: Escrever seu próprio código leva tempo. Usar pacotes existentes pode economizar um esforço significativo.
  • Manutenção: As bibliotecas precisam de atualizações e correções de bugs. Muitas vezes, é mais eficiente deixar uma equipe de código aberto lidar com isso.

Os desenvolvedores podem encontrar e baixar pacotes de várias fontes, tais como:

  • Registros: Os registros são coleções de pacotes, como o registro npm. Você também pode hospedar seu próprio registro.
  • Repositórios: Você pode instalar pacotes diretamente de uma URL do GitHub.
  • Arquivos: Os pacotes podem ser instalados a partir de uma pasta local ou arquivo compactado, útil para testar seus próprios pacotes.
  • Diretórios: Você também pode instalar diretamente de um diretório.

Depois de selecionar um pacote, verifique suas dependências para considerar os seguintes fatores:

  • Tamanho: mais dependências significam uma pegada maior. O tamanho do espaço ocupado é importante se você tiver limitações de largura de banda ou hardware. Lembre-se, a instalação de um pacote também instala suas dependências. Isso pode resultar em uma pasta de node_modules grande.
  • Popularidade: A popularidade de um pacote pode indicar a sua qualidade.
  • Licenciamento: Se você planeja vender seu software, certifique-se de que todas as licenças de pacotes de dependência permitam a reutilização e revenda.
  • Manutenção ativa: evite dependências preteridas ou raramente atualizadas.

Para saber mais sobre um pacote, visite a página do pacote no NPM e no repositório GitHub. Você também pode usar o comando npm: npm view <package name>.

Como instalar um pacote

Para instalar um pacote, use a CLI npm instalada com o Node.js. Você pode adicionar um pacote ao seu projeto Node.js com o npm install comando no terminal.

npm install <name of package>

Quando você executa o comando, a ferramenta de linha de comando se conecta a um registro global, busca o install código e o coloca em uma node_modules pasta na raiz do seu projeto.

Algumas opções comuns para o comando install incluem:

  • Para pacotes somente de desenvolvimento, use --save-dev. Essa opção salva na devDependencies propriedade de package.json. Essas dependências geralmente são formatar, fiapos, construir, transpilar e ferramentas de teste.
  • Para embalagens somente de produção, use --production. Essa opção exclui pacotes somente de desenvolvimento.
  • Para ferramentas disponíveis globalmente, use -go . As ferramentas de linha de comando geralmente são instaladas globalmente em vez de importadas para projetos. As dependências globais são instaladas em um diretório em todo o sistema, não no nível node_modulesproejct. No entanto, os pacotes globais podem atrapalhar o seu sistema. O npx comando resolve isso instalando pacotes temporariamente. Use npx <name> para buscar um pacote, executá-lo e, em seguida, removê-lo.

Após a instalação, o diretório do projeto se parece com o exemplo a seguir:

package.json
node_modules/
  <name of dependency>/
    <files included in the dependency>
src
  index.js

Comandos da CLI npm

A ferramenta de linha de comando npm tem alguns comandos para ajudá-lo com tarefas como instalar pacotes, criar pacotes e inicializar projetos .js Node.

Os comandos do NPM se enquadram em categorias:

  • Gerenciar dependências: comandos para instalar, atualizar e remover pacotes.
  • Executar scripts: comandos para gerenciar fluxos de desenvolvimento, como teste e construção de código.
  • Configure environment: Comandos para configurar caminhos de instalação e fontes de pacote.
  • Criar e publicar pacotes: Comandos para criar e publicar pacotes.

Se você quiser uma lista detalhada de todos os comandos, digite o seguinte comando no terminal:

npm --help

Verificar instalação

Para ver o que está na sua package.json pasta, utilize npm list. O npm list comando lista todos os pacotes no node_modules diretório que foram instalados. Cada pacote instalado instalou todas as suas próprias dependências.

Como o comando pode resultar em uma lista longa, dificultando a compreensão, você pode listar pacotes em diferentes profundidades com o list comando list. Na profundidade 0, o comando lista os mesmos conteúdos que tem na secção dependencies do package.json.

npm list --depth=<depth>

Se você instalou o pacote Jest, npm list --depth=0 produz uma saída semelhante a esta saída:

├── jest@26.0.1

Limpar dependências

Se já não precisar de uma embalagem, remova-a. A remoção de uma dependência mantém seu projeto limpo e economiza espaço. Essa limpeza é especialmente importante para aplicativos de página única (SPAs) como Angular, React ou Vue. Essas aplicações agrupam e comprimem código num ficheiro servido no navegador. Quanto maior for o ficheiro, mais tempo demora a carregar, o que pode dissuadir os utilizadores.

Existem duas formas de limpar as dependências de que já não precisa:

  • Desinstalar: Para desinstalar um pacote, execute o npm uninstall <name of dependency>arquivo . Este comando remove o pacote do arquivo de manifesto package.json e da pasta node_modules.
  • Prune: Use npm prune para remover todas as dependências não listadas do node_modules. A remoção é útil quando você deseja remover várias dependências sem executar a desinstalação de cada uma. Para podar:
    1. Exclua as entradas de dependências ou devDependencies em package.json.
    2. run npm prune.