jq.nvim

Run jq and variants like yq or gojq in an interactive window in Neovim and process the current buffer.

Features

Run jq in an interactive window in Neovim.
Ability to run variants of jq like yq or gojq.
Copy the output of the process.
Ability to write the output of jq back to a file.

Installation

`lazy.nvim`

{
  "cenk1cenk2/jq.nvim",
  dependencies = {
    -- https://github.com/nvim-lua/plenary.nvim
    "nvim-lua/plenary.nvim",
    -- https://github.com/MunifTanjim/nui.nvim
    "MunifTanjim/nui.nvim",
    -- https://github.com/grapp-dev/nui-components.nvim
    "grapp-dev/nui-components.nvim",
  },
}

Configuration

Setup

Plugin requires no setup by default. However if you want to change the default settings for good, then you can call it.

require("jq").setup()

You can find the default configuration file and available options here.

Usage

This plugin only exposes one interface that toggles to UI.

All the following options are optional.

require("jq").run({
  --- you can pass additional options to configure the current instance
  -- if you want to toggle from the memory
  toggle = true,
  -- commands for the instance else it will use the default
  -- the default command would be the first one in the table
  commands = {
    {
      -- command to be run
      command = "jq",
      -- filetype of the output
      filetype = "json",
      -- hidden arguments that will not be shown in the ui
      arguments = "-r"
    },
  },
  -- arguments to start with in the ui
  arguments = "",
  -- query to start with, if not provided it will use the default
  query = ".",
})

Feeding Lines

The default behavior is to use the current buffer as a source, however you can also provide data manually.

require("jq").run({
  filename = "test.json",
  lines = { "lines", "i", "obtained", "from", "somewhere" }
})

References

The UI is only possible due to beautiful work done on MunifTanjim/nui.nvim and grapp-dev/nui-components.nvim.