chore: minor type fixes

add `rest.` prefix to all classes

Author: boltlessengineer

lua/rest-nvim/client/curl/cli.lua

@@ -219,7 +219,7 @@ function builder.http_version(version)
 end
 
 ---build curl request arguments based on Request object
----@param request Request
+---@param request rest.Request
 ---@return string[] args
 function builder.build(request)
   local args = {}
@@ -241,7 +241,7 @@ function builder.build(request)
 end
 
 ---returns future containing Result
----@param request Request Request data to be passed to cURL
+---@param request rest.Request Request data to be passed to cURL
 ---@return nio.control.Future future future containing rest.Response
 function curl.request(request)
   local progress_handle = progress.handle.create({

lua/rest-nvim/client/curl/libcurl.lua

@@ -55,7 +55,7 @@ end
 
 ---Execute an HTTP request using cURL
 ---return return nil if execution failed
----@param request Request Request data to be passed to cURL
+---@param request rest.Request Request data to be passed to cURL
 ---@return table? info The request information (url, method, headers, body, etc)
 function client.request_(request)
   logger.info("sending request to: " .. request.url)

lua/rest-nvim/commands.lua

@@ -31,7 +31,7 @@
 -- HACK: what is the type of opts here?
 
 ---@class RestCmd
----@field impl fun(args:string[], opts: any) The command implementation
+---@field impl fun(args:string[], opts: table?) The command implementation
 ---@field complete? fun(subcmd_arg_lead: string): string[] Command completions callback, taking the lead of the subcommand's argument
 
 local commands = {}
@@ -45,13 +45,11 @@ local parser = require("rest-nvim.parser")
 ---@type table<string, RestCmd>
 local rest_command_tbl = {
   run = {
-    -- TODO: run request by name
-    impl = function(args, opts)
+    impl = function(args, _opts)
       if #args > 1 then
         vim.notify("Running multiple request isn't supported yet", vim.log.levels.WARN)
         return
       elseif #args == 1 then
-        -- TODO: get request by name
         request.run_by_name(args[1])
         return
       end

lua/rest-nvim/config/check.lua

@@ -18,7 +18,7 @@ local function validate(tbl)
 end
 
 ---Validates the configuration
----@param cfg RestConfig
+---@param cfg rest.Config
 ---@return boolean is_valid
 ---@return string|nil error_message
 function check.validate(cfg)

lua/rest-nvim/config/init.lua

@@ -6,50 +6,50 @@
 ---
 ---@brief ]]
 
----@type RestConfig
-local config = {}
+---@type rest.Config
+local config
 
 ---@alias RestResultFormatters string|fun(body:string):string,table
 
----@class RestOptsHighlight
+---@class rest.Opts.Highlight
 --- Whether current request highlighting is enabled or not (Default: `true`)
 ---@field enable? boolean
 --- Duration time of the request highlighting in milliseconds (Default: `250`)
 ---@field timeout? number
 
----@class RestOptsResult
----@field window? RestOptsResultWindow
----@field behavior? RestOptsResultBehavior
----@field keybinds? RestOptsResultKeybinds
+---@class rest.Opts.Result
+---@field window? rest.Opts.Result.Window
+---@field behavior? rest.Opts.Result.Behavior
+---@field keybinds? rest.Opts.Result.Keybinds
 
----@class RestOptsResultWindow
+---@class rest.Opts.Result.Window
 --- Open request results in a horizontal split (Default: `false`)
 ---@field horizontal? boolean
 ---@field enter? boolean
 
----@class RestOptsResultBehavior
+---@class rest.Opts.Result.Behavior
 ---@field decode_url boolean
----@field statistics RestOptsStatistics
+---@field statistics rest.Opts.Statistics
 ---@field formatters table<string,RestResultFormatters>
 
----@class RestOptsStatistics
+---@class rest.Opts.Statistics
 ---@field enable boolean
----@field stats table<string,RestOptsResultStatStyle>
+---@field stats table<string,rest.Opts.Result.Stat.Style>
 
----@class RestOptsResultKeybinds
+---@class rest.Opts.Result.Keybinds
 --- Mapping for cycle to previous result pane (Default: `"H"`)
 ---@field prev? string
 --- Mapping for cycle to next result pane (Default: `"L"`)
 ---@field next? string
 
----@class RestOptsResultStatStyle
+---@class rest.Opts.Result.Stat.Style
 --- Title used on result pane
 ---@field title? string
 --- Winbar title. Set to `false` or `nil` to not show for winbar, set to empty string
 --- to hide title If true, rest.nvim will use lowered `title` field
 ---@field winbar? string|boolean
 
----@class RestOpts
+---@class rest.Opts
 --- Environment variables file pattern for telescope.nvim
 --- (Default: `".*env.*$"`)
 ---@field env_pattern? string
@@ -60,15 +60,15 @@ local config = {}
 --- Table of custom dynamic variables
 ---@field custom_dynamic_variables? table<string, fun():string>
 --- Request highlighting config
----@field highlight? RestOptsHighlight
+---@field highlight? rest.Opts.Highlight
 --- Result view config
----@field result? RestOptsResult
+---@field result? rest.Opts.Result
 
----@type RestOpts
+---@type rest.Opts
 vim.g.rest_nvim = vim.g.rest_nvim
 
 ---rest.nvim default configuration
----@class RestConfig
+---@class rest.Config
 local default_config = {
   ---@type string Environment variables file pattern for telescope.nvim
   env_pattern = ".*env.*$",
@@ -80,9 +80,9 @@ local default_config = {
   ---@type table<string, fun():string> Table of custom dynamic variables
   custom_dynamic_variables = {},
 
-  ---@class RestConfigResult
+  ---@class rest.Config.Result
   result = {
-    ---@class RestConfigResultWindow
+    ---@class rest.Cnofig.Result.Window
     window = {
       -- TODO: use `:horizontal` instead. see `:h command-modifiers` and opts.smods
       ---@type boolean Open request results in a horizontal split
@@ -94,17 +94,17 @@ local default_config = {
       ---@type boolean
       cookies = true,
     },
-    ---@class RestConfigResultBehavior
+    ---@class rest.Config.Result.Behavior
     behavior = {
       ---@type boolean Whether to decode the request URL query parameters to improve readability
       decode_url = true,
-      ---@class RestConfigResultStats
+      ---@class rest.Config.Result.Stats
       statistics = {
         ---@type boolean Whether enable statistics or not
         enable = true,
         ---Statistics to be shown, takes cURL's easy getinfo constants name
         ---@see https://curl.se/libcurl/c/curl_easy_getinfo.html
-        ---@type table<string,RestOptsResultStatStyle>
+        ---@type table<string,rest.Opts.Result.Stat.Style>
         stats = {
           total_time = { winbar = "take", title = "Time taken" },
           size_download_t = { winbar = "size", title = "Download size" },
@@ -133,15 +133,15 @@ local default_config = {
         end,
       },
     },
-    ---@class RestConfigResultKeybinds
+    ---@class rest.Config.Result.Keybinds
     keybinds = {
       ---@type string Mapping for cycle to previous result pane
       prev = "H",
       ---@type string Mapping for cycle to next result pane
       next = "L",
     },
   },
-  ---@class RestConfigHighlight
+  ---@class rest.Config.Highlight
   highlight = {
     ---@type boolean Whether current request highlighting is enabled or not
     enable = true,
@@ -151,7 +151,7 @@ local default_config = {
   ---@see vim.log.levels
   ---@type integer log level
   _log_level = vim.log.levels.WARN,
-  ---@class RestConfigDebugInfo
+  ---@class rest.Config.DebugInfo
   _debug_info = {
     -- NOTE: default option is `nil` to prevent overwriting as empty array
     ---@type string[]
@@ -166,7 +166,7 @@ config = vim.tbl_deep_extend("force", {
     unrecognized_configs = check.get_unrecognized_keys(opts, default_config),
   },
 }, default_config, opts)
----@cast config RestConfig
+---@cast config rest.Config
 local ok, err = check.validate(config)
 
 if not ok then

lua/rest-nvim/context.lua

@@ -4,10 +4,10 @@ local dotenv = require("rest-nvim.dotenv")
 local config = require("rest-nvim.config")
 local M = {}
 
----@class Context
+---@class rest.Context
 ---@field vars table<string,string>
 ---@field files string[]
----@field request? Request
+---@field request? rest.Request
 ---@field response? rest.Response
 local Context = {}
 Context.__index = Context
@@ -40,9 +40,9 @@ local rest_variables = {
   end,
 }
 
----@return Context
+---@return rest.Context
 function Context:new()
-  ---@type Context
+  ---@type rest.Context
   local obj = {
     __index = self,
     vars = {},

lua/rest-nvim/init.lua

@@ -9,7 +9,7 @@
 local rest = {}
 
 ---Set up rest.nvim
----@param user_configs RestOpts User configurations
+---@param user_configs rest.Opts User configurations
 function rest.setup(user_configs)
   -- Set up rest.nvim configurations
   vim.g.rest_nvim = user_configs

lua/rest-nvim/parser/dotenv.lua

@@ -52,7 +52,7 @@ function M.parse(path, setter)
   local file_contents = utils.read_file(path)
   if env_ext == "json" then
     local ok, json_tbl = pcall(vim.json.decode, file_contents)
-    if not ok or not type(json_tbl) == "table" or vim.islist(json_tbl) then
+    if not ok or type(json_tbl) ~= "table" or vim.islist(json_tbl) then
       logger.error("failed parsing json data")
       return false
     end

lua/rest-nvim/parser/init.lua

@@ -12,10 +12,6 @@ local config = require("rest-nvim.config")
 
 ---@alias BodyType "json"|"xml"|"external"|"form"|"graphql"
 
----@class ReqBody
----@field __TYPE BodyType
----@field data any
-
 local NAMED_REQUEST_QUERY = vim.treesitter.query.parse("http", [[
 (section
   (request_separator
@@ -39,7 +35,7 @@ local function get_node_field_text(node, field, source)
 end
 
 ---@param src string
----@param context Context
+---@param context rest.Context
 ---@param encoder? fun(s:string):string
 ---@return string
 ---@return integer
@@ -56,7 +52,7 @@ end
 
 ---@param req_node TSNode Tree-sitter request node
 ---@param source Source
----@param context Context
+---@param context rest.Context
 ---@return table<string,string> headers
 local function parse_headers(req_node, source, context)
   local headers = {}
@@ -74,12 +70,12 @@ end
 
 ---@param body_node TSNode
 ---@param source Source
----@param context Context
----@return ReqBody|nil
+---@param context rest.Context
+---@return rest.Request.Body|nil
 function M.parse_body(body_node, source, context)
   local body = {}
   body.__TYPE = body_node:type():gsub("_%w+", "")
-  ---@cast body ReqBody
+  ---@cast body rest.Request.Body
   if body.__TYPE == "json" then
     body.data = vim.trim(vim.treesitter.get_node_text(body_node, source))
     body.data = expand_variables(body.data, context)
@@ -128,7 +124,7 @@ local IN_PLACE_VARIABLE_QUERY = "(variable_declaration) @inplace_variable"
 
 ---parse all in-place variables from source
 ---@param source Source
----@return Context ctx
+---@return rest.Context ctx
 function M.create_context(source)
   local query = vim.treesitter.query.parse("http", IN_PLACE_VARIABLE_QUERY)
   local ctx = Context:new()
@@ -184,7 +180,7 @@ end
 
 ---@param vd_node TSNode
 ---@param source Source
----@param ctx Context
+---@param ctx rest.Context
 function M.parse_variable_declaration(vd_node, source, ctx)
   vim.validate({ node = utils.ts_node_spec(vd_node, "variable_declaration") })
   local name = assert(get_node_field_text(vd_node, "name", source))
@@ -204,7 +200,7 @@ end
 
 ---@param script_node TSNode
 ---@param source Source
----@param context Context
+---@param context rest.Context
 function M.parse_pre_request_script(script_node, source, context)
   local node = assert(script_node:named_child(0))
   local str = parse_script(node, source)
@@ -213,7 +209,7 @@ end
 
 ---@param handler_node TSNode
 ---@param source Source
----@param context Context
+---@param context rest.Context
 function M.parse_request_handler(handler_node, source, context)
   local node = assert(handler_node:named_child(0))
   local str = parse_script(node, source)
@@ -239,8 +235,8 @@ end
 ---failed.
 ---@param node TSNode Tree-sitter request node
 ---@param source Source
----@param context? Context
----@return Request|nil
+---@param context? rest.Context
+---@return rest.Request|nil
 function M.parse(node, source, context)
   assert(node:type() == "section")
   context = context or Context:new()
@@ -293,7 +289,7 @@ function M.parse(node, source, context)
     url = headers["host"]..url
     headers["host"] = nil
   end
-  ---@type Request
+  ---@type rest.Request
   return {
     name = name,
     context = context,

lua/rest-nvim/request.lua

@@ -10,20 +10,24 @@ local ui     = require("rest-nvim.ui.result")
 local nio    = require("nio")
 local response = require("rest-nvim.response")
 
----@class Request
----@field context Context
+---@class rest.Request.Body
+---@field __TYPE BodyType
+---@field data any
+
+---@class rest.Request
+---@field context rest.Context
 ---@field name? string The request identifier
 ---@field method string The request method
 ---@field url string The request URL
 ---@field http_version? string The request HTTP protocol
 ---@field headers table<string,string>
----@field body? ReqBody
+---@field body? rest.Request.Body
 ---@field handlers fun()[]
 
----@type Request|nil
+---@type rest.Request|nil
 local rest_nvim_last_request = nil
 
----@param req Request
+---@param req rest.Request
 local function run_request(req)
   logger.debug("run_request")
   local client = require("rest-nvim.client.curl.cli")