marek-g/rust-ledger-parser

Rust library for parsing ledger cli (https://www.ledger-cli.org/) input files.

ledger-parser

Rust library for parsing Ledger-cli input files.

File format

Only a subset of the ledger-cli's file format is implemented.

Supported elements:

• Line comments (starting with: ; # % | *)

• Inline comments (starting with ;)

• Transaction headers with format (minimum two spaces or one tab between DESC and NOTE):

  DATE[=EDATE] [*|!] [(CODE)] DESC  [; NOTE]
  

• Transaction postings with format (minimum two spaces or one tab between ACCOUNT and AMOUNT):

    ACCOUNT  [AMOUNT] [= BALANCE] [; NOTE]
  

  • Virtual accounts are supported

  • Posting comments with dates, effective dates, and metadata tags are supported

    ACCOUNT  [AMOUNT] [= BALANCE]  ; [YYYY-MM-DD]
    ACCOUNT  [AMOUNT] [= BALANCE]  ; [=YYYY-MM-DD]
    ACCOUNT  [AMOUNT] [= BALANCE]  ; :TAG1:TAG2:
    ACCOUNT  [AMOUNT] [= BALANCE]  ; Tag: String Value
    ACCOUNT  [AMOUNT] [= BALANCE]  ; Tag:: -1
    ACCOUNT  [AMOUNT] [= BALANCE]  ; Tag:: 1.0
    ACCOUNT  [AMOUNT] [= BALANCE]  ; Tag:: [YYYY-MM-DD]
  

• AMOUNT can be combined with lot and commodity prices ({}, {{}}, @, @@)

• Commodity prices with format:

  P DATE SYMBOL PRICE
  

• Command directives: include

Example

Parsing:

let ledger: ledger_parser::Ledger = r#"; Example 1
2018-10-01=2018-10-14 ! (123) Description
  ; Transaction comment
  TEST:Account 123  $1.20
  ; Posting comment
  TEST:Account 345  -$1.20"#
    .parse()?;

Serializing:

use ledger_parser::{ Serializer, SerializerSettings };

println!("{}", ledger);
println!("{}", ledger.to_string_pretty(&SerializerSettings::default().with_indent("\t")));

See also

• ledger-utils - ledger-cli file processing Rust library, useful for calculating balances, creating reports etc.

rust-ledger-parser's Issues

Interested in collaboration?

Hi, Marek!

Not sure if you've already noticed, I've recently raised a question in the plain-text accounting channel on Reddit, which got some interest in developing (a) Ledger(-like) in Rust. Obviously you're doing a lot in that regard already so I was wondering if you were interesting in pooling-in with others.
I've (very recently!) created an organization to collect those interested in idea and try to focus the time and effort in a common goal. Please chip in if you're interested! Your parser is often mentioned in the discussions so far.
Cheers!

Support for Multiple Commodity conversion prices

First of all thank you for the parser, its amazing to find a parser written in rust :)
It would be great to see support for multiple commodities which is usually the case when dealing with stocks and other assets
eg:

2020-02-01
    assets:cc:ada          2000 ADA @ $0.02
    assets:bank:checking                   $-40

from https://hledger.org/investments.html?highlight=stock#a-stock-purchase

thanks :D

Thanks!

Just wanted to let you know that I appreciated being able to find this package! Though basic, it seems sufficient for use in scripts, and I plan on using it. Writing data shouldn't be too hard, so I just need to find a package that can do that, or write my own function.

I hope to be able to submit pull requests for some improvement items or documentation, so thanks again for maintaining it!

Balance assertion support

Would it be reasonable to add balance verifications to Postings and the parser? A downside would be that this would likely require a major version bump due to the new (optional) field in Posting.

This is probably something that I can attempt to implement myself with a pull request if it seems like a reasonable feature to add.