Как установить и использовать менеджер пакетов Yarn для Node.js
Введение
Yarn — это менеджер пакетов для Node.js, ориентированный на скорость, безопасность и согласованность. Первоначально он был создан для решения некоторых проблем с популярным менеджером пакетов NPM. Хотя с тех пор два менеджера пакетов сблизились с точки зрения производительности и функций, Yarn остается популярным, особенно в мире разработки React.
Некоторые из уникальных особенностей Yarn:
- Механизм кэширования для каждого проекта, который может значительно ускорить последующие установки и сборки.
- Последовательная, детерминированная установка, гарантирующая, что структура установленных библиотек всегда одинакова.
- Проверка контрольной суммы всех пакетов для проверки их целостности.
- «Рабочие пространства», которые облегчают использование Yarn в монорепозитории (несколько проектов, разработанных в одном репозитории исходного кода).
В этом уроке вы установите Yarn глобально, добавите Yarn в конкретный проект и изучите некоторые основные команды Yarn.
Развертывайте свои интерфейсные приложения из GitHub с помощью платформы приложений DigitalOcean. Позвольте DigitalOcean сосредоточиться на масштабировании вашего приложения.
Установка и использование менеджера пакетов Yarn для Node.js
- Установите Yarn по всему миру
- Установите Yarn в свой проект
- Используйте пряжу
Предварительные условия
Перед установкой и использованием менеджера пакетов Yarn вам необходимо установить Node.js. Чтобы узнать, установлен ли у вас уже Node.js, введите следующую команду в локальный терминал командной строки:
node -v
Если вы видите напечатанный номер версии, например v12.16.3, у вас установлен Node.js. Если вы получаете сообщение об ошибке команда не найдена (или подобную формулировку), прежде чем продолжить, установите Node.js.
Чтобы установить Node.js, следуйте нашему руководству для Ubuntu, Debian, CentOS или macOS.
После установки Node.js перейдите к шагу 1, чтобы установить менеджер пакетов Yarn.
Шаг 1 — Глобальная установка Yarn
Yarn имеет уникальный способ установки и запуска в ваших проектах JavaScript. Сначала вы устанавливаете команду yarn глобально, затем используете глобальную команду yarn для установки определенной локальной версии Yarn в каталог вашего проекта. Это необходимо для того, чтобы все, кто работает над проектом (и все инструменты автоматического тестирования и развертывания проекта), использовали одну и ту же версию yarn, чтобы избежать противоречивого поведения и результатов.
Сопровождающие Yarn рекомендуют устанавливать Yarn глобально с помощью менеджера пакетов NPM, который по умолчанию включен во все установки Node.js. Используйте флаг -g с npm install, чтобы сделать это:
sudo npm install -g yarn
После установки пакета команда yarn напечатает собственный номер версии. Это позволит вам убедиться, что он установлен правильно:
yarn --version
1.22.11
Теперь, когда команда yarn установлена глобально, вы можете использовать ее для установки Yarn в конкретный проект JavaScript.
Шаг 2 — Установка Yarn в ваш проект
Вы можете пропустить этот шаг, если используете Yarn для работы с существующим проектом на основе Yarn. В проекте уже должна быть настроена локальная версия Yarn и все файлы конфигурации, необходимые для его использования.
Если вы настраиваете новый собственный проект, вам нужно сейчас настроить версию Yarn для конкретного проекта.
Сначала перейдите в каталог вашего проекта:
cd ~/my-project
Если у вас нет каталога проекта, вы можете создать новый с помощью mkdir и затем перейти в него:
mkdir my-project
cd my-project
Теперь используйте команду yarn set, чтобы установить версию berry:
yarn set version berry
Будет загружена текущая, активно разрабатываемая версия Yarn — berry — сохраните ее в каталоге .yarn/releases/ вашего проекта и настройте . файл конфигурации Yarnrc.yml:
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
3.0.0
Вы увидите версию 3.0.0 или выше. Это последняя версия Yarn.
Примечание. Если вы cd выйдете из каталога проекта и снова запустите yarn --version, вы снова получите глобальный Номер версии Yarn, в данном случае 1.22.11. Каждый раз, когда вы запускаете yarn, вы используете глобально установленную версию команды. Глобальная команда yarn сначала проверяет, находится ли она в каталоге проекта Yarn с файлом .yarnrc.yml, и если да, то передает команду проекту. - конкретная версия Yarn, настроенная в настройке yarnPath проекта.
Теперь ваш проект настроен с использованием специальной версии Yarn. Далее мы рассмотрим несколько часто используемых команд yarn, с которых можно начать.
Использование пряжи
В Yarn есть множество подкоманд, но для начала вам понадобятся всего несколько. Давайте посмотрим на первые подкоманды, которые вы захотите использовать.
Получать помощь
Приступая к работе с любым новым инструментом, полезно узнать, как получить доступ к его онлайн-справке. В Yarn флаг --help можно добавить к любой команде, чтобы получить дополнительную информацию:
yarn --help
Это позволит распечатать общую справку по команде yarn. Чтобы получить более подробную информацию о подкоманде, добавьте --help после подкоманды:
yarn install --help
Это позволит распечатать подробную информацию о том, как использовать команду yarn install.
Начинаем проект новой пряжи
Если вы начинаете проект с нуля, используйте субкоманду 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 хранит файлы в папке .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 CLI.
Для получения более общей помощи по Node.js и JavaScript посетите наши страницы тегов Node.js и JavaScript, где вы найдете соответствующие учебные пособия, технические обсуждения и вопросы и ответы сообщества.