npm - @rustledger/wasm - Versions diffs - 0.1.0 → 0.2.0 - Mend

@rustledger/wasm 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -1,167 +1,73 @@
+<div align="center">
 # rustledger
-A pure Rust implementation of [Beancount](https://beancount.github.io/), the double-entry bookkeeping language.
+**A blazing-fast Rust implementation of [Beancount](https://beancount.github.io/)**
+Parse and validate your ledger faster than Python beancount.
 [![CI](https://github.com/rustledger/rustledger/actions/workflows/ci.yml/badge.svg)](https://github.com/rustledger/rustledger/actions/workflows/ci.yml)
-[![Crates.io](https://img.shields.io/crates/v/rustledger.svg)](https://crates.io/crates/rustledger)
-[![Documentation](https://docs.rs/rustledger/badge.svg)](https://docs.rs/rustledger)
-[![codecov](https://codecov.io/gh/rustledger/rustledger/graph/badge.svg)](https://codecov.io/gh/rustledger/rustledger)
-[![License](https://img.shields.io/crates/l/rustledger.svg)](LICENSE)
+[![GitHub Release](https://img.shields.io/github/v/release/rustledger/rustledger)](https://github.com/rustledger/rustledger/releases)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
+</div>
-[![GitHub Release](https://img.shields.io/github/v/release/rustledger/rustledger?label=release)](https://github.com/rustledger/rustledger/releases)
-[![npm](https://img.shields.io/npm/v/@rustledger/wasm?label=npm%20wasm)](https://www.npmjs.com/package/@rustledger/wasm)
-[![AUR](https://img.shields.io/aur/version/rustledger?logo=arch-linux&label=AUR)](https://aur.archlinux.org/packages/rustledger)
-[![Copr](https://copr.fedorainfracloud.org/coprs/robcohen/rustledger/package/rustledger/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/robcohen/rustledger/)
-[![Packaging status](https://repology.org/badge/tiny-repos/rustledger.svg)](https://repology.org/project/rustledger/versions)
+---
 ## Why rustledger?
-- **10x faster** than Python beancount - parse and validate large ledgers in milliseconds
-- **Pure Rust** - No Python dependencies, single binary, compiles to native and WebAssembly
-- **Drop-in replacement** - Compatible `bean-*` CLI commands for easy migration
-- **Formally verified** - Core algorithms verified with 19 TLA+ specifications
-- **Full compatibility** - Parses any valid beancount file
+| | |
+|---|---|
+| **Much faster** | Parse and validate large ledgers in milliseconds ([see benchmarks](#performance)) |
+| **Single binary** | No Python, no dependencies, just download and run |
+| **Drop-in replacement** | Compatible `bean-*` CLI commands for easy migration |
+| **Full compatibility** | Parses any valid beancount file |
+## Install
+| Platform | Command |
+|----------|---------|
+| **Script** | `curl -sSfL rustledger.github.io/i \| sh` |
+| **macOS** | `brew install rustledger/rustledger/rustledger` |
+| **Ubuntu/Debian** | `sudo add-apt-repository ppa:robcohen/rustledger && sudo apt install rustledger` |
+| **Fedora/RHEL** | `sudo dnf copr enable rustledger/rustledger && sudo dnf install rustledger` |
+| **Arch** | `yay -S rustledger-bin` |
+| **Windows** | `scoop bucket add rustledger https://github.com/rustledger/scoop-rustledger && scoop install rustledger` |
+| **Cargo** | `cargo binstall rustledger` or `cargo install rustledger` |
+| **Nix** | `nix run github:rustledger/rustledger` |
+| **Docker** | `docker run --rm -v "$PWD:/data" ghcr.io/rustledger/rustledger /data/ledger.beancount` |
+| **Binaries** | [GitHub Releases](https://github.com/rustledger/rustledger/releases) |
+| **npm** | `npm install @rustledger/wasm` (WebAssembly) |
 ## Quick Start
 ```bash
-# Install
-cargo install rustledger
-# Validate your ledger
 rledger-check ledger.beancount
-# Query your data
 rledger-query ledger.beancount "SELECT account, SUM(position) GROUP BY account"
 ```
-Example output:
-```
-$ rledger-check example.beancount
-Loaded 1,247 directives in 12ms
-✓ No errors found
-$ rledger-query example.beancount "BALANCES WHERE account ~ 'Assets:'"
-account                    balance
--------------------------  ----------------
-Assets:Bank:Checking       2,450.00 USD
-Assets:Bank:Savings       15,000.00 USD
-Assets:Investments         5,230.50 USD
-```
-## Installation
-### Quick Install (Linux/macOS)
-```bash
-curl -sSfL rustledger.github.io/i | sh
-```
-### Homebrew (macOS/Linux)
-```bash
-brew install rustledger/rustledger/rustledger
-```
-### Scoop (Windows)
-```powershell
-scoop bucket add rustledger https://github.com/rustledger/scoop-rustledger
-scoop install rustledger
-```
-### Cargo
-```bash
-# Pre-built binary (fast)
-cargo binstall rustledger
-# Build from source
-cargo install rustledger
-```
-### Nix
-```bash
-# Run directly
-nix run github:rustledger/rustledger -- rledger-check ledger.beancount
-# Install to profile
-nix profile install github:rustledger/rustledger
-```
-### Arch Linux (AUR)
-```bash
-# Pre-built binary (recommended)
-yay -S rustledger-bin
-# Or build from source
-yay -S rustledger
-```
-### Docker
-```bash
-# Validate a ledger file
-docker run --rm -v "$PWD:/data" ghcr.io/rustledger/rustledger /data/ledger.beancount
-# Run queries
-docker run --rm -v "$PWD:/data" --entrypoint rledger-query ghcr.io/rustledger/rustledger \
-  /data/ledger.beancount "SELECT account, SUM(position) GROUP BY account"
-# Use a specific version
-docker run --rm -v "$PWD:/data" ghcr.io/rustledger/rustledger:1.0.0 /data/ledger.beancount
-```
-### Pre-built Binaries
-Download from [GitHub Releases](https://github.com/rustledger/rustledger/releases) for:
-- Linux (x86_64, ARM64, glibc and musl)
-- macOS (Intel and Apple Silicon)
-- Windows (x86_64, ARM64)
-### As a Library
-```bash
-cargo add rustledger-core rustledger-parser rustledger-loader
-```
-### WebAssembly (npm)
-```bash
-npm install @rustledger/wasm
-```
-### MCP Server
-```bash
-npm install -g @rustledger/mcp-server
-```
 ## CLI Commands
 | Command | Description |
 |---------|-------------|
 | `rledger-check` | Validate ledger files with detailed error messages |
-| `rledger-format` | Auto-format beancount files |
 | `rledger-query` | Run BQL queries (interactive shell or one-shot) |
+| `rledger-format` | Auto-format beancount files |
 | `rledger-report` | Generate balance, account, and statistics reports |
-| `rledger-doctor` | Debugging tools: context, linked transactions, missing opens |
+| `rledger-doctor` | Debugging tools for ledger issues |
 | `rledger-extract` | Import transactions from CSV/OFX bank statements |
 | `rledger-price` | Fetch commodity prices from online sources |
-### Examples
+Python beancount users can also use `bean-check`, `bean-query`, etc.
+<details>
+<summary><strong>CLI examples</strong></summary>
 ```bash
 # Validate with plugins
 rledger-check --native-plugin auto_accounts ledger.beancount
-rledger-check --native-plugin pedantic ledger.beancount
-# Format in place
-rledger-format --in-place ledger.beancount
-# Interactive query shell with readline and history
+# Interactive query shell
 rledger-query ledger.beancount
 # One-shot query
@@ -169,123 +75,31 @@ rledger-query ledger.beancount "SELECT date, narration WHERE account ~ 'Expenses
 # Reports
 rledger-report ledger.beancount balances
-rledger-report ledger.beancount accounts
 rledger-report ledger.beancount stats
-# Debugging
-rledger-doctor ledger.beancount context 42        # Show context around line 42
-rledger-doctor ledger.beancount linked ^trip-2024 # Find linked transactions
-rledger-doctor ledger.beancount missing           # Find missing Open directives
-```
-### Python Beancount Compatibility
-For users migrating from Python beancount, the `bean-*` commands are also available:
-```bash
-bean-check ledger.beancount
-bean-format ledger.beancount
-bean-query ledger.beancount "SELECT ..."
-bean-report ledger.beancount balances
-bean-doctor ledger.beancount context 42
-```
-### Shell Completions
-All CLI commands support generating shell completions:
-```bash
-# Bash (add to ~/.bashrc)
-rledger-check --generate-completions bash >> ~/.bashrc
-# Zsh (add to ~/.zshrc)
-rledger-check --generate-completions zsh >> ~/.zshrc
-# Fish
-rledger-check --generate-completions fish > ~/.config/fish/completions/rledger-check.fish
-# PowerShell
-rledger-check --generate-completions powershell >> $PROFILE
-```
-Generate completions for each command you use (`rledger-check`, `rledger-query`, etc.).
-## Library Usage
-```rust
-use rustledger_loader::load;
-use std::path::Path;
-fn main() -> anyhow::Result<()> {
-    let result = load(Path::new("ledger.beancount"))?;
-    println!("Loaded {} directives", result.directives.len());
-    for error in &result.errors {
-        eprintln!("{}", error);
-    }
-    Ok(())
-}
-```
-## Importing Bank Statements
-rustledger includes an import framework for extracting transactions from CSV and OFX files:
-```rust
-use rustledger_importer::ImporterConfig;
-let config = ImporterConfig::csv()
-    .account("Assets:Bank:Checking")
-    .currency("USD")
-    .date_column("Date")
-    .narration_column("Description")
-    .amount_column("Amount")
-    .date_format("%m/%d/%Y")
-    .build();
-let result = config.extract_from_string(csv_content)?;
-for directive in result.directives {
-    println!("{}", directive);
-}
+# Format in place
+rledger-format --in-place ledger.beancount
 ```
-Supports:
-- CSV with configurable columns, delimiters, date formats
-- Separate debit/credit columns
-- OFX/QFX bank statement files
-- Currency symbols, parentheses for negatives, thousand separators
+</details>
 ## Crates
 | Crate | Description |
 |-------|-------------|
-| [`rustledger-core`](crates/rustledger-core) | Core types: Amount, Position, Inventory, Directives |
-| [`rustledger-parser`](crates/rustledger-parser) | Lexer and parser with error recovery |
-| [`rustledger-loader`](crates/rustledger-loader) | File loading, includes, options |
-| [`rustledger-booking`](crates/rustledger-booking) | Interpolation and booking engine |
-| [`rustledger-validate`](crates/rustledger-validate) | 30 validation error codes |
-| [`rustledger-query`](crates/rustledger-query) | BQL query engine |
-| [`rustledger-plugin`](crates/rustledger-plugin) | Native and WASM plugin system |
-| [`rustledger-importer`](crates/rustledger-importer) | CSV/OFX import framework |
-| [`rustledger`](crates/rustledger) | Command-line tools |
-| [`rustledger-wasm`](crates/rustledger-wasm) | WebAssembly library target |
-## Features
-### Parser
-- All 12 directive types (transaction, balance, open, close, commodity, pad, event, query, note, document, custom, price)
-- Cost specifications: `{100 USD}`, `{{100 USD}}`, `{100 # 5 USD}`, `{*}`
-- Price annotations: `@ 100 USD`, `@@ 1000 USD`
-- Arithmetic expressions: `(40.00/3 + 5) USD`
-- Multi-line strings with `"""..."""`
-- All transaction flags: `* ! P S T C U R M`
-- Metadata with 6 value types
-- Error recovery (continues parsing after errors)
-### Booking Methods
+| `rustledger` | CLI tools (rledger-check, rledger-query, etc.) |
+| `rustledger-core` | Core types: Amount, Position, Inventory |
+| `rustledger-parser` | Lexer and parser with error recovery |
+| `rustledger-loader` | File loading and includes |
+| `rustledger-booking` | Interpolation and 7 booking methods |
+| `rustledger-validate` | 26 validation error codes |
+| `rustledger-query` | BQL query engine |
+| `rustledger-plugin` | 20 built-in plugins + Python plugin support |
+| `rustledger-importer` | CSV/OFX import framework |
+| `rustledger-wasm` | WebAssembly bindings for JavaScript/TypeScript |
+<details>
+<summary><strong>Booking methods (7)</strong></summary>
 | Method | Description |
 |--------|-------------|
@@ -297,123 +111,54 @@ Supports:
 | `AVERAGE` | Average cost basis |
 | `NONE` | No cost tracking |
-### Built-in Plugins (14)
+</details>
+<details>
+<summary><strong>Built-in plugins (20)</strong></summary>
 | Plugin | Description |
 |--------|-------------|
-| `implicit_prices` | Generate price entries from transaction costs |
-| `check_commodity` | Validate commodity declarations |
 | `auto_accounts` | Auto-generate Open directives |
-| `leafonly` | Error on postings to non-leaf accounts |
-| `noduplicates` | Hash-based duplicate transaction detection |
-| `onecommodity` | Single commodity per account |
-| `unique_prices` | One price per day per commodity pair |
+| `auto_tag` | Automatically tag transactions |
+| `check_average_cost` | Validate average cost bookings |
 | `check_closing` | Zero balance assertion on account close |
+| `check_commodity` | Validate commodity declarations |
+| `check_drained` | Ensure accounts are drained before close |
 | `close_tree` | Close descendant accounts |
 | `coherent_cost` | Enforce cost OR price (not both) |
-| `sellgains` | Cross-check capital gains against sales |
+| `commodity_attr` | Validate commodity attributes |
+| `currency_accounts` | Enforce currency constraints on accounts |
+| `document_discovery` | Auto-discover document files |
+| `implicit_prices` | Generate price entries from transaction costs |
+| `leafonly` | Error on postings to non-leaf accounts |
+| `noduplicates` | Hash-based duplicate transaction detection |
+| `nounused` | Warn on unused accounts |
+| `onecommodity` | Single commodity per account |
 | `pedantic` | Enable all strict validations |
+| `sellgains` | Cross-check capital gains against sales |
+| `unique_prices` | One price per day per commodity pair |
 | `unrealized` | Calculate unrealized gains |
-| `nounused` | Warn on unused accounts |
-### Options (28 supported)
+**Python plugins**: Run existing Python beancount plugins via CPython-WASI sandbox.
-- Account prefixes (`name_assets`, `name_liabilities`, etc.)
-- Equity accounts (`account_previous_balances`, `account_unrealized_gains`, etc.)
-- Tolerance settings (`inferred_tolerance_default` with wildcards)
-- Booking method, document directories, and more
+</details>
 ## Performance
-rustledger is approximately **10x faster** than Python beancount:
-| Operation | Python beancount | rustledger | Speedup |
-|-----------|------------------|------------|---------|
-| Parse 10K transactions | ~800ms | ~80ms | 10x |
-| Full validation | ~1.2s | ~120ms | 10x |
-| BQL query | ~200ms | ~20ms | 10x |
-*Benchmarks on M1 MacBook Pro with a real-world 10,000 transaction ledger.*
-## Formal Verification
-Core algorithms are formally specified and verified using TLA+:
-- **19 TLA+ specifications** covering inventory management, booking methods, validation rules
-- **Inductive invariants** prove conservation of units across all operations
-- **Model checking** explores millions of states to find edge cases
-- **Refinement proofs** verify Rust implementation matches specifications
-```bash
-# Run all TLA+ model checks
-just tla-all
-# Check specific specification
-just tla-check Conservation
-```
-## Development
+[![Benchmark](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/rustledger/rustledger/benchmarks/.github/badges/benchmark.json)](https://github.com/rustledger/rustledger/actions/workflows/bench.yml)
-### With Nix (recommended)
-```bash
-# Enter development shell with all tools
-nix develop
-# Run tests
-cargo test --all-features
-# Run lints
-cargo clippy --all-features
-# Format code
-cargo fmt
-```
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/rustledger/rustledger/benchmarks/.github/badges/benchmark-chart.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/rustledger/rustledger/benchmarks/.github/badges/benchmark-chart.svg">
+  <img alt="Benchmark Chart" src="https://raw.githubusercontent.com/rustledger/rustledger/benchmarks/.github/badges/benchmark-chart.png" width="100%">
+</picture>
-### Without Nix
-```bash
-# Install Rust
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-# Clone and build
-git clone https://github.com/rustledger/rustledger
-cd rustledger
-cargo build --release
-```
-### Running Tests
-```bash
-# All tests
-cargo test --all-features
-# Specific crate
-cargo test -p rustledger-parser
-# With coverage
-cargo llvm-cov --all-features
-```
-## Compatibility
-rustledger is fully compatible with Python beancount. It can parse and validate any valid beancount file. The `bean-*` command aliases are included by default for easy migration.
-Known differences:
-- Some edge cases in expression evaluation may differ slightly
-- Plugin system uses native Rust or WASM (Python plugins not supported)
-## License
-This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+<sub>Benchmarks run nightly on identical 10K transaction ledgers. [View workflow →](https://github.com/rustledger/rustledger/actions/workflows/bench.yml)</sub>
 ## Contributing
-Contributions are welcome! Please feel free to submit a Pull Request.
+See [CLAUDE.md](CLAUDE.md) for architecture and development setup.
-Before submitting:
-1. Run `cargo test --all-features`
-2. Run `cargo clippy --all-features`
-3. Run `cargo fmt`
+## License
-See [CLAUDE.md](CLAUDE.md) for code standards and architecture overview.
+[GPL-3.0](LICENSE)

package/package.json CHANGED Viewed

@@ -5,7 +5,7 @@
     "Rustledger Contributors"
   ],
   "description": "Beancount WebAssembly bindings for JavaScript/TypeScript",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "GPL-3.0-only",
   "repository": {
     "type": "git",

package/rustledger_wasm_bg.wasm CHANGED Viewed

Binary file