limabean-contrib

A supplementary package for limabean which welcomes contributions, in particular plugins.

Plugins

• example-magic-money - stateful transducer example
• example-set-narration - simplest possible example plugin

Contributing

Contributions of new plugins are very welcome. Steps to take:

1. Write and test your plugin
2. Add a full description in the docs, and link to it from the list above
3. Add a test, as below

A plugin is simply a Clojure transducer. The function which creates the transducer takes two parameters: the config supplied in the beanfile (or nil if none), and the options extracted from the beanfile, as made available in the REPL as *options*.

Tests

Each plugin has its tests alongside the plugin, and will be found be the test runner. At least two tests are expected: with and without config. Additional tests are welcome, but not required.

Each test comprises a Beancount file together with a sibling golden output directory containing expected test output in EDN format. The test runner will find all such pairs and run the tests.

Running of the tests does require the supplementary executable limabean-pod to be on the path, for parsing of Beancount files.

Tests comprise a Beancount file and a golden directory as siblings. Once these exist, golden output files may be created or updated using the following command.

kiri> clojure -X:gen-golden

which requires at least limabean 0.4.2

To verify all tests are passing:

kiri> clojure -X:test

License

Copyright © 2025-26 Simon Guest, except as otherwise indicated on individual plugins.

Unless otherwise stated, licensed under either of

• Apache License, Version 2.0 LICENSE-APACHE
• MIT license LICENSE-MIT

at your option.

Individual plugins may have different licenses, for example where these are derived works of original Beancount plugins.