sync develop and main (#68)

* healthcheck: refactoring, remove deprecation wanings (#35)

* refactor(checkhealth): remove deprecation warnings, complete rewrite

* refactor(checkhealth): rename util file

* style(healthchecker): reformat lua in vim file

* refactor(health): move all report function into table

* add editorconfig (#36)

* refactor of public plugin's api (#37)

* refactor: move all plugin functionality to init.lua

* fix(commands): now it uses correct module paths

* refactor(config): change way how it handles options

* refactor(gotests): use correct config, change way how deps required, fix some typos

* fix(healthchecker): use correct config

* refactor(iferr): change api

* refactor(impl): change api

* refactor(installer): change api

* refactor(struct_tags): change way of importting deps

* refactor(struct_tags): rename M to struct_tags

* run stylua

* refactor(dap): make it all in one file, and make some refactoring

* refactor(_utils): change way how it organizes

* fix: use new _utils api

* refactor(_utils.health): reorganize module

* refactor(_utils.ts): some renameing, moving requires lines

* run stylua

* update tooling (#38)

* chore: delete pre-commit

* chore: switch from makefile to taskfile

* chore(ci): update and add one more linter

* chore(editorconfig): add config for Go

* chore(editorconfig): remove max_line_length

* fix: editorconfig-check on README.md

* feat: run tests independent from user's nvim config

* remove editorconfig-checker

* fix(config): now it not removes .setup() from itself after calling
.setup()

* fix(config): now it works correctly

* chore: update taskfile, and linter config

* feat(config): make it optional to call .setup()

* run tests independent of user nvim setup (#39)

* chore(lua_ls): now lua_ls knows about testing functions

* spec: change way how tests srtuctured

* test(config): refactor tests

* test: utils

* refactor(utils): remove not used function

* chore(ci): add test runner

* chore(ci): remove taskfile from deps

* fix: now it works

* fix(dap): now dlv uses cmd to run from config

* chore(ci): run tests on many versions of nvim

* refactor: commands runner (#42)

* feat(utils): first impl of own commands runner

* refactor(gotests): uses own runner instead of vendored

* refactor(utils): back to plenary.job

* refactor(gotests): use new runner, clean code

* fix(runner): now it returns output correctly

* refactor(iferr): use vim.system

i have tried to use _utils.runner, but i can't figure out how to make `< file.go` for the command

* refactor(impl): use new runner

* refactor(installer): use new runner

* refactor(struct_tags): use new runner

* refactor: commands such as :GoGet runs with new runner

* refactor: throw errors in more lua way, i think

* refactor(utils): notify now has title

* refactor: use more correct way of notifying

* refactor(runner): write error message on error

* add ability for setting custom tools options (#44)

* feat(gotests): add custom templates support

* feat(struct_tags): add support for custom `transform` option

* fix(health): check if bin is installed, and added message about treesitter parser

* fix: fix iferr config (#56)

* Add support for named tests (#50)

* fix(typo): README.md (#47)

* feat: add support for named tests

* test

* tags in table

* debug installer msg

* test

* hardcoded @develop

* get gotests tag from setup()

* update readme

* store install tag in urls table

* removed gotests tag

* update README.md

* remove urls installer index reference

* remove named arg from add_test()

* .

* update README.md

* update README.md

---------

Co-authored-by: Steve M <gearcog@users.noreply.github.com>

* reformat .editorconfig config

* refactor(api)!: mave tags and gotests api into their sub tables

* add help file, and docs (#59)

* idk how good this idea is

* this could be working but i still cant figure out how to run it

* ignore tags that mini.doc gens, but why?

* chore(taskfile): force exiting after tests

because i got infinit ci

* chore(ci): add more nvim versions to run on

* chore: update taskfile

* feat: add docs generator

* docs: its only begining

* refactor: update docgen script

* docs: write some more

* docs(config): update

* docs: update readme

* language

* hope it would work

* what about that?

* maybe this would work?

* update md

* upd

* WHY DOESNT IT WORKING

* idk by but 0.9.3 just fails the ci, so i deleted it from suite

* again update, why does markdown not work in embeded html

* maybe it can help?

* upd

* again update

* kinda fix

* fix: formatting

* again some updating

* some readme updating

* fix, this shouldnt be in repo

* i finnaly undertood how to fix this fking skill issue

* fix(struct_tags): typo

* refactor(docs): change the order in generated file

* docs: install deps

* refactor(scripts): rename doc-gen script

* docs(impl): write docs

* docs(dap): add doc

* stylua .

* docs(struct_tags): add doc

* docs(gotests): add docs

* docs(iferr): add docs

* docs(comment): add doc

* update CONTRIBUTING.md

* docs(README): talk about `develop` branch

* docs: update README.md

* refactor(health): keep in mind new way of health check (#63)

* feat: add logger (#64)

* refactor(health): keep in mind new way of health check (#63)

* feat(log): add logger module

* refactor(utils): remove unused code

* refactor(log, utils): get plugin name from config

* refactor(logger): add some type annotations

* refactor(utils): log notifications

* feat: LOGGER™

* feat(config): TYPES

* refactor(log): dont give a thing about var that is not even declared

* feat(log): add easy way to open log

* refactor(log): some types

* update types

* docs: regen

* fix(log): make setting log level by config work

* feat(iferr): write error to log file if occur

* feat(gotests): add logger

* add deprecation message (#67)

---------

Co-authored-by: Arne Van Maele <93863978+arnevm123@users.noreply.github.com>
Co-authored-by: Alex <49870662+ysomad@users.noreply.github.com>
Co-authored-by: Steve M <gearcog@users.noreply.github.com>

lua/gopher/health.lua

@@ -1,44 +1,70 @@
-local c = require("gopher.config").config.commands
+local health = {}
+local cmd = require("gopher.config").commands
+local u = require "gopher._utils.health_util"
 
-local requried_for_work_msg = "Gopher.nvim will not work without it!"
-local M = {
-  _required = {
-    plugins = {
-      { lib = "plenary", help = requried_for_work_msg },
-      { lib = "nvim-treesitter", help = requried_for_work_msg },
-      { lib = "dap", help = "Required for set upping debugger" },
+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 },
+  },
+  bin = {
+    {
+      bin = cmd.go,
+      msg = "required for `:GoGet`, `:GoMod`, `:GoGenerate`, `:GoWork`, `:GoInstallDeps`",
+      optional = false,
     },
-    binarys = {
-      { bin = c.go, help = "required for GoMod, GoGet, GoGenerate command" },
-      { bin = c.gomodifytags, help = "required for modify struct tags" },
-      { bin = c.impl, help = "required for interface implementing" },
-      { bin = c.gotests, help = "required for test(s) generation" },
-      { bin = c.dlv, help = "required for debugger(nvim-dap)" },
+    { bin = cmd.gomodifytags, msg = "required for `:GoTagAdd`, `:GoTagRm`", optional = false },
+    { bin = cmd.impl, msg = "required for `:GoImpl`", optional = false },
+    { bin = cmd.iferr, msg = "required for `:GoIfErr`", optional = false },
+    {
+      bin = cmd.gotests,
+      msg = "required for `:GoTestAdd`, `:GoTestsAll`, `:GoTestsExp`",
+      optional = false,
     },
+    { bin = cmd.dlv, msg = "required for debugging, (`nvim-dap`, `gopher.dap`)", optional = true },
+  },
+  treesitter = {
+    { parser = "go", msg = "required for `gopher.nvim`", optional = false },
   },
 }
 
-function M.check()
-  local health = vim.health or require "health"
-  local u = require "gopher._utils._health"
-
-  health.report_start "Required plugins"
-  for _, plugin in ipairs(M._required.plugins) do
-    if u.lualib_is_found(plugin.lib) then
-      health.report_ok(plugin.lib .. " installed.")
+function health.check()
+  u.start "required plugins"
+  for _, plugin in ipairs(deps.plugin) do
+    if u.is_lualib_found(plugin.lib) then
+      u.ok(plugin.lib .. " installed")
     else
-      health.report_error(plugin.lib .. " not found. " .. plugin.help)
+      if plugin.optional then
+        u.warn(plugin.lib .. " not found, " .. plugin.msg)
+      else
+        u.error(plugin.lib .. " not found, " .. plugin.msg)
+      end
     end
   end
 
-  health.report_start "Required go tools"
-  for _, binary in ipairs(M._required.binarys) do
-    if u.binary_is_found(binary.bin) then
-      health.report_ok(binary.bin .. " installed")
+  u.start "required binaries"
+  u.info "all those binaries can be installed by `:GoInstallDeps`"
+  for _, bin in ipairs(deps.bin) do
+    if u.is_binary_found(bin.bin) then
+      u.ok(bin.bin .. " installed")
     else
-      health.report_warn(binary.bin .. " is not installed but " .. binary.help)
+      if bin.optional then
+        u.warn(bin.bin .. " not found, " .. bin.msg)
+      else
+        u.error(bin.bin .. " not found, " .. bin.msg)
+      end
+    end
+  end
+
+  u.start "required treesitter parsers"
+  for _, parser in ipairs(deps.treesitter) do
+    if u.is_treesitter_parser_available(parser.parser) then
+      u.ok(parser.parser .. " parser installed")
+    else
+      u.error(parser.parser .. " parser not found, " .. parser.msg)
     end
   end
 end
 
-return M
+return health