Variable: use-package-ensure-function

use-package-ensure-function is a customizable variable defined in use-package-ensure.el.gz.

Value

use-package-ensure-elpa

Documentation

Function that ensures a package is installed.

This function is called with three arguments: the name of the package declared in the use-package form; the arguments passed to all :ensure keywords (always a list, even if only one); and the current state plist created by previous handlers.

Note that this function is called whenever :ensure is provided, even if it is nil. It is up to the function to decide on the semantics of the various values for :ensure.

This function should return non-nil if the package is installed.

The default value uses package.el to install the package.

Source Code

;; Defined in /usr/src/emacs/lisp/use-package/use-package-ensure.el.gz
(defcustom use-package-ensure-function 'use-package-ensure-elpa
  "Function that ensures a package is installed.
This function is called with three arguments: the name of the
package declared in the `use-package' form; the arguments passed
to all `:ensure' keywords (always a list, even if only one); and
the current `state' plist created by previous handlers.

Note that this function is called whenever `:ensure' is provided,
even if it is nil.  It is up to the function to decide on the
semantics of the various values for `:ensure'.

This function should return non-nil if the package is installed.

The default value uses package.el to install the package."
  :type '(choice (const :tag "package.el" use-package-ensure-elpa)
                 (function :tag "Custom"))
  :group 'use-package-ensure)