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

Примечание

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

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

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

Чтобы использовать этот модуль в плейбуке, укажите: 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 глобально. Если `global=true`, то для установки пакетов не используется `path`. Варианты: `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. Если `global=true`, то для установки пакетов не используется `path`.
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	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

- 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/npm_module.html