Merge pull request #4 from heilgar/feature/curl-cp

Feature/curl cp

Author: heilgar

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] 2024-09-17
+### Added
+- New feature: Generate and display curl command in dry run output
+- New command: `:HttpCopyCurl` to copy curl command for the request under cursor
+- New keybinding: `<leader>hc` to copy curl command
+- Support for comments in .http and .rest files
+    - Full line comments starting with '#'
+    - Inline comments from '#' to end of line
+
+
 ## [1.0.0] 2024-09-17
 ### Added
 - Comprehensive test suite

README.md

@@ -120,6 +120,7 @@ You can adjust these settings to your preferences.
 - `:HttpStop`: Stop the currently running HTTP request.
 - `:HttpVerbose`: Toggle verbose mode for debugging.
 - `:HttpDryRun`: Perform a dry run of the request under the cursor.
+- `:HttpCopyCurl`: Copy the curl command for the HTTP request under the cursor.
 
 ### Keybindings
 
@@ -131,6 +132,7 @@ The plugin comes with the following default keybindings:
 - `<leader>hx`: Stop running HTTP request
 - `<leader>hv`: Toggle verbose mode
 - `<leader>hd`: Perform dry run
+- `<leader>hc`: Copy curl command for HTTP request under cursor
 
 To customize these keybindings, you can add the following to your Neovim configuration:
 

doc/http_client.txt

@@ -48,6 +48,9 @@ COMMANDS                                              *http_client-commands*
 :HttpRunAll                                                     *:HttpRunAll*
     Run all HTTP requests in the current file.
 
+:HttpCopyCurl                                                 *:HttpCopyCurl*
+    Copy the curl command for the HTTP request under the cursor.
+
 ------------------------------------------------------------------------------
 KEYBINDINGS                                        *http_client-keybindings*
 
@@ -71,6 +74,9 @@ The plugin comes with the following default keybindings:
 <leader>hd                                            *http_client-dry-run*
     Perform dry run
 
+<leader>hc                                          *http_client-copy-curl*
+    Copy curl command for the HTTP request under cursor
+
 To customize these keybindings, you can pass a 'keybindings' table to the
 setup function in your Neovim configuration:
 >
@@ -254,6 +260,22 @@ Dry runs can be executed even if no environment file is selected. In this case,
 a warning will be displayed in the dry run output if environment variables are
 needed but not set.
 
+------------------------------------------------------------------------------
+COMMENTS                                              *http_client-comments*
+
+The plugin now supports comments in .http and .rest files. Comments can be used
+to add explanations or temporarily disable parts of requests.
+
+- Full line comments start with '#' at the beginning of the line
+- Inline comments start with '#' and continue to the end of the line
+
+Examples:
+
+# This is a full line comment
+GET https://api.example.com/users # This is an inline comment
+
+Comments are ignored when parsing and executing requests.
+
 ==============================================================================
 vim:ft=help:et:ts=4:sw=4:sts=4:norl:
 

lua/http_client/commands/init.lua

@@ -2,6 +2,7 @@ local M = {}
 
 M.request = require('http_client.commands.request')
 M.select_env = require('http_client.commands.select_env')
+M.utils = require('http_client.commands.utils')
 
 return M
 

lua/http_client/commands/utils.lua

@@ -0,0 +1,25 @@
+local M = {}
+
+local vvv = require('http_client.utils.verbose')
+local parser = require('http_client.core.parser')
+local environment = require('http_client.core.environment')
+local http_client = require('http_client.core.http_client')
+local curl_generator = require('http_client.core.curl_generator')
+
+M.copy_curl = function()
+    local request = parser.get_request_under_cursor()
+    if not request then
+        print('\nNo valid HTTP request found under cursor')
+        return
+    end
+
+    local env = environment.get_current_env()
+    request = parser.replace_placeholders(request, env)
+
+    local curl_command = curl_generator.generate_curl(request)
+    vim.fn.setreg('+', curl_command)
+    print('Curl command copied to clipboard')
+end
+
+return M
+

lua/http_client/config.lua

@@ -10,7 +10,8 @@ M.defaults = {
         run_request = "<leader>hr",
         stop_request = "<leader>hx",
         dry_run = "<leader>hd",
-        toggle_verbose = "<leader>hv"
+        toggle_verbose = "<leader>hv",
+        copy_curl = "<leader>hc",
     },
 }
 

lua/http_client/core/curl_generator.lua

@@ -0,0 +1,30 @@
+local M = {}
+
+local function escape_quotes(str)
+    return str:gsub('"', '\\"')
+end
+
+M.generate_curl = function(request)
+    local curl_parts = { "curl" }
+
+    -- Add method
+    table.insert(curl_parts, "-X " .. request.method)
+
+    -- Add headers
+    for key, value in pairs(request.headers or {}) do
+        table.insert(curl_parts, '-H "' .. escape_quotes(key) .. ': ' .. escape_quotes(value) .. '"')
+    end
+
+    -- Add body if present
+    if request.body then
+        table.insert(curl_parts, "-d '" .. request.body .. "'")
+    end
+
+    -- Add URL
+    table.insert(curl_parts, '"' .. escape_quotes(request.url) .. '"')
+
+    return table.concat(curl_parts, " ")
+end
+
+return M
+

