recipe-runner/io-module

Recipe Runner 的 IO 模块

dev-master / 1.0.x-dev 2019-07-19 14:19 UTC

This package is auto-updated.

Last update: 2024-09-20 01:52:02 UTC


README

Latest Version on Packagist Build Status

输入/输出操作,如 writeask,用于与用户交互。

需求

安装

创建一个配方,并将模块添加到 packages 部分

name: "Your recipe"
extra:
  rr:
    packages:
      "recipe-runner/io-module": "1.0.x-dev"

使用方法

方法:write

将消息写入输出。

steps:
    - actions:
        - write: "Hi user. Welcome back."

允许多行消息

steps:
    - actions:
        - write: 
            "Hi user"
            "Welcome :)"

方法:ask

向用户提问。

steps:
    - actions:
        - ask: "What's your name?"
          register: "question1"
        - write: "The Response was: '{{question1['response']}}'"

问题的默认值为空字符串。也可以设置自定义默认值

ask:
  question: "What's your name?"
  default: "Jack"

响应

{
  "response": "bla bla"
}

方法 ask_yes_no

向用户提出是/否问题。接受的响应值

  • true:true, "true", "yes", "1", 1
  • false:false, "false", "no", "0", 0

默认值:true

ask_yes_no: "Are you sure?"

ask_yes_no:
  question: "What's your name?"
  default: true

响应

{
  "response": true
}

对于模块开发者

首选的安装方法是 composer

composer require recipe-runner/io-module

单元测试

您可以使用以下命令运行单元测试

$ cd io-module
$ composer test

许可证

此库是开源软件,根据 MIT 许可证 许可。