Как установить и использовать менеджер пакетов Yarn для Node.js

Учебники
JavaScript

Введение

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

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

  • A per-project caching mechanism, that can greatly speed up subsequent installs and builds
  • Постоянные, детерминированные установки, гарантирующие, что структура установленных библиотек всегда одинакова
  • Проверка контрольных сумм всех пакетов для проверки их целостности
  • “Workspaces”, которые облегчают использование Yarn в монорепозитории (несколько проектов, разрабатываемых в одном репозитории исходного кода)

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

Разверните ваши фронтенд-приложения из GitHub с помощью DigitalOcean App Platform. Позвольте DigitalOcean масштабировать ваше приложение.

Установка и использование менеджера пакетов Yarn для Node.js

  1. Установите Yarn глобально
  2. Установите Yarn в ваш проект
  3. Используйте Yarn

Предварительные требования

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

  1. node -v

Если вы видите номер версии, например, v12.16.3, у вас установлен Node.js. Если вы получаете ошибку command not found (или подобную фразу), пожалуйста, установите 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, чтобы сделать это:

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

  1. sudo npm install -g yarn

После установки пакета запустите команду yarn для вывода своей версии. Это позволит вам проверить правильность установки:

  1. yarn --version



Output
1.22.11

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

Шаг 2 — Установка Yarn в вашем проекте

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

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

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

  1. cd ~/my-project

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

  1. mkdir my-project

  2. cd my-project

Теперь используйте команду yarn set для установки версии berry:

  1. 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 еще раз:

  1. yarn --version



Output
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 имеет много подкоманд, но вам нужно всего несколько для начала. Давайте рассмотрим первые подкоманды, которые вы захотите использовать.

Получение помощи

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

  1. yarn --help

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

  1. yarn install --help

Это выведет подробности о том, как использовать команду yarn install.

Начало нового проекта Yarn

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

  1. yarn init

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

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

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

  1. yarn install

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

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

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

  1. yarn add package-name

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

Обновление вашего файла .gitignore для Yarn

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

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

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

Для получения более подробной информации о том, как настроить Git и Yarn, обратитесь к официальной документации Yarn по .gitignore.

Заключение

В этом уроке вы установили Yarn и узнали о некоторых подкомандах yarn. Для получения более подробной информации о работе с Yarn, ознакомьтесь с официальной документацией по командной строке Yarn.

Для получения более общей помощи по Node.js и JavaScript, пожалуйста, посетите наши страницы тегов Node.js и JavaScript, где вы найдете соответствующие уроки, технические разговоры и вопросы и ответы сообщества.

Source:
https://www.digitalocean.com/community/tutorials/how-to-install-and-use-the-yarn-package-manager-for-node-js