diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39092b1..1a825db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,6 @@ You can install these with: ```bash sudo pacman -S selene stylua # or whatever is your package manager -# or way of installing pkgs ``` For formatting use this following commands, or setup your editor to integrate with selene/stylua: @@ -39,6 +38,7 @@ task docgen ``` ### Commit messages + We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), please follow it. ### Testing @@ -48,8 +48,5 @@ All tests live in [/spec](https://github.com/olexsmir/gopher.nvim/tree/main/spec You can run tests with: ```bash -task test -# also there are some aliases for that task tests -task spec ``` diff --git a/README.md b/README.md index 126475c..49cb8ed 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Requirements: } ``` -## Configuratoin +## Configuration > [!IMPORTANT] > diff --git a/doc/gopher.nvim.txt b/doc/gopher.nvim.txt index 45f0617..29a3786 100644 --- a/doc/gopher.nvim.txt +++ b/doc/gopher.nvim.txt @@ -11,7 +11,7 @@ Table of Contents Setup....................................................|gopher.nvim-setup| Install dependencies..............................|gopher.nvim-install-deps| Configuration...........................................|gopher.nvim-config| - Modifty struct tags................................|gopher.nvim-struct-tags| + Modify struct tags.................................|gopher.nvim-struct-tags| Auto implementation of interface methods..................|gopher.nvim-impl| Generating unit tests boilerplate......................|gopher.nvim-gotests| Iferr....................................................|gopher.nvim-iferr| @@ -20,7 +20,7 @@ Table of Contents ------------------------------------------------------------------------------ *gopher.nvim-setup* `gopher.setup`({user_config}) -Setup function. This method simply merges default configs with opts table. +Setup function. This method simply merges default config with opts table. 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| @@ -33,8 +33,8 @@ Parameters ~ *gopher.nvim-install-deps* `gopher.install_deps` Gopher.nvim implements most of its features using third-party tools. -To install these tools, you can run `:GoInstallDeps` command -or call `require("gopher").install_deps()` if you want ues lua api. +To install these tools, you can run `:GoInstallDeps` command +or call `require("gopher").install_deps()` if you want to use lua api. ============================================================================== @@ -51,7 +51,7 @@ You can look at default options |gopher.nvim-config-defaults| local default_config = { --minidoc_replace_end - -- log level, you might consider using DEBUG or TRACE for degugging the plugin + -- log level, you might consider using DEBUG or TRACE for debugging the plugin ---@type number log_level = vim.log.levels.INFO, @@ -92,13 +92,16 @@ Class ~ *gopher.nvim-struct-tags* struct-tags is utilizing the `gomodifytags` tool to add or remove tags to struct fields. Usage ~ -- put your coursor on the struct -- run `:GoTagAdd json` to add json tags to struct fields -- run `:GoTagRm json` to remove json tags to struct fields -note: if you dont spesify the tag it will use `json` as default +How to add/remove tags to struct fields: -simple example: +------------------------------------------------------------------------------ +2. Run `:GoTagAdd json` to add json tags to struct fields +3. Run `:GoTagRm json` to remove json tags to struct fields + +NOTE: if you dont specify the tag it will use `json` as default + +Example: >go // before type User struct { @@ -121,19 +124,25 @@ simple example: impl is utilizing the `impl` tool to generate method stubs for interfaces. Usage ~ -1. put your coursor on the struct on which you want implement the interface - and run `:GoImpl io.Reader` - which will automatically choose the reciver for the methods and - implement the `io.Reader` interface -2. same as previous but with custom receiver, so put your coursor on the struct - run `:GoImpl w io.Writer` - where `w` is the receiver and `io.Writer` is the interface -3. specift receiver, struct, and interface - there's no need to put your coursor on the struct if you specify all arguments - `:GoImpl r RequestReader io.Reader` - where `r` is the receiver, `RequestReader` is the struct and `io.Reader` is the interface +1. Automatically implement an interface for a struct: + - Place your cursor on the struct where you want to implement the interface. + - Run `:GoImpl io.Reader` + - This will automatically determine the receiver and implement the `io.Reader` interface. -simple example: +2. Specify a custom receiver: + - Place your cursor on the struct + - Run `:GoImpl w io.Writer`, where: + - `w` is the receiver. + - `io.Writer` is the interface to implement. + +3. Explicitly specify the receiver, struct, and interface: + - No need to place the cursor on the struct if all arguments are provided. + - Run `:GoImpl r RequestReader io.Reader`, where: + - `r` is the receiver. + - `RequestReader` is the struct. + - `io.Reader` is the interface to implement. + +Example: >go type BytesReader struct{} // ^ put your cursor here @@ -141,7 +150,7 @@ simple example: // this is what you will get func (b *BytesReader) Read(p []byte) (n int, err error) { - panic("not implemented") // TODO: Implement + panic("not implemented") // TODO: Implement } < @@ -151,30 +160,31 @@ simple example: gotests is utilizing the `gotests` tool to generate unit tests boilerplate. Usage ~ -- generate unit test for spesisfic function/method - - to specift the function/method put your cursor on it - - run `:GoTestAdd` +- Generate unit test for specific function/method: + 1. Place your cursor on the desired function/method. + 2. Run `:GoTestAdd` -- generate unit tests for all functions/methods in current file +- Generate unit tests for *all* functions/methods in current file: - run `:GoTestsAll` -- generate unit tests only for exported(public) functions/methods +- Generate unit tests *only* for *exported(public)* functions/methods: - run `:GoTestsExp` -you can also specify the template to use for generating the tests. see |gopher.nvim-config| -more details about templates can be found at: https://github.com/cweill/gotests +You can also specify the template to use for generating the tests. See |gopher.nvim-config| +More details about templates can be found at: https://github.com/cweill/gotests ------------------------------------------------------------------------------ *gopher.nvim-gotests-named* -if you prefare using named tests, you can enable it in the config. -but you would need to install `gotests@develop` because stable version doesn't support this feature. -you can do it with: +You can enable named tests in the config if you prefer using named tests. +But you must install `gotests@develop` because the stable version doesn't support this feature. + >lua -- simply run go get in your shell: go install github.com/cweill/gotests/...@develop -- if you want to install it within neovim, you can use one of this: + -- if you choose to install gotests this way i reocmmend adding it to your `build` section in your |lazy.nvim| vim.fn.jobstart("go install github.com/cweill/gotests/...@develop") @@ -186,15 +196,12 @@ you can do it with: } < -if you choose to install `gotests` within neovim, i recommend adding it to your `build` section in your |lazy.nvim| - - ============================================================================== ------------------------------------------------------------------------------ *gopher.nvim-iferr* -if you're using `iferr` tool, this module provides a way to automatically insert `if err != nil` check. +If you're using `iferr` tool, this module provides a way to automatically insert `if err != nil` check. Usage ~ -execute `:GoIfErr` near any err variable to insert the check +Execute `:GoIfErr` near any `err` variable to insert the check ============================================================================== diff --git a/lua/gopher/config.lua b/lua/gopher/config.lua index 8265838..18c08c3 100644 --- a/lua/gopher/config.lua +++ b/lua/gopher/config.lua @@ -29,7 +29,7 @@ local config = {} local default_config = { --minidoc_replace_end - -- log level, you might consider using DEBUG or TRACE for degugging the plugin + -- log level, you might consider using DEBUG or TRACE for debugging the plugin ---@type number log_level = vim.log.levels.INFO, @@ -66,10 +66,9 @@ local default_config = { ---@private local _config = default_config --- I am kinda secret so don't tell anyone about me --- even dont use me +-- I am kinda secret so don't tell anyone about me even dont use me -- --- if you don't belive me that i am secret see +-- if you don't believe me that i am secret see -- the line below it says @private ---@private _config.___plugin_name = "gopher.nvim" ---@diagnostic disable-line: inject-field diff --git a/lua/gopher/gotests.lua b/lua/gopher/gotests.lua index da4753d..1c177b6 100644 --- a/lua/gopher/gotests.lua +++ b/lua/gopher/gotests.lua @@ -2,30 +2,31 @@ ---@tag gopher.nvim-gotests ---@text gotests is utilizing the `gotests` tool to generate unit tests boilerplate. ---@usage ---- - generate unit test for spesisfic function/method ---- - to specift the function/method put your cursor on it ---- - run `:GoTestAdd` +--- - Generate unit test for specific function/method: +--- 1. Place your cursor on the desired function/method. +--- 2. Run `:GoTestAdd` --- ---- - generate unit tests for all functions/methods in current file +--- - Generate unit tests for *all* functions/methods in current file: --- - run `:GoTestsAll` --- ---- - generate unit tests only for exported(public) functions/methods +--- - Generate unit tests *only* for *exported(public)* functions/methods: --- - run `:GoTestsExp` --- ---- you can also specify the template to use for generating the tests. see |gopher.nvim-config| ---- more details about templates can be found at: https://github.com/cweill/gotests +--- You can also specify the template to use for generating the tests. See |gopher.nvim-config| +--- More details about templates can be found at: https://github.com/cweill/gotests --- ---@tag gopher.nvim-gotests-named ---@text ---- if you prefare using named tests, you can enable it in the config. ---- but you would need to install `gotests@develop` because stable version doesn't support this feature. ---- you can do it with: +--- You can enable named tests in the config if you prefer using named tests. +--- But you must install `gotests@develop` because the stable version doesn't support this feature. +--- --- >lua --- -- simply run go get in your shell: --- go install github.com/cweill/gotests/...@develop --- --- -- if you want to install it within neovim, you can use one of this: +--- -- if you choose to install gotests this way i reocmmend adding it to your `build` section in your |lazy.nvim| --- --- vim.fn.jobstart("go install github.com/cweill/gotests/...@develop") --- @@ -36,8 +37,6 @@ --- } --- } --- < ---- ---- if you choose to install `gotests` within neovim, i recommend adding it to your `build` section in your |lazy.nvim| local c = require "gopher.config" local ts_utils = require "gopher._utils.ts" diff --git a/lua/gopher/health.lua b/lua/gopher/health.lua index e9351fe..9fa0bed 100644 --- a/lua/gopher/health.lua +++ b/lua/gopher/health.lua @@ -5,8 +5,8 @@ local u = require "gopher._utils.health_util" local deps = { plugin = { { lib = "dap", msg = "required for `gopher.dap`", optional = true }, - { lib = "plenary", msg = "required for everyting in gopher.nvim", optional = false }, - { lib = "nvim-treesitter", msg = "required for everyting in gopher.nvim", optional = false }, + { lib = "plenary", msg = "required for everything in gopher.nvim", optional = false }, + { lib = "nvim-treesitter", msg = "required for everything in gopher.nvim", optional = false }, }, bin = { { diff --git a/lua/gopher/iferr.lua b/lua/gopher/iferr.lua index bcd4b24..a3a193e 100644 --- a/lua/gopher/iferr.lua +++ b/lua/gopher/iferr.lua @@ -1,7 +1,7 @@ ---@toc_entry Iferr ---@tag gopher.nvim-iferr ----@text if you're using `iferr` tool, this module provides a way to automatically insert `if err != nil` check. ----@usage execute `:GoIfErr` near any err variable to insert the check +---@text If you're using `iferr` tool, this module provides a way to automatically insert `if err != nil` check. +---@usage Execute `:GoIfErr` near any `err` variable to insert the check local c = require "gopher.config" local log = require "gopher._utils.log" diff --git a/lua/gopher/impl.lua b/lua/gopher/impl.lua index f461376..4e1ec9a 100644 --- a/lua/gopher/impl.lua +++ b/lua/gopher/impl.lua @@ -2,19 +2,25 @@ ---@tag gopher.nvim-impl ---@text impl is utilizing the `impl` tool to generate method stubs for interfaces. ---@usage ---- 1. put your coursor on the struct on which you want implement the interface ---- and run `:GoImpl io.Reader` ---- which will automatically choose the reciver for the methods and ---- implement the `io.Reader` interface ---- 2. same as previous but with custom receiver, so put your coursor on the struct ---- run `:GoImpl w io.Writer` ---- where `w` is the receiver and `io.Writer` is the interface ---- 3. specift receiver, struct, and interface ---- there's no need to put your coursor on the struct if you specify all arguments ---- `:GoImpl r RequestReader io.Reader` ---- where `r` is the receiver, `RequestReader` is the struct and `io.Reader` is the interface +--- 1. Automatically implement an interface for a struct: +--- - Place your cursor on the struct where you want to implement the interface. +--- - Run `:GoImpl io.Reader` +--- - This will automatically determine the receiver and implement the `io.Reader` interface. --- ---- simple example: +--- 2. Specify a custom receiver: +--- - Place your cursor on the struct +--- - Run `:GoImpl w io.Writer`, where: +--- - `w` is the receiver. +--- - `io.Writer` is the interface to implement. +--- +--- 3. Explicitly specify the receiver, struct, and interface: +--- - No need to place the cursor on the struct if all arguments are provided. +--- - Run `:GoImpl r RequestReader io.Reader`, where: +--- - `r` is the receiver. +--- - `RequestReader` is the struct. +--- - `io.Reader` is the interface to implement. +--- +--- Example: --- >go --- type BytesReader struct{} --- // ^ put your cursor here @@ -22,7 +28,7 @@ --- --- // this is what you will get --- func (b *BytesReader) Read(p []byte) (n int, err error) { ---- panic("not implemented") // TODO: Implement +--- panic("not implemented") // TODO: Implement --- } --- < diff --git a/lua/gopher/init.lua b/lua/gopher/init.lua index 2aa138e..e18a8bd 100644 --- a/lua/gopher/init.lua +++ b/lua/gopher/init.lua @@ -17,7 +17,7 @@ local gopher = {} ---@toc_entry Setup ---@tag gopher.nvim-setup ----@text Setup function. This method simply merges default configs with opts table. +---@text Setup function. This method simply merges default config with opts table. --- 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| --- @@ -32,8 +32,8 @@ end ---@toc_entry Install dependencies ---@tag gopher.nvim-install-deps ---@text Gopher.nvim implements most of its features using third-party tools. ---- To install these tools, you can run `:GoInstallDeps` command ---- or call `require("gopher").install_deps()` if you want ues lua api. +--- To install these tools, you can run `:GoInstallDeps` command +--- or call `require("gopher").install_deps()` if you want to use lua api. gopher.install_deps = require("gopher.installer").install_deps gopher.impl = require("gopher.impl").impl diff --git a/lua/gopher/struct_tags.lua b/lua/gopher/struct_tags.lua index 4389b62..b3c9dc7 100644 --- a/lua/gopher/struct_tags.lua +++ b/lua/gopher/struct_tags.lua @@ -1,13 +1,15 @@ ----@toc_entry Modifty struct tags +---@toc_entry Modify struct tags ---@tag gopher.nvim-struct-tags ---@text struct-tags is utilizing the `gomodifytags` tool to add or remove tags to struct fields. ----@usage - put your coursor on the struct ---- - run `:GoTagAdd json` to add json tags to struct fields ---- - run `:GoTagRm json` to remove json tags to struct fields +---@usage +--- How to add/remove tags to struct fields: +-- 1. Place cursor on the struct +--- 2. Run `:GoTagAdd json` to add json tags to struct fields +--- 3. Run `:GoTagRm json` to remove json tags to struct fields --- ---- note: if you dont spesify the tag it will use `json` as default +--- NOTE: if you dont specify the tag it will use `json` as default --- ---- simple example: +--- Example: --- >go --- // before --- type User struct { @@ -74,7 +76,7 @@ local function modify(...) end, }) - -- decode goted value + -- decode value local tagged = vim.json.decode(table.concat(output)) if tagged.errors ~= nil