search

jellydn / hurl.nvim

Hurl.nvim is a Neovim plugin designed to run HTTP requests directly from `.hurl` files. Elevate your API development workflow by executing and viewing responses without leaving your editor.
https://gyazo.com/19492e8b5366cec3f22d5fd97a63f37a
MIT License
158 stars 15 forks source link
hacktoberfest hurl neovim neovim-plugin

readme

Welcome to hurl.nvim ๐Ÿ‘‹

Hurl.nvim is a Neovim plugin designed to run HTTP requests directly from `.hurl` files. Elevate your API development workflow by executing and viewing responses without leaving your editor.

[!IMPORTANT] Version 2 is in development! We're working on making hurl.nvim even better. Try out the canary branch and share your feedback:

{
  "jellydn/hurl.nvim",
  branch = "canary",
  -- ... rest of your configuration
}

All Contributors

IT Man - Effortless APIs with Hurl.nvim: A Developer's Guide to Neovim Tooling [Vietnamese]

Prerequisites

Features

Usage

Add the following configuration to your Neovim setup with lazy.nvim:

{
  "jellydn/hurl.nvim",
  dependencies = {
      "MunifTanjim/nui.nvim",
      "nvim-lua/plenary.nvim",
      "nvim-treesitter/nvim-treesitter"
  },
  ft = "hurl",
  opts = {
    -- Show debugging info
    debug = false,
    -- Show notification on run
    show_notification = false,
    -- Show response in popup or split
    mode = "split",
    -- Default formatter
    formatters = {
      json = { 'jq' }, -- Make sure you have install jq in your system, e.g: brew install jq
      html = {
        'prettier', -- Make sure you have install prettier in your system, e.g: npm install -g prettier
        '--parser',
        'html',
      },
      xml = {
        'tidy', -- Make sure you have installed tidy in your system, e.g: brew install tidy-html5
        '-xml',
        '-i',
        '-q',
      },
    },
    -- Default mappings for the response popup or split views
    mappings = {
      close = 'q', -- Close the response popup or split view
      next_panel = '<C-n>', -- Move to the next response popup window
      prev_panel = '<C-p>', -- Move to the previous response popup window
    },
  },
  keys = {
    -- Run API request
    { "<leader>A", "<cmd>HurlRunner<CR>", desc = "Run All requests" },
    { "<leader>a", "<cmd>HurlRunnerAt<CR>", desc = "Run Api request" },
    { "<leader>te", "<cmd>HurlRunnerToEntry<CR>", desc = "Run Api request to entry" },
    { "<leader>tE", "<cmd>HurlRunnerToEnd<CR>", desc = "Run Api request from current entry to end" },
    { "<leader>tm", "<cmd>HurlToggleMode<CR>", desc = "Hurl Toggle Mode" },
    { "<leader>tv", "<cmd>HurlVerbose<CR>", desc = "Run Api in verbose mode" },
    -- Run Hurl request in visual mode
    { "<leader>h", ":HurlRunner<CR>", desc = "Hurl Runner", mode = "v" },
  },
}

When configuring nvim-treesitter add hurl to the ensure_installed list of parsers.

Simple demo in split mode:

Show in split mode

[!NOTE] I frequently utilize the nightly version of Neovim, so if you encounter any issues, I recommend trying that version first. I may not have the time to address problems in the stable version. Your contributions via pull requests are always welcome.

Env File Support: vars.env

hurl.nvim seamlessly integrates with environment files named vars.env to manage environment variables for your HTTP requests. These environment variables are essential for customizing your requests with dynamic data such as API keys, base URLs, and other configuration values.

Customization

You can specify the name of the environment file in your hurl.nvim configuration. By default, hurl.nvim looks for a file named vars.env, but you can customize this to any file name that fits your project's structure.

Here's how to set a custom environment file name in your hurl.nvim setup:

require('hurl').setup({
  -- Specify your custom environment file name here
  env_file = {
      'hurl.env',
  },
  -- Other configuration options...
})

