yj 1.2.3

Command line tool that converts YAML to JSON
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
116
117
118
119
120
121
122
123
124

# YJ - YAML to JSON
[![Build Status](https://api.cirrus-ci.com/github/bruceadams/yj.svg)](https://cirrus-ci.com/github/bruceadams/yj)

Simple command line tool to convert a YAML input file into a JSON output file.

## How to, etc.

### Built in help

```bash
% yj --help
Command line tool that converts YAML to JSON

Usage: yj [OPTIONS] [INPUT]

Arguments:
  [INPUT]  Input YAML file name. Defaults to stdin

Options:
  -c, --compact          Use compact formatting for the JSON output
  -y, --yaml             Format the output as YAML instead of JSON
  -j, --json             Parse the input as JSON. For most use cases, this
                         option makes no difference. Valid JSON is valid
                         YAML, so JSON input will (should?) parse
                         correctly even when being handled with the YAML
                         parser. Use this option when you want failure
                         (instead of weird results) when the input is
                         invalid JSON
  -o, --output <OUTPUT>  Output file name for the JSON. Defaults to stdout
  -h, --help             Print help information
  -V, --version          Print version information
```

### Installing

Local build and install with `cargo`:

```bash
$ cargo install yj
```

Prebuilt binaries are available on
[Github releases](https://github.com/bruceadams/yj/releases)
for some common platforms.

On macOS, the prebuilt binary can be installed using
[Homebrew](https://brew.sh). Unfortunately, Homebrew picked up a
different utility with the name `yj` after I chose that name here.
So, a simple `brew install yj` gets that tool, not this one 😞.

```bash
$ brew tap bruceadams/utilities
$ brew install bruceadams/utilities/yj
```

Alternatively on macOS, you may also install `yj` using [MacPorts](https://www.macports.org):

```bash
$ sudo port selfupdate
$ sudo port install yj
```

Minimal Docker images are available on
[Docker Hub](https://cloud.docker.com/repository/docker/bruceadams/yj):

```bash
$ docker pull bruceadams/yj
```

### Example runs

```bash
$ cat .travis.yml
language: rust
os:
  - linux
  - osx
  - windows
rust:
  - stable
  - beta
  - nightly
matrix:
  allow_failures:
    - rust: nightly
  fast_finish: true
$ yj .travis.yml
{
  "language": "rust",
  "os": [
    "linux",
    "osx",
    "windows"
  ],
  "rust": [
    "stable",
    "beta",
    "nightly"
  ],
  "matrix": {
    "allow_failures": [
      {
        "rust": "nightly"
      }
    ],
    "fast_finish": true
  }
}
$ echo pi: 3.1415926 | yj
{
  "pi": 3.1415926
}
$ echo pi: 3.1415926 | yj -c
{"pi":3.1415926}$
```

## Build

Build it your self with Rust 2018, which needs a recent installation of Rust.
Get Rust installed from https://rustup.rs/.

```bash
cargo build
```