https://github.com/functionreturnfunction/dashboard-project-status

Display the status of a git project in emacs-dashboard
https://github.com/functionreturnfunction/dashboard-project-status

dashboard emacs git

Last synced: 3 months ago
JSON representation

Display the status of a git project in emacs-dashboard

• Host: GitHub
• URL: https://github.com/functionreturnfunction/dashboard-project-status
• Owner: functionreturnfunction
• Created: 2019-01-31T19:35:25.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-02T13:54:27.000Z (almost 6 years ago)
• Last Synced: 2024-04-14T04:27:57.654Z (7 months ago)
• Topics: dashboard, emacs, git
• Language: Emacs Lisp
• Size: 135 KB
• Stars: 3
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

README

        
* dashboard-project-status [[https://travis-ci.org/functionreturnfunction/dashboard-project-status][https://travis-ci.org/functionreturnfunction/dashboard-project-status.png?branch=master]] [[https://coveralls.io/github/functionreturnfunction/dashboard-project-status][https://coveralls.io/repos/github/functionreturnfunction/dashboard-project-status/badge.svg?branch=master]] [[https://melpa.org/#/dashboard-project-status][file: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

#+begin_src emacs-lisp

(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))

#+end_src

*** Without use-package

#+begin_src emacs-lisp

;; 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)))

#+end_src

*** 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".