feat: remove external formatter, use gq instead

Author: boltlessengineer

README.md

@@ -37,6 +37,7 @@ CLI. For more information on this, please see this [blog post](https://amartin.c
 - Set custom pre-request and post-request hooks to dynamically interact with the data
 - Easily set environment variables based on the response to re-use the data later
 - Tree-sitter based parsing and syntax highlighting for speed and perfect accuracy
+- Format response body with native `gq` command
 - Possibility of using dynamic/environment variables and Lua scripting in HTTP files
 - Save received cookies and load them automatically
 
@@ -48,11 +49,7 @@ CLI. For more information on this, please see this [blog post](https://amartin.c
 
 ### Dependencies
 
-- System-wide
-  - `curl`
-- Optional [can be changed, see config below](#default-configuration)
-  - `jq`   (to format JSON output)
-  - `tidy` (to format HTML output)
+- `curl`
 
 ### [rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim) (recommended)
 
@@ -109,31 +106,9 @@ local default_config = {
     hooks = {
       ---@type boolean Decode the request URL segments on response UI to improve readability
       decode_url = true,
-      ---@type boolean Format the response body
+      ---@type boolean Format the response body using `gq` command
       format = true,
     },
-    ---@type table<string,RestResultFormatter>
-    formatters = {
-      json = "jq",
-      html = function(body)
-        if vim.fn.executable("tidy") == 0 then
-          return body, { found = false, name = "tidy" }
-        end
-        -- stylua: ignore
-        local fmt_body = vim.fn.system({
-          "tidy",
-          "-i",
-          "-q",
-          "--tidy-mark",      "no",
-          "--show-body-only", "auto",
-          "--show-errors",    "0",
-          "--show-warnings",  "0",
-          "-",
-        }, body):gsub("\n$", "")
-
-        return fmt_body, { found = true, name = "tidy" }
-      end,
-    },
   },
   ---@class rest.Config.Clients
   clients = {
@@ -160,7 +135,7 @@ local default_config = {
     ---@type boolean
     enable = true,
     ---@type string
-    pattern = "%.env.*"
+    pattern = ".*%.env.*"
   },
   ---@class rest.Config.UI
   ui = {

lua/rest-nvim/config/check.lua

@@ -30,7 +30,6 @@ function check.validate(cfg)
     ["request.hooks.encode_url"] = { cfg.request.hooks.encode_url, "boolean" },
     response = { cfg.response, "table" },
     ["response.hooks"] = { cfg.response.hooks, "table" },
-    ["response.formatters"] = { cfg.response.formatters, "table" },
     clients = { cfg.clients, "table" },
     ["clients.curl"] = { cfg.clients.curl, "table" },
     ["clients.curl.statistics"] = { cfg.clients.curl.statistics, "table" },

lua/rest-nvim/config/init.lua

@@ -16,8 +16,6 @@
 ---@type rest.Config
 local config
 
----@alias RestResultFormatter string|fun(body:string):string,table
-
 ---@class RestStatisticsStyle
 --- Title used on Statistics pane
 ---@field title? string
@@ -51,8 +49,6 @@ local config
 ---@class rest.Opts.Response
 --- Default response hooks (aka. request handlers) configuration
 ---@field hooks? rest.Opts.Response.Hooks
---- Formatters used for response format hook
----@field formatters? table<string,RestResultFormatter>
 
 ---@class rest.Opts.Response.Hooks
 --- Decode url segments on response UI too improve readability (Default: `true`)
@@ -125,31 +121,9 @@ local default_config = {
     hooks = {
       ---@type boolean Decode the request URL segments on response UI to improve readability
       decode_url = true,
-      ---@type boolean Format the response body
+      ---@type boolean Format the response body using `gq` command
       format = true,
     },
-    ---@type table<string,RestResultFormatter>
-    formatters = {
-      json = "jq",
-      html = function(body)
-        if vim.fn.executable("tidy") == 0 then
-          return body, { found = false, name = "tidy" }
-        end
-        -- stylua: ignore
-        local fmt_body = vim.fn.system({
-          "tidy",
-          "-i",
-          "-q",
-          "--tidy-mark",      "no",
-          "--show-body-only", "auto",
-          "--show-errors",    "0",
-          "--show-warnings",  "0",
-          "-",
-        }, body):gsub("\n$", "")
-
-        return fmt_body, { found = true, name = "tidy" }
-      end,
-    },
   },
   ---@class rest.Config.Clients
   clients = {

lua/rest-nvim/health.lua

@@ -64,41 +64,6 @@ local function configuration_health()
   else
     vim.health.ok("No unrecognized configuration options were found")
   end
-
-  -- Formatters
-  local formatters = config.response.formatters
-  for ft, formatter in pairs(formatters) do
-    if type(formatter) == "string" then
-      if vim.fn.executable(formatter) ~= 1 then
-        vim.health.warn(
-          "Formatter for `"
-            .. ft
-            .. "` is set to `"
-            .. formatter
-            .. "`, however, rest.nvim could not find it in your system"
-        )
-      else
-        vim.health.ok(
-          "Formatter for `" .. ft .. "` is set to `" .. formatter .. "` and rest.nvim found it in your system"
-        )
-      end
-    elseif type(formatter) == "function" then
-      local _, fmt_meta = formatter("")
-      if not fmt_meta.found then
-        vim.health.warn(
-          "Formatter for `"
-            .. ft
-            .. "` is set to `"
-            .. fmt_meta.name
-            .. "`, however, rest.nvim could not find it in your system"
-        )
-      else
-        vim.health.ok(
-          "Formatter for `" .. ft .. "` is set to `" .. fmt_meta.name .. "` and rest.nvim found it in your system"
-        )
-      end
-    end
-  end
 end
 
 function health.check()

lua/rest-nvim/response.lua

@@ -1,8 +1,5 @@
 local response = {}
 
-local config = require("rest-nvim.config")
-local logger = require("rest-nvim.logger")
-
 ---@class rest.Response
 ---@field status rest.Response.status
 ---@field body string?
@@ -14,51 +11,4 @@ local logger = require("rest-nvim.logger")
 ---@field version string
 ---@field text string
 
----Try format the result body
----@param content_type string?
----@param body string
----@return string[]
-function response.try_format_body(content_type, body)
-  ---@type string
-  local res_type
-  if content_type then
-    res_type = vim.split(content_type, "/")[2]:gsub(";.*", "")
-  end
-  if res_type == "octet-stream" then
-    return { "Binary answer" }
-  else
-    local formatters = config.response.formatters
-    local fmt = formatters[res_type]
-    if fmt then
-      if type(fmt) == "function" then
-        local ok, out = pcall(fmt, body)
-        if ok and out then
-          body = out
-        else
-          logger.error("Error calling formatter on response body:\n" .. out)
-        end
-      elseif vim.fn.executable(fmt[1] or fmt) then
-        local cmd = type(fmt) == "string" and { fmt } or fmt
-        ---@cast cmd string[]
-        local sc = vim.system(cmd, { stdin = body }):wait()
-        if sc.code == 0 and sc.stdout then
-          body = sc.stdout --[[@as string]]
-        else
-          logger.error("Error running formatter '" .. fmt .. "' on response body:\n" .. sc.stderr)
-          vim.notify("[rest.nvim] Formatting response body failed. See `:Rest logs` for more info", vim.log.levels.ERROR)
-        end
-      end
-    elseif res_type ~= nil then
-      local msg = (
-        "Could not find a formatter for the body type "
-          .. res_type
-          .. " returned in the request, the results will not be formatted"
-      )
-      logger.info(msg)
-      vim.notify(msg, vim.log.levels.INFO)
-    end
-    return vim.split(body, "\n", {trimempty = res_type == "json"})
-  end
-end
-
 return response

lua/rest-nvim/ui/result.lua

@@ -11,7 +11,6 @@ local ui = {}
 local config = require("rest-nvim.config")
 local utils = require("rest-nvim.utils")
 local paneui = require("rest-nvim.ui.panes")
-local res = require("rest-nvim.response")
 
 local function set_lines(buffer, lines)
   vim.api.nvim_buf_set_lines(buffer, 0, -1, false, lines)
@@ -70,12 +69,12 @@ local panes = {
         local content_type = data.response.headers["content-type"]
         table.insert(lines, "")
         table.insert(lines, "#+RES")
-        ---@type string[]
-        local body
-        if config.response.hooks.format then
-          body = res.try_format_body(content_type and content_type[1], data.response.body)
-        else
-          body = vim.split(data.response.body, "\n")
+        local body = vim.split(data.response.body, "\n")
+        local res_type = content_type[1]:match(".*/([^;]+)")
+        if res_type == "octet_stream" then
+          body = { "Binary answer" }
+        elseif config.response.hooks.format then
+          body = utils.gq_lines(body, res_type)
         end
         vim.list_extend(lines, body)
         table.insert(lines, "#+END")

lua/rest-nvim/utils.lua

@@ -276,4 +276,19 @@ function utils.nvim_lazy_set_wo(bufnr, name, value)
   })
 end
 
+---format lines using native vim `gq` command
+---@param lines string[]
+---@param filetype string
+---@return string[]
+function utils.gq_lines(lines, filetype)
+  local format_buf = vim.api.nvim_create_buf(false, true)
+  vim.bo[format_buf].filetype = filetype
+  vim.api.nvim_buf_set_lines(format_buf, 0, -1, false, lines)
+  vim.api.nvim_buf_call(format_buf, function ()
+    vim.cmd("normal gg")
+    vim.cmd("normal gqG")
+  end)
+  return vim.api.nvim_buf_get_lines(format_buf, 0, -1, false)
+end
+
 return utils

spec/minimum_init.lua

@@ -16,9 +16,6 @@ vim.g.rest_nvim = {
   cookies = {
     path = "/tmp/rest-nvim.cookies"
   },
-  response = {
-    formatters = {}
-  },
 }
 ---@diagnostic disable-next-line: undefined-field
 vim.uv.fs_unlink(vim.g.rest_nvim.cookies.path)