Merge pull request #28 from gennaro-tedesco/fix_escaping

added parse_key function to strip vim special characters

Author: gennaro-tedesco

lua/nvim-jqx/init.lua

@@ -5,6 +5,7 @@ local jqx = require("nvim-jqx.jqx")
 local config = require("nvim-jqx.config")
 local fw = require("nvim-jqx.floating")
 
+---@returns boolean
 local function is_valid_ft(ft)
 	if not (ft == "json" or ft == "yaml") then
 		print("only json or yaml files")
@@ -28,6 +29,7 @@ local function is_valid_ft(ft)
 	return true
 end
 
+---set keymaps in the qf to query entry on keypress
 local function set_qf_maps(ft)
 	vim.api.nvim_exec(
 		[[autocmd FileType qf nnoremap <buffer> ]]
@@ -39,6 +41,9 @@ local function set_qf_maps(ft)
 	)
 end
 
+---main function interface that populates the quickfix list on invocation
+---invoke set_qf_maps and jqx.populate_qf
+---@param type string variable type to fetch if given
 local function jqx_open(type)
 	local ft = vim.bo.filetype
 	if not is_valid_ft(ft) then
@@ -52,6 +57,8 @@ local function jqx_open(type)
 	jqx.populate_qf(ft, type, config.sort)
 end
 
+---execute jq query from user input
+---@param q string user query
 local function query_jq(q)
 	local ft = vim.bo.filetype
 	if not is_valid_ft(ft) then

lua/nvim-jqx/jqx.lua

@@ -10,20 +10,37 @@ local function has_value(tab, val)
 	return false
 end
 
+---remove vim special characters from json keys
+---@param key string
+---@return string "parsed key"
+local function parse_key(key)
+	return (key:gsub("/", "\\/"))
+end
+
+---return location of key in buffer
+---@param key string
+---@param ft string
+---@return table
 local function get_key_location(key, ft)
 	if ft == "json" then
 		return {
-			row = vim.api.nvim_exec([[g/^\s*"]] .. key .. [["/echo line('.')]], true),
-			col = vim.api.nvim_exec([[g/^\s*"]] .. key .. [["/execute "normal! ^" | echo col('.')-1]], true),
+			row = vim.api.nvim_exec([[g/^\s*"]] .. parse_key(key) .. [["/echo line('.')]], true),
+			col = vim.api.nvim_exec([[g/^\s*"]] .. parse_key(key) .. [["/execute "normal! ^" | echo col('.')-1]], true),
 		}
 	elseif ft == "yaml" then
 		return {
-			row = vim.api.nvim_exec([[g/^]] .. key .. [[/echo line('.')]], true),
-			col = vim.api.nvim_exec([[g/^]] .. key .. [[/execute "normal! ^" | echo col('.')]], true),
+			row = vim.api.nvim_exec([[g/^]] .. parse_key(key) .. [[/echo line('.')]], true),
+			col = vim.api.nvim_exec([[g/^]] .. parse_key(key) .. [[/execute "normal! ^" | echo col('.')]], true),
 		}
+	else
+		return {}
 	end
 end
 
+---fetch json keys for cur buf and populate qf list
+---@param ft string
+---@param type string variable type to fetch if given
+---@param sort boolean sort list alphabetically
 local function populate_qf(ft, type, sort)
 	local cmd_lines = {}
 	local cur_file = vim.fn.getreg("%")