Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quelpa/quelpa-use-package
Emacs quelpa handler for use-package
https://github.com/quelpa/quelpa-use-package
emacs package-manager quelpa use-package
Last synced: 3 months ago
JSON representation
Emacs quelpa handler for use-package
- Host: GitHub
- URL: https://github.com/quelpa/quelpa-use-package
- Owner: quelpa
- License: gpl-3.0
- Created: 2015-07-31T19:51:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-08-22T18:20:44.000Z (over 2 years ago)
- Last Synced: 2024-02-17T07:36:24.066Z (about 1 year ago)
- Topics: emacs, package-manager, quelpa, use-package
- Language: Emacs Lisp
- Homepage:
- Size: 43 KB
- Stars: 130
- Watchers: 10
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# quelpa-use-package
[](https://travis-ci.org/quelpa/quelpa-use-package)
[](https://melpa.org/#/quelpa-use-package)
[](https://stable.melpa.org/#/quelpa-use-package)
If you are using [use-package](https://github.com/jwiegley/use-package) (which can help to simplify your .emacs) you can use the [quelpa](https://github.com/quelpa/quelpa) handler provided by `quelpa-use-package`.
## Installation
**Requirements**: Emacs 25.1
Assuming you have bootstrapped `quelpa`, install `quelpa-use-package` (which installs `use-package` as a dependency) and require the library:
```cl
(quelpa
'(quelpa-use-package
:fetcher git
:url "https://github.com/quelpa/quelpa-use-package.git"))
(require 'quelpa-use-package)
```
## Usage
After that it is possible to call `use-package` with the `:quelpa` keyword:
```cl
;; installs abc-mode with quelpa
(use-package abc-mode :quelpa)
;; does the same (`t' is optional)
(use-package abc-mode :quelpa t)
;; again... (if the package would have another name)
(use-package abc-mode :quelpa abc-mode)
;; passes upgrade parameter to quelpa
(use-package abc-mode :quelpa (:upgrade t))
;; uses the given recipe
(use-package abc-mode
:quelpa (abc-mode :fetcher github :repo "mkjunker/abc-mode"))
;; recipe with plist arguments
(use-package abc-mode
:quelpa ((abc-mode :fetcher github :repo "mkjunker/abc-mode") :upgrade t))
```
The `quelpa` handler is compatible with [MELPA's recipe format](https://github.com/melpa/melpa#recipe-format). You may want to check the optional properties not mentioned above.
### Using quelpa with `:ensure`
To make `:ensure t` use `quelpa` instead of `package.el` set the `use-package-ensure-function` in your init file:
```cl
(setq use-package-ensure-function 'quelpa)
```
After that:
```cl
(use-package abc-mode :ensure t)
```
will install `abc-mode` with `quelpa`.
And if you enable `use-package-always-ensure`:
``` cl
(setq use-package-always-ensure t)
```
then
``` cl
(use-package abc-mode)
```
will install `abc-mode` with `quelpa`.
### Conditional execution
Note that the `:quelpa` keyword is inserted after `:if`, `:when`, `:unless` and `:requires` so that you can make the installation of a package depend on some requirement, for example:
```cl
(use-package magit-filenotify
:when (fboundp 'file-notify-add-watch)
:quelpa (magit-filenotify :fetcher github :repo "magit/magit-filenotify")
```
In this case `magit-filenotify` is only installed if the function `file-notify-add-watch` is bound.
Likewise you can use `:requires` to make the installation depend on a feature being available:
```cl
(use-package magit-filenotify
:requires filenotify
:quelpa (magit-filenotify :fetcher github :repo "magit/magit-filenotify"))
```
### Overriding `use-package-always-ensure`
To install some packages with quelpa but use `use-package-always-ensure` to install all others from an ELPA repo `:ensure` needs to be disabled if the `:quelpa` keyword is found.
`quelpa-use-package` provides an advice for this purpose which can be activated thus:
```cl
(quelpa-use-package-activate-advice)
```
To disable it again you can use:
```cl
(quelpa-use-package-deactivate-advice)
```