Flutter命令行工具插件pipe_cli的使用

Flutter命令行工具插件pipe_cli的使用

为什么要使用它？

Pipe的目标是帮助用户自动化日常任务并标准化代码。通过Pipe，您可以使用markdown和yaml创建和文档化CLI命令和代码模板。借助Pipe，您可以创建脚本以执行以下操作：

• 生成代码
• 重构代码
• 运行命令

以及其他更多功能。

动机

您是否知道一个可以处理所有需求的CLI命令？

有时我们需要非常特定的命令，或者对已知命令进行一些修改，但有时这些修改无法配置，并且没有满足期望的可用命令。

Pipe CLI 允许您使用灵活的配置编写CLI命令，使用yaml脚本和预制命令。

特性

• 创建CLI（命令行界面）
• 创建子命令
• 为CLI添加选项

安装

dart pub global activate pipe_cli

使用方法

开始使用

1. 在项目的根目录下创建一个名为pipe.md的文件，并用yaml编写您的CLI命令。
2. 运行您的CLI命令：

   pipe <your_created_cli>
   

创建CLI（命令行界面）

要创建一个新的CLI命令，只需在pipe.md文件中添加您的脚本。

**`example.yaml`**

```yaml
say_hello:
 name: 'hello'            # 命令名称，用于终端调用
 abbr: 'h'                # 命令缩写，作为名称的别名
 description: 'Say hello'  # 命令描述
 execute:
  - print: 'Hello World'   # 一个名为“print”的预制命令，将在终端显示“Hello World”

要使用该命令，只需运行：

```bash
pipe say hello

创建子命令

要创建子命令，首先编写您的命令，并添加一个名为sub-commands的列表，其中包含将作为子命令工作的CLI名称。子命令名称必须由命令名称和名称通过点分隔组成。

**`example.yaml`**

```yaml
say:
  name: 'say'            # 命令名称，用于终端调用
  abbr: 's'              # 命令缩写，作为名称的别名
  description: 'Say something'  # 命令描述
  sub_commands:
    - say.hello
say.hello:
  name: 'hello'
  abbr: 'h'
  description: 'Say hello'
  execute:
    - print: 'Hello World'   # 一个名为“print”的预制命令，将在终端显示“Hello World”

要使用该命令，只需运行：

```bash
pipe say hello

为CLI添加选项

要为CLI添加选项，首先编写您的命令，并添加一个名为args的列表，其中包含CLI选项的定义。子命令名称必须由命令名称和名称通过点分隔组成。

**`example.yaml`**

```yaml
say:
  name: 'say'              # 命令名称，用于终端调用
  abbr: 's'                # 命令缩写，作为名称的别名
  description: 'Say something'  # 命令描述
  sub_commands:
    - say.hello
say.hello:
  name: 'hello'
  abbr: 'h'
  description: 'Say hello'
  args:
    world:
      help: "appends a word 'World' to phrase"   # 显示的帮助文本，当使用--help标志时
      abbr: w                                    # 该标志的别名（使用-w）
      negatable: true                            # 创建选项--no-world，将world设置为false
      defaults: true                             # 设置默认值为true
  execute:
    if_flag:
      flag: world
      then:
        - print: 'Hello World'    # 一个名为“print”的预制命令，将在终端显示“Hello World”
      else:
        - print: 'Hello'          # 一个名为“print”的预制命令，将在终端显示“Hello”

要使用该命令，只需运行：

```bash
pipe say hello --world

或

pipe say hello -w

管道文件（pipe.md）

创建一个名为pipe.md的markdown文件，然后编写您的第一个命令。

**`name_of_script`**

```yaml
gen_usecase:
 name: usecase
 abbr: u
 description: 'Creates an usecase in a custom template'

该命令接收一个模式，从该模式提取两个参数feature和name，然后在lib/**feature**/domain/usecases/路径下创建一个名为**name**_usecase.dart的usecase。

 execute:
  - install:
    - get_it
  - capture:
     text: '{{rest}}'
     regex: '(?<feature>[A-z]*)@(?<name>[A-z]*)'
  - file_name: '{{name}}_usecase'
  - file_path: 'lib/features/{{feature}}/domain/usecase/{{file_name}}.dart'
  - build_usecase: '{{interface_usecase}}{{\n}}{{usecase}}'
  - generate:
     template: '{{build_usecase}}'
     path: '{{file_path}}'

模板

创建一个新行 \n

usecase接口模板 interface_usecase

abstract class I{{file_name|pascalCase}} {
  Future<void> call();
}

usecase实现模板 usecase

class {{file_name|pascalCase}} extends I{{file_name|pascalCase}} {
  [@override](/user/override)
  Future<void> call() async {
    throw UnimplementedError();
  }
}

命令

capture: 使用等于命名捕获组（正则表达式）的名称创建变量，给定的regex具有text值匹配的结果。

```yaml
...
capture:
 text: 'a CamelCase word'
 regex: '(?<word_with_camelCase>^[a-z]|[A-Z0-9])[a-z]*'

**generate**: 使用`template`内容创建一个文件`path`。

```yaml
```yaml
...
generate:
 template: '{{build_usecase}}'
 path: '{{file_path}}'

**print**: 打印给定的值。

```yaml
```yaml
...
print: 'Hello World'

**run**: 在终端运行一个命令。

```yaml
```yaml
...
run:
  executable: 'dart'
  args:
    - pub
    - add
    - dio
  show_outputs: true      # 默认为true - 显示给定命令（dart）的输出
  provide_feedback: true  # 默认为true - 提供成功或错误的反馈

### 变量

使用一个值为`String`、`num`或`bool`的yaml对象声明变量，变量名称不能与对象名称匹配。

```yaml
```yaml
...
name: 'André'
hello_world: 'Hello {{André}}'
print: hello_world

### 模板

Dart代码保存为模板，并可以通过评估语法`{{template_name}}`作为参数使用，传递模板名称，即模板名称前的Dart块内容。

```yaml
```yaml
generate_class:
  name: generate_class
  abbr: g
  description: Creates a Class.
  execute:
    - class_name: 'some_class'
    - generate:
        template: '{{use_case.dart}}'
        path: 'lib/classes/{{class_name}}.dart'

class_template

class {{class_name|pascalCase}}{}