Run gulp tasks from Emacs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

113 lines
4.1 KiB

;;; gulp-task-runner.el --- Gulp task runner -*- lexical-binding: t; -*-
;; Copyright (C) 2016, 2017 Nicolas Petton
;; Author: Nicolas Petton <>
;; Keywords: convenience, javascript
;; Version: 1.0
;; Package: gulp-task-runner
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <>.
;;; Commentary:
;; Run `M-x gulp' to choose a task from the list of Gulp tasks and run it.
;;; Code:
(defvar gulp--task-cache nil
"Map gulpfile path to the list of its tasks.")
(defun gulp (&optional prefix)
"Prompt for a gulp task and run it.
With PREFIX or when called interactively with a prefix argument,
forces reload of the task list from gulpfile.js."
(interactive "P")
(when prefix
(let* ((gulpfile (or (gulp--current-gulpfile)
(gulp-bin (executable-find "gulp")))
(if gulpfile
(gulp--run-gulpfile gulpfile gulp-bin)
(warn "No gulpfile to get the tasks from"))))
(defun gulp--run-gulpfile (gulpfile gulp-bin)
"Let the user choose a task from GULPFILE and run it."
(let* ((tasks (gulp--get-tasks gulpfile gulp-bin))
(task (completing-read "Gulp task: " tasks)))
;; Use a temporary buffer to change current directory
(cd (file-name-directory gulpfile))
(let ((compilation-buffer-name-function #'gulp--get-buffer-name))
(compilation-start (format "%s %s" gulp-bin task))))))
(defun gulp--add-to-cache (gulpfile tasks)
"Add (GULPFILE TASKS) to `gulp--task-cache'."
;; because we are using alist functions, there is no need to erase
;; pairs with same key
(setq gulp--task-cache
(cons (cons gulpfile tasks)
(defun gulp--invalidate-cache (&optional gulpfile)
"Remove cached task list for GULPFILE.
If GULPFILE is nil, remove task list for `gulp--current-gulpfile'."
(let ((gulpfile (or gulpfile (gulp--current-gulpfile))))
(gulp--add-to-cache gulpfile nil)))
(defun gulp--current-gulpfile (&optional dir)
"Return path of the gulpfile from DIR or `default-directory'."
(let* ((dir (or dir default-directory))
(gulpfile (locate-dominating-file (or dir default-directory)
(when gulpfile
(expand-file-name "gulpfile.js" gulpfile))))
(defun gulp--get-tasks-from-gulp (gulp-bin)
"Ask gulp for a task list."
(process-lines gulp-bin "--tasks-simple"))
(defun gulp--get-tasks-from-cache (&optional gulpfile)
"Lookup for a task list for GULPFILE in `gulp--task-cache'.
If GULPFILE is absent, its value is takend from
(let ((gulpfile (or gulpfile (gulp--current-gulpfile))))
(cdr (assoc gulpfile gulp--task-cache))))
(defun gulp--get-gulpfiles-from-cache ()
"Return a list of all gulpfiles in `gulp--task-cache'."
(mapcar #'car gulp--task-cache))
(defun gulp--gulpfile-from-cache ()
"Let the user choose a gulpfile from the cache."
(let ((gulpfiles (gulp--get-gulpfiles-from-cache)))
(when gulpfiles
(completing-read "Choose a gulpfile: " gulpfiles))))
(defun gulp--get-tasks (gulpfile gulp-bin)
"Return a list of gulp tasks for GULPFILE.
Either use `gulp--task-cache' or run gulp to get the tasks."
(or (gulp--get-tasks-from-cache gulpfile)
(let ((tasks (gulp--get-tasks-from-gulp gulp-bin)))
(gulp--add-to-cache gulpfile tasks)
(defun gulp--get-buffer-name (&rest _)
"Return the name of a gulp task buffer."
(provide 'gulp-task-runner)
;;; gulp-task-runner.el ends here