File Location

The plugin searches for a vars.env (env_file config) in multiple locations to accommodate various project structures and ensure that environment-specific variables for your HTTP requests are easily accessible. The search occurs in the following order:

  1. Current File's Directory: The directory where the current file is located. This is particularly useful for projects where environment variables are specific to a particular module or component.

  2. Specific Directories in Project: The plugin scans predefined directories within the project, which are commonly used for organizing different aspects of a project:

    • src/: The source code directory.
    • test/ and tests/: Directories typically used for test scripts.
    • server/: If your project includes a server component, this directory is checked.
    • src/tests/ and server/tests/: These are checked for environment variables specific to tests within the respective src and server directories.

  3. Intermediate Directories from Git Root to Current File: If the project is a git repository, the plugin identifies the root of the repository and then searches for vars.env in every directory on the path from this root to the current file's directory. This feature is particularly useful in monorepo setups or large projects, where different modules or packages may have their own environment variables.

By checking these locations, the plugin ensures a comprehensive search for environment variables, catering to a wide range of project structures and setups.

Swappable environment

To change the environment file name, use the HurlSetEnvFile command followed by the new file name. You can have multiple variable files by having comma-separated values.

Notes

Test fixtures

This is a feature that allows you to define custom variables in your .hurl files. You can define a list of custom variables with a name and a callback function that returns the value of the variable. The callback function is executed every time the variable is used in the .hurl file.

[!NOTE] This is a workaround to inject dynamic variables into the hurl command, refer https://github.com/Orange-OpenSource/hurl/issues?q=sort:updated-desc+is:open+label:%22topic:+generators%22

  -- Custom below to add your own fixture variables
  fixture_vars = {
    {
      name = 'random_int_number',
      callback = function()
        return math.random(1, 1000)
      end,
    },
    {
      name = 'random_float_number',
      callback = function()
        local result = math.random() * 10
        return string.format('%.2f', result)
      end,
    },
  }

Then you can use {{random_int_number}} and {{random_float_number}} in your .hurl files.

POST https://api.example.com
Content-Type: application/json

{
  "name": "Product ID {{random_int_number}}",
  "price": {{random_float_number}}
}

Demo

Check out the following demos to see hurl.nvim in action:

Run a File

Run the entire file by pressing <leader>A or run HurlRunner command.

Run a file in popup mode

Run a Selection

Select a range of lines and press <leader>h to execute the request or run HurlRunner command.

Run a selection in popup mode

Run at current line

Place your cursor on a HURL entry and press <leader>a or run HurlRunnerAt command to execute the entry request.

Run at current line in popup mode

Verbose mode

Run HurlVerbose command to execute the request in verbose mode. The response will be displayed in QuickFix window. This is useful for debugging purposes or getting the curl command from hurl file.

Run at current line in verbose mode

Run to entry

Place your cursor on the line you want to run to that entry and press <leader>te or run HurlRunnerToEntry command to execute the request. Run to entry in split mode

Note: it's running from start of file to the selected entry and ignore the remaining of the file. It is useful for debugging purposes.

Run from current entry to end

Similar to HurlRunnerToEntry, we could run from current entry to end of file with HurlRunnerToEnd command.

Toggle Mode

Run HurlToggleMode command to toggle between split and popup mode.

Toggle mode

HurlSetVariable

The HurlSetVariable command allows you to set environment variables for your HTTP requests. This is particularly useful for setting dynamic data such as API keys, base URLs, and other configuration values.

To use this command, type :HurlSetVariable followed by the variable name and its value. For example:

:HurlSetVariable API_KEY your_api_key

This will set the API_KEY environment variable to your_api_key. You can then use this variable in your .hurl files like this:

GET https://api.example.com
Authorization: Bearer {{API_KEY}}

HurlManageVariable

The HurlManageVariable command provides a convenient way to view your environment variables. When you run this command, it opens a new buffer in popup with the current environment variables and their values.

To use this command, simply type :HurlManageVariable in the command line:

