Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions go-mode.el
Original file line number Diff line number Diff line change
Expand Up @@ -1751,10 +1751,16 @@ The following extra functions are defined:
- `godef-describe' and `godef-jump'
- `go-coverage'

If you want to automatically run `gofmt' before saving a file,
add the following hook to your Emacs configuration:
If you want to automatically run `gofmt' before saving a file enable the
gofmt minor mode. To do so you can add the following to to your Emacs
configuration:

\(add-hook 'before-save-hook #'gofmt-before-save)
\(add-hook 'go-mode-hook #'gofmt-mode)

Or if you use `use-package':

\(use-package go-mode
:hook ((go-mode . gofmt-mode)))
Comment on lines +1762 to +1763
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I included the use-package instructions because it is now included with Emacs. Let me know if you prefer to remove it


If you want to use `godef-jump' instead of etags (or similar),
consider binding godef-jump to `M-.', which is the default key
Expand Down Expand Up @@ -1995,15 +2001,13 @@ arguments can be set as a list via ‘gofmt-args’."
(kill-buffer errbuf))))

;;;###autoload
(defun gofmt-before-save ()
"Add this to .emacs to run gofmt on the current buffer when saving:
\(add-hook 'before-save-hook 'gofmt-before-save).

Note that this will cause ‘go-mode’ to get loaded the first time
you save any file, kind of defeating the point of autoloading."

(interactive)
(when (eq major-mode 'go-mode) (gofmt)))
(define-minor-mode gofmt-mode
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The minor mode approach is what the prettier mode does as well. It was where I got the idea.

https://github.com/prettier/prettier-emacs/blob/e9b73e81d3e1642aec682195f127a42dfb0b5774/prettier-js.el#L203-L210

"Runs gofmt before saving the file."
:lighter "gofmt"
:global nil
(if gofmt-mode
(add-hook 'before-save-hook 'gofmt nil 'local)
(remove-hook 'before-save-hook 'gofmt 'local)))

(defun godoc--read-query ()
"Read a godoc query from the minibuffer."
Expand Down