Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/licht1stein/repo-hydra.el
Easily define repo-specific Emacs hydras
https://github.com/licht1stein/repo-hydra.el
emacs
Last synced: 8 days ago
JSON representation
Easily define repo-specific Emacs hydras
- Host: GitHub
- URL: https://github.com/licht1stein/repo-hydra.el
- Owner: licht1stein
- License: gpl-3.0
- Created: 2023-05-06T09:44:34.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-23T09:59:58.000Z (7 months ago)
- Last Synced: 2024-04-23T13:33:22.024Z (7 months ago)
- Topics: emacs
- Language: Emacs Lisp
- Homepage:
- Size: 2.03 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# repo-hydra.el
Easily create repo-specific menus for Emacs. There is also a transient based version of this library [repo-transient.el](https://github.com/licht1stein/repo-transient.el)
This library was inspired by an amazingly instructive [interview](https://www.youtube.com/watch?v=2nH59edD5Uo) by Juan Monetta ([@jpmonettas](https://github.com/jpmonettas)), he also wrote the main macro which I only slightly changed and turned into a library.
## Examples
### Normal repo hydra
This is an example repo-hydra for this repository. Note, that the first argument to `repo-hydra-define` has to exactly match the root directory name of the git repo (case sensitive).
```elisp
(repo-hydra-define
"repo-hydra.el"
("i" text-scale-increase "In")
("o" text-scale-decrease "Out"))
```
If `repo-hydra-show` is called from within the `repo-hydra.el` repository, the hydra will show:
### Clojure repo hydra
I have kept the original logic of the Clojure macro in `repo-hydra-define-clj`, it automatically evaluates the clojure code in strings with the current CIDER REPL:
```elisp
(repo-hydra-define-clj
"sanskrit"
("c" sanskrit-cider-connect "Connect REPL" (cider-connect-clj '(:host "localhost" :port 33000)))
("p" sanskrit-portal "Portal" "(user/portal)")
("P" sanskrit-clear-portal "Clear Portal" "(user/clear-portal)")
("S" sanskrit-require-snitch "Require snitch" "(require '[snitch.core :refer [defn* defmethod* *fn *let]])"))
```
## Install
### Using use-package and straight
```elisp
(use-package repo-hydra
:straight (:type git :host github :repo "licht1stein/repo-hydra.el")
:bind ("" . repo-hydra-show))
```
## Versioning
This library uses [break versioning](https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md), this means that upgrading from 1.0.x to 1.0.whatever is always non-breaking, upgrading to 1.1.x might break something small, and upgrading to 2.x.x will break something big.