community.general.yarn 模块 – 使用 Yarn 管理 node.js 包

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。 您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定： community.general.yarn。

概要

要求

以下要求需要在执行此模块的主机上满足。

  • Yarn 安装在 bin 路径中（通常为 /usr/local/bin）

参数

参数

注释

可执行文件

路径

yarn 的可执行文件位置。

全局

布尔值

全局安装 node.js 库

选项

  • false ←（默认）

  • true

忽略脚本

布尔值

安装时使用 --ignore-scripts 标志。

选项

  • false ←（默认）

  • true

名称

字符串

要安装的 node.js 库的名称

如果省略，则安装 package.json 中的所有包。

要从本地 node.js 库进行全局安装。 在 node.js 库的路径前添加“file:”。

路径

路径

将安装 Node.js 库的基本路径。

这是 node_modules 文件夹所在的位置。

生产

布尔值

在生产模式下安装依赖项。

Yarn 将忽略 package.json 中 devDependencies 下的任何依赖项

选项

  • false ←（默认）

  • true

注册表

字符串

从中安装模块的注册表。

状态

字符串

命名 node.js 库的安装状态

如果选择 absent，则必须提供 name 选项

选项

  • "present" ←（默认）

  • "absent"

  • "latest"

版本

字符串

要安装的库的版本。

必须是 semver 格式。 如果需要“latest”，请改用“state”参数

属性

属性

支持

描述

检查模式

支持: 完整

可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。

差异模式

支持: 无

当处于差异模式时，将返回有关已更改（或可能需要在 check_mode 中更改）的详细信息。

示例

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

- name: Remove the globally-installed package "imagemin".
  community.general.yarn:
    name: imagemin
    global: true
    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

返回值

常见的返回值记录在这里，以下是此模块特有的字段

键

描述

已更改

布尔值

Yarn 是否更改了任何软件包数据

返回: 始终

示例: true

调用

字典

执行期间使用的参数和值

返回: 成功

示例: {"module_args": {"executable": null, "globally": false, "ignore_scripts": false, "name": null, "path": "/some/path/folder", "production": false, "registry": null, "state": "present", "version": null}}

msg

字符串

如果 Yarn 语法不正确，则提供错误消息

返回: 失败

示例: "Package must be explicitly named when uninstalling."

输出

字符串

Yarn 生成的输出。

返回: 始终

示例: "yarn add v0.16.1[1/4] 正在解析包...[2/4] 正在获取包...[3/4] 正在链接依赖项...[4/4] 正在构建新包...成功 已保存锁定文件。成功 已保存 1 个新依赖项[email protected] 完成 耗时 0.59秒。"

作者

  • David Gunter (@verkaufer)

  • Chris Hoffman (@chrishoffman), NPM Ansible 模块的创建者)