emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(go): keybinds and command docstrings

Browse source 
Close: #6972
This commit is contained in:
Henrik Lissner 2023-02-23 00:52:41 -05:00
parent 63daee4b94
commit 89994b73a3
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
2 changed files with 41 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

33
modules/lang/go/README.org
View file

@ -91,6 +91,39 @@ go install github.com/fatih/gomodifytags@latest
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
** Keybinds
| Keys | Description |
|---------------------+-------------------------------------------------------|
| [[kbd:][<localleader> a]] | Add field tags to a struct |
| [[kbd:][<localleader> d]] | Remove field tags from a struct |
| [[kbd:][<localleader> e]] | Evaluate buffer or selection in the Go playground |
| [[kbd:][<localleader> i]] | Go to imports |
| [[kbd:][<localleader> b c]] | run ~$ go clean~ |
| [[kbd:][<localleader> b b]] | run ~$ go build~ |
| [[kbd:][<localleader> b r]] | run ~$ go run .~ |
| [[kbd:][<localleader> h .]] | lookup symbol at point in godoc |
| [[kbd:][<localleader> h d]] | describe symbol at point |
| [[kbd:][<localleader> h v]] | list free variables |
| [[kbd:][<localleader> h i]] | list implements relations for package types |
| [[kbd:][<localleader> h p]] | list peers for channel |
| [[kbd:][<localleader> h P]] | "what does this point to" |
| [[kbd:][<localleader> h r]] | list references to object |
| [[kbd:][<localleader> h e]] | which errors |
| [[kbd:][<localleader> h w]] | what query |
| [[kbd:][<localleader> h c]] | show callers of function at point |
| [[kbd:][<localleader> h C]] | show callees of function at point |
| [[kbd:][<localleader> t t]] | rerun last test |
| [[kbd:][<localleader> t a]] | run all tests in project |
| [[kbd:][<localleader> t f]] | run all tests in current file |
| [[kbd:][<localleader> t s]] | run single test at point |
| [[kbd:][<localleader> t g]] | Generate tests for all exported or selected functions |
| [[kbd:][<localleader> t G]] | Generate tests for all functions |
| [[kbd:][<localleader> t e]] | Generate tests for all exported functions |
| [[kbd:][<localleader> t b s]] | go test.bench single |
| [[kbd:][<localleader> t b a]] | go test.bench all |
| [[kbd:][<localleader> r i a]] | search imports to add |
| [[kbd:][<localleader> r i r]] | reimove unused imports |
* TODO Configuration
#+begin_quote
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]

9
modules/lang/go/autoload.el
View file

@ -17,6 +17,7 @@
;;;###autoload
(defun +go/test-rerun ()
"Rerun last run test."
(interactive)
(if +go-test-last
(+go--spawn +go-test-last)
@ -24,16 +25,19 @@
;;;###autoload
(defun +go/test-all ()
"Run all tests for this project."
(interactive)
(+go--run-tests ""))
;;;###autoload
(defun +go/test-nested ()
"Run all tests in current directory and below, recursively."
(interactive)
(+go--run-tests "./..."))
;;;###autoload
(defun +go/test-single ()
"Run single test at point."
(interactive)
(if (string-match "_test\\.go" buffer-file-name)
(save-excursion
@ -43,6 +47,7 @@
;;;###autoload
(defun +go/test-file ()
"Run all tests in current file."
(interactive)
(if (string-match "_test\\.go" buffer-file-name)
(save-excursion
@ -55,11 +60,13 @@
;;;###autoload
(defun +go/bench-all ()
"Run all benchmarks in project."
(interactive)
(+go--run-tests "-test.run=NONE -test.bench=\".*\""))
;;;###autoload
(defun +go/bench-single ()
"Run benchmark at point."
(interactive)
(if (string-match "_test\\.go" buffer-file-name)
(save-excursion
@ -70,7 +77,7 @@
;;;###autoload
(defun +go/play-buffer-or-region (&optional beg end)
"TODO"
"Evaluate active selection or buffer in the Go playground."
(interactive "r")
(if (use-region-p)
(go-play-region beg end)