community.general.pnpm module – Manage Node.js packages with pnpm

Note

This module is part of the community.general collection (version 10.7.5).

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.pnpm.

New in community.general 7.4.0

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • Pnpm executable present in PATH.

Parameters

Parameter

Comments

alias

string

Alias of the Node.js library.

dev

boolean

Install dependencies in development mode.

Pnpm ignores any regular dependencies in package.json.

Choices:

  • false ← (default)

  • true

executable

path

The executable location for pnpm.

The default location it searches for is PATH, fails if not set.

global

boolean

Install the Node.js library globally.

Choices:

  • false ← (default)

  • true

ignore_scripts

boolean

Use the --ignore-scripts flag when installing.

Choices:

  • false ← (default)

  • true

name

string

The name of a Node.js library to install.

All packages in package.json are installed if not provided.

no_optional

boolean

Do not install optional packages, equivalent to --no-optional.

Choices:

  • false ← (default)

  • true

optional

boolean

Install dependencies in optional mode.

Choices:

  • false ← (default)

  • true

path

path

The base path to install the Node.js libraries.

production

boolean

Install dependencies in production mode.

Pnpm ignores any dependencies under devDependencies in package.json.

Choices:

  • false ← (default)

  • true

state

string

Installation state of the named Node.js library.

If absent is selected, a name option must be provided.

Choices:

  • "present" ← (default)

  • "absent"

  • "latest"

version

string

The version of the library to be installed, in semver format.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Install "tailwindcss" Node.js package.
  community.general.pnpm:
    name: tailwindcss
    path: /app/location

- name: Install "tailwindcss" Node.js package on version 3.3.2
  community.general.pnpm:
    name: tailwindcss
    version: 3.3.2
    path: /app/location

- name: Install "tailwindcss" Node.js package globally.
  community.general.pnpm:
    name: tailwindcss
    global: true

- name: Install "tailwindcss" Node.js package as dev dependency.
  community.general.pnpm:
    name: tailwindcss
    path: /app/location
    dev: true

- name: Install "tailwindcss" Node.js package as optional dependency.
  community.general.pnpm:
    name: tailwindcss
    path: /app/location
    optional: true

- name: Install "tailwindcss" Node.js package version 0.1.3 as tailwind-1
  community.general.pnpm:
    name: tailwindcss
    alias: tailwind-1
    version: 0.1.3
    path: /app/location

- name: Remove the globally-installed package "tailwindcss".
  community.general.pnpm:
    name: tailwindcss
    global: true
    state: absent

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

- name: Update all packages in package.json to their latest version.
  community.general.pnpm:
    path: /app/location
    state: latest

Authors

  • Aritra Sen (@aretrosen)

  • Chris Hoffman (@chrishoffman), creator of NPM Ansible module