pipeline-cli 0.6.0

一个rust写的windows平台的构建工具，用于快捷执行一系列脚本。该命令行工具的想法来源是pipelight,但是pipelight不支持windows，所以写了这个工具。

安装

使用cargo进行安装

cargo install pipeline-cli

内建函数

• pipeline(pipeline_name:String,closure:Closure):包裹一组由step和parallel组成的任务
• step(name:String,closure:Closure) 一个普通的任务，会阻塞后面的任务执行
• parallel(name:String,closure:Closure) 一个并行的任务，不会阻塞后面的任务执行
• cmd(command:String) 调用sh（linux）或者powershell执行一条命令
• env(key:String,value:String) 设置当前任务的环境变量
• max(..a:Int|Float) 返回一串Int或者Float数中的最大值
• println(..a:Any) 输入任意值，将其打印到控制台,带换行。（注意：pipeline任务运行的时候，其日志输出会覆盖println的内容）
• workspace(path:String) 切换当前命令的工作空间，影响cmd，movefile,replace函数中路径的书写
• move(source_path:String,target_path:String) 将一个文件从source_path移动到target_path处，如果target_path路径不存在会尝试创建一系列文件夹
• replace(file_path:String,regex:String,replace_content:String) 通过正则将file_path处的文件中的内容替换成replace_content
• copy(source_path:String,target_path:String) 将一个文件从source_path复制到target_path处,如果target_path路径不存在会尝试创建一系列文件夹

语法

1. 注释

//行注释
/* 注释段 */
/*
注释段
*/

2. 函数定义

fn add(a:Int,b:Int){
    return a+b
}

3. 函数调用

print(add(12,5))

4. 条件判断

let a=true
if a{
    println("Hello")
}

5. 声明变量

let a=1
let a=1.25
let a="hello"
let a=true
let b=a

Examples

需要在项目目录下添加一个名为pipeline.kts的文件，文件语法采用kotlin dsl语法，仅支持函数使用内建函数进行调用

一个pipeline.kts的例子:

pipeline("dev"){
    step("web"){
        workspace("./web")
        cmd("yarn dev")
    }
    step("tailwind"){
        workspace("./web")
        cmd("npx tailwindcss -i./src/style.css -o./src/output.css --watch")
    }
    step("go"){
        workspace("./test")
        copy("cmd/main.go","t/main.go")
        move("t/main.go","cmd/main.go")
    }
}
pipeline("hz"){
    step("new"){
         workspace("./")
         cmd("hz new -module github.com/yanguiyuan/cloudspace -idl idl/api/api.thrift")
         cmd("go mod tidy")
    }
    step("clean"){
        workspace("./")
        cmd("Remove-Item -Path ./biz -Recurse ")
        cmd("Remove-Item -Path ./script -Recurse ")
        cmd("del ./.hz")
        cmd("del ./build.sh")
        cmd("del ./router.go")
        cmd("del ./router_gen.go")
        cmd("del ./main.go")
    }
}

1.执行Pipeline dev下的Step web相关命令：

pipeline run dev.web
或者运行dev下的所有step
pipeline run dev

2.列出所有的任务

pipeline list

3.初始化项目使用模板

pipeline init -t <template_name>
//或者
pipeline init --template <template_name>
//例如
pipeline init -t hertz-vue

4.列出所有可用的模版（模版存放在用户目录的.pipeline目录下，可能需要你手动创建目录）

pipeline template

5.将当前项目中的pipeline.kts保存为模版

pipeline template -a/--add <template_name>

6.移除指定模版

pipeline template -r/--remove <template_name>