lua/http_client/core/parser.lua

@@ -12,6 +12,14 @@ local function extract_test_name(lines)
     return ""
 end
 
+local function remove_comment(line)
+    local comment_start = line:find("#")
+    if comment_start then
+        return line:sub(1, comment_start - 1):match("^%s*(.-)%s*$") -- Trim and remove comment part
+    end
+    return line:match("^%s*(.-)%s*$")                               -- Trim if no comment
+end
+
 M.get_request_under_cursor = function()
     local current_line = vim.api.nvim_win_get_cursor(0)[1]
     local lines = vim.api.nvim_buf_get_lines(0, 0, -1, false)
@@ -21,7 +29,7 @@ M.get_request_under_cursor = function()
 
     -- First pass: check if there are any ### separators
     for _, line in ipairs(lines) do
-        if line:match("^###") then
+        if line:match("^###") and not line:match("^###%s*#") then
             has_separators = true
             break
         end
@@ -30,7 +38,7 @@ M.get_request_under_cursor = function()
     if has_separators then
         -- Find the request that contains the cursor
         for i, line in ipairs(lines) do
-            if line:match("^###") then
+            if line:match("^###") and not line:match("^###%s*#") then
                 if i <= current_line then
                     request_start = i
                 else
@@ -49,7 +57,7 @@ M.get_request_under_cursor = function()
         if not request_start then
             request_start = 1
             for i, line in ipairs(lines) do
-                if line:match("^###") then
+                if line:match("^###") and not line:match("^###%s*#") then
                     request_end = i - 1
                     break
                 end
@@ -105,6 +113,7 @@ M.parse_request = function(lines)
 
     for _, line in ipairs(lines) do
         line = trim(line)
+
         if line:match("^>%s*{%%") then
             in_response_handler = true
             response_handler = ""
@@ -117,29 +126,34 @@ M.parse_request = function(lines)
                 stage = "body"
             end
         elseif stage == "start" then
-            -- Updated regex to make HTTP version optional
+            line = remove_comment(line)
             local method, url, version = line:match("^(%S+)%s+(.+)%s+(HTTP/%S+)$")
             if not method then
-                -- If no HTTP version, try matching without it
                 method, url = line:match("^(%S+)%s+(.+)$")
             end
             if method and url then
                 request.method = method
                 request.url = url
-                request.http_version = version or "HTTP/1.1" -- Default to HTTP/1.1 if not specified
+                request.http_version = version or "HTTP/1.1"
                 stage = "headers"
             end
         elseif stage == "headers" then
+            line = remove_comment(line)
             local key, value = line:match("^([^:]+):%s*(.+)$")
             if key and value then
-                request.headers[trim(key)] = trim(value)
+                key = trim(key)
+                value = remove_comment(value)
+                value = trim(value)
+                if value ~= "" then
+                    request.headers[key] = value
+                end
             end
         elseif stage == "body" then
-            table.insert(body_lines, line)
+            table.insert(body_lines, remove_comment(line))
         end
     end
 
-    if #body_lines > 0 then
+    if #body_lines > 0 and request.method ~= 'GET' then
         request.body = table.concat(body_lines, "\n")
     end
 

lua/http_client/init.lua

@@ -27,6 +27,7 @@ local function set_keybindings()
             vim.keymap.set('n', M.config.get('keybindings').stop_request, ':HttpStop<CR>', opts)
             vim.keymap.set('n', M.config.get('keybindings').dry_run, ':HttpDryRun<CR>', opts)
             vim.keymap.set('n', M.config.get('keybindings').toggle_verbose, ':HttpVerbose<CR>', opts)
+            vim.keymap.set('n', M.config.get('keybindings').copy_curl, ':HttpCopyCurl<CR>', opts)
         end
     })
 end
@@ -92,6 +93,12 @@ M.setup = function(opts)
         desc = 'Perform a dry run of the HTTP request without sending it.'
     })
 
+    vim.api.nvim_create_user_command('HttpCopyCurl', function()
+        M.commands.utils.copy_curl()
+    end, {
+        desc = 'Copy curl command for the HTTP request under cursor.'
+    })
+
 
 
     setup_docs()

lua/http_client/ui/dry_run.lua

@@ -1,5 +1,6 @@
 local M = {}
 local environment = require('http_client.core.environment')
+local curl_generator = require('http_client.core.curl_generator')
 
 local function format_headers(headers)
     local formatted = {}
@@ -34,6 +35,7 @@ M.display_dry_run = function(http_client)
     local merged_env_info = vim.inspect(merged_env)
     local current_request = vim.inspect(http_client.http_client.get_current_request() or {})
 
+    local curl_command = curl_generator.generate_curl(request)
 
     local ui = require('http_client.ui.display')
 
@@ -50,6 +52,9 @@ Dry Run Information (%s):
 # Body:
 %s
 
+# Curl command:
+%s
+
 Environment Information:
 ------------------------
 Current env file: %s
@@ -69,6 +74,7 @@ Current request:
         request.status or "N/A",
         format_headers(request.headers),
         request.body or "No body",
+        curl_command,
         env_file,
         private_env,
         merged_env_info,