EmacsでGoの開発環境構築 / fujimisakari blog

今さら感がありますが、最近よくGoを使っててあらためてEmacs環境を整備したのでざっくりまとめてみます。

メジャーモードの導入(go-mode)

まずGo言語のためのメジャーモードのgo-modeで入れます。
シンタックスハイライトやインデント、goコマンドをelispインタフェース通して利用できるようになります。

1	M-x package-install go-mode

環境変数設定

go-modeやGoに関連する作業にGOPATHが必要になるのでEmacsにも環境変数を設定します。

1	(setenv "GOPATH" "/home/dev/go")

タグジャンプ設定(helm-gtags)

定義元へのジャンプは godefがよく紹介されてますが他言語の開発とタグジャンプ操作は同じインタフェースにしたいのでGnu Global + Pygmentsを利用したhelm-gtagsでタグジャンプ設定します。
GOPATH直下でタグDBを作成するのですべての定義元へジャンプできるようになります。

導入方法はこの辺りを参考
https://qiita.com/yoshizow/items/9cc0236ac0249e0638ff
https://github.com/syohex/emacs-helm-gtags
http://blog.10rane.com/2014/09/17/to-reading-comprehension-of-the-source-code-by-introducing-the-helm-gtags-mode/

Go言語はまだPygmentsでサポートされていないので.ctagsに以下を追加します

--langdef=Go
--langmap=Go:.go
--regex-Go=/func([ \t]+\([^)]+\))?[ \t]+([a-zA-Z0-9_]+)/\2/d,func/
--regex-Go=/var[ \t]+([a-zA-Z_][a-zA-Z0-9_]+)/\1/d,var/
--regex-Go=/const[ \t]+([a-zA-Z_][a-zA-Z0-9_]+)/\1/d,const/
--regex-Go=/type[ \t]+([a-zA-Z_][a-zA-Z0-9_]+)/\1/d,type/

コード補完(go-autocomplete)

コード補完はgocodeを利用するので事前インストールします

1	$ go get -u github.com/nsf/gocode

auto-complete.elを利用したインタフェースで補完しますのでこちらをインストールして、
その後にGo言語の補完で利用するgo-autocompleteをインストールします。

1	(require 'go-autocomplete)

エラーチェック(go-flymake)

エラーチェックはgo-flymakeを利用します。
入力のたびにGoのSyntaxを自動チェックして知らせてくれるようになります。

1	(require 'go-flymake)

ドキュメント確認

go-eldoc

カーソル位置のシンボルのドキュメントをミニバッファに表示してくれます

M-x package-install go-eldoc

(require 'go-eldoc)
(add-hook 'go-mode-hook 'go-eldoc-setup)

パッケージ単位でドキュメントを確認

ここのやつをちょっといじってるだけです
http://syohex.hatenablog.com/entry/20130618/1371567527

helm経由でパッケージを選んでドキュメントを確認できるようになります

(defvar helm-go-packages-source
  (helm-build-sync-source "Helm Go Packages"
    :candidates (go-packages)
    :candidate-number-limit 300
    :action 'godoc))

(defun helm-go-packages ()
  (interactive)
  (helm :sources '(helm-go-packages-source) :buffer "*helm go packages*"))

ポップアップでドキュメントを確認

go-eldocとほぼ同じ機能なのですが、ミニバッファだと見にくかったり、詳細がなかったり、他とイベントとカブったとき表示されないのでPopupで確認できるようにしました。
操作はリージョン選択してgodoc-popupを実行するだけです。(popup.elが必要になります)

(defun godoc-popup ()
  (interactive)
  (unless (use-region-p)
    (error "Dose not region selection"))
  (let ((query (buffer-substring-no-properties (region-beginning) (region-end))))
    (run-at-time 0.1 nil 'deactivate-mark)
    (popup-tip
     (with-temp-buffer
       (let ((standard-output (current-buffer))
             (help-xref-following t))
         (prin1 (funcall 'shell-command-to-string (concat "go doc " query)))
         (buffer-substring-no-properties (+ (point-min) 1) (- (point-max) 3)))))))

任意パッケージをdiredで開く

こちらはhelm-ghq.elで実現できたのですが、目的のパッケージをdiredで開くだけのシンプルなものがほしかったので用意しました。(事前にghqコマンドをインストールしておく必要があります)

(defun helm-ghq--get-candidates ()
  (let* ((cmd-result (funcall 'shell-command-to-string "ghq list"))
         (candidates (split-string cmd-result "\n"))
         (candidates (sort candidates 'string<))
         (candidates (cdr candidates)))
    candidates))

(defvar helm-ghq-list-source
  (helm-build-sync-source "Helm ghq list"
    :candidates (helm-ghq--get-candidates)
    :candidate-number-limit 300
    :action 'helm-ghq--dired))

(defun helm-ghq--dired (name)
  (when (one-window-p)(split-window-horizontally))
  (other-window 1)
  (dired (concat (getenv "GOPATH") "/src/" name)))

(defun helm-ghq-list ()
  (interactive)
  (helm :sources '(helm-ghq-list-source) :buffer "*helm ghq list*"))

Tips

コード整形

go-modeのデフォルト機能のgofmtを利用する。現在のバッファに対してコード整形が適用されます。
また保存時自動的にこのコマンドを実行したい場合は次のようにhookに登録します。

1	(add-hook 'before-save-hook 'gofmt-before-save)

パッケージのimport

こちらもgo-modeのデフォルト機能のgo-import-addを利用します。helm経由で選択できるので便利。

1	go-import-add (Default: C-c C-a)

また、使っていないimportも go-remove-unused-imports を使うと使用していないpackageたちをimportから一括で外してくれるはずだがなぜかできない。。

コード整形とimportの整理を同時にしてくれる

goimportsはgofmtの関連ツールで標準のディストリビューションには入ってませんが
コード整形と必要に応じてインポートの宣言の挿入と削除を同時に行ってくれます。

$ go get golang.org/x/tools/cmd/goimports

gofmtコマンドの上書き設定します
(setq gofmt-command "goimports")

godocのバッファー名は`godoc`にする

go-mode機能のgodoc使った場合に、新たにバッファが生成されどんどん増えていくのでpopwinで無駄なバッファを生成しないようにしたいのですが
バッファー名が*godoc xxxxx*みたいに毎回変わりpopwin設定ができないのでバッファー名は*godoc*固定となるように関数を上書きます。

(defun godoc--get-buffer (query)
  "Get an empty buffer for a godoc QUERY."
  (let* ((buffer-name "*godoc*")
         (buffer (get-buffer buffer-name)))
    ;; Kill the existing buffer if it already exists.
    (when buffer (kill-buffer buffer))
    (get-buffer-create buffer-name)))

ショートカット

若干めんどうだったのでショートカットを用意しました

(defun insert-go-channel-arrow ()
  (interactive)
  (insert "<-"))

(defun insert-go-expression ()
  (interactive)
  (insert ":="))

現在の設定

https://github.com/fujimisakari/.emacs.d/blob/master/inits/46-go-mode.el

参考サイト

http://emacs-jp.github.io/programming/golang.html
http://syohex.hatenablog.com/entry/20130618/1371567527
http://unknownplace.org/archives/golang-editing-with-emacs.html

EmacsでGoの開発環境構築