Yarn как установить зависимости: все, что вам нужно знать о них

все, что вам нужно знать о них

Yarn это новый менеджер пакетов, совместно созданный Facebook, Google, Exponent и Tilde. Как можно прочитать в официальной документации, его целью является решение целого ряда проблем, с которыми столкнулись разработчики при использовании npm, а именно:

  • установка пакетов не была достаточно быстрой и последовательной;
  • существовали проблемы с безопасностью, так как npm позволяет пакетам запускать код при установке.

Но не тревожьтесь. Это не попытка полностью заменить npm. Yarn это новый клиент командной строки, скачивающий модули из реестра npm. В самом реестре ничего не меняется — вы можете скачивать и публиковать модули также, как и прежде.

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

Yarn или npm: функциональные отличия

На первый взгляд Yarn и npm кажутся похожими. Но если заглянуть под капот, мы увидим отличия Yarn.

Файл yarn.lock

В файле package.json, с помощью которого Yarn и npm отслеживают зависимости, номера версий не указываются точно, вместо этого задается их диапазон. Таким образом, вы можете задать определенную основную или вспомогательную версию, при этом позволяя npm установить последний патч с исправлениями каких-либо багов.

В идеальном мире семантического версионирования, релизы с патчами не содержат коренных изменений. Но, к сожалению, в реальности это не всегда верно. Стратегия, выбранная npm может привести к тому, что на двух машинах с идентичными файлами package.json будут установлены различные версии пакетов, что может привести к появлению багов.

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

В npm команда npm shrinkwrap так же генерирует файл блокировки, а команда npm install считывает его до чтения package.json, также как Yarn сначала читает yarn.lock. Разница состоит в том, что Yarn всегда автоматически обновляет yarn.lock, а в npm это надо делать вручную.

  1. документация yarn.lock
  2. документация npm shrinkwrap

Параллельная установка

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

Для сравнения я установил пакет express с помощью npm и Yarn, не используя кэш, файлы shrinkwrap или lock; всего в установке 42 файла.

  • npm: 9 секунд
  • Yarn: 1. 37 секунд

Я не поверил своим глазам. Повторение дало такие же результаты. Затем я установил gulp со 195 зависимостями.

  • npm: 11 секунд
  • Yarn: 7.81 секунд

Кажется, что разница зависит от количества устанавливаемых пакетов, в любом случае Yarn быстрее.

Консольные логи

По умолчанию npm выводит очень много. Например, он рекурсивно перечисляет все установленные пакеты при выполнении npm install <package>. Yarn с другой стороны, обходится минимумом информации и использует эмодзи (если у вас mac).

Yarn или npm: различия в интерфейсе командной строки

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

yarn global

В отличие от npm, где глобальные операции выполняются за счет опции -g или --global, команды Yarn нуждаются в префиксе global. Также как и в npm, специфические для проекта зависимости глобально не устанавливаются.

Префикс global работает только с командами yarn add, yarn bin, yarn ls и yarn remove. За исключением yarn add, все эти команды идентичны своим эквивалентам в npm.

  1. Документация global.

yarn install

Команда npm install устанавливает все зависимости из файла package.json и позволяет вам добавлять новые пакеты. Команда yarn install только устанавливает зависимости, перечисленные в файле yarn.lock или package.json, именно в таком порядке.

  1. Документация yarn install
  2. Документация npm install

yarn add [–dev]

Аналогично npm install <package>, команда yarn add <package> добавляет пакет и устанавливает зависимости. Как видно из названия команды, она добавляет зависимости, это означает автоматическое сохранение ссылки на пакет в файле package. json, также как это делается в npm с флагом --save. Флаг --dev в Yarn добавляет зависимости для разработки, также как флаг --save-dev в npm.

  1. Документация yarn add
  2. Документация npm install

yarn licenses [ls|generate-disclaimer]

