Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nickserv/add-hooks
Emacs function for setting multiple hooks.
https://github.com/nickserv/add-hooks
emacs emacs-lisp emacs-packages
Last synced: 4 months ago
JSON representation
Emacs function for setting multiple hooks.
- Host: GitHub
- URL: https://github.com/nickserv/add-hooks
- Owner: nickserv
- License: gpl-3.0
- Created: 2017-04-06T22:42:34.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-17T01:24:06.000Z (about 7 years ago)
- Last Synced: 2024-10-07T19:03:26.363Z (4 months ago)
- Topics: emacs, emacs-lisp, emacs-packages
- Language: Emacs Lisp
- Homepage:
- Size: 47.9 KB
- Stars: 16
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `add-hooks`
[](https://travis-ci.org/nickmccurdy/add-hooks)
[](https://melpa.org/#/add-hooks)
[](https://stable.melpa.org/#/add-hooks)
Emacs functions for setting multiple hooks.
Typically, you would need to call `add-hook` multiple times with
similar arguments to declare multiple functions for one hook, or
vice versa. `add-hooks-pair` is a variant that takes multiple
hooks or functions that apply to each other. The `add-hooks`
function tidies up duplicate hook and function names further into a
single declarative call (inspired by the
[`bind-key`](https://github.com/jwiegley/use-package/blob/master/bind-key.el)
package).
If you're using [`use-package`](https://github.com/jwiegley/use-package), use its [`:hook`](https://github.com/jwiegley/use-package#hooks) keyword instead, which has a
similar syntax while establishing autoload definitions and supporting
deferred loading.
## Documentation
### `(add-hooks-pair HOOKS FUNCTIONS)`
Call `add-hook` for each combined pair of items in *HOOKS* and *FUNCTIONS*.
*HOOKS* can be a symbol or a list of symbols representing hook
variables (the `-hook` suffix is implied). *FUNCTIONS* can be a
symbol, a lambda, or a list of either representing hook
functions. If lists are used, a function can be added to
multiple hooks and/or multiple functions can be added to a hook.
#### Example
```emacs
ELISP> (add-hooks-pair '(css-mode sgml-mode) 'emmet-mode)
nil
ELISP> css-mode-hook
(emmet-mode)
ELISP> sgml-mode-hook
(emmet-mode)
```
### `(add-hooks PAIRS)`
Call `add-hooks-pair` on each cons pair in *PAIRS*.
Each pair has a `car` for setting hooks and a `cdr` for setting
functions to add to those hooks. Pair values are passed to the
*HOOKS* and *FUNCTIONS* arguments of `add-hooks-pair`, respectively.
#### Usage
```emacs
(add-hooks ((HOOKS . FUNCTIONS)...))
```
#### Example
```emacs
ELISP> (add-hooks '(((css-mode sgml-mode) . emmet-mode)))
nil
ELISP> css-mode-hook
(emmet-mode)
ELISP> sgml-mode-hook
(emmet-mode)
```