Beanfmt - Beancount Formatter

中文

A fast Beancount file formatter extension for Visual Studio Code, with CJK double-width character support and smart date-based sorting.

Features

• Column alignment — automatically aligns currencies and cost annotations
• CJK-aware — correctly handles double-width CJK characters for alignment
• Thousands separator — add, remove, or keep commas in numbers
• Brace spacing — control spaces inside cost braces { ... }
• Inline comment alignment — align trailing ; comments to a column
• Smart date sorting — sort entries by date (asc/desc) with time metadata intra-day ordering, timeless-entry positioning, and directive-type sort barriers
• Fast — powered by a WASM-compiled Rust core

Usage

1. Open a .bean or .beancount file
2. Format via Shift+Alt+F (or Shift+Option+F on macOS), or enable format on save:

"[beancount]": {
    "editor.defaultFormatter": "cyrus-x.beanfmt",
    "editor.formatOnSave": true
}

Settings

Note: These settings are ignored when a .beanfmt.toml or beanfmt.toml exists in the workspace — the config file is the source of truth. See the project README for the config file format.

中文

一个快速的 Beancount 文件格式化 VS Code 扩展，支持 CJK 双宽度字符对齐和智能日期排序。

功能特性

• 列对齐 — 自动对齐货币和成本标注
• CJK 感知 — 正确处理中日韩双宽度字符的对齐
• 千位分隔符 — 添加、移除或保留数字中的逗号
• 花括号空格 — 控制成本花括号内的空格 { ... }
• 行内注释对齐 — 将行尾 ; 注释对齐到指定列
• 智能日期排序 — 按日期排序条目（升序/降序），支持 time 元数据的日内排序、无时间条目定位以及按指令类型设置排序屏障
• 高性能 — 基于 Rust 编译为 WASM 的核心引擎

使用方法

1. 打开 .bean 或 .beancount 文件
2. 使用 Shift+Alt+F（macOS 上为 Shift+Option+F）格式化，或启用保存时自动格式化：

"[beancount]": {
    "editor.defaultFormatter": "cyrus-x.beanfmt",
    "editor.formatOnSave": true
}

配置项

注意： 当工作区存在 .beanfmt.toml 或 beanfmt.toml 时，以上配置项将被忽略——配置文件是唯一可信来源。配置文件格式见项目 README。

许可证

MIT