Weekly updates (#648)

* feat: allow using variables in redirect response (#647)
* fix(lsp): return "" if no item.value
* feat(cmd): do not display big responses
* fix(formatter): graphql deindentation
* feat(cmd): format json response on redirect
* fix(graphql): support multiline arguments
* feat: Mouse support for winbar ui (#653)

* feat: Mouse support for winbar ui
* feat: Mouse support for winbar ui (pr review)
* refact(ui): update icons
* fix(grammar): remove comments from body
---------

Co-authored-by: YaroSpace <5670940+YaroSpace@users.noreply.github.com>
Co-authored-by: BenTriByte <6076614+huantrinh1802@users.noreply.github.com>
Co-authored-by: Aquib Javed <77913442+tamton-aquib@users.noreply.github.com>

Author: 3 people

NEWS.md

@@ -1,5 +1,11 @@
 # Kulala News
 
+## Version 5.3.3
+
+### Feature: support variables in redirect response path
+### Feature: do not display big responses + `max_response_size` config option
+### Feature: format json response on redirect
+
 ## Version 5.3.2
 
 ### Enhancement: support url encoding in scheme, authority, path

docs/docs/getting-started/configuration-options.mdx

@@ -448,6 +448,12 @@ Generate a bug report on error.
 
 Default: `false`
 
+### format_json_on_redirect
+
+Format json response when redirecting to file
+
+Default: `true`
+
 ## Scripts
 
 ### scripts.node_path_resolver
@@ -531,8 +537,8 @@ Example:
         width = 80,
         height = 20,
         split = "vertical",
-        bo = { foldmethod = "indent" }, -- buffer options
-        wo = { number = true, wrap = true }, -- window options
+        bo = { number = true, wrap = true }, -- buffer options
+        wo = { foldmethod = "indent" }, -- window options
       },
     },
   },
