golang module 在 spacemcs 中的配置

Posted 2022-10-14 wang_yb

概述

golang 官方的包管理从 1.11 版本就开始支持了, 之前尝试了几次, 效果都不理想, 就一直用 dep 来管理 package.

最近 1.13 版本发布了, 使用 go module 的官方管理方式越来越多, dep 也早就不在继续开发了. 鉴于此, 是时候把 golang 的包管理方式迁移到 go module 上来了.

我一直是用 spacemacs 来开发各种应用, 所以本文也是介绍如何在 spacemacs 中配置 golang module 的开发环境.

配置方法

go module 其实本身是不需要什么配置, 这里的配置其实为了更方便的编码而做的 spacemacs 配置. 能够让它支持自动补全, 代码调转等等开发时常用的操作.

需要的软件

使用 go module, golang 的工程不用在放在 GOPATH 下, 所有传统的 gocode 不能再用来做代码补全这些了. 我们这里采用 gopls 来代替 gocode.

出来 golang 1.13, 额外需要的软件就是 gopls

安装好 golang 1.13, 安装 gopls 非常简单:

$ GO111MODULE=on go get golang.org/x/tools/gopls@latest

spacemacs 的配置

go layer

spacemacs 的 develop 分支默认继承了 lsp 的功能. LSP 是什么 所以配置起来很简单, 在 dotspacemacs-configuration-layers 下配置:

dotspacemacs-configuration-layers
'(
  ... ...
  lsp
  ;; ----------------------------------------------------------------
  ;; Example of useful layers you may want to use right away.
  ;; Uncomment some layer names and press `SPC f e R' (Vim style) or
  ;; `M-m f e R' (Emacs style) to install them.
  ;; ----------------------------------------------------------------

  (go :variables
      go-backend 'lsp
      go-tab-width 8
      godoc-at-point-function 'godoc-gogetdoc)
 ... ...
 )

lsp-mode

lsp-mode 是 emacs 对 lsp 的封装, 参考其中 golang 的部分, 在 dotspacemacs/user-config 中配置:

;; lsp
(use-package lsp-mode
  :hook (go-mode . lsp-deferred)
  :commands (lsp lsp-deferred))

(setq lsp-auto-guess-root nil)
(setq lsp-ui-doc-enable nil)
(setq lsp-ui-sideline-enable nil)
(setq lsp-prefer-flymake :none)

project root 设置

使用 go module 之后, golang 项目的目录不一定在 GOPATH 下, 所以定义了个配置 project root 的函数. 当然, 如果不设置, 默认值是 emacs 的 projectile-project-root

;; project path settings
(setq current-project-path (projectile-project-root))

(defun set-project-path (relative-path)
  (interactive
   (list (read-string "relative path: " "." nil nil nil)))
  (setq current-project-path (file-truename relative-path)))

(defun get-project-path ()
  (interactive)
  (message current-project-path))

build/install 快捷键

增加 2 个快捷键, 用来执行 go build 和 go install

;; go build/install
(setq default-go-package "")

(defun go-build (&optional pkg)
  (interactive
   (list (read-string (format "Package Name[%s]: " default-go-package) nil nil "")))

  (if (not (string= pkg ""))
      (setq default-go-package pkg))

  (if (string= current-project-path "")
      (message "You MUST set current-project-path FIRST!")
    (projectile-with-default-dir current-project-path
      (projectile-run-compilation (concat "go build " default-go-package))))
  )

(defun go-install (&optional pkg)
  (interactive
   (list (read-string (format "Package Name[%s]: " default-go-package) nil nil "")))

  (if (not (string= pkg ""))
      (setq default-go-package pkg))

  (if (string= current-project-path "")
      (message "You MUST set current-project-path FIRST!")
    (projectile-with-default-dir current-project-path
      (projectile-run-compilation (concat "go install " default-go-package))))
)

;; set shortcuts
(spacemacs/set-leader-keys-for-major-mode 'go-mode
  "xi" 'go-install)

(spacemacs/set-leader-keys-for-major-mode 'go-mode
  "xb" 'go-build)

go build 和 go install 的快捷键分别是: SPC m x b 和 SPC m x i

使用中遇到的坑

在尝试使用的过程中, 遇到 2 个坑, 耗费了大半天的时间… :(

错误内容: LSP : main.go not in project or it is blacklisted

在 spacemacs 的 ****Message**** buffer 中, 提示 LSP : main.go not in project or it is blacklisted 几近波折, 才发现不知道什么时候, 当前的项目被加入到 blacklist 中了…

解决方法:

1. M-X lsp-workspace-blacklist-remove
2. 找到项目所在的文件夹, 然后选择它, 将它从 blacklist 中移除即可

错误内容: no AST for file:///..../foo.go

如果项目本身就是 golang 工程的话, 一般不会出现这个问题, 我有个项目, golang 工程是其中的一部分, 工程结构大致如下:

.
├── backend
│?? └── this-is-golang-project-root
├── deploy
│?? ├── builder
│?? └── docker-compose.yml
├── frontend
│?? └── ui
└── README.md

golang 工程不在项目的根目录, 使用时在 spacemacs 的 ****Message**** buffer 中, 提示: no AST for file:///..../foo.go

解决方式:

1. 设置 (setq lsp-auto-guess-root nil)
2. M-x set-project-path
3. 设置 golang project path, 设置这个的目的是为了使用 SPC m x b 和 SPC m x i 来随时执行 go build 和 go install