chore(commons): upgrade logging api (#228)

Author: linrongbin16

README.md

@@ -127,7 +127,7 @@ There're several **router types**:
 > - `browse` generate the `/src` url (default): https://bitbucket.org/gitlinkernvim/gitlinker.nvim/src/dbf3922382576391fbe50b36c55066c1768b08b6/.gitignore#lines-9:14.
 > - `blame` generate the `/annotate` url: https://bitbucket.org/gitlinkernvim/gitlinker.nvim/annotate/dbf3922382576391fbe50b36c55066c1768b08b6/.gitignore#lines-9:14.
 > - `default_branch` generate the `/main` or `/master` url: https://bitbucket.org/gitlinkernvim/gitlinker.nvim/src/master/.gitignore#lines-9:14.
-> - `current_branch` generate the current branch url: https://bitbucket.org/gitlinkernvim/gitlinker.nvim/src/master/.gitignore#lines-9:14.
+> - `current_branch` generate the current branch url: https://bitbucket.org/gitlinkernvim/gitlinker.nvim/src/feat-dev/.gitignore#lines-9:14.
 
 To specify the remote when there're multiple git remotes, add `remote=xxx` parameter, for example:
 
@@ -408,9 +408,7 @@ For complete default options, please see `Defaults` in [configs.lua](https://git
 >
 > Please refer to `Defaults.router` in [configs.lua](https://github.com/linrongbin16/gitlinker.nvim/blob/master/lua/gitlinker/configs.lua) for more examples about string template.
 
-To create customized urls for other git hosts, please bind the target git host name with a new router.
-
-A router simply constructs the url string from below components (upper case with prefix `_A.`):
+To create customized urls for other git hosts, please bind the target git host name with a new router. A router simply constructs the url string from below components (upper case with prefix `_A.`):
 
 - `_A.PROTOCOL`: Network protocol before `://` delimiter, for example:
   - `https` in `https://github.com`.
@@ -476,15 +474,15 @@ require("gitlinker").setup({
 })
 ```
 
-The template string use curly braces `{}` to contain lua scripts, and evaluate via [luaeval()](https://neovim.io/doc/user/lua.html#lua-eval) (while the error message can be confusing if there's any syntax issue).
+The template string use curly braces `{}` to contain lua scripts, and evaluate via [luaeval()](https://neovim.io/doc/user/lua.html#lua-eval), while the error message can be confusing if there's any syntax issue.
 
 #### Lua Function
 
 > [!NOTE]
 >
-> Please refer to [routers.lua](https://github.com/linrongbin16/gitlinker.nvim/blob/master/lua/gitlinker/routers.lua) for builtin routers implementation.
+> Please refer to [routers.lua](https://github.com/linrongbin16/gitlinker.nvim/blob/master/lua/gitlinker/routers.lua) for more examples about function-based routers.
 
-You can also bind a lua function to it, which accepts a lua table parameter that contains the same fields, but in lower case, without the prefix `_A.`:
+You can also bind a lua function to the git host, the function accepts only 1 lua table as its parameter, which contains the same fields as string template, but in lower case, without the prefix `_A.`:
 
 - `protocol`
 - `username`
@@ -506,7 +504,7 @@ The 2 branch components are:
 - `default_branch`
 - `current_branch`
 
-Thus you can use below lua function to implement your router:
+Thus you can implement your router with below lua function:
 
 ```lua
 --- @param s string

lua/gitlinker.lua

@@ -38,9 +38,11 @@ local function _url_template_engine(lk, template)
     local close_pos = str.find(template, CLOSE_BRACE, open_pos + string.len(OPEN_BRACE))
     logger:ensure(
       type(close_pos) == "number" and close_pos > open_pos,
-      "failed to evaluate url template(%s) at pos %d",
-      vim.inspect(template),
-      open_pos + string.len(OPEN_BRACE)
+      string.format(
+        "failed to evaluate url template(%s) at pos %d",
+        vim.inspect(template),
+        open_pos + string.len(OPEN_BRACE)
+      )
     )
     table.insert(exprs, {
       plain = false,
@@ -81,10 +83,12 @@ local function _url_template_engine(lk, template)
         CURRENT_BRANCH = str.not_empty(lk.current_branch) and lk.current_branch or "",
       })
       logger:debug(
-        "|_url_template_engine| exp:%s, lk:%s, evaluated:%s",
-        vim.inspect(exp.body),
-        vim.inspect(lk),
-        vim.inspect(evaluated)
+        string.format(
+          "|_url_template_engine| exp:%s, lk:%s, evaluated:%s",
+          vim.inspect(exp.body),
+          vim.inspect(lk),
+          vim.inspect(evaluated)
+        )
       )
       table.insert(results, evaluated)
     end
@@ -121,18 +125,15 @@ local function _router(router_type, lk)
   local confs = configs.get()
   logger:ensure(
     type(confs._routers[router_type]) == "table",
-    "unknown router type %s!",
-    vim.inspect(router_type)
+    string.format("unknown router type %s!", vim.inspect(router_type))
   )
   logger:ensure(
     type(confs._routers[router_type].list_routers) == "table",
-    "invalid router type %s! 'list_routers' missing.",
-    vim.inspect(router_type)
+    string.format("invalid router type %s! 'list_routers' missing.", vim.inspect(router_type))
   )
   logger:ensure(
     type(confs._routers[router_type].map_routers) == "table",
-    "invalid router type %s! 'map_routers' missing.",
-    vim.inspect(router_type)
+    string.format("invalid router type %s! 'map_routers' missing.", vim.inspect(router_type))
   )
 
   for i, tuple in ipairs(confs._routers[router_type].list_routers) do
@@ -180,7 +181,10 @@ local function _router(router_type, lk)
       end
     end
   end
-  logger:ensure(false, "%s not support, please bind it in 'router'!", vim.inspect(lk.host))
+  logger:ensure(
+    false,
+    string.format("%s not support, please bind it in 'router'!", vim.inspect(lk.host))
+  )
   return nil
 end
 
@@ -219,9 +223,11 @@ local _link = function(opts)
   -- )
   logger:ensure(
     ok and str.not_empty(url),
-    "fatal: failed to generate permanent url from remote (%s): %s",
-    vim.inspect(lk.remote_url),
-    vim.inspect(url)
+    string.format(
+      "fatal: failed to generate permanent url from remote (%s): %s",
+      vim.inspect(lk.remote_url),
+      vim.inspect(url)
+    )
   )
 
   if opts.action then
@@ -242,10 +248,12 @@ local _link = function(opts)
     message = opts.message
   end
   logger:debug(
-    "|_link| message:%s, opts:%s, confs:%s",
-    vim.inspect(message),
-    vim.inspect(opts),
-    vim.inspect(confs)
+    string.format(
+      "|_link| message:%s, opts:%s, confs:%s",
+      vim.inspect(message),
+      vim.inspect(opts),
+      vim.inspect(confs)
+    )
   )
   if message then
     local msg = lk.file_changed and url .. " (lines can be wrong due to file change)" or url --[[@as string]]
@@ -295,10 +303,6 @@ local function setup(opts)
     file_log_name = "gitlinker.log",
   })
 
-  local logger = logging.get("gitlinker")
-
-  -- logger:debug("|setup| confs:%s", vim.inspect(confs))
-
   -- command
   vim.api.nvim_create_user_command(confs.command.name, function(command_opts)
     local r = range.make_range()