Skip to content

Commit

Permalink
docs: highlight support for hledger
Browse files Browse the repository at this point in the history
  • Loading branch information
tbm committed Jul 27, 2020
1 parent 9ffb166 commit 3d3b373
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 8 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Conversion is based on (concrete) syntax, so that information that is not
meaningful for accounting reasons but still valuable (e.g., comments,
formatting, etc.) can be preserved.

ledger2beancount supports the file formats from:

* [ledger](https://ledger-cli.org/)
* [hledger](https://hledger.org/)

## Usage

Expand Down Expand Up @@ -116,6 +120,20 @@ use ledger2beancount and to configure it to your needs.
* Timeclock (`I`, `i`, `O`, `o`, `b`, `h`)
* Periodic transactions

### Supported features from hledger

* Account aliases can be regular expressions
* Amounts
* All digit group marks (space, comma, and period) are supported
* Number format can be specified via `commodity` and `D` directives
* Narration: support for `payee | note` format
* Posting dates: `date` and `date2`
* Tags: `tag1:, tag2:, tag2: info`
* Balance assertions
* Sub-account balance assertions: recognised but not supported in beancount
* Total balance assertions: recognised but no equivalent in beancount
* Directives
* `end aliases`

## Authors

Expand Down
15 changes: 8 additions & 7 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

## 2.4 (unreleased)

* Improve support for hledger
* Fix parsing of hledger tags
* Support commas as decimal markers
* Support digit group marks through `commodity` and `D` directives
* Support `end aliases` directive
* Support regex aliases
* Recognise total balance assertions
* Recognise sub-account balance assertions
* Handle price directives with comments
* Add support for `define` directive
* Convert all uppercase metadata tags to all lowercase
* Improve handling of ledger lots without cost
* Don't assume implicit conversion when price is on second posting
* Allow transactions without postings
* Fix parsing of hledger tags
* Support commas as decimal markers for hledger
* Support hledger's `end aliases` directive
* Support hledger's regex aliases
* Recognise hledger's total balance assertions
* Recognise hledger's sub-account balance assertions
* Support digit group marks through `commodity` and `D` directives
* Fix parsing issue in commodity declarations
* Support commodities that contain quotation marks
* Add `--version` option to show version
Expand Down
19 changes: 18 additions & 1 deletion docs/features.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Features

The majority of features from ledger are supported by ledger2beancount.
The majority of features from [ledger](https://ledger-cli.org/) and [hledger](https://hledger.org/) are supported by ledger2beancount.

## Fully supported

Expand Down Expand Up @@ -80,3 +80,20 @@ commented out during the conversion from ledger to beancount:
* Timeclock support (`I`, `i`, `O`, `o`, `b`, `h`)
* Periodic transactions

## Supported features from hledger

The following syntax from [hledger](https://hledger.org/) is supported if the `hledger` configuration variable is set:

* Account aliases can be regular expressions
* Amounts
* All digit group marks (space, comma, and period) are supported
* Number format can be specified via `commodity` and `D` directives
* Narration: support for `payee | note` format
* Posting dates: `date` and `date2`
* Tags: `tag1:, tag2:, tag2: info`
* Balance assertions
* Sub-account balance assertions: recognised but not supported in beancount
* Total balance assertions: recognised but no equivalent in beancount
* Directives
* `end aliases`

5 changes: 5 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ Conversion is based on (concrete) syntax, so that information that is not
meaningful for accounting reasons but still valuable (e.g., comments,
formatting, etc.) can be preserved.

As input, ledger2beancount supports the file formats from:

* [ledger](https://ledger-cli.org/)
* [hledger](https://hledger.org/)

ledger2beancount aims to be compatible with the latest official release of
beancount.

0 comments on commit 3d3b373

Please sign in to comment.