Как установить и использовать Yarn Package Manager для Node.js

Введение

Yarn — это менеджер пакетов для Node.js, ориентированный на скорость, безопасность и стабильность. Изначально он был создан для исправления некоторых проблем популярного менеджера пакетов NPM. Хотя с тех пор эти два менеджера пакетов сблизились по функциональности и функционалу, Yarn остаётся популярным, особенно в сфере разработки на React.

Некоторые уникальные особенности Yarn:

• Механизм хранения в каждом проекте, который может значительно ускорить последующий монтаж и строительство.
• Фиксированные и окончательные установки, которые гарантируют, что структура установленных библиотек всегда одинакова.
• Тестирование агрегации всех пакетов для проверки их целостности
• “Рабочие пространства”, которые упрощают использование Yarn в монорепозитории (несколько проектов, разработанных в одном репозитории исходного кода).

В этом уроке вы установите Yarn глобально, добавите Yarn в определенный проект и изучите некоторые основные команды Yarn.

Предпосылки

Для установки и использования менеджера пакетов Yarn необходимо установить Node.js. Чтобы проверить, установлен ли Node.js, введите следующую команду в локальном терминале командной строки:

node -v

Если вы видите номер версии, например, v12.16.3, у вас установлен Node.js. Если вы столкнулись с ошибкой «команда не найдена» (или аналогичной), установите Node.js, прежде чем продолжить.

Шаг 1 — Глобальная установка YARN

Yarn имеет уникальный способ установки и запуска в ваших JavaScript-проектах. Сначала вы устанавливаете Yarn глобально, а затем используете глобальную команду yarn для установки конкретной локальной версии Yarn в каталоге вашего проекта. Это необходимо для того, чтобы все участники проекта (и все инструменты автоматизированного тестирования и развертывания проекта) использовали одну и ту же версию Yarn, чтобы избежать несогласованного поведения и результатов.

Разработчики Yarn рекомендуют установить Yarn глобально с помощью менеджера пакетов NPM, который по умолчанию входит в комплект всех установок Node.js. Для этого используйте флаг -g при установке npm:

sudo npm install -g yarn

После установки пакета команда пряжа Попросите его вывести номер версии. Это позволит вам убедиться, что установка прошла успешно:

yarn --version

Output
1.22.11

Теперь, когда вы установили команду yarn глобально, вы можете использовать ее для установки Yarn в определенном проекте JavaScript.

Шаг 2 — Установка пряжи в ваш проект

Если вы используете Yarn для работы с существующим проектом на его основе, этот шаг можно пропустить. Проект должен быть уже настроен с локальной версией Yarn и всеми необходимыми файлами конфигурации.

Если вы начинаете новый проект для себя, вам теперь нужно настроить версию Yarn для конкретного проекта.

Сначала перейдите в каталог вашего проекта:

cd ~/my-project

Если у вас нет каталога проекта, вы можете создать новую папку с помощью mkdir, а затем войти в нее:

mkdir my-project
cd my-project

Теперь от команды набор пряжи Чтобы установить версию Berry используйте:

yarn set version berry

Это загрузит текущую разработанную версию Yarn – berry – и сохранит ее в каталоге .yarn/releases/ вашего проекта, а также настроит файл конфигурации .yarnrc.yml:

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!

Теперь попробуйте еще раз выполнить команду yarn --version:

yarn --version

Output
3.0.0

Вы увидите версию 3.0.0 или выше. Это последняя версия Yarn.

Теперь ваш проект настроен на использование версии Yarn, адаптированной для конкретного проекта. Далее мы рассмотрим некоторые часто используемые команды Yarn, которые помогут вам начать работу.

Использование пряжи

В Yarn множество подкоманд, но для начала работы вам понадобятся лишь несколько. Давайте рассмотрим первые подкоманды, которые вам понадобятся.

Приступая к работе с любым новым инструментом, полезно научиться пользоваться его онлайн-справкой. В Yarn можно добавить флаг --help к любой команде, чтобы получить дополнительную информацию:

yarn --help

Выводит общую справку по команде yarn. Чтобы получить более подробную информацию о подкоманде, добавьте –help после неё:

yarn install --help

Будут выведены подробные сведения о том, как использовать команду установки пряжи.

Начинаем новый проект YARN

Если вы начинаете проект с нуля, используйте подкоманду init для создания необходимых файлов Yarn:

yarn init

Это добавит в ваш каталог файл конфигурации package.json и файл yarn.lock. package.json содержит конфигурацию и список зависимостей вашего модуля. Файл yarn.lock привязывает эти зависимости к определённым версиям, обеспечивая согласованность дерева зависимостей.

Установка всех зависимостей для проекта

Чтобы загрузить и установить все зависимости в существующем проекте на основе Yarn, используйте подкоманду install:

yarn install

Это позволит загрузить и установить модули, необходимые для начала работы.

Добавление новой зависимости в проект

Используйте подкоманду add для добавления новых зависимостей в проект:

yarn add package-name

Это загрузит и установит модуль, а также обновит файлы package.json и yarn.lock.

Обновление файла .gitignore Для пряжи

Yarn хранит файлы в папке .yarn в каталоге вашего проекта. Некоторые из этих файлов следует добавить в систему контроля версий, а другие — игнорировать. Базовая конфигурация .gitignore для Yarn выглядит следующим образом:

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

При этом будет проигнорирован весь каталог yarn., а затем добавлены некоторые исключения для важных папок, включая каталог releases, содержащий версию Yarn, специфичную для вашего проекта.

Более подробную информацию о настройке Git и Yarn можно найти в официальной документации Yarn по адресу .gitignore.

Результат

В этом руководстве вы установили Yarn и познакомились с несколькими подкомандами Yarn. Подробнее об использовании Yarn можно узнать в официальной документации по интерфейсу командной строки Yarn.