https://github.com/clojure-emacs/cider-hydra

Hydras for CIDER
https://github.com/clojure-emacs/cider-hydra

Last synced: 3 months ago
JSON representation

Hydras for CIDER

• Host: GitHub
• URL: https://github.com/clojure-emacs/cider-hydra
• Owner: clojure-emacs
• Created: 2016-02-11T10:32:34.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-02-13T16:40:51.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T01:26:16.977Z (6 months ago)
• Language: Emacs Lisp
• Size: 5.86 KB
• Stars: 24
• Watchers: 4
• Forks: 11
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[Hydras](https://github.com/abo-abo/hydra) for [CIDER](https://github.com/clojure-emacs/cider).

## Overview

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

## Install

After setting up [MELPA](http://melpa.org/) as a repository, use `M-x package-install cider-hydra` to install the package.

## Setup

Add the following to your init file:

```emacs-lisp

(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.

## See Also

- The [which-key](https://github.com/justbur/emacs-which-key) package, which

  displays keys following for a prefix key.