/dashboard-project-status

Display the status of a git project in emacs-dashboard

Primary LanguageEmacs Lisp

dashboard-project-status https://travis-ci.org/functionreturnfunction/dashboard-project-status.png?branch=master https://coveralls.io/repos/github/functionreturnfunction/dashboard-project-status/badge.svg?branch=master https://melpa.org/packages/dashboard-project-status-badge.svg

Display a git project’s status in a dashboard widget.

If magit is installed, a link to the project in magit will be provided as well.

Screenshot

./screenshot.png

Installation / Usage

use-package

(use-package dashboard
  :config
  (use-package dashboard-project-status
   :config
    (add-to-list 'dashboard-item-generators
                 `(project-status . ,(dashboard-project-status *your directory*)))
    (add-to-list 'dashboard-items '(project-status) t)
    (setq dashboard-items '((project-status . 10)
                            (recents        . 10)
                            (agenda         . 10))))
  (dashboard-setup-startup-hook))

Without use-package

;; some time before calling `dashboard-setup-startup-hook':
(reqiure 'dashboard-project-status)
(add-to-list 'dashboard-item-generators
  `(project-status . ,(dashboard-project-status *your directory*)))
(add-to-list 'dashboard-items '(project-status) t)
(setq dashboard-items '((project-status . 10)
                        (recents        . 10)
                        (agenda         . 10)))

Auto-Refresh Project

Setting the optional second argument UPDATE for `dashboard-insert-project-status’ anything non-nil will cause the project to be refreshed automatically using “git remote update”.