(release)!: Version 2.0.0 (dmmulroy#35)

* Adds `watch mode` support along with `auto_focus_qflist` and auto_start_watch_mode` as configuration options
* Adds `pretty ts errors mode` along with `pretty_errors` configuration option


---------
Co-authored-by: Dillon Mulroy <dillon.mulroy@gmail.com>
Co-authored-by: pmwals09 <pmwals09@gmail.com>
Co-authored-by: Alessandro Senese <senesealessandro@gmail.com>

Author: 3 people

README.md

@@ -1,4 +1,5 @@
 # tsc.nvim
+
 <img width="569" alt="image" src="https://user-images.githubusercontent.com/2755722/233876554-efb9cfe6-c038-46c8-a7cb-b7a4aa9eac5b.png">
 
 This Neovim plugin provides an asynchronous interface to run project-wide TypeScript type-checking using the TypeScript compiler (`tsc`). It displays the type-checking results in a quickfix list and provides visual notifications about the progress and completion of type-checking.
@@ -65,6 +66,8 @@ require('tsc').setup()
 
 To run TypeScript type-checking, execute the `:TSC` command in Neovim. The plugin will display a progress notification while the type-checking is in progress. When the type-checking is complete, it will show a notification with the results and open a quickfix list if there are any errors.
 
+If `watch` mode is enabled, tsc.nvim will automatically run in the background every time you save in a typescript or tsx file and report the results back to you. In addition, if `auto_start_watch_mode` is enabled, the `:TSC` command will be executed on your behalf when you enter a typescript or tsx files.
+
 ## 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:
@@ -73,28 +76,32 @@ By default, the plugin uses the default `tsc` command with the `--noEmit` flag t
 {
   auto_open_qflist = true,
   auto_close_qflist = false,
+  auto_focus_qflist = false,
+  auto_start_watch_mode = false,
   bin_path = utils.find_tsc_bin(),
   enable_progress_notifications = true,
   flags = {
     noEmit = true,
     project = function()
       return utils.find_nearest_tsconfig()
     end,
+    watch = false,
   },
   hide_progress_notifications_from_history = true,
   spinner = { "⣾", "⣽", "⣻", "⢿", "⡿", "⣟", "⣯", "⣷" },
+  pretty_errors = true,
 }
 ```
 
-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:
+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`), provide a function (as in the case of the `project`) or enable watch mode. 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?
+### I'm using `nvim-notify` and being spammed by progress notifications, what's going on?
 
 It's likely that the overwritten default `vim.notify` function isn't returning `nvim-notify`'s notification record, which is used to replace the existing notification. Make sure that you're nvim-notify configuration looks something like this:
 

lua/tsc/better-messages-test.lua

@@ -0,0 +1,48 @@
+local bm = require("tsc.better-messages")
+
+describe("Does the basics", function()
+  it("Replaces the original text with the correct md file text", function()
+    local original_message = "TS7061: A mapped type may not declare properties or methods"
+    local expected_message = "TS7061: You're trying to create a mapped type with both static and dynamic properties."
+    assert.equals(expected_message, bm.translate(original_message))
+  end)
+end)
+
+describe("Handles slots", function()
+  it("Handles a message with one slot", function()
+    local original_message = "TS2604: JSX element type 'BadComponent' does not have any construct or call signatures."
+    local expected_message = "TS2604: 'BadComponent' cannot be used as a JSX component because it isn't a function."
+    assert.equals(expected_message, bm.translate(original_message))
+  end)
+  it("Handles a message with multiple slots", function()
+    local original_message = "TS2551: Property 'foo' does not exist on type 'bar'. Did you mean 'baz'?"
+    local expected_message =
+      "TS2551: You're trying to access 'foo' on an object that doesn't contain it. Did you mean 'baz'?"
+    assert.equals(expected_message, bm.translate(original_message))
+  end)
+end)
+
+describe("Handles links", function()
+  it("Removes a 'read more' link", function()
+    local original_message = "TS7006: Parameter 'foo' implicitly has an 'bar' type."
+    -- check 7006.md to see original pretty message with link
+    local expected_message =
+      "TS7006: I don't know what type 'foo' is supposed to be, so I've defaulted it to 'bar'. Your `tsconfig.json` file says I should throw an error here."
+    assert.equals(expected_message, bm.translate(original_message))
+  end)
+  it("Removes a 'this article' link and sentence", function()
+    local original_message =
+      "TS7053: Element implicitly has an 'any' type because expression of type 'foo' can't be used to index type 'bar'."
+    -- check 7053.md to see original pretty message with link
+    local expected_message = "TS7053: You can't use 'foo' to index into 'bar'."
+    assert.equals(expected_message, bm.translate(original_message))
+  end)
+  it("Handles removes other links href, keeps link text", function()
+    local original_message =
+      "TS1268: An index signature parameter type must be 'string', 'number', 'symbol', or a template literal type."
+    -- check 1268.md to see original pretty message with link
+    local expected_message =
+      "TS1268: Objects in TypeScript (and JavaScript!) can only have strings, numbers or symbols as keys. Template literal types are a way of constructing strings."
+    assert.equals(expected_message, bm.translate(original_message))
+  end)
+end)

lua/tsc/better-messages.lua

@@ -0,0 +1,110 @@
+-- Module M for better error message handling
+local M = {}
+
+-- Regex pattern for capturing numbered parameters like {0}, {1}, etc.
+local parameter_regex = "({%d})"
+
+-- Extracts parameter placeholders from a given error template.
+-- @param error_template string: The template string containing parameter placeholders.
+-- @return table: A list of all parameter placeholders found in the template.
+local function get_params(error_template)
+  local params = {}
+  for param in error_template:gmatch(parameter_regex) do
+    table.insert(params, param)
+  end
+  return params
+end
+
+-- Extracts quoted strings from a given message.
+-- @param message string: The message string containing quoted parts.
+-- @return table: A list of all quoted strings found in the message.
+local function get_matches(message)
+  local matches = {}
+
+  for match in string.gmatch(message, "'(.-)'") do
+    table.insert(matches, match)
+  end
+
+  return matches
+end
+
+-- Constructs a better error message by replacing placeholders in the template with actual values.
+-- @param error_msg string: The original error message.
+-- @param error_template string: The error template with placeholders.
+-- @param better_error_template string: The improved error message template.
+-- @return string: The improved error message, or original if replacement isn't possible.
+local function better_error_message(error_msg, error_template, better_error_template)
+  local matches = get_matches(error_msg)
+  local params = get_params(error_template)
+
+  if #params ~= #matches then
+    return error_msg
+  end
+
+  local better_error = better_error_template
+
+  for i = 1, #params do
+    better_error = better_error:gsub(params[i], matches[i])
+  end
+
+  return better_error
+end
+
+-- Retrieves a markdown file associated with a specific error number.
+-- @param error_num string: The error number identifier.
+-- @return file* | nil: The file pointer to the markdown file, if exists.
+local function get_error_markdown_file(error_num)
+  local filename = error_num .. ".md"
+  local plugin_path = vim.fn.fnamemodify(debug.getinfo(1).source:sub(2), ":p:h")
+  return io.open(plugin_path .. "/better-messages/" .. filename, "r")
+end
+
+-- Parses a markdown file to extract 'original' and 'better' content.
+-- @param markdown file*: The markdown file pointer.
+-- @return table: A table with 'original' and 'better' keys containing extracted contents.
+local function parse_md(markdown)
+  local contents = markdown:read("*all")
+  markdown:close()
+
+  -- First, remove the leading and trailing '---'
+  local trimmedMarkdown = contents:gsub("^%-%-%-%s*", ""):gsub("%s*%-%-%-$", "")
+
+  -- Split the remaining content at the '---' separator
+  local originalContent, betterContent = trimmedMarkdown:match("^(.-)%s*%-%-%-%s*(.-)$")
+
+  -- Trim whitespace from both contents
+  originalContent = originalContent:gsub('^original:%s*"(.-)"%s*$', "%1")
+  betterContent = betterContent:gsub("^%s*(.-)%s*$", "%1")
+
+  -- Return the table with the extracted contents
+  return {
+    original = originalContent,
+    better = betterContent,
+  }
+end
+
+-- Attempt to translate a given compiler message into a better one.
+-- @param message string: The original compiler message to parse.
+-- @return string: The improved or original error message.
+M.translate = function(message)
+  local error_num, original_message = message:match("^.*TS(%d+):%s(.*)")
+  local improved_text_file = get_error_markdown_file(error_num)
+  if improved_text_file == nil then
+    return message
+  end
+
+  local parsed = parse_md(improved_text_file)
+
+  local params = get_params(parsed["original"])
+
+  if #params == 0 then
+    return "TS" .. error_num .. ": " .. parsed.body
+  end
+
+  local better_error = better_error_message(original_message, parsed["original"], parsed["better"])
+
+  return "TS" .. error_num .. ": " .. better_error
+end
+
+-- Returning the module M.
+return M

lua/tsc/better-messages/1002.md

@@ -0,0 +1,5 @@
+---
+original: 'Unterminated string literal.'
+---
+
+You've started a string (via a single or double quote) but haven't ended it.

lua/tsc/better-messages/1003.md

@@ -0,0 +1,5 @@
+---
+original: 'Identifier expected.'
+---
+
+I was expecting a name but none was provided.

lua/tsc/better-messages/1006.md

@@ -0,0 +1,5 @@
+---
+original: 'A file cannot have a reference to itself.'
+---
+
+You've got a triple-slash reference inside a file that's referencing itself.

lua/tsc/better-messages/1009.md

@@ -0,0 +1,5 @@
+---
+original: 'Trailing comma not allowed.'
+---
+
+You've added a trailing comma when you're not supposed to add it.

lua/tsc/better-messages/1014.md

@@ -0,0 +1,5 @@
+---
+original: 'A rest parameter must be last in a parameter list.'
+---
+
+A parameter in a function that starts with `...` must be the last one in the list.

lua/tsc/better-messages/1015.md

@@ -0,0 +1,5 @@
+---
+original: 'Parameter cannot have question mark and initializer.'
+---
+
+You can use a question mark or an default value, but not both at once.

lua/tsc/better-messages/1091.md

@@ -0,0 +1,5 @@
+---
+original: "Only a single variable declaration is allowed in a 'for...in' statement."
+---
+
+You can only create a single variable in a 'for...in' statement