hledger-parser 1.0.0-beta.1

Hledger jornal parser
Documentation 
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

# hledger-parser

[![Coverage Status](https://coveralls.io/repos/github/ngalaiko/hledger-parser/badge.svg?branch=master)](https://coveralls.io/github/ngalaiko/hledger-parser?branch=master)

parser for hledger journals powered by [chumsky][]

## goals

* parse plaintext .journals into structured data to build tools on top

## non goals

* re-build hledger in rust

## current state

public beta

it's able to parse [cheatsheet][] and my personal ledger (which is quite extensive)

i don't like the api so far, so it will probably change

things i don't like:

* year directive - it is only used for parsing, probably no reason to export it?
* decimal mark directive - same thing
* error messages
* period::interval type definitions

## binary

a small binary comes with this lib that i found helpful during development and testing

```sh
> cargo run --features cli -- --help
Usage: hledger-parser --ledger-file <LEDGER_FILE>

Options:
      --ledger-file <LEDGER_FILE>  [env: LEDGER_FILE=/path/to/ledger.journal]
  -h, --help                       Print help
```

[chumsky]: https://github.com/zesterer/chumsky
[cheatsheet]: ./examples/fixture/cheatsheet.journal