На момент написания в npm нет эквивалента этой команды. Yarn licenses ls выводит список лицензий всех установленных в проекте пакетов, а yarn licenses generate-disclaimer генерирует дисклеймер, содержащий текст всех лицензий всех пакетов в проекте. Некоторые лицензии требуют включать текст лицензии в ваш проект, поэтому этот инструмент весьма полезен.

  1. Документация yarn licenses

yarn why

Эта команда смотрит в граф зависимостей и выясняет, почему указанный пакет установлен в вашем проекте. Возможно, вы сами добавили его, а, может, это зависимость установленного вами пакета. Команда yarn why помогает вам с этим разобраться.

  1. Документация yarn why

yarn upgrade

Эта команда обновляет пакеты до последней версии, соответствующей диапазону из package.json вместо установки точных версий из yarn.lock. Чтобы добиться того же в npm, вам надо последовательно выполнить:

rm -rf node_modules
npm install

Эту команду не надо путать с npm update, обновляющей пакеты до самой свежей версии.

  1. Документация yarn upgrade

yarn generate-lock-entry

Команда yarn generate-lock-entry генерирует файл yarn.lock на основе зависимостей из package.json. Это похоже на npm shrinkwrap. Эту команду следует использовать с осторожностью, так как файл блокировки генерируется и обновляется автоматически при добавлении и обновлении зависимостей с помощью yarn add и yarn upgrade.

  1. Документация yarn generate-lock-entry
  2. Документация npm shrinkwrap

Стабильность и надежность

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

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

Перспективы

Возможно, вы опасаетесь повторения истории с Node.js и io.js. Напомню, что io.js был форком Node.js, созданным несколькими основными разработчиками после разногласий по поводу управления проектом. Меньше, чем через год, обе команды пришли к соглашению, io.js был слит с Node.js и прекращен. Независимо от того, кто был прав, это обогатило Node.js новыми функциями.

Я вижу схожие паттерны между npm и Yarn. Хотя Yarn это не форк, он исправляет некоторые из недостатков npm. Разве будет плохо, если npm учтет это и попросит Facebook, Google и остальных разработчиков Yarn улучшить npm? Хотя об этом слишком рано пока говорить, но я надеюсь, что так и произойдет.

В любом случае, будущее Yarn выглядит светлым. Сообщество проявляет интерес к появлению нового пакетного менеджера. К сожалению, пока отсутствует дорожная карта проекта, поэтому я не знаю, какие сюрпризы Yarn готовит для нас.

Заключение

По умолчанию Yarn набирает больше очков, чем npm. У нас есть файл блокировки, установка пакетов быстра, как никогда и они все автоматически сохраняются в package.json. Последствия установки и использования Yarn минимальны — вы можете попробовать его только в одном проекте, чтобы увидеть, подходит он вам или нет. Это делает Yarn превосходной заменой npm.

Я мог бы однозначно рекомендовать попробовать Yarn в каком-нибудь проекте, раньше или позже. Если вы осторожны в установке и использовании новых программ, подождите пару месяцев. В конце концов, npm проверен в боевых условиях, а в мире разработки программного обеспечения это немаловажно.

Если же вы замечали, что вам приходиться ждать окончания установки пакетов npm, то вам самое время ознакомиться с руководством по переходу на Yarn.

Yarn 2 — Устанавливаем и разбираемся / Хабр

Знакомство

Yarn 2 (Berry) — это новый выпуск революционного и хорошо зарекомендовавшего себя менеджера пакетов Yarn, включающий в себя такие особенности, как: Plug’n’Play, возможность расширения модульного API, оффлайн-кэш и улучшенную поддержку рабочих пространств.

Plug’n’Play

Yarn PnP  —  это новая функция, которая по умолчанию включена в Yarn 2. PnP избавляет проекты от папки node_modules в пользу файла .pnp.js.

Файл .pnp.js сопоставляет все пакеты, установленные в проекте, с тем местом, где Yarn разместил их на вашем диске. Это избавляет от большого количества операций ввода-вывода при генерации node_modules, обеспечивая более быструю и надёжную установку.

