olexsmir/gopher.nvim
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update

Browse source
This commit is contained in:
Oleksandr Smirnov 2025-03-23 00:55:46 +02:00
parent f8bb168db1
commit 829d337055
No known key found for this signature in database
2 changed files with 13 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/gopher.nvim.txt
View file

@ -8,15 +8,15 @@ gopher.nvim is a minimalistic plugin for Go development in Neovim written in Lua
It's not an LSP tool, the main goal of this plugin is add go tooling support in Neovim. It's not an LSP tool, the main goal of this plugin is add go tooling support in Neovim.
Table of Contents Table of Contents
Setup |gopher.nvim-setup()| Setup..................................................|gopher.nvim-setup()|
Install dependencies |gopher.nvim-dependencies| Install dependencies..............................|gopher.nvim-dependencies|
Config |gopher.nvim-config| Config..................................................|gopher.nvim-config|
Commands |gopher.nvim-commands| Commands..............................................|gopher.nvim-commands|
Modify struct tags |gopher.nvim-struct-tags| Modify struct tags.................................|gopher.nvim-struct-tags|
Auto implementation of interface methods |gopher.nvim-impl| Auto implementation of interface methods..................|gopher.nvim-impl|
Generating unit tests boilerplate |gopher.nvim-gotests| Generating unit tests boilerplate......................|gopher.nvim-gotests|
Iferr |gopher.nvim-iferr| Iferr....................................................|gopher.nvim-iferr|
Generate comments |gopher.nvim-comments| Generate comments.....................................|gopher.nvim-comments|
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-setup()* *gopher.nvim-setup()*
@ -141,10 +141,9 @@ Example:
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-impl* *gopher.nvim-impl*
impl is utilizing the `impl` tool to generate method stubs for interfaces. Integration of `impl` tool to generate method stubs for interfaces.
Usage ~ Usage ~
1. Automatically implement an interface for a struct: 1. Automatically implement an interface for a struct:
- Place your cursor on the struct where you want to implement the interface. - Place your cursor on the struct where you want to implement the interface.
- Run `:GoImpl io.Reader` - Run `:GoImpl io.Reader`
@ -218,4 +217,4 @@ Usage ~
Set cursor on line with function/method/struct/etc and run `:GoCmt` to generate a comment. Set cursor on line with function/method/struct/etc and run `:GoCmt` to generate a comment.
vim:tw=78:ts=8:noet:ft=help:norl: vim:tw=78:ts=8:noet:ft=help:norl:

5
lua/gopher/impl.lua
View file

@ -1,10 +1,9 @@
---@toc_entry Auto implementation of interface methods ---@toc_entry Auto implementation of interface methods
---@tag gopher.nvim-impl ---@tag gopher.nvim-impl
---@text ---@text
--- impl is utilizing the `impl` tool to generate method stubs for interfaces. --- Integration of `impl` tool to generate method stubs for interfaces.
--- ---
---@usage ---@usage 1. Automatically implement an interface for a struct:
--- 1. Automatically implement an interface for a struct:
--- - Place your cursor on the struct where you want to implement the interface. --- - Place your cursor on the struct where you want to implement the interface.
--- - Run `:GoImpl io.Reader` --- - Run `:GoImpl io.Reader`
--- - This will automatically determine the receiver and implement the `io.Reader` interface. --- - This will automatically determine the receiver and implement the `io.Reader` interface.