Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
153 lines (121 sloc) 4.98 KB
;;; git-auto-commit-mode.el --- Emacs Minor mode to automatically commit and push
;; Copyright (C) 2012, 2013, 2014, 2015 Tom Willemse <>
;; Author: Tom Willemse <>
;; Created: Jan 9, 2012
;; Version: 4.4.0
;; Keywords: vc
;; URL:
;; This file 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 file 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 file; If not, see <>.
;;; Commentary:
;; git-auto-commit-mode is an Emacs minor mode that tries to commit
;; changes to a file after every save.
;; When `gac-automatically-push-p' is non-nil, it also tries to push
;; to the current upstream.
;;; Code:
(defgroup git-auto-commit-mode nil
"Customization options for `git-auto-commit-mode'."
:group 'external)
(defcustom gac-automatically-push-p nil
"Automatically push after each commit.
If non-nil a git push will be executed after each commit."
:tag "Automatically push"
:group 'git-auto-commit-mode
:type 'boolean
:risky t)
(make-variable-buffer-local 'gac-automatically-push-p)
(defcustom gac-ask-for-summary-p nil
"Ask the user for a short summary each time a file is committed?"
:tag "Ask for a summary on each commit"
:group 'git-auto-commit-mode
:type 'boolean)
(defcustom gac-shell-and " && "
"How to join commands together in the shell. For fish shell,
you want to customise this to: \" ; and \" instead of the default."
:tag "Join shell commands"
:group 'git-auto-commit-mode
:type 'string)
(defun gac-relative-file-name (filename)
"Find the path to FILENAME relative to the git directory."
(let* ((git-dir
"\n+$" "" (shell-command-to-string
"git rev-parse --show-toplevel")))
"^/" "" (replace-regexp-in-string
git-dir "" filename))))
(defun gac-password (proc string)
"Ask the user for a password when necessary.
PROC is the process running git. STRING is the line that was
output by PROC."
(let (ask)
(string-match "^Enter passphrase for key '\\\(.*\\\)': $" string)
(string-match "^\\\(.*\\\)'s password:" string))
(setq ask (format "Password for '%s': " (match-string 1 string))))
((string-match "^[pP]assword:" string)
(setq ask "Password:")))
(when ask
(process-send-string proc (concat (read-passwd ask nil) "\n")))))
(defun gac-process-filter (proc string)
"Check if PROC is asking for a password and promps the user if so.
STRING is the output line from PROC."
(set-buffer (process-buffer proc))
(let ((inhibit-read-only t))
(gac-password proc string))))
(defun gac-process-sentinel (proc status)
"Report PROC change to STATUS."
(message "git %s" (substring status 0 -1)))
(defun gac--commit-msg (filename)
"Get a commit message.
Default to FILENAME."
(let ((relative-filename (gac-relative-file-name filename)))
(if (not gac-ask-for-summary-p)
(read-string "Summary: " nil nil relative-filename))))
(defun gac-commit ()
"Commit the current buffer's file to git."
(let* ((buffer-file (buffer-file-name))
(filename (convert-standard-filename
(file-name-nondirectory buffer-file)))
(commit-msg (gac--commit-msg buffer-file))
(default-directory (file-name-directory buffer-file)))
(concat "git add " (shell-quote-argument filename)
"git commit -m " (shell-quote-argument commit-msg)))))
(defun gac-push ()
"Push commits to the current upstream.
This doesn't check or ask for a remote, so the correct remote
should already have been set up."
(let ((proc (start-process "git" "*git-auto-push*" "git" "push")))
(set-process-sentinel proc 'gac-process-sentinel)
(set-process-filter proc 'gac-process-filter)))
(defun gac-after-save-func ()
"Commit the current file.
When `gac-automatically-push-p' is non-nil also push."
(when gac-automatically-push-p
(define-minor-mode git-auto-commit-mode
"Automatically commit any changes made when saving with this
mode turned on and optionally push them too."
:lighter " ga"
(if git-auto-commit-mode
(add-hook 'after-save-hook 'gac-after-save-func t t)
(remove-hook 'after-save-hook 'gac-after-save-func t)))
(provide 'git-auto-commit-mode)
;;; git-auto-commit-mode.el ends here