В новой документации Yarn подробно рассказывается о недостатках node_modules, как структуры папок, и объясняется, почему необходим новый взгляд на управление зависимостями.

Монорепозитории

Не зависимо от того, являетесь бы поклонником монорепозиториев или нет, чтобы обеспечить качественное управление большими проектами и сложными рабочими процессами, потребуется хороший набор инструментов.

Популярным рецептом настойки JavaScript монорепозитория является комбинация рабочих пространств Yarn и использование Lerna в качестве менеджера проектов.

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

Модульная архитектура, плагины

Сделав важный шаг вперед, Yarn 2 был переработан в пользу нового модульного API, расширяемого при помощью плагинов. В настоящее время большинство функций уже реализовано с их помощью — даже yarn add и yarn install являются предустановленными плагинами!

Вы можете сами написать плагин для Yarn, а чтобы дать вам представление об этом процессе, разработчики Yarn создали плагин TypeScript, который будет автоматически добавлять соответствующие @types/packages каждый раз, когда вы запускаете yarn add.

Как начать работу?

Установка

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

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

❯ npm install -g yarn

Выполнив данную инструкцию (запуск yarn --version должен вывести что-то вроде 1.22.x), перейдём к созданию каталога для запуска нового проекта:

❯ mkdir my-app
❯ cd my-app

“Berry” — кодовое имя релизной ветки Yarn 2.
Изменим версию Yarn конкретно для каталога my-app:

❯ yarn set version berry

После выполнения данной команды установка будет завершена, и можно переходить к установке зависимостей!

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

Общие команды управления остались теми же, что и в предыдущих версиях:

  • yarn init  —  инициализация проекта

  • yarn add <package> [--dev]  —  добавление пакета

  • yarn remove <package>  —  удаление пакета

  • yarn up <package>  —  обновление пакета

Также, вы можете увидеть некоторые изменения консольного интерфейса в новой версии Yarn:

  • каждый набор связанных задач, выполняемых в процессе установки, сгруппирован;

  • почти все сообщения имеют собственные коды ошибок, которые можно найти в документации;

  • цвета теперь используются только для обозначения важных частей каждого сообщения.

Установка React.js с Yarn-плагином TypeScript

Далеко не все пакеты поставляются с собственными определениями типов, но уже нет поводов для волнения, ведь там, где их нет, Yarn возьмёт работу на себя.

Перед выполнением операцией ниже, следует установить Yarn Berry для рабочей директории и убрать детей от экрана.

Инициализируем package.json и установим плагин TypeScript:

❯ yarn init
❯ yarn plugin import typescript

Проведем установку библиотеки React:

❯ yarn add react react-dom
➤ YN0000: ┌ Resolution step
➤ YN0000: └ Completed in 1s 932ms
➤ YN0000: ┌ Fetch step
➤ YN0013: │ loose-envify@npm:1.4.0
➤ YN0013: │ object-assign@npm:4.1.1
➤ YN0013: │ react-dom@npm:17.0.2
➤ YN0013: │ react@npm:17.0.2
➤ YN0013: │ scheduler@npm:0.20.2
➤ YN0000: └ Completed in 0s 502ms
➤ YN0000: ┌ Link step
➤ YN0000: └ Completed
➤ YN0000: Done in 2s 503ms

Зависимости @types/ были успешно установлены!

package.json

Что в итоге

Ветка Yarn 1. x (Classic) уже официально перешла в статус поддержки, предполагающей только исправление уязвимостей.

Все новые функции будут разрабатываться исключительно для Yarn 2, версия которого будет распространяться через yarn set version.

Для React Native всё таки придётся подключать node modules.

Если Yarn не подружится с вашей IDE, нужно будет кое-что установить. Не скучайте!

установка пряжи

| Yarn

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

Если вы привыкли использовать npm, возможно, вы ожидаете использовать --save или
--save-dev . Они были заменены пряжей add и пряжей add --dev . Для
больше информации см.
пряжа добавить документацию .

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

Если вам нужны воспроизводимые зависимости, что обычно имеет место в системах непрерывной интеграции, вы должны передать флаг --frozen-lockfile .