:HurlManageVariable

The default keymap for this buffer is:

Manage variables

For now, if you want to modify the global variables, you can do so by using the HurlSetVariable command or by editing your vars.env file directly.

HurlShowLastResponse

The HurlShowLastResponse command allows you to view the response of your last HTTP request.

:HurlShowLastResponse

Default Key Mappings

hurl.nvim comes with some default key mappings to streamline your workflow:

These key mappings are active within the popup windows that hurl.nvim displays.

Configuration

hurl.nvim can be customized with the following default configurations:

--- Default configuration for hurl.nvim
local default_config = {
  debug = false,
  mode = 'split',
  show_notification = false,
  auto_close = true,
  -- Default split options
  split_position = 'right',
  split_size = '50%',
  -- Default popup options
  popup_position = '50%',
  popup_size = {
    width = 80,
    height = 40,
  },
  env_file = { 'vars.env' },
  fixture_vars = {
    {
      name = 'random_int_number',
      callback = function()
        return math.random(1, 1000)
      end,
    },
    {
      name = 'random_float_number',
      callback = function()
        local result = math.random() * 10
        return string.format('%.2f', result)
      end,
    },
  },
  find_env_files_in_folders = utils.find_env_files_in_folders,
  formatters = {
    json = { 'jq' },
    html = {
      'prettier',
      '--parser',
      'html',
    },
    xml = {
      'tidy',
      '-xml',
      '-i',
      '-q',
    },
  },
}

To apply these configurations, include them in your Neovim setup like this:

require('hurl').setup({
  debug = true,          -- Enable to show detailed logs
  mode = 'popup',        -- Change to 'popup' to display responses in a popup window
  env_file = { 'vars.env' }, -- Change this to use a different environment file name
  formatters = {
    json = { 'jq' },    -- Customize the JSON formatter command
    html = {
      'prettier',       -- Customize the HTML formatter command
      '--parser',
      'html',
    },
    xml = {
      'tidy',           -- Customize the XML formatter command
      '-xml',
      '-i',
      '-q',
    },
  },
})

Adjust the settings as per your needs to enhance your development experience with hurl.nvim.

Tips

[!TIP] Enable debug mode with debug = true for detailed logs

[!TIP] Split mode with Edgy

right = {
  { title = "Hurl Nvim", size = { width = 0.5 }, ft = "hurl-nvim" },
}

[!TIP] Syntax Highlighting in Stable Neovim

autocmd BufRead,BufNewFile *.hurl setfiletype sh

For example, here is my autocmd for .hurl files.

Resources

IT Man - Building and Testing a #Hapi Server with #Hurl: A Step-By-Step Demo [Vietnamese]

Credits

Author

๐Ÿ‘ค Huynh Duc Dung

Show your support

If this plugin has been helpful, please give it a โญ๏ธ.

kofi paypal buymeacoffee

Star History

Star History Chart

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

Dung Duc Huynh (Kaka)
Dung Duc Huynh (Kaka)
๐Ÿ’ป ๐Ÿ“–		 Cenk Kฤฑlฤฑรง
Cenk Kฤฑlฤฑรง
๐Ÿ’ป ๐Ÿ“–		 Andre Van Der Merwe
Andre Van Der Merwe
๐Ÿ’ป		 Sergey Kochetkov
Sergey Kochetkov
๐Ÿ“– ๐Ÿ’ป		 rbingham
rbingham
๐Ÿ’ป		 Horacio Sanson
Horacio Sanson
๐Ÿ’ป ๐Ÿ“–		 xiwang
xiwang
๐Ÿ’ป ๐Ÿ“–
wenjin
wenjin
๐Ÿ’ป		 Aron Griffis
Aron Griffis
๐Ÿ’ป		 Javier Ugarte
Javier Ugarte
๐Ÿ’ป		 Daniel Jeller
Daniel Jeller
๐Ÿ’ป ๐Ÿ“–		 Xouzoura
Xouzoura
๐Ÿ’ป
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!