Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в состав коллекции community.general (версия 2.0.1).

Для его установки используйте: 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 глобально
ignore_scripts
логическое значение
    Варианты:
  • нет ←
  • да
Использовать флаг --ignore-scripts при установке.
name
строка
Имя устанавливаемой библиотеки node.js.
Если опущено, устанавливаются все пакеты из package.json.
Для глобальной установки из локальной библиотеки node.js. Добавить "file:" к пути к библиотеке node.js.
path
путь
Базовый путь, где будут установлены библиотеки Node.js.
Здесь находится папка node_modules.
production
логическое значение
    Варианты:
  • нет ←
  • да
Установить зависимости в режиме production.
Yarn проигнорирует любые зависимости из devDependencies в package.json
registry
строка
Репозиторий для установки модулей.
state
строка
    Варианты:
  • present ←
  • absent
  • latest
Состояние установки указанной библиотеки node.js
Если выбран параметр absent, необходимо указать имя пакета.
version
строка
Версия устанавливаемой библиотеки.
Должна быть в формате semver. Если требуется "latest", используйте параметр "state" вместо этого.

Примеры

- 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: yes

- name: Remove the globally-installed package "imagemin".
  community.general.yarn:
    name: imagemin
    global: yes
    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
логическое значение
всегда
Изменил ли Yarn данные о пакетах

Пример:
True
invocation
словарь
успех
Параметры и значения, использованные во время выполнения

Пример:
{'module_args': {'executable': None, 'globally': False, 'ignore_scripts': False, 'name': None, 'path': '/some/path/folder', 'production': False, 'registry': None, 'state': 'present', 'version': None}}
msg
строка
ошибка
Предоставляет сообщение об ошибке, если синтаксис Yarn был некорректен

Пример:
Название пакета должно быть явно указано при удалении.
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/yarn_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API