Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cenk1cenk2/jq.nvim
Run jq and variants like yq or gojq in an interactive window in Neovim and process the current buffer.
https://github.com/cenk1cenk2/jq.nvim
neovim-plugin nvim-plugin
Last synced: about 4 hours ago
JSON representation
Run jq and variants like yq or gojq in an interactive window in Neovim and process the current buffer.
- Host: GitHub
- URL: https://github.com/cenk1cenk2/jq.nvim
- Owner: cenk1cenk2
- License: mit
- Created: 2024-09-13T13:58:53.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T16:25:43.000Z (2 months ago)
- Last Synced: 2024-09-16T05:32:37.579Z (2 months ago)
- Topics: neovim-plugin, nvim-plugin
- Language: Lua
- Homepage:
- Size: 73.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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`
```lua
{
"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.
```lua
require("jq").setup()
```
You can find the default configuration file and available options [here](https://github.com/cenk1cenk2/jq.nvim/blob/main/lua/jq/config.lua).
## Usage
This plugin only exposes one interface that toggles to UI.
All the following options are **optional**.
```lua
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.
```lua
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](https://github.com/MunifTanjim/nui.nvim) and [grapp-dev/nui-components.nvim](https://github.com/grapp-dev/nui-components.nvim).