Coder Social home page Coder Social logo

avy's Introduction

MELPA MELPA Stable

Introduction

avy is a GNU Emacs package for jumping to visible text using a char-based decision tree. See also ace-jump-mode and vim-easymotion - avy uses the same idea.

logo

Command overview

You can bind some of these useful commands in your config.

avy-goto-char

Input one char, jump to it with a tree.

(global-set-key (kbd "C-:") 'avy-goto-char)

After C-: b:

avy-goto-char

avy-goto-char-2

Input two consecutive chars, jump to the first one with a tree.

The advantage over the previous one is less candidates for the tree search. And it's not too inconvenient to enter two consecutive chars instead of one.

(global-set-key (kbd "C-'") 'avy-goto-char-2)

After C-' bu:

avy-goto-char-2

avy-goto-char-timer

Input an arbitrary amount of consecutive chars, jump to the first one with a tree.

This is a more flexible version of avy-goto-char-2. First part works similarly to isearch: you type a query and it's highlighted dynamically on the screen. When you stop typing for avy-timeout-seconds (0.5s by default), you'll be able to select one of the candidates with avy. As you're inputting characters, you can use C-h (backspace) or DEL (delete) to forget the last typed character and RET to end the input sequence immediately and select a candidate.

avy-goto-line

Input zero chars, jump to a line start with a tree.

(global-set-key (kbd "M-g f") 'avy-goto-line)

After M-g f:

avy-goto-line

You can actually replace the M-g g binding of goto-line, since if you enter a digit for avy-goto-line, it will switch to goto-line with that digit already entered.

avy-goto-word-1

Input one char at word start, jump to a word start with a tree.

(global-set-key (kbd "M-g w") 'avy-goto-word-1)

After M-g wb:

avy-goto-word-1

avy-goto-word-0

Input zero chars, jump to a word start with a tree.

Compared to avy-goto-word-1, there are a lot more candidates. But at a least there's not need to input the initial char.

(global-set-key (kbd "M-g e") 'avy-goto-word-0)

After M-g e:

avy-goto-word-0

Org-mode commands

  • avy-org-goto-heading-timer: Type part of an Org heading. When you stop typing, if only one heading on the screen matches, it will be jumped to; if more than one matches, you can jump to a heading with Avy. This is like avy-goto-char-timer but for Org headings.
  • avy-org-refile-as-child: With point in an entry you want to refile, run this command, select a heading with Avy, and the entry will be refiled as its first child heading. This makes it quick and easy to refile to headings that are visible on-screen, even to other windows or buffers.

Other commands

There are some more commands which you can explore yourself by looking at the code.

Bindings

You add this to your config to bind some stuff:

(avy-setup-default)
(global-set-key (kbd "C-c C-j") 'avy-resume)

It will bind, for example, avy-isearch to C-' in isearch-mode-map, so that you can select one of the currently visible isearch candidates using avy.

Customization

See the comprehensive custom variable list on the defcustom wiki page.

See how to write your own avy commands on the custom-commands wiki page.

Contributing

Copyright Assignment

Avy is subject to the same copyright assignment policy as Emacs itself, org-mode, CEDET and other packages in GNU ELPA. Any legally significant contributions can only be accepted after the author has completed their paperwork. Please see the request form if you want to proceed.

The copyright assignment isn't a big deal, it just says that the copyright for your submitted changes to Emacs belongs to the FSF. This assignment works for all projects related to Emacs. To obtain it, you need to send one email, then send one letter (if you live in the US, it's digital), and wait for some time (in my case, I had to wait for one month).

Style

The basic code style guide is to use (setq indent-tabs-mode nil). It is provided for you in .dir-locals.el, please obey it.

Before submitting the change, run make compile and make test to make sure that it doesn't introduce new compile warnings or test failures. Also run make checkdoc to see that your changes obey the documentation guidelines.

Use your own judgment for the commit messages, I recommend a verbose style using magit-commit-add-log.

avy's People

Contributors

abo-abo avatar aethanyc avatar alphapapa avatar bbatsov avatar choppinblockparty avatar cute-jumper avatar duianto avatar dvzubarev avatar fabacino avatar jiangbinzhao avatar justbur avatar ketanaka avatar madand avatar magicdirac avatar marktriggs avatar markus1189 avatar momomo5717 avatar nloyola avatar pengux avatar quicknir avatar rswgnu avatar tprk77 avatar tsdh avatar vermiculus avatar walseb avatar whatacold avatar yanghaoxie avatar yangzhao11 avatar yashi avatar yorkz avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.