yaml-include 0.3.0

A simple cli that output to stdout recursivly included data from a yaml file path
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

# Yaml-include

A yaml processor that can recursivly include files through `!include <path>` tag.

## Install

```shell
cargo install yaml-include
```

## Usage

### Help

```shell
yaml-include --help
```

```yaml
Output yaml with recursive "!included" data

Usage: yaml-include <FILE_PATH>

Arguments:
  <FILE_PATH>  main yaml file to process

Options:
  -h, --help     Print help
  -V, --version  Print version
```

### Run

Ex.:

```shell
yaml-include data/sample/main.yml > main_inlined.yml
```

## Features

Basically,
turns this:

`main.yml`:

```yaml
data:
    - !include file_a.yml
    - !include file_b.yml
```

`file_a.yml`:

```yaml
something:
    - this
    - that
```

`file_b.yml`:

```yaml
other:
    - text: !include file_c.txt
    - markdown: !include file_d.md
```

`file_c.txt`:

```yaml
This is some "long" multiline
text file i don't want to edit
inline in a long yaml file
```

`file_d.md`:

```markdown
# This is some markdown data

## I don't want to edit

- inline
- in a long yaml file
```

Into that:

```yaml
data:
  - something:
      - this
      - that
  - other:
      - text: |-
          This is some long multiline
          text i don't want to edit
          inline in a long yaml file
      - markdown: |
          # This is some markdown data

          ## I don't want to edit

          - inline
          - in a long yaml file

```

> see [data/sample](data/sample)