yarn install

Установите все зависимости, перечисленные в package.json в локальном
Папка node_modules .

Файл yarn.lock используется следующим образом:

  • Если yarn.lock присутствует и его достаточно для удовлетворения всех зависимостей, перечисленных в package.json , точные версии записаны в yarn.lock установлены, а yarn.lock останется без изменений. Yarn не будет проверять наличие новых версий.
  • Если yarn.lock отсутствует или недостаточно для удовлетворения всех зависимостей, перечисленных в package.json (например, если вы вручную добавите зависимость к package.json ), Yarn ищет самые новые доступные версии, которые удовлетворяют ограничениям в package. json . Результаты записываются в yarn.lock .

Если вы хотите, чтобы yarn.lock не обновлялся, используйте --frozen-lockfile .

yarn install --check-files

Проверяет, что уже установленные файлы в node_modules не были удалены.

yarn install --flat

Установите все зависимости, но разрешите только одну версию для каждого пакета. При первом запуске вам будет предложено
выбрать одну версию для каждого пакета, который зависит от нескольких
диапазоны версий. Они будут добавлены в ваш package.json под
разрешения поля.

 "разрешения": {
  "пакет-а": "2.0.0",
  "пакет-б": "5.0.0",
  "пакет-c": "1.5.2"
}
 

установка пряжи --force

Выполняет повторную загрузку всех пакетов, даже тех, которые были установлены ранее.

yarn install --har

Выводит HTTP-архив со всех
сетевые запросы, выполняемые во время установки. Файлы HAR обычно используются
для исследования производительности сети и может быть проанализирована с помощью таких инструментов, как
Google HAR Analyzer или
HAR-просмотрщик.

yarn install --ignore-scripts

Не выполнять скрипты, определенные в проекте package.json и его зависимостях.

yarn install --modules-folder <путь>

Указывает альтернативное расположение каталога node_modules вместо стандартного ./node_modules .

yarn install --no-lockfile

Не читать и не создавать файл блокировки yarn.lock .

yarn install --production[=true|false]

Yarn не будет устанавливать пакеты, перечисленные в devDependencies , если Переменная среды NODE_ENV установлена ​​на production . Используйте этот флаг, чтобы дать Yarn указание игнорировать NODE_ENV и вместо этого использовать статус «производство или нет» из этого флага.

Примечания: --production совпадает с --production=true . --prod является псевдонимом --production .

yarn install --pure-lockfile

Не создавать файл блокировки yarn.lock .

yarn install --focus

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

Должен выполняться в отдельной рабочей области в проекте рабочих областей. Невозможно запустить в проекте, не относящемся к рабочим областям, или в корне проекта рабочих областей.

Узнайте больше о целевых рабочих пространствах.

установка пряжи --frozen-lockfile

Не генерировать файл блокировки yarn.lock и не работать, если требуется обновление.

yarn install --silent

Выполнить установку yarn без печати журнала установки.

yarn install --ignore-engines

Игнорировать проверку двигателей.

yarn install --ignore-Optional

Не устанавливать необязательные зависимости.

yarn install --offline

Запустить установку yarn в автономном режиме.

yarn install --non-interactive

Отключить интерактивные подсказки, например, при наличии недопустимой версии зависимости.

yarn install --update-checksums

Обновите контрольные суммы в файле блокировки yarn.lock , если есть несоответствие между ними и контрольной суммой их пакета.

yarn install --audit

Проверяет установленные пакеты на наличие известных проблем безопасности. Количество найденных проблем будет добавлено к выходным данным. Используйте команда аудита пряжи для получения дополнительных сведений. В отличие от npm, который автоматически запускает аудит при каждой установке, yarn делает это только по запросу. (Это может измениться в более позднем обновлении, так как функция доказала свою стабильность.)

yarn install --no-bin-links

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

yarn install --link-duplicates

Создание жестких ссылок на повторяющиеся модули в node_modules.

yarn install --verbose

