docs: update readme
This commit is contained in:
parent
7af08c9780
commit
6ee261cfa6
3 changed files with 14 additions and 7 deletions
15
README.md
15
README.md
|
|
@ -39,17 +39,21 @@ Requirements:
|
||||||
>
|
>
|
||||||
> If you need more info look `:h gopher.nvim`
|
> If you need more info look `:h gopher.nvim`
|
||||||
|
|
||||||
**Take a look at default options**
|
**Take a look at default options (might be a bit outdated, look `:h gopher.nvim-config-defaults`)**
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
require("gopher").setup {
|
require("gopher").setup {
|
||||||
|
log_level = vim.log.levels.INFO,
|
||||||
|
|
||||||
|
-- timeout for running internal commands
|
||||||
|
timeout = 2000,
|
||||||
|
|
||||||
commands = {
|
commands = {
|
||||||
go = "go",
|
go = "go",
|
||||||
gomodifytags = "gomodifytags",
|
gomodifytags = "gomodifytags",
|
||||||
gotests = "gotests",
|
gotests = "gotests",
|
||||||
impl = "impl",
|
impl = "impl",
|
||||||
iferr = "iferr",
|
iferr = "iferr",
|
||||||
dlv = "dlv",
|
|
||||||
},
|
},
|
||||||
gotests = {
|
gotests = {
|
||||||
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
|
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
|
||||||
|
|
@ -61,6 +65,12 @@ require("gopher").setup {
|
||||||
},
|
},
|
||||||
gotag = {
|
gotag = {
|
||||||
transform = "snakecase",
|
transform = "snakecase",
|
||||||
|
-- default tags to add to struct fields
|
||||||
|
default_tag = "json",
|
||||||
|
},
|
||||||
|
iferr = {
|
||||||
|
-- choose a custom error message
|
||||||
|
message = nil,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
@ -84,7 +94,6 @@ require("gopher").setup {
|
||||||
- [impl](https://github.com/josharian/impl)
|
- [impl](https://github.com/josharian/impl)
|
||||||
- [gotests](https://github.com/cweill/gotests)
|
- [gotests](https://github.com/cweill/gotests)
|
||||||
- [iferr](https://github.com/koron/iferr)
|
- [iferr](https://github.com/koron/iferr)
|
||||||
- [dlv](github.com/go-delve/delve/cmd/dlv)
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
|
||||||
|
|
@ -57,7 +57,7 @@ You can look at default options |gopher.nvim-config-defaults|
|
||||||
---@type number
|
---@type number
|
||||||
log_level = vim.log.levels.INFO,
|
log_level = vim.log.levels.INFO,
|
||||||
|
|
||||||
-- timeout for running commands
|
-- timeout for running internal commands
|
||||||
---@type number
|
---@type number
|
||||||
timeout = 2000,
|
timeout = 2000,
|
||||||
|
|
||||||
|
|
@ -73,7 +73,6 @@ You can look at default options |gopher.nvim-config-defaults|
|
||||||
gotests = "gotests",
|
gotests = "gotests",
|
||||||
impl = "impl",
|
impl = "impl",
|
||||||
iferr = "iferr",
|
iferr = "iferr",
|
||||||
dlv = "dlv",
|
|
||||||
},
|
},
|
||||||
---@class gopher.ConfigGotests
|
---@class gopher.ConfigGotests
|
||||||
gotests = {
|
gotests = {
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,7 @@ local default_config = {
|
||||||
---@type number
|
---@type number
|
||||||
log_level = vim.log.levels.INFO,
|
log_level = vim.log.levels.INFO,
|
||||||
|
|
||||||
-- timeout for running commands
|
-- timeout for running internal commands
|
||||||
---@type number
|
---@type number
|
||||||
timeout = 2000,
|
timeout = 2000,
|
||||||
|
|
||||||
|
|
@ -49,7 +49,6 @@ local default_config = {
|
||||||
gotests = "gotests",
|
gotests = "gotests",
|
||||||
impl = "impl",
|
impl = "impl",
|
||||||
iferr = "iferr",
|
iferr = "iferr",
|
||||||
dlv = "dlv",
|
|
||||||
},
|
},
|
||||||
---@class gopher.ConfigGotests
|
---@class gopher.ConfigGotests
|
||||||
gotests = {
|
gotests = {
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue