Como Instalar e Usar o Gerenciador de Pacotes Yarn para o Node.js

Introdução

O Yarn é um gerenciador de pacotes para Node.js que foca em velocidade, segurança e consistência. Ele foi originalmente criado para resolver alguns problemas com o popular gerenciador de pacotes NPM. Embora os dois gerenciadores de pacotes tenham desde então convergido em termos de desempenho e recursos, o Yarn continua sendo popular, especialmente no mundo do desenvolvimento React.

Algumas das características únicas do Yarn são:

• A per-project caching mechanism, that can greatly speed up subsequent installs and builds
• Instalações consistentes e determinísticas que garantem que a estrutura das bibliotecas instaladas seja sempre a mesma
• Teste de checksum de todos os pacotes para verificar sua integridade
• “Workspaces”, que facilitam o uso do Yarn em um monorepo (múltiplos projetos desenvolvidos em um único repositório de código-fonte)

Neste tutorial, você irá instalar o Yarn globalmente, adicionar o Yarn a um projeto específico e aprender alguns comandos básicos do Yarn.

Instalando e Usando o Gerenciador de Pacotes Yarn para Node.js

1. Instale o Yarn globalmente
2. Instale o Yarn em seu projeto
3. Usando o Yarn

Pré-requisitos

Antes de instalar e usar o gerenciador de pacotes Yarn, você precisará ter o Node.js instalado. Para verificar se você já possui o Node.js instalado, digite o seguinte comando no terminal de linha de comando local:

node -v

Se você vir um número de versão, como v12.16.3 impresso, você tem o Node.js instalado. Se você receber um erro de comando não encontrado (ou frase similar), por favor, instale o Node.js antes de continuar.

Para instalar o Node.js, siga nosso tutorial para Ubuntu, Debian, CentOS ou macOS.

Uma vez que você tenha o Node.js instalado, siga para o Passo 1 para instalar o gerenciador de pacotes Yarn.

Passo 1 — Instalando o Yarn Globalmente

O Yarn possui uma forma única de instalar e executar-se em seus projetos JavaScript. Primeiro, você instala o comando yarn globalmente, então você utiliza o comando global yarn para instalar uma versão local específica do Yarn em seu diretório de projeto. Isso é necessário para garantir que todos que trabalham em um projeto (e todas as ferramentas de teste automatizadas e de implantação do projeto) estejam executando a mesma versão do yarn, para evitar comportamentos e resultados inconsistentes. Os mantenedores do Yarn recomendam instalar o Yarn globalmente utilizando o gerenciador de pacotes NPM, que está incluído por padrão em todas as instalações do Node.js. Utilize a flag -g com o comando npm install para fazer isso:

Os mantenedores do Yarn recomendam a instalação global do Yarn usando o gerenciador de pacotes NPM, que é incluído por padrão em todas as instalações do Node.js. Use a bandeira -g com npm install para fazer isso:

sudo npm install -g yarn

Após a instalação do pacote, faça o comando yarn imprimir seu próprio número de versão. Isso permitirá verificar se ele foi instalado corretamente:

yarn --version

Output
1.22.11

Agora que você tem o comando yarn instalado globalmente, pode usá-lo para instalar o Yarn em um projeto JavaScript específico.

Passo 2 — Instalando o Yarn no seu projeto

Você pode pular este passo se estiver usando o Yarn para trabalhar em um projeto existente baseado no Yarn. O projeto deve já estar configurado com uma versão local do Yarn e todos os arquivos de configuração necessários para usá-lo.

Se você estiver configurando um novo projeto seu, desejará configurar uma versão específica do projeto do Yarn agora.

Primeiro, navegue até o diretório do seu projeto:

cd ~/my-project

Se você não tiver um diretório de projeto, poderá criar um novo com mkdir e depois entrar nele:

mkdir my-project
cd my-project

Agora use o comando yarn set para definir a versão como berry:

yarn set version berry

Isso baixará a versão atual, em desenvolvimento ativo do Yarn – berry – salve-o em um diretório .yarn/releases/ em seu projeto e configure um arquivo de configuração .yarnrc.yml também:

Output
Resolving berry to a url...
Downloading https://github.com/yarnpkg/berry/raw/master/packages/berry-cli/bin/berry.js...
Saving it into /home/sammy/my-project/.yarn/releases/yarn-berry.cjs...
Updating /home/sammy/my-project/.yarnrc.yml...
Done!

Agora tente novamente o comando yarn --version:

yarn --version

Output
3.0.0

Você verá que a versão é 3.0.0 ou superior. Esta é a versão mais recente do Yarn.

Seu projeto agora está configurado com uma versão específica do projeto do Yarn. Em seguida, vamos analisar alguns comandos yarn comumente usados para iniciar.

Usando o Yarn

O Yarn possui muitas subcomandos, mas você só precisa de alguns para começar. Vamos analisar os primeiros subcomandos que você desejará usar.

Obtendo Ajuda

Ao começar com qualquer nova ferramenta, é útil aprender como acessar sua ajuda online. No Yarn, a bandeira --help pode ser adicionada a qualquer comando para obter mais informações:

yarn --help

Isso imprimirá ajuda geral para o comando yarn. Para obter informações mais específicas sobre um subcomando, adicione --help após o subcomando:

yarn install --help

Isso imprimiria detalhes sobre como usar o comando yarn install.

Iniciando um Novo Projeto com Yarn

Se você está iniciando um projeto do zero, use o subcomando init para criar os arquivos específicos do Yarn que você precisará:

yarn init

Isso adicionará um arquivo de configuração package.json e um arquivo yarn.lock ao seu diretório. O package.json contém a configuração e sua lista de dependências de módulo. O arquivo yarn.lock bloqueia essas dependências para versões específicas, garantindo que a árvore de dependências seja sempre consistente.

Instalando todas as Dependências de um Projeto

Para baixar e instalar todas as dependências em um projeto existente baseado em Yarn, use o subcomando install:

yarn install

Isso baixará e instalará os módulos que você precisa para começar.

Adicionando uma Nova Dependência a um Projeto

Use o subcomando add para adicionar novas dependências a um projeto:

yarn add package-name

Isso baixará o módulo, instalá-lo e atualizará seus arquivos package.json e yarn.lock.

Atualizando seu Arquivo .gitignore para o Yarn

O Yarn armazena arquivos em uma pasta .yarn dentro do diretório do seu projeto. Alguns desses arquivos devem ser verificados no controle de versão e outros devem ser ignorados. A configuração básica do .gitignore para o Yarn segue:

.yarn/*
!.yarn/patches
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*

Isso ignora a pasta inteira .yarn e depois adiciona algumas exceções para pastas importantes, incluindo a pasta releases que contém a versão específica do Yarn para o seu projeto.

Para obter mais detalhes sobre como configurar o Git e o Yarn, por favor, consulte a documentação oficial do Yarn sobre .gitignore.

Conclusão

Neste tutorial, você instalou o Yarn e aprendeu sobre alguns subcomandos yarn. Para obter mais informações sobre o uso do Yarn, dê uma olhada na documentação oficial da CLI do Yarn em Yarn CLI documentation.

Para obter mais ajuda geral sobre Node.js e JavaScript, visite nossas páginas de tags Node.js e JavaScript, onde você encontrará tutoriais relevantes, palestras técnicas e perguntas e respostas da comunidade.