@@ -777,6 +783,12 @@ Example:
 }
 ```
 
+### ui.max_response_size
+
+Do not show responses over maximum size, in bytes
+
+Default: `32000`
+
 ### ui.show_request_summary
 
 Enable/disable request summary in the output window.

docs/docs/getting-started/requirements.md

@@ -32,6 +32,12 @@ List of requirements for using kulala.
 
 (Only required for formatted JSON responses)
 
+## prettier
+
+- [prettier](https://prettier.io)
+
+(Only required for formatting GraphQL)
+
 ## xmllint
 
 - [xmllint][xmllint] (tested with libxml v20914)
@@ -54,5 +60,20 @@ vim.filetype.add({
 
 This will make Neovim recognize files with the `.http` extension as HTTP files.
 
-[ts]: https://github.com/nvim-treesitter/nvim-treesitter?tab=readme-ov-file#supported-languages
+[ts]: https://github.com/nvim-treesitter/nvim-treesitter
+
+Kulala.nvim comes with a parser compiled with the latest version of treesitter. 
+
+If you have Neovim `0.10.x`, you might get an error `ABI version mismatch for kulala_http.so: supported between 13 and 14, found 15`.
+
+You need to install `tree-sitter CLI` and recompile the parser:
+
+1. Delete the existing parser at `nvim-treesitter/parser/kulala_http`
+2. Install the `tree-sitter CLI` (if not installed already):
+    - from distribution repositories
+    - or from https://github.com/tree-sitter/tree-sitter/tree/master/crates/cli
+3. Recompile the parser:
+    - Open a  `http` file in Neovim (this will load Kulala)
+    - Run `:TSInstallFromGrammar kulala_http`
+   
 [xmllint]: https://packages.ubuntu.com/noble/libxml2-utils

lua/kulala/cmd/export.lua

@@ -482,7 +482,7 @@ M.export_requests = function(action)
   local file = vim.fn.fnamemodify(path, ":t:r") .. ".json"
   file = (export_type == "folder" and path or vim.fn.fnamemodify(path, ":p:h")) .. "/" .. file
 
-  if Fs.write_json(file, collection, true, true) then Logger.info("Exported collection: " .. file) end
+  if Fs.write_json(file, collection, { escape = true }) then Logger.info("Exported collection: " .. file) end
 
   return collection
 end

lua/kulala/cmd/formatter.lua

@@ -13,14 +13,15 @@ local function capitalize(str)
   return str:lower():gsub("^%l", string.upper):gsub("%-%l", string.upper)
 end
 
-local function trim(str)
-  str = str or ""
-  str = str:gsub("^%s+", ""):gsub("%s+$", ""):gsub("[ \t]+", " ")
-  return str
+local function trim(str, collapse)
+  str = (str or ""):gsub("^%s+", ""):gsub("%s+$", "")
+  return collapse and str:gsub("[ \t]+", " ") or str
 end
 
-local function get_text(node)
-  return trim(ts.get_node_text(node, buf))
+local function get_text(node, collapse)
+  collapse = collapse == nil and true or collapse
+  local text = ts.get_node_text(node, buf)
+  return trim(text, collapse) or text
 end
 
 local function get_fields(node, names)
@@ -267,7 +268,7 @@ format_rules = {
   end,
 
   ["raw_body"] = function(node)
-    local body = get_text(node)
+    local body = get_text(node, false)
 
     local request = current_section().request
     request.body = #request.body > 0 and (request.body .. "\n\n" .. body) or body
@@ -276,7 +277,7 @@ format_rules = {
   end,
 
   ["multipart_form_data"] = function(node)
-    local body = get_text(node)
+    local body = get_text(node, false)
 
     local request = current_section().request
     request.body = #request.body > 0 and (request.body .. "\n\n" .. body) or body
@@ -285,7 +286,7 @@ format_rules = {
   end,
 
   ["xml_body"] = function(node)
-    local body = get_text(node)
+    local body = get_text(node, false)
 
     local formatted = Formatter.xml(body) or body
     formatted = formatted:gsub("\n*$", "")
@@ -297,7 +298,7 @@ format_rules = {
   end,
 
   ["json_body"] = function(node)
-    local json = get_text(node)
+    local json = get_text(node, false)
 
     if format_opts.quote_json_variables then
       local lcurly, rcurly = "X7BX7B", "X7DX7D"
@@ -324,7 +325,8 @@ format_rules = {
   end,
 
   ["graphql_data"] = function(node)
-    local body = get_text(node)
+    local body = get_text(node, false)
+
     local formatted = Formatter.graphql(body, { sort = format_opts.sort.json }) or body
     formatted = formatted:gsub("\n*$", "")
 
@@ -344,16 +346,16 @@ format_rules = {
   end,
 
   ["pre_request_script"] = function(node)
-    local script = get_text(node)
-    script = script:gsub("\n", "\n  "):gsub("\n  %%}", "\n%%}")
+    local script = get_text(node, false)
+    script = script:gsub("\n", "\n  "):gsub("\n%s+%%}", "\n%%}")
 
     table.insert(current_section().request.pre_request_script, script)
     return script
   end,
 
   ["res_handler_script"] = function(node)
-    local script = get_text(node)
-    script = script:gsub("\n", "\n  "):gsub("\n  %%}", "\n%%}")
+    local script = get_text(node, false)
+    script = script:gsub("\n", "\n  "):gsub("\n%s+%%}", "\n%%}")
 
     table.insert(current_section().request.res_handler_script, script)
     return script

lua/kulala/cmd/init.lua

@@ -176,6 +176,16 @@ local function inject_payload(errors, request)
   return table.concat(lines, "\n")
 end
 
+local function get_body()
+  local max_size = CONFIG.get().ui.max_response_size
+  if vim.fn.getfsize(GLOBALS.BODY_FILE) > max_size then
+    FS.write_file(GLOBALS.HEADERS_FILE, "Content-Type: text/plain", true)
+    return "The size of response is > " .. max_size / 1000 .. "Kb.\nPath to response: " .. GLOBALS.BODY_FILE
+  else
+    return FS.read_file(GLOBALS.BODY_FILE) or ""
+  end
+end
+
 local function save_response(request_status, parsed_request)
   local buf = DB.get_current_buffer()
   local line = parsed_request.show_icon_line_number or 0
@@ -202,7 +212,7 @@ local function save_response(request_status, parsed_request)
     time = vim.fn.localtime(),
     duration = request_status.duration or 0,
     body = "",
-    body_raw = FS.read_file(GLOBALS.BODY_FILE) or "",
+    body_raw = get_body(),
     json = {},
     filtered = nil,
     headers = FS.read_file(GLOBALS.HEADERS_FILE) or "",

lua/kulala/cmd/lsp.lua

@@ -26,17 +26,17 @@ local trigger_chars = { "@", "#", "-", ":", "{", "$", ">", "<", ".", "(", '"' }
 
 local function make_item(label, description, kind, detail, documentation, text, format, score)
   return {
-    label = label,
+    label = label or "",
     labelDetails = {
-      description = description,
+      description = description or "",
     },
-    kind = kind,
-    detail = detail,
+    kind = kind or "",
+    detail = detail or "",
     documentation = {
-      value = documentation,
+      value = documentation or "",
       kind = vim.lsp.protocol.MarkupKind.Markdown,
     },
-    insertText = text,
+    insertText = text or "",
     insertTextFormat = format or lsp_format.PlainText,
     sortText = score or tostring(1.02), -- fix for blink.cmp
   }

lua/kulala/config/defaults.lua

@@ -64,6 +64,9 @@ local M = {
     },
   },
 
+  -- format json response when redirecting to file
+  format_json_on_redirect = true,
+
   scripts = {
     -- Resolves "NODE_PATH" environment variable for node scripts. Defaults to the first "node_modules" directory found upwards from "script_file_dir".
     node_path_resolver = nil, ---@type fun(http_file_dir: string, script_file_dir: string, script_data: ScriptData): string|nil
@@ -116,6 +119,9 @@ local M = {
     -- disable notifications of script output
     disable_script_print_output = false,
 
+    -- do not show responses over maximum size, in bytes
+    max_response_size = 32000,
+
     report = {
       -- possible values: true | false | "on_error"
       show_script_output = true,

lua/kulala/config/init.lua

@@ -17,8 +17,8 @@ M.options = M.defaults
 
 local function set_signcolumn_icons()
   vim.fn.sign_define {
-    { name = "kulala.done", text = M.options.icons.inlay.done },
-    { name = "kulala.error", text = M.options.icons.inlay.error },
+    { name = "kulala.done", text = M.options.icons.inlay.done, texthl = "String" },
+    { name = "kulala.error", text = M.options.icons.inlay.error, texthl = "ErrorMsg" },
     { name = "kulala.loading", text = M.options.icons.inlay.loading },
     { name = "kulala.space", text = " " },
   }

lua/kulala/formatter/init.lua

@@ -1,12 +1,12 @@
 local Config = require("kulala.config")
-local Graphql = require("kulala.parser.graphql")
 local Logger = require("kulala.logger")
 local Shell = require("kulala.cmd.shell_utils")
 
 local M = {}
 
 M.format = function(formatter, contents, opts)
   opts = vim.tbl_deep_extend("keep", opts or {}, {
+    escape = true,
     verbose = true,
   })
 
@@ -29,7 +29,7 @@ M.format = function(formatter, contents, opts)
 
   if not result or result.code ~= 0 or result.stderr ~= "" or result.stdout == "" then return contents end
 
-  return result.stdout
+  return opts.escape and result.stdout or result.stdout:gsub("\\/", "/"):gsub('\\"', '"')
 end
 
 M.json = function(contents, opts)
@@ -50,16 +50,7 @@ M.graphql = function(contents, opts)
   local formatter = Config.get().contenttypes["application/graphql"]
   if not (formatter and type(formatter.formatter) == "table") then return contents end
 
-  local _, json = Graphql.get_json(contents)
-  if not json then return contents end
-
-  local formatted = M.format(formatter.formatter, json.query, opts)
-
-  if json.variables and next(json.variables) then
-    formatted = formatted .. "\n" .. M.json(json.variables, { sort = opts.sort })
-  end
-
-  return formatted
+  return M.format(formatter.formatter, contents, opts)
 end
 
 M.html = function(contents, opts)