bug: Fix qflist and monorepo support (dmmulroy#20)

* bug: fix file path reference in qflist to prevent opening to empty buffers
* bug: fix monorepo support by defaulting to using neared tsconfig to open buffer
* feat: support flags as a table that accepts flag names as keys and values as strings, booleans, or functions

Author: dmmulroy

README.md

@@ -71,18 +71,29 @@ To run TypeScript type-checking, execute the `:TSC` command in Neovim. The plugi
 
 ## Configuration
 
-By default it uses the default `tsc` command with the `--noEmit` flag to avoid generating output files during type-checking. Here's the default configuration:
+By default, the plugin uses the default `tsc` command with the `--noEmit` flag to avoid generating output files during type-checking. It also emulates the default tsc behavior of performing a backward search from the current directory for a `tsconfig` file. The flags option can accept both a string and a table. Here's the default configuration:
 
 ```lua
 {
   auto_open_qflist = true,
   enable_progress_notifications = true,
-  flags = "--noEmit",
+  flags = {
+    noEmit = true,
+    project = function()
+      return utils.find_nearest_tsconfig()
+    end,
+  },
   hide_progress_notifications_from_history = true,
   spinner = { "⣾", "⣽", "⣻", "⢿", "⡿", "⣟", "⣯", "⣷" },
 }
 ```
 
+With this configuration, you can use keys for flag names and their corresponding values to enable/disable the flag (in the case of `noEmit = true`) or provide a function (as in the case of the `project`). This makes the configuration more explicit and easier to read. Additionally, the flags option is backwards compatible and can accept a string value if you prefer a simpler configuration:
+
+```lua
+flags = "--noEmit",
+```
+
 ## FAQs
 
 ### I'm using `nvim-notify` and being spammed by progress notifcations, what's going on?
@@ -98,16 +109,20 @@ end
 
 ```
 
-### Why doesn't `tsc.nvim` typecheck my entire monorepo?
+### Why doesn't tsc.nvim typecheck my entire monorepo?
 
-In a monorepo setup, tsc.nvim only typechecks the current project by default because it uses the tsconfig.json of the current directory. If you need to typecheck across all projects in the monorepo, you must change the flags configuration option in the setup function from --noEmit to --build --composite. The --build flag instructs TypeScript to typecheck all referenced projects and the --composite flag enables project references and incremental builds for better management of dependencies and build performance. Your adjusted setup function should look like this:
+In a monorepo setup, tsc.nvim only typechecks the project associated with the nearest `tsconfig.json` by default. If you need to typecheck across all projects in the monorepo, you must change the flags configuration option in the setup function to include `--build`. The `--build` flag instructs TypeScript to typecheck all referenced projects, taking into account project references and incremental builds for better management of dependencies and build performance. Your adjusted setup function should look like this:
 
 ```lua
 require('tsc').setup({
-  flags = "--build --composite",
+  flags = {
+    build = true,
+  },
 })
 ```
 
+With this configuration, tsc.nvim will typecheck all projects in the monorepo, taking into account project references and incremental builds.
+
 ## Contributing
 
 Feel free to open issues or submit pull requests if you encounter any bugs or have suggestions for improvements. Your contributions are welcome!

lua/tsc/init.lua

@@ -9,12 +9,15 @@ if success then
   nvim_notify = pcall_result
 end
 
-local is_running = false
-
 local DEFAULT_CONFIG = {
   auto_open_qflist = true,
   enable_progress_notifications = true,
-  flags = "--noEmit",
+  flags = {
+    noEmit = true,
+    project = function()
+      return utils.find_nearest_tsconfig()
+    end,
+  },
   hide_progress_notifications_from_history = true,
   spinner = { "⣾", "⣽", "⣻", "⢿", "⡿", "⣟", "⣯", "⣷" },
 }
@@ -25,6 +28,7 @@ local DEFAULT_NOTIFY_OPTIONS = {
 }
 
 local config = {}
+local is_running = false
 
 local function get_notify_options(...)
   local overrides = {}
@@ -38,42 +42,6 @@ local function get_notify_options(...)
   return vim.tbl_deep_extend("force", {}, DEFAULT_NOTIFY_OPTIONS, overrides)
 end
 
-local function set_qflist(errors)
-  vim.fn.setqflist({}, "r", { title = "TSC", items = errors })
-
-  if #errors > 0 and config.auto_open_qflist then
-    vim.cmd("copen")
-  end
-end
-
-local function parse_tsc_output(output)
-  local errors = {}
-  local files = {}
-
-  if output == nil then
-    return { errors = errors, files = files }
-  end
-
-  for _, line in ipairs(output) do
-    local filename, lineno, colno, message = line:match("^(.+)%((%d+),(%d+)%)%s*:%s*(.+)$")
-    if filename ~= nil then
-      table.insert(errors, {
-        filename = filename,
-        lnum = tonumber(lineno),
-        col = tonumber(colno),
-        text = message,
-        type = "E",
-      })
-
-      if vim.tbl_contains(files, filename) == false then
-        table.insert(files, filename)
-      end
-    end
-  end
-
-  return { errors = errors, files = files }
-end
-
 local function format_notification_msg(msg, spinner_idx)
   if spinner_idx == 0 or spinner_idx == nil then
     return string.format(" %s ", msg)
@@ -84,14 +52,14 @@ end
 
 M.run = function()
   -- Closed over state
-  local cmd = utils.get_tsc_cmd()
+  local tsc = utils.find_tsc_bin()
   local errors = {}
   local files_with_errors = {}
   local notify_record
   local notify_called = false
   local spinner_idx = 0
 
-  if not utils.is_executable(cmd) then
+  if not utils.is_executable(tsc) then
     vim.notify(
       format_notification_msg(
         "tsc was not available or found in your node_modules or $PATH. Please run install and try again."
@@ -140,12 +108,12 @@ M.run = function()
   end
 
   local function on_stdout(_, output)
-    local result = parse_tsc_output(output)
+    local result = utils.parse_tsc_output(output)
 
     errors = result.errors
     files_with_errors = result.files
 
-    set_qflist(errors)
+    utils.set_qflist(errors, config.auto_open_qflist)
   end
 
   local on_exit = function()
@@ -184,20 +152,18 @@ M.run = function()
     stdout_buffered = true,
   }
 
-  vim.fn.jobstart(cmd .. " " .. config.flags, opts)
+  vim.fn.jobstart(tsc .. " " .. utils.parse_flags(config.flags), opts)
 end
 
 function M.is_running()
   return is_running
 end
 
 function M.setup(opts)
-  config = vim.tbl_deep_extend("force", config, DEFAULT_CONFIG, opts or {})
+  config = vim.tbl_extend("force", config, DEFAULT_CONFIG, opts or {})
 
   vim.api.nvim_create_user_command("TSC", function()
-    vim.cmd("silent cd %:h")
     M.run()
-    vim.cmd("silent cd-")
   end, { desc = "Run `tsc` asynchronously and load the results into a qflist", force = true })
 end
 

lua/tsc/utils.lua

@@ -4,7 +4,7 @@ M.is_executable = function(cmd)
   return cmd and vim.fn.executable(cmd) == 1 or false
 end
 
-M.get_tsc_cmd = function()
+M.find_tsc_bin = function()
   local node_modules_tsc_binary = vim.fn.findfile("node_modules/.bin/tsc", ".;")
 
   if node_modules_tsc_binary ~= "" then
@@ -14,4 +14,88 @@ M.get_tsc_cmd = function()
   return "tsc"
 end
 
+M.find_nearest_tsconfig = function()
+  local tsconfig = vim.fn.findfile("tsconfig.json", ".;")
+
+  if tsconfig ~= "" then
+    return tsconfig
+  end
+
+  return nil
+end
+
+M.parse_flags = function(flags)
+  if type(flags) == "string" then
+    return flags
+  end
+
+  local parsed_flags = ""
+
+  for key, value in pairs(flags) do
+    key = string.gsub(key, "%-%-", "")
+
+    if type(value) == "function" then
+      value = value()
+    end
+
+    if type(value) ~= "string" and type(value) ~= "boolean" then
+      vim.notify(
+        string.format(
+          "Skipping flag '%s' because of an invalid value. Valid values include strings, booleans, or a function that returns a string or boolean.",
+          key
+        ),
+        vim.log.levels.ERROR
+      )
+    else
+      if type(value) == "boolean" then
+        if value == true then
+          parsed_flags = parsed_flags .. string.format("--%s ", key)
+        end
+      else
+        parsed_flags = parsed_flags .. string.format("--%s %s ", key, value)
+      end
+    end
+  end
+
+  return parsed_flags
+end
+
+M.parse_tsc_output = function(output)
+  local errors = {}
+  local files = {}
+
+  if output == nil then
+    return { errors = errors, files = files }
+  end
+
+  for _, line in ipairs(output) do
+    local filename, lineno, colno, message = line:match("^(.+)%((%d+),(%d+)%)%s*:%s*(.+)$")
+    if filename ~= nil then
+      table.insert(errors, {
+        filename = filename,
+        lnum = tonumber(lineno),
+        col = tonumber(colno),
+        text = message,
+        type = "E",
+      })
+
+      if vim.tbl_contains(files, filename) == false then
+        table.insert(files, filename)
+      end
+    end
+  end
+
+  return { errors = errors, files = files }
+end
+
+M.set_qflist = function(errors, auto_open)
+  auto_open = auto_open or true
+
+  vim.fn.setqflist({}, "r", { title = "TSC", items = errors })
+
+  if #errors > 0 and auto_open then
+    vim.cmd("copen")
+  end
+end
+
 return M