概述

这是一个Rust属性类似的proc宏，可以减少调用shell命令和解析结果所需的代码量。

它允许您使用强类型函数将任何语言的脚本包装起来。函数的参数设置为环境变量，脚本的结果被解析为值或迭代器。

文档

仓库

示例

基本

use shellfn::shell;
use std::error::Error;

#[shell]
fn list_modified(dir: &str) -> Result<impl Iterator<Item=String>, Box<Error>> { r#"
    cd $DIR
    git status | grep '^\s*modified:' | awk '{print $2}'
"# }

不同的解释器

use shellfn::shell;
use std::error::Error;

#[shell(cmd = "python -c")]
fn pretty_json(json: &str, indent: u8, sort_keys: bool) -> Result<String, Box<Error>> { r#"
import os, json

input = os.environ['JSON']
indent = int(os.environ['INDENT'])
sort_keys = os.environ['SORT_KEYS'] == 'true'
obj = json.loads(input)

print(json.dumps(obj, indent=indent, sort_keys=sort_keys))
 "# }

用法

您可以在具有以下属性的函数上使用 #[shell] 属性：

• 包含单个表达式（表示要执行的脚本的字符串字面量）的主体
• 实现了 .to_string() 方法的类型
• 返回值为 void、T、Result<T, E>、impl Iterator<Item=T>、Result<impl Iterator<Item=T>> 或 Result<impl Iterator<Item=Result<T, E>>>，具有约束

T: FromStr,
<T as FromStr>::Err: StdError,
E: From<shellfn::Error<<T as FromStr>::Err>>,

• 详细说明

#[shell] 属性执行以下操作：

1. 将每个参数设置为一个环境变量
2. 运行shell命令
3. 使用 std::process::Command 启动命令
4. 根据返回类型，它可能解析输出

大多数步骤都可以进行调整

• 默认命令是 bash -c。您可以使用 cmd 参数来更改它

#[shell(cmd = "python -c")]

• 默认情况下，脚本作为最后一个参数添加。您可以使用 PROGRAM 特殊变量在 cmd 参数中更改它

#[shell(cmd = "bash -c PROGRAM -i")]

• 您可以在 cmd 参数中像在脚本中一样使用函数参数设置的环境变量

#[shell(cmd = "python -m $MODULE")]
fn run(module: &str)

• 如果返回类型不是在 Result 中包裹结果的一部分，您可以通过添加 no_panic 标志来决定抑制恐慌

#[shell(no_panic)]

以下返回类型目前被识别

术语表

说明

1. no_panic 属性没有任何影响
2. 它读取所有 stdout 在产生任何失败之前
3. 它产生所有项目，直到它遇到错误或退出代码

向量与迭代器

返回类型为 Vec 的变体与返回类型为 impl Iterator 的变体非常相似。关键区别在于

• impl Iterator 只在必要时分配一个项目，并在解析后立即产生它，而 Vec 是逐行读取输出，但将解析后的输出存储在临时的 Vec 中
• Vec 意识到退出代码。当子进程以错误状态完成时，impl Iterator 将停止产生值，而 Vec 将返回错误或恐慌