isabella232 / cider-hydra Goto Github PK

Hydras for CIDER.

This package defines some hydras (pop-up menus of commands with common prefixes) for CIDER.

Hydras serve several important purposes: discovery, memorization, and organization.

• Discovery

  • Grouping related commands together under a common prefix and displaying them in a single menu facilitates discovery.

  • For example, if a user wants to know about CIDER's documentation commands, they could bring up a hydra that includes commands like cider-doc', cider-javadoc', etc, some of which may be new to them.

• Memorization

  • Hydras serve as a memory aid for the user. By grouping related commands together, the user has less need to memorize every command; knowing one, she can find the others.

• Organization

  • The process of creating hydras can aid in organizing code. This gives both developers and users a better overview of what the project can or cannot do.

  • Thus, each hydra is like a section of a quick-reference card. In fact, many of the hydras here are inspired by the CIDER refcard: https://github.com/clojure-emacs/cider/blob/master/doc/cider-refcard.pdf

After setting up MELPA as a repository, use M-x package-install cider-hydra to install the package.

Add the following to your init file:

(add-hook 'clojure-mode-hook #'cider-hydra-mode)

To turn hydras off, just disable the cider-hydra-mode, which will restore the previous CIDER commands.

• The which-key package, which displays keys following for a prefix key.