🐛fix(args): All generators now accept a option to pass arguments dire…

…ctly to the command to generate documentation.
Zeioth · Jan 12, 2024 · ad5b4d4 · ad5b4d4
1 parent 9dc8c56
commit ad5b4d4
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 13 deletions.
diff --git a/lua/dooku/backends/doxygen.lua b/lua/dooku/backends/doxygen.lua
@@ -32,7 +32,7 @@ function M.generate(is_autocmd)
   if job then uv.process_kill(job, 9) end -- Running already? kill it
   job = uv.spawn(
     "doxygen",
-    { args = { "Doxyfile", config.doxygen_args }, cwd = doxygen_dir, detach = true }
+    { args = config.doxygen_args , cwd = doxygen_dir, detach = true }
   )
 
   -- Open html docs

diff --git a/lua/dooku/backends/godoc.lua b/lua/dooku/backends/godoc.lua
@@ -23,7 +23,7 @@ function M.generate(is_autocmd)
         vim.log.levels.INFO, {title="dooku.nvim"})
     end
 
-    job = vim.fn.jobstart('godoc ' .. config.godoc_args, { cwd = cwd })
+    job = uv.spawn("godoc", { args = config.godoc_args, cwd = cwd, detach = true })
     autocmd("VimLeavePre", {
       desc = "Stop godoc when exiting vim",
       group = augroup("dooku_stop_godoc", { clear = true }),

diff --git a/lua/dooku/backends/jsdoc.lua b/lua/dooku/backends/jsdoc.lua
@@ -30,7 +30,7 @@ function M.generate(is_autocmd)
 
   if job then uv.process_kill(job, 9) end -- Running already? kill it
   job = uv.spawn(
-    "jsdoc", { args = { "-c", "jsdoc.json" }, cwd = cwd, detach = true }
+    "jsdoc", { args = config.jsdoc_args , cwd = cwd, detach = true }
   )
 
   -- Open html docs

diff --git a/lua/dooku/backends/rustdoc.lua b/lua/dooku/backends/rustdoc.lua
@@ -25,7 +25,7 @@ function M.generate(is_autocmd)
     if job then uv.process_kill(job, 9) end -- Running already? kill it
     job = uv.spawn(
       "cargo",
-      { args = {"rustdoc", config.cargo_rustdoc_args, "--", config.rustdoc_args}, cwd = cwd, detach = true }
+      { args = config.rustdoc_args, cwd = cwd, detach = true }
     )
 
     -- Open html docs

diff --git a/lua/dooku/backends/typedoc.lua b/lua/dooku/backends/typedoc.lua
@@ -30,7 +30,7 @@ function M.generate(is_autocmd)
 
   if job then uv.process_kill(job, 9) end -- Running already? kill it
   job = uv.spawn(
-    "typedoc", { cwd = cwd, detach = true }
+    "typedoc", { args = config.typedoc_args, cwd = cwd, detach = true }
   )
 
   -- Open html docs

diff --git a/lua/dooku/config.lua b/lua/dooku/config.lua
@@ -72,8 +72,8 @@ function M.set(opts)
           M.doxygen_clone_to_dir .. "/README.md"
       )
 
-  -- Args for godoc
-  M.doxygen_args = opts.doxygen_args or ""
+  -- Args for doxygen
+  M.doxygen_args = opts.doxygen_args or { "Doxyfile" }
 
   -- [TYPEDOC]
   -- -----------------------------------------------------------------------
@@ -106,6 +106,9 @@ function M.set(opts)
         .. M.typedoc_clone_to_dir
       )
 
+  -- Args for typedoc
+  M.typedoc_args = opts.typedoc_args or { "" }
+
   -- [JSDOC]
   -- -----------------------------------------------------------------------
   M.jsdoc_filetypes = opts.jsdoc_filetypes or { "javascript" }
@@ -135,6 +138,9 @@ function M.set(opts)
         .. M.jsdoc_clone_to_dir
       )
 
+  -- Args for jsdoc
+  M.jsdoc_args = opts.jsdoc_args or { "-c", "jsdoc.json", "--readme", "README.md" }
+
   -- [RUSTDOC]
   -- -----------------------------------------------------------------------
   M.rustdoc_filetypes = opts.rustdoc_filetypes or { "rust" }
@@ -146,8 +152,7 @@ function M.set(opts)
   M.rustdoc_html_file = opts.rustdoc_html_file or "index.html"
 
   -- args for rustdoc
-  M.cargo_rustdoc_args = opts.cargo_rustdoc_args or ""
-  M.rustdoc_args = opts.rustdoc_args or ""
+  M.rustdoc_args = opts.rustdoc_args or { "rustdoc" }
 
   -- [GODOC]
   ---------------------------------------------------------------
@@ -157,13 +162,10 @@ function M.set(opts)
   M.godoc_html_url = opts.godoc_html_file or "localhost:6060"
 
   -- Args for godoc
-  M.godoc_args = opts.godoc_args or "-index"
+  M.godoc_args = opts.godoc_args or { "-index" }
 
   -- After setting the config
   ---------------------------------------------------------------
-  -- Convert empty string to nil where necessary
-  M.cargo_rustdoc_args = utils.sanitize_string(M.cargo_rustdoc_args)
-  M.rustdoc_args = utils.sanitize_string(M.rustdoc_args)
 
   -- expose the config as global
   vim.g.dooku_config = M