VaultBranch

by 李昌荣
5
4
3
2
1
Score: 50/100

Description

Reviews

No reviews yet.

Stats

1
stars
177
downloads
0
forks
9
days
1
days
1
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
87
commits

Latest Version

a day ago

Changelog

VaultBranch 1.0.10 — padded dates, resizable history columns and commit hash copying.

  • Standardize graph dates as YYYY/MM/DD, with padded month/day. File history uses YYYY/MM/DD HH:mm:ss in local time.
  • Resize Commit message, Date, Author and Commit columns by dragging header separators. Remember widths; support arrow keys, double-click/Home reset and horizontal scrolling in narrow panes.
  • Click a short commit ID to copy its full hash without selecting or opening that commit. Preserve keyboard row selection and avoid nested buttons or duplicate hints.
  • Update CSS during drags, then save once on release. Four native drag checks confirm no Git history/detail reads, no row replacements and no settings writes during pointer movement.

Local Windows / Obsidian 1.15.1; ms, median:

Measurement ms Samples
Plugin reload (warm cache) 12.2 5
Click → Staged / Changed page ready 214.8 / 159.2 20 each
Changed 1.6 MB JSON: type / Enter / Backspace 4.8 / 8.5 / 1.1 5 each
Changed 1.28 MB Markdown: type / Enter / Backspace 6.5 / 5.1 / 6.4 5 each

First sidebar: 204.9 ms; first diff: 140.0 ms, separately from plugin loading. Warm caches. CPU sampling/logging on for switching and off for typing; highlighting, autosave and table compatibility off. No speedup or physical-paint claim.

Validated in one full release-check run: 160 automated tests, 1012 UI assertions and both builds' three performance probes. Final sessions, pending reads, runtime and console errors: zero.

Version/tag: 1.0.10. Baseline: 1.0.9 / f7c46a4437368afb36754177ef87dba8be160af0. Tested source: 84b6f394273b28ab07a58ff44be8cd793610485d. Compare 1.0.9...1.0.10.

Performance report and reproduction · Raw samples. The tag workflow appends the exact release commit.

Release assets retain GitHub provenance attestations. Desktop only; requires Git installed separately.

Release tag: 1.0.10

Release commit: f06938d46e6bdda766dfd03de66b9a5aca5a719a

README file from

Github

VaultBranch

English | 简体中文

Git source control inside Obsidian. Desktop only; requires Git and a vault initialized as a Git repository.

Features

  • Git sidebar: browse changes, stage files or folders, commit, pull and push; choose a remote/upstream on first Push.
  • Editable diffs: compare versions side by side, edit changes and restore individual blocks; manual save or optional autosave.
  • Image comparisons: compare images in Changes, Staged and file history; zoom and pan. SVG defaults to preview with a source switch.
  • Commit graph and file history: explore branches, merges and past changes, including file renames; resize graph columns and click commit IDs to copy. Dates use YYYY/MM/DD.
  • Branches and Stash: create or switch branches, save changes, Apply or Pop a selected stash, and confirm before Drop.
  • Conflict resolution: native two-pane comparison with an editable local result; accept either side or both per conflict, undo choices and swap pane order, then save and stage explicitly.
  • Editor options: diff folding and navigation, optional JSON/Markdown syntax highlighting, date insertion and Chinese/English UI.
  • Note tables: optionally render tables without a preceding blank line in Reading view and Live Preview, with native table source styles.

Installation

Install Git and initialize your vault as a Git repository (git init in the vault folder). Git authentication and commit identity use your local Git configuration.

  • BRAT: add crli-idea/VaultBranch in BRAT, then enable VaultBranch under Settings → Community plugins.
  • Manual: download main.js, manifest.json and styles.css from the latest release. Put all three in <vault>/.obsidian/plugins/vaultbranch/, reload Obsidian, and enable VaultBranch.

Basic usage

Open VaultBranch: Open Source Control sidebar from the command palette. Click a Changed file to compare and edit it; save with Ctrl/Cmd+S. Use + to stage a file or folder, enter a commit message, and commit the staged changes. Pull/Push synchronize with your configured remote; first Push lets you choose the remote and upstream. Open Git Graph to browse commits, or right-click a file for File history.

Text settings apply with Enter or on blur; normalized numeric fields show the value actually used.

Capabilities

Desktop only. The plugin uses Node.js filesystem access for repository files and Git metadata, including linked-worktree metadata outside the vault. It runs your installed Git through execFile with argument arrays and shell: false; Git hooks and credential helpers follow your local Git configuration. These capabilities run with Obsidian's OS permissions. It writes commit hashes or diagnostic logs to the clipboard only when you request Copy; it does not read the clipboard. Release assets receive GitHub provenance attestations, which verify build origin rather than remove these capability warnings.

Current performance · 1.0.12

Local Windows / Obsidian 1.15.1, compared with 1.0.11. Medians in ms; this UI correctness release makes no speedup claim.

Measurement ms Samples
Plugin reload (warm cache) 9.3 5
Click → Staged / Changed page ready 148.5 / 110.4 20 each
Changed 1.6 MB JSON: type / Enter / Backspace 4.8 / 5.5 / 1.4 5 each
Changed 1.28 MB Markdown: type / Enter / Backspace 5.2 / 4.6 / 4.5 5 each

Table compatibility defaults off. Switching includes CPU sampling; typing measures native input to document update. Environment, ranges, comparison and reproduction · Tag 1.0.12.

Feedback

Bug reports and feature requests are welcome! Open an issue.