search

ice9js / ace-jump-sublime

Jump between characters in Sublime Text 3 without using a mouse at ease
MIT License
202 stars 30 forks source link

readme

AceJump

A plugin for Sublime Text 3 heavily inspired by AceJump for emacs.

AceJump allows you to move the cursor to any character to any place currently on screen. To clarify, you can jump between characters in all visible portions of currently open documents in any panes. Like it's emacs counterpart, AceJump for sublime features word (on the image below), character and line modes which make jumping even easier.

AceJump

After selecting a mode, you type in a character (except in line mode, where you don't have to type in anything) and appropriate labels are displayed. Then all you need to do is press the key from the label and voila!

Installation

PackageControl

You can install AceJump from PackageControl by following the steps below:

Manual installation

You can install AceJump manually using git by running the following command within sublime packages directory (Preferences > Browse Packages):

$ git clone git@github.com:ice9js/ace-jump-sublime.git AceJump/

Or you can just copy the contents of this repository into Packages/AceJump.

Usage

Word mode

Goes to a word starting with the given character. This mode works only with alphanumeric characters. If you're interested in jumping to a special character, use character mode instead.

No need to press enter after selecting a label!

Word mode

Character mode

Goes to an occurence of the given character.

Character mode

Line mode

Labels all non-empty lines and lets you jump to one of them.

Line mode

Within Line mode

Labels all words within the line where current cursor locate and lets you jump to one of them.

Select mode

After triggering select mode, the next jump will select everything inbetween the current cursor position and the selected label. When select mode is triggered, the next jump is limited to the current file.

Select mode

Multiple cursors mode

After triggering multiple cursors mode, the next jump will add a new cursor to the view instead of moving the existing one. Again, when this mode is triggered, only jumps in the same file are available.

Multiple cursors mode

Jump-after mode

In this mode, the cursor will jump behind the targeted instance. Unfortunetely, this mode cannot be paired with select or multiple cursors mode yet.

Jump-after mode

Batching

In case there are more places to jump to than labels available, labels will be batched and you can cycle through them by simply pressing enter.

Batching

Customization

In order to access AceJump settings, go to Preferences > Package Settings > AceJump > Settings - User.

Key bindings

Go to Preferences > Package Settings > AceJump > Key Bindings - User. You can then override the bindings for any of the following commands:

The commands accept an optional Boolean current_buffer_only argument. When present and set to true, AceJump only performs on the currently edited buffer.

Labels

You can override the labels setting to provide your own set of labels to be used by AceJump.

Highlighting

You can also set the syntsx scope that's used for highlighting by overriding labels_scope. The default scope is invalid.

Case sensitivity

Ace jump is case sensitive by default. Case sensitivity can be toggled on and off by altering the search_case_sensitivity setting.

Jumping behind the last character in a line

By setting jump_behind_last_characters to true, AceJump will jump behind a character if it's the last character on a line, without the need to trigger jump after mode. This only works in character mode and is switched off by default.

Known issues

It has been reported that the Select mode, Multi cursors mode and Jump after mode might not work using the specified keybinding.
As a workaround for that follow these steps: