docs(usage): fold api section (#219)

.github/workflows/ci.yml

@@ -88,7 +88,7 @@ jobs:
         shell: bash
         run: |
           luarocks install vusted
-          vusted --shuffle ./spec
+          vusted ./spec
   code_coverage:
     name: Code Coverage
     needs:

README.md

@@ -138,6 +138,10 @@ There're several arguments:
 >
 > Highly recommend reading [Customize Urls](#customize-urls) before this section, which helps understanding the router design of this plugin.
 
+<details>
+<summary><i>Click here to see lua api</i></summary>
+<br/>
+
 You can also use the `link` API to generate git permlink:
 
 ```lua
@@ -148,7 +152,7 @@ You can also use the `link` API to generate git permlink:
 require("gitlinker").link(opts)
 ```
 
-#### Parameters:
+**Parameters:**
 
 - `opts`: (Optional) lua table that contains below fields:
 
@@ -222,7 +226,9 @@ require("gitlinker").link({
 })
 ```
 
-> The `link` API is running in async way because it uses lua coroutine to avoid editor blocking.
+> The `link` API is running in async mode and cannot directly returns the generated link, because it uses lua coroutine to avoid blocking IO.
+
+</details>
 
 ### Recommended Key Mappings
 

lua/gitlinker/commons/str.lua

@@ -126,7 +126,7 @@ M.split = function(s, sep, opts)
   assert(type(sep) == "string")
   opts = opts or {
     plain = true,
-    trimempty = true,
+    trimempty = false,
   }
   opts.plain = type(opts.plain) == "boolean" and opts.plain or true
   opts.trimempty = type(opts.trimempty) == "boolean" and opts.trimempty or false

lua/gitlinker/commons/version.txt

@@ -1 +1 @@
-11.0.1
+11.0.2

spec/gitlinker_spec.lua

@@ -5,11 +5,14 @@ describe("gitlinker", function()
   local assert_true = assert.is_true
   local assert_false = assert.is_false
 
-  vim.opt.swapfile = false
-  vim.api.nvim_command("cd " .. cwd)
-  vim.cmd([[ edit lua/gitlinker.lua ]])
+  before_each(function()
+    vim.api.nvim_command("cd " .. cwd)
+    vim.opt.swapfile = false
+    vim.cmd([[edit lua/gitlinker.lua]])
+  end)
+
   local gitlinker = require("gitlinker")
-  gitlinker.setup({
+  pcall(gitlinker.setup, {
     debug = true,
     file_log = true,
     router = {
@@ -52,19 +55,6 @@ describe("gitlinker", function()
     },
   })
 
-  before_each(function() end)
-  after_each(function()
-    local done = false
-    vim.defer_fn(function()
-      done = true
-    end, 100)
-    for i = 1, 50 do
-      vim.wait(10, function()
-        return done
-      end)
-    end
-  end)
-
   local routers = require("gitlinker.routers")
 
   describe("[_url_template_engine]", function()