🔧 Advanced Usage

Eask is just a regular Emacs Lisp file and should be read from Emacs itself! You can do:

; Regular Eask file content...

(setq byte-compile-error-on-warn t)  ; Signal error if warning occurred

🪝 Hooks

eask provides some hooks which enable you to execute code before and after each command. The hooks look like so:

For example, to consider warnings as errors when byte-compiling with the command eask compile:

(add-hook 'eask-before-compile-hook
          (lambda () (setq byte-compile-error-on-warn t)))

This is also equivalent to option --strict:

$ eask compile [FILES..] --strict

Or hooks that run on every command:

(add-hook 'eask-before-command-hook
           (lambda ()
             (message "%s" (eask-command))))  ; print the current command

For subcommands that contain spaces, will concatenate with /:

$ eask lint checkdoc     # lint/checkdoc
$ eask generate license  # generate/license

therefore,

(add-hook 'eask-before-lint/checkdoc-hook
           (lambda ()
             ;; do stuff before checkdoc linting...
             ))

You can add your own command through our command interface:

(eask-defcommand my-test-command
  "A test command that prints out useless message."
  (message "This is a test command!"))