Flutter脚本执行插件cli_script的使用

简介

cli_script 包旨在让编写调用子进程的脚本变得简单，同时具备shell脚本的简洁性和Dart的强大功能。它捕捉了shell脚本的核心优点：简洁性、管道化和可组合性。与此同时，它使用了标准的Dart特性，如异常处理、Stream 和 Future，并在此基础上进行了一些扩展，使其在脚本环境中更容易使用。

虽然 cli_script 可以作为任何Dart应用程序中的库使用，但其主要目标是支持独立脚本，这些脚本与shell脚本具有相同的目的。由于它们只是普通的Dart代码，因此这些脚本将比Shell脚本更具可维护性，而不会牺牲易用性。

示例代码

Hello World 脚本

这是一个简单的Hello World脚本示例：

import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    await run('echo "Hello, world!"');
  });
}

注意，wrapMain() 并不是严格必要的，但它可以更优雅地处理错误。

创建和修改文件

以下是一个创建目录和文件的例子：

import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    await run("mkdir -p path/to/dir");
    await run("touch path/to/dir/foo");
  });
}

获取命令输出

获取命令输出也非常简单，可以使用 output() 或 lines() 方法：

import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    await for (var file in lines("find . -type f -maxdepth 1")) {
      var contents = await output("cat", args: [file]);
      if (contents.contains("needle")) print(file);
    }
  });
}

检查命令是否成功

你可以使用 check() 来测试命令是否成功（返回退出码0）：

import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    await for (var file in lines("find . -type f -maxdepth 1")) {
      if (await check("grep -q needle", args: [file])) print(file);
    }
  });
}

管道化

cli_script 支持通过 | 操作符连接多个进程，形成一个管道：

import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    var pipeline = Script("find -name *.dart") |
        Script("xargs grep waitFor") |
        Script("wc -l");
    print("${await pipeline.stdout.text} instances of waitFor");
  });
}

你也可以使用 Script.pipeline 构造函数来实现相同的功能：

import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    var count = await Script.pipeline([
      Script("find -name *.dart"),
      Script("xargs grep waitFor"),
      Script("wc -l")
    ]).stdout.text;
    print("$count instances of waitFor");
  });
}

文件操作

你可以轻松地将Dart数据传递给进程，例如读取文件内容并进行处理：

import 'dart:io';
import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    var pipeline = read("names.txt") |
        Script("grep Natalie") |
        Script("wc -l");
    print("There are ${await pipeline.stdout.text} Natalies");
  });
}

写入文件

你可以使用 > 操作符将脚本或管道的输出写入文件：

import 'dart:io';
import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() {
    Script.capture((_) async {
      await for (var file in lines("find . -type f -maxdepth 1")) {
        var contents = await output("cat", args: [file]);
        if (contents.contains("needle")) print(file);
      }
    }) > write("needles.txt");
  });
}

组合性

cli_script 中的任何东西都可以是一个 Script，最常见的方法是使用 Script.capture()：

import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    var script = Script.capture((_) async {
      await run("find . -type f -maxdepth 1");
      print("subdir/extra-file");
    });

    await for (var file in script.stdout.lines) {
      if (await check("grep -q needle", args: [file])) print(file);
    }
  });
}

其他特性

参数解析

cli_script 函数接受两种格式的参数：executableAndArgs 字符串和 args 列表。这使得调用简单命令时不需要过多的样板代码，并且可以轻松传递动态生成的参数而不必担心空格问题。

搜索和替换

cli_script 提供了一些有用的函数来进行搜索和替换操作，而无需启动子进程：

import 'dart:io';
import 'package:cli_script/cli_script.dart';

void main() {
  wrapMain(() async {
    var pipeline = File("names.txt").openRead() |
        grep("Natalie") |
        Script("wc -l");
    print("There are ${await pipeline.stdout.text} Natalies");
  });
}

以上就是 cli_script 插件的基本使用方法和一些常见示例。希望这些信息能帮助你在Flutter项目中更高效地编写和管理脚本。