community.general.npm модуль – Управление пакетами node.js с помощью npm

Примечание

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

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

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

Для использования в playbook, укажите: community.general.npm.

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

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

Управление пакетами node.js с помощью Node Package Manager (npm).

Требования

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

npm установлен в пути bin (рекомендуется /usr/local/bin)

Параметры

Параметр	Комментарии
ci boolean	Установка пакетов на основе файла package-lock, аналогично запуску `npm ci`. Варианты: `false` ← (по умолчанию) `true`
executable path	Расположение исполняемого файла для npm. Это полезно, если вы используете менеджер версий, такой как nvm.
force boolean добавлено в community.general 9.5.0	Использовать флаг `--force` при установке. Варианты: `false` ← (по умолчанию) `true`
global boolean	Установить библиотеку node.js глобально. Варианты: `false` ← (по умолчанию) `true`
ignore_scripts boolean	Использовать флаг `--ignore-scripts` при установке. Варианты: `false` ← (по умолчанию) `true`
name string	Имя библиотеки node.js для установки.
no_bin_links boolean добавлено в community.general 2.5.0	Использовать флаг `--no-bin-links` при установке. Варианты: `false` ← (по умолчанию) `true`
no_optional boolean добавлено в community.general 2.0.0	Использовать флаг `--no-optional` при установке. Варианты: `false` ← (по умолчанию) `true`
path path	Базовый путь для установки библиотек node.js.
production boolean	Установить зависимости в режиме production, исключая devDependencies. Варианты: `false` ← (по умолчанию) `true`
registry string	Реестр для установки модулей.
state string	Состояние библиотеки node.js. Варианты: `"present"` ← (по умолчанию) `"absent"` `"latest"`
unsafe_perm boolean	Использовать флаг `--unsafe-perm` при установке. Варианты: `false` ← (по умолчанию) `true`
version string	Версия для установки.

Атрибуты

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

Примеры

- name: Install "coffee-script" node.js package.
  community.general.npm:
    name: coffee-script
    path: /app/location

- name: Install "coffee-script" node.js package on version 1.6.1.
  community.general.npm:
    name: coffee-script
    version: '1.6.1'
    path: /app/location

- name: Install "coffee-script" node.js package globally.
  community.general.npm:
    name: coffee-script
    global: true

- name: Force Install "coffee-script" node.js package.
  community.general.npm:
    name: coffee-script
    force: true

- name: Remove the globally package "coffee-script".
  community.general.npm:
    name: coffee-script
    global: true
    state: absent

- name: Install "coffee-script" node.js package from custom registry.
  community.general.npm:
    name: coffee-script
    registry: 'http://registry.mysite.com'

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

- name: Update packages based on package.json to their latest version.
  community.general.npm:
    path: /app/location
    state: latest

- name: Install packages based on package.json using the npm installed with nvm v0.10.1.
  community.general.npm:
    path: /app/location
    executable: /opt/nvm/v0.10.1/bin/npm
    state: present

Авторы

Chris Hoffman (@chrishoffman)

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

© 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/npm_module.html