Модуль community.general.yarn — управление пакетами Node.js с помощью Yarn

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.yarn.

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Управление пакетами Node.js с помощью менеджера пакетов Yarn https://yarnpkg.com/.
Обратите внимание, что в настоящий момент этот модуль работает только с Yarn Classic.

Требования

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

Yarn Classic в одном из каталогов bin (обычно /usr/local/bin)

Параметры

Параметр	Комментарии
executable path	Путь к исполняемому файлу yarn.
global boolean	Установить библиотеку Node.js глобально. Возможные значения: `false` ← (по умолчанию) `true`
ignore_scripts boolean	Использовать флаг `--ignore-scripts` при установке. Возможные значения: `false` ← (по умолчанию) `true`
name string	Имя устанавливаемой библиотеки Node.js. Если параметр не указан, устанавливаются все пакеты из package.json. Чтобы глобально установить локальную библиотеку Node.js, добавьте `file:` перед путём к библиотеке Node.js.
path path	Базовый путь, в котором Node.js устанавливает библиотеки. Здесь находится каталог `node_modules`.
production boolean	Установить зависимости в режиме production. `yarn` игнорирует все зависимости в разделе devDependencies файла `package.json`. Возможные значения: `false` ← (по умолчанию) `true`
registry string	Реестр, из которого устанавливаются модули.
state string	Состояние установки указанной библиотеки Node.js. Если выбрано `absent`, необходимо указать параметр `name`. Возможные значения: `"present"` ← (по умолчанию) `"absent"` `"latest"`
version string	Версия устанавливаемой библиотеки. Версия должна соответствовать формату semver. Если требуется «latest», вместо этого используйте аргумент `state`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогнозируемый статус изменений, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, необходимо изменить в `check_mode`).

Примеры

- name: Install "imagemin" Node.js package.
  community.general.yarn:
    name: imagemin
    path: /app/location

- name: Install "imagemin" Node.js package on version 5.3.1
  community.general.yarn:
    name: imagemin
    version: '5.3.1'
    path: /app/location

- name: Install "imagemin" Node.js package globally.
  community.general.yarn:
    name: imagemin
    global: true

- name: Remove the globally-installed package "imagemin".
  community.general.yarn:
    name: imagemin
    global: true
    state: absent

- name: Install "imagemin" Node.js package from custom registry.
  community.general.yarn:
    name: imagemin
    registry: 'http://registry.mysite.com'

- name: Install packages based on package.json.
  community.general.yarn:
    path: /app/location

- name: Update all packages in package.json to their latest version.
  community.general.yarn:
    path: /app/location
    state: latest

Возвращаемые значения

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

Ключ	Описание
out string	Вывод, сформированный Yarn. Возвращается: всегда Пример: `"yarn add v0.16.1[1/4] Resolving packages...[2/4] Fetching packages...[3/4] Linking dependencies...[4/4] Building fresh packages...success Saved lockfile.success Saved 1 new dependency..left-pad@1.1.3 Done in 0.59s."`

Авторы

David Gunter (@verkaufer)
Chris Hoffman (@chrishoffman), создатель модуля Ansible для NPM)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/yarn_module.html