cargo-pipe 0.1.14

A command-line tool to generate and build data integration app using pipebase framework
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

[`cargo-pipe`] is a [`clap`] based command-line tool to generate and build [`pipebase`] app with manifest

## Installation
install Rust and Cargo
```sh
curl https://sh.rustup.rs -sSf | sh
```
install [`rustfmt`]
```sh
rustup component add rustfmt
```
install `cargo-pipe` CLI
```sh
cargo install cargo-pipe
```

## Usage
```
cargo pipe --help
```

## Quick Start
go to [`resources`] folder
```
cargo pipe new && \
cargo pipe validate -o -p && \
cargo pipe generate && \
cargo pipe build -o timer -r
```
run app
```
./timer
```
note that, any change to `pipe.yml` requires re-run `validate`, `generate`, `build` steps

## Validation & Debug
validate manifest only
```
cargo pipe validate -o -p
```
build with debug flag
```
cargo pipe build -d
...
     Warning struct is never constructed: `Bar`
     Warning 1 warning emitted
```
fix the warning by remove `objects` section
```
@@ -23,13 +23,6 @@ pipes:
     config:
       ty: PrinterConfig
     upstreams: [ "timer1", "timer2" ]
-objects:
-  - ty: Bar
-    fields:
-      - name: bar1
-        ty: Integer
-      - name: bar2
-        ty: String
```
since manifest changed, re-generate and build
```
cargo pipe generate && \
cargo pipe build -d
```

## Describe Manifest
list all pipes and objects
```
cargo pipe describe -a
...
    Describe pipes
      Result pipe: timer1, printer, timer2
    Describe objects
      Result objects: Bar
```
describe a pipe
```
cargo pipe describe -p timer1
...
    Describe pipe timer1
      Result
Name:   timer1
Type:   poller
Config: { type: TimerConfig, path: catalogs/timer1.yml }
Upstream: []
```
describe an object
```
cargo pipe describe -o Bar
...
    Describe object Bar
      Result
Type: Bar
Type Metas:
Fields:
Name   Type Metas
bar1    i32
bar2 String
```
describe pipelines cross a pipe
```
cargo pipe describe -l printer
...
    Describe pipelines for printer
      Result pipeline: timer2(u128) -> printer
      Result pipeline: timer1(u128) -> printer
```

[`cargo-pipe`]: https://github.com/pipebase/pipebase/tree/main/cargo-pipe
[`resources`]: https://github.com/pipebase/pipebase/tree/main/cargo-pipe/resources
[`clap`]: https://github.com/clap-rs/clap
[`rustfmt`]: https://github.com/rust-lang/rustfmt
[`pipebase`]: https://github.com/pipebase/pipebase