nu_plugin_from_dhall 0.1.0

Nushell plugin to add Dhall support
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

`nu_plugin_from_dhall`
=====================

[![Check](https://github.com/autophagy/nu_plugin_from_dhall/actions/workflows/check.yaml/badge.svg)](https://github.com/autophagy/nu_plugin_from_dhall/actions/workflows/check.yaml) [![Test](https://github.com/autophagy/nu_plugin_from_dhall/actions/workflows/test.yaml/badge.svg)](https://github.com/autophagy/nu_plugin_from_dhall/actions/workflows/test.yaml)

This is a plugin for [Nushell] to open [Dhall] files into `nu`'s structured
data types.

# Installing

```bash
cargo install nu_plugin_from_dhall
plugin add ~/.cargo/bin/nu_plugin_from_dhall
plugin use ~/.cargo/bin/nu_plugin_from_dhall
```

# Usage

Given a Dhall file:

```bash
> cat example.dhall
let AccountType = < Guest : Text | User : Natural | Admin : Bool >

let Person =
      { name : Text
      , age : Natural
      , accountType : AccountType
      , nickname : Optional Text
      }

let alice
    : Person
    = { name = "Alice"
      , age = 24
      , accountType = AccountType.Admin False
      , nickname = Some "Cool Alice"
      }

let bob
    : Person
    = { name = "Bob"
      , age = 49
      , accountType = AccountType.User 777
      , nickname = None Text
      }

let carlo
    : Person
    = { name = "Carlo"
      , age = 20
      , accountType = AccountType.Guest "Only around for an hour"
      , nickname = Some "Cooler Carlo"
      }

in  [ alice, bob, carlo ]
```

Use `open` to parse the Dhall expression into structured data that Nushell can
pipe:

```bash
> open example.dhall
╭───┬─────────────────────────────────────┬─────┬───────┬──────────────╮
│ # │             accountType             │ age │ name  │   nickname   │
├───┼─────────────────────────────────────┼─────┼───────┼──────────────┤
│ 0 │ ╭───────┬───────╮                   │  24 │ Alice │ Cool Alice   │
│   │ │ Admin │ false │                   │     │       │              │
│   │ ╰───────┴───────╯                   │     │       │              │
│ 1 │ ╭──────┬─────╮                      │  49 │ Bob   │              │
│   │ │ User │ 777 │                      │     │       │              │
│   │ ╰──────┴─────╯                      │     │       │              │
│ 2 │ ╭───────┬─────────────────────────╮ │  20 │ Carlo │ Cooler Carlo │
│   │ │ Guest │ Only around for an hour │ │     │       │              │
│   │ ╰───────┴─────────────────────────╯ │     │       │              │
╰───┴─────────────────────────────────────┴─────┴───────┴──────────────╯

> open example.dhall | where age > 20 | get name
╭───┬───────╮
│ 0 │ Alice │
│ 1 │ Bob   │
╰───┴───────╯
```

Alternatively, you can also use `from dhall`:

```bash
> open example.dhall --raw | from dhall | select name nickname
╭───┬───────┬──────────────╮
│ # │ name  │   nickname   │
├───┼───────┼──────────────┤
│ 0 │ Alice │ Cool Alice   │
│ 1 │ Bob   │              │
│ 2 │ Carlo │ Cooler Carlo │
╰───┴───────┴──────────────╯
```

[Nushell]: https://www.nushell.sh
[Dhall]: https://dhall-lang.org