community.general.npm module – Manage node.js packages with npm
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.npm
.
Synopsis
Manage node.js packages with Node Package Manager (npm).
Aliases: packaging.language.npm
Requirements
The below requirements are needed on the host that executes this module.
npm installed in bin path (recommended /usr/local/bin)
Parameters
Parameter |
Comments |
---|---|
Install packages based on package-lock file, same as running Choices:
|
|
The executable location for npm. This is useful if you are using a version manager, such as nvm. |
|
Install the node.js library globally. Choices:
|
|
Use the Choices:
|
|
The name of a node.js library to install. |
|
Use the Choices:
|
|
Use the Choices:
|
|
The base path where to install the node.js libraries. |
|
Install dependencies in production mode, excluding devDependencies. Choices:
|
|
The registry to install modules from. |
|
The state of the node.js library. Choices:
|
|
Use the Choices:
|
|
The version to be installed. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- 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: 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