Показать дополнительные журналы при установке зависимостей

yarn add | Yarn

Устанавливает пакет и все пакеты, от которых он зависит.

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

В общем, пакет — это просто папка с кодом и файл package.json
который описывает содержимое. Если вы хотите использовать другой пакет, вы сначала
нужно добавить его в свои зависимости. Это означает запуск пряжи add [package-name]
чтобы установить его в свой проект.

Это также обновит ваш package.json и ваш yarn.lock , чтобы другие
разработчики, работающие над проектом, получат те же зависимости, что и вы, когда
они запускают пряжу или пряжу устанавливают .

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

Вы можете указать версии, используя один из следующих способов:

  1. пряжа добавить имя пакета устанавливает «последнюю» версию пакета.
  2. yarn add [email protected] устанавливает определенную версию пакета из
    реестр.
  3. yarn add package-name@tag устанавливает определенный
    «тег» (например, бета , следующий или последний ).

Вы также можете указать пакеты из разных мест:

  1. пряжа добавить имя пакета устанавливает пакет из
    реестр npm, если вы не указали другой
    в вашем package. json .
  2. yarn add file:/path/to/local/folder устанавливает пакет, который находится на вашем
    локальная файловая система. Это полезно для тестирования других ваших пакетов, которые
    не были опубликованы в реестре.
  3. пряжа добавить файл:/path/to/local/tarball.tgz устанавливает пакет из gzip-архива
    tarball, который можно использовать для совместного использования пакета перед его публикацией.
  4. yarn add link:/path/to/local/folder устанавливает символическую ссылку на пакет, который
    в вашей локальной файловой системе. Это полезно для разработки связанных пакетов в
    среды монорепозитория.
  5. yarn add устанавливает пакет из удаленного репозитория git.
  6. yarn add # устанавливает пакет с удаленного
    репозиторий git в определенной ветке git, git commit или git tag.
  7. yarn add https://my-project. org/package.tgz устанавливает пакет из
    удаленный tar-архив, сжатый gzip.

Предостережения

Если вы ранее использовали диспетчер пакетов, такой как npm, возможно, вы ищете
как добавить глобальные зависимости.

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

Если вы пытаетесь использовать инструмент CLI, который имеет корзину , вы можете получить к ним доступ в
ваш каталог ./node_modules/.bin . Вы также можете использовать
глобальная команда:

 пряжа глобальная добавить <пакет...>
 

Команды

yarn add

Это установит один или несколько пакетов в ваш
зависимости .

yarn add ..> [--dev/-D]

Использование --dev или -D установит один или несколько пакетов в вашу
devDependencies .

yarn add [--peer/-P]

Использование --peer или -P установит один или несколько пакетов в ваш
одноранговые зависимости .

yarn add [--необязательный/-O]

Использование --необязательный или -O установит один или несколько пакетов в ваш
дополнительные зависимости .

yarn add [--exact/-E]

Использование --exact или -E устанавливает пакеты как точные версии. По умолчанию
использовать самый последний выпуск с той же основной версией. Например,
yarn add [email protected] примет версию 1.9.1 , но
yarn add [email protected] --exact будет принимать только версию 1. 2.3 .

пряжа добавить [--tilde/-T]

Использование --tilde или -T устанавливает самый последний выпуск пакетов, которые
имеют ту же минорную версию. По умолчанию используется самая последняя версия с
та же основная версия. Например, пряжа add [email protected] --tilde примет
1.2.9 но не 1.3.0 .

yarn add [--ignore-workspace-root-check/-W]

Использование --ignore-workspace-root-check или -W позволяет установить пакет
в корне рабочих пространств. Это, как правило, нежелательное поведение, поскольку
обычно предполагается, что зависимости являются частью рабочей области. Например
пряжа добавить lerna --ignore-workspace-root-check --dev в корень рабочей области
позволит использовать lerna в сценариях корневого package.json.

yarn add @npm:

Это установит пакет под пользовательским псевдонимом.

This entry was posted in Популярное