rustledger-wasm

WebAssembly bindings for rustledger, enabling Beancount functionality in JavaScript/TypeScript.

Features

Feature	Description
`parse()`	Parse Beancount source to JSON
`validateSource()`	Validate ledger with error reporting
`query()`	Run BQL queries
`format()`	Format source with consistent alignment
`expandPads()`	Expand pad directives
`runPlugin()`	Run native plugins (with `plugins` feature)
`bqlCompletions()`	BQL query completions (with `completions` feature)
`ParsedLedger`	Single-file stateful class with editor features
`Ledger`	Multi-file stateful class for queries
`parseMultiFile()`	Parse multiple files with include resolution
`validateMultiFile()`	Validate across multiple files
`queryMultiFile()`	Query across multiple files

Example

import init, { parse, validateSource, query } from '@rustledger/wasm';

await init();

const source = `
2024-01-01 open Assets:Bank USD
2024-01-15 * "Coffee"
  Expenses:Food  5.00 USD
  Assets:Bank   -5.00 USD
`;

const result = parse(source);
if (result.errors.length === 0) {
    const validation = validateSource(source);
    console.log('Valid:', validation.valid);

    const balances = query(source, 'BALANCES');
    console.log('Balances:', balances.rows);
}

Stateful API

Single-file: `ParsedLedger`

For multiple operations on the same source, with full editor features:

import { ParsedLedger } from '@rustledger/wasm';

const ledger = new ParsedLedger(source);

if (ledger.isValid()) {
    const balances = ledger.balances();
    const formatted = ledger.format();

    // Editor features
    const completions = ledger.getCompletions(5, 10);
    const hover = ledger.getHoverInfo(3, 5);
    const definition = ledger.getDefinition(4, 3);
}

ledger.free(); // Release WASM memory

Multi-file: `Ledger`

For ledgers spanning multiple files with include directives:

import { Ledger } from '@rustledger/wasm';

const ledger = Ledger.fromFiles({
    "main.beancount": 'include "accounts.beancount"\n2024-01-15 * "Coffee"\n  Expenses:Food  5 USD\n  Assets:Bank',
    "accounts.beancount": "2024-01-01 open Assets:Bank USD\n2024-01-01 open Expenses:Food USD"
}, "main.beancount");

if (ledger.isValid()) {
    const balances = ledger.query("BALANCES");

    // Cross-file completions (pass the file being edited)
    const completions = ledger.getCompletions(currentFileSource, line, char);
}

ledger.free();

Cargo Features

plugins (default) - Include native plugin support
completions (default) - Include BQL query completions

Building

wasm-pack build --target web crates/rustledger-wasm

License

GPL-3.0-only

rustledger-wasm 0.18.0