Variable: use-package-keywords

use-package-keywords is a customizable variable defined in use-package-core.el.gz.

Value

(:pin :ensure :disabled :load-path :requires :defines :functions
      :preface :if :when :unless :vc :no-require :catch :after :custom
      :custom-face :bind :bind* :bind-keymap :bind-keymap*
      :interpreter :mode :magic :magic-fallback :hook :commands
      :autoload :init :defer :demand :load :config :diminish :delight
      :ensure-system-package)

Documentation

The set of valid keywords, in the order they are processed in.

The order of this list is *very important*, so it is only advisable to insert new keywords, never to delete or reorder them. Further, attention should be paid to the NEWS.md if the default order ever changes, as they may have subtle effects on the semantics of use-package declarations and may necessitate changing where you had inserted a new keyword earlier.

Note that :disabled is special in this list, as it causes nothing at all to happen, even if the rest of the use-package declaration is incorrect.

This variable was added, or its default value changed, in Emacs 31.1.

Source Code

;; Defined in /usr/src/emacs/lisp/use-package/use-package-core.el.gz
(defcustom use-package-keywords
  '(:pin
    :ensure
    :disabled
    :load-path
    :requires
    :defines
    :functions
    :preface
    :if :when :unless
    :vc
    :no-require
    :catch
    :after
    :custom
    :custom-face
    :bind
    :bind*
    :bind-keymap
    :bind-keymap*
    :interpreter
    :mode
    :magic
    :magic-fallback
    :hook
    ;; Any other keyword that also declares commands to be autoloaded (such as
    ;; :bind) must appear before this keyword.
    :commands
    :autoload
    :init
    :defer
    :demand
    :load
    ;; This must occur almost last; the only forms which should appear after
    ;; are those that must happen directly after the config forms.
    :config
    :diminish
    :delight)
  "The set of valid keywords, in the order they are processed in.
The order of this list is *very important*, so it is only
advisable to insert new keywords, never to delete or reorder
them.  Further, attention should be paid to the NEWS.md if the
default order ever changes, as they may have subtle effects on
the semantics of `use-package' declarations and may necessitate
changing where you had inserted a new keyword earlier.

Note that `:disabled' is special in this list, as it causes
nothing at all to happen, even if the rest of the `use-package'
declaration is incorrect."
  :type '(repeat symbol)
  :group 'use-package
  :version "31.1")