Модуль community.general.yarn – Управление пакетами node.js с Yarn

Примечание

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

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

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

Для использования в книге задач укажите: community.general.yarn.

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

Описание

Управление пакетами node.js с помощью менеджера пакетов Yarn (https://yarnpkg.com/)

Требования

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

Yarn установлен в пути bin (обычно /usr/local/bin)

Параметры

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

Атрибуты

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

Примеры

- 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

Значения возврата

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

Ключ	Описание
changed boolean	Указывает, изменил ли Yarn какие-либо данные пакетов Возвращается: всегда Пример: `true`
invocation словарь	Параметры и значения, используемые во время выполнения Возвращается: успешно Пример: `{"module_args": {"executable": null, "globally": false, "ignore_scripts": false, "name": null, "path": "/some/path/folder", "production": false, "registry": null, "state": "present", "version": null}}`
msg строка	Предоставляет сообщение об ошибке, если синтаксис Yarn был некорректным Возвращается: неудачно Пример: `"Package must be explicitly named when uninstalling."`
out строка	Вывод, сгенерированный 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), создатель модуля NPM Ansible

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

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