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

i finnaly undertood how to fix this fking skill issue

Browse source
This commit is contained in:
Smirnov Oleksandr 2024-03-15 23:57:26 +02:00
parent 43701418e2
commit b686b40144
2 changed files with 14 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

32
doc/gopher.nvim.txt
View file

@ -9,7 +9,7 @@ It's not an LSP tool, the main goal of this plugin is add go tooling support in
*gopher.nvim-table-of-contents* *gopher.nvim-table-of-contents*
Table of Contents Table of Contents
Configuration...........................................|gopher.nvim-config| Configuration...........................................|gopher.nvim-config|
Setup....................................................|gopher.nvim-setup| Setup.............................................|gopher.nvim-config-setup|
============================================================================== ==============================================================================
@ -19,26 +19,13 @@ config it is the place where you can configure the plugin.
also this is optional is you're ok with default settings. also this is optional is you're ok with default settings.
You can look at default options |gopher.nvim-config-defaults| You can look at default options |gopher.nvim-config-defaults|
------------------------------------------------------------------------------
Type ~
gopher.Config
------------------------------------------------------------------------------
*gopher.nvim-config.ConfigGoTagTransform*
Possible values for |gopher.Config|.gotag.transform:
"snakecase" "GopherUser" -> "gopher_user"
"camelcase" "GopherUser" -> "gopherUser"
"lispcase" "GopherUser" -> "gopher-user"
"pascalcase" "GopherUser" -> "GopherUser"
"titlecase" "GopherUser" -> "Gopher User"
"keep" keeps the original field name
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-config-defaults* *gopher.nvim-config-defaults*
Default values: `default_config`
>lua >lua
{ local default_config = {
--minidoc_replace_end
-- user specified paths to binaries -- user specified paths to binaries
---@class gopher.ConfigCommand ---@class gopher.ConfigCommand
commands = { commands = {
@ -58,7 +45,6 @@ Default values:
template_dir = nil, template_dir = nil,
-- switch table tests from using slice to map (with test name for the key) -- switch table tests from using slice to map (with test name for the key)
-- works only with gotests installed from develop branch -- works only with gotests installed from develop branch
---@type boolean
named = false, named = false,
}, },
---@class gopher.ConfigGoTag ---@class gopher.ConfigGoTag
@ -68,20 +54,20 @@ Default values:
}, },
} }
< <
Class ~ Class
{gopher.Config} {gopher.Config}
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-setup* *gopher.nvim-config-setup*
`config.setup`({user_config}) `config.setup`({user_config})
Setup function. This method simply merges default configs with opts table. Setup function. This method simply merges default configs with opts table.
You can read more about configuration at |gopher.nvim-config| You can read more about configuration at |gopher.nvim-config|
Calling this function is optional, if you ok with default settings. Look |gopher.nvim.config-defaults| Calling this function is optional, if you ok with default settings. Look |gopher.nvim.config-defaults|
Usage ~ Usage
`require("gopher").setup {}` (replace `{}` with your `config` table) `require("gopher").setup {}` (replace `{}` with your `config` table)
Parameters ~ Parameters
{user_config} `(optional)` gopher.Config {user_config} `(optional)` gopher.Config

10
lua/gopher/config.lua
View file

@ -5,13 +5,13 @@
--- You can look at default options |gopher.nvim-config-defaults| --- You can look at default options |gopher.nvim-config-defaults|
---@type gopher.Config ---@type gopher.Config
--minidoc_replace_start ---@private
local config = {} local config = {}
--minidoc_replace_end
---@tag gopher.nvim-config.ConfigGoTagTransform ---@tag gopher.nvim-config.ConfigGoTagTransform
---@text Possible values for |gopher.Config|.gotag.transform: ---@text Possible values for |gopher.Config|.gotag.transform:
--- ---
---@private
---@alias gopher.ConfigGoTagTransform ---@alias gopher.ConfigGoTagTransform
---| "snakecase" "GopherUser" -> "gopher_user" ---| "snakecase" "GopherUser" -> "gopher_user"
---| "camelcase" "GopherUser" -> "gopherUser" ---| "camelcase" "GopherUser" -> "gopherUser"
@ -20,14 +20,15 @@ local config = {}
---| "titlecase" "GopherUser" -> "Gopher User" ---| "titlecase" "GopherUser" -> "Gopher User"
---| "keep" keeps the original field name ---| "keep" keeps the original field name
--minidoc_replace_start {
---@tag gopher.nvim-config-defaults ---@tag gopher.nvim-config-defaults
---@text Default values:
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section):gsub(">", ">lua") ---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section):gsub(">", ">lua")
--- ---
---@class gopher.Config ---@class gopher.Config
--minidoc_replace_start {
local default_config = { local default_config = {
--minidoc_replace_end --minidoc_replace_end
-- user specified paths to binaries -- user specified paths to binaries
---@class gopher.ConfigCommand ---@class gopher.ConfigCommand
commands = { commands = {
@ -47,7 +48,6 @@ local default_config = {
template_dir = nil, template_dir = nil,
-- switch table tests from using slice to map (with test name for the key) -- switch table tests from using slice to map (with test name for the key)
-- works only with gotests installed from develop branch -- works only with gotests installed from develop branch
---@type boolean
named = false, named = false,
}, },
---@class gopher.ConfigGoTag ---@class gopher.ConfigGoTag