binky-mode

Jump between points like a rabbit !

This package provides commands to jump between points in buffers and files. Marked position, last jump position and recent buffers are all supported in same mechanism like point-to-register but with an enhanced experience.

Table of Contents

binky-mode
- Screenshot
- Install
  - dependencies
  - package
- Usage
- Customization
- Feature
- Comparison
- Todo
- FAQ
- License

Screenshot

Call M-x binky-* related command

? for toggle preview mannually, q or escape for quit

Call M-x binky-margin-mdoe

Or use mark as indicator, (setq binky-margin-string nil)

Install

dependencies

emacs, version >= 26.3
cl-lib

package

Manually

Clone and add to load-path, require the package.

Melpa

This package is available on MELPA. Install with M-x package-install RET binky-mode from within Emacs.

Usage

;; Directly
(require 'binky-mode)
(binky-mode)
(binky-margin-mode)

;; Or with `use-package`, etc
(use-package binky-mode
  :hook (after-init-hook . (lambda () (binky-mode) (binky-margin-mode))))

binky-add : add current positon to records
binky-delete : delete existed position from records
binky-jump : jump to position of records
binky-view : view the position of records in other window
binky-margin-mode : toggle to enable or disable margin indicator feature
binky-auto-toggle : toggle to enable or disable auto-mark feature
binky-binky : one command to rule all. e.g:
- press j, if record j exists, call binky-jump, otherwise call binky-add.
- press J, call binky-delete.
- press ctrl-j, view the record j in other window without jumping.
With C-u prefix, keep editing untill quit

Customization

Lots of options are provided, see customization part in file.

Feature

Better UI experience than register-to-point, such as preview customization, jump highlight and margin indicator
Integration with buffers switch, and more sorting strategies are provided now and in future
Vim-like mark and jump style.

Comparison

Dogears
- Bookmark style record
- More infomations: relevance, within, directory, etc
Binky-mode
- Register style record
- Vim-like mark and jump
- Flexible and customizable

I have used dogears for several months, and it's great in most features except so many information I don't need. A better and Vim-marks style jumping system is the top priority for me. While evil is too heavy, so I wrote binky-mode to imitate parts of features.

Enjoy it.

Todo

Avoid adding duplicated records
Margin indicator support
Fringe indicator support
More sorting strategy: frecency, duration
Add command to store records cross sessions
Add command to cycle sorting startegy in preview
Add option to show same buffer records first in preview

FAQ

binky-margin-mode conflicts with other packages like flycheck, diff-hl, linum-mode(built-in), etc ?

binky-margin-mode supports only margin for now, so solutions here :

Use fringe in other packages

;; flycheck
;; Use left-fringe or right-fringe
 (setq flycheck-indication-mode 'left-fringe)

;; diff-hl
;; use fringe by default, don't turn on diff-hl-margin-mode

;; linum-mode
;; don't support fringe, use display-line-numbers-mode (since 26.0.50) instead

Use different side of margin in other packages

(setq binky-margin-side 'left)

;; flycheck, different margin side
(setq flycheck-indication-mode 'right-margin)

;; diff-hl, different margin side
(setq diff-hl-side 'right)
(diff-hl-margin-mode)

All records position change to 1 after run format-all-buffer command ?

format-all formats buffer by overwriting it's entire content, all markers position would be change to position 1. Please use other formatters like apheleia instead.

License

See LICENSE.

zenspider/binky-mode