Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 2.69 KB

README.md

File metadata and controls

91 lines (62 loc) · 2.69 KB
Raw

vim-jq

Vim runtime files for jq script files (the command-line JSON processor).

If you are looking for a Vim plugin that runs jq interactively in Vim similar to jqplay.org, see vim-jqplay.

Syntax highlighting

Screenshot

(Code snippet from: jq-zeros)

Syntax highlighting options

" Don't highlight builtin functions/filters (default: 1)
let g:jq_highlight_builtin_functions = 0

" Don't highlight module prefix, like NAME:: (default: 1)
let g:jq_highlight_module_prefix = 0

" Don't highlight imported JSON file prefix, like $NAME:: (default: 1)
let g:jq_highlight_json_file_prefix = 0

" Highlight objects like .foo (default: 0)
let g:jq_highlight_objects = 1

" Highlight all function calls (default: 0)
" This will highlight all words directly followed by an opening parenthesis
let g:jq_highlight_function_calls = 1

Mappings

  • Move to next/previous function definition: ]], [[
  • Move to next/previous nested function definition: ]m, [m
  • Enhanced gf: when pressed on an included module path foo/bar edits the file foo/bar.jq if the file can be found in Vim's 'path', otherwise tries to edit foo/bar/bar.jq.
  • Move between matching if/elif/else/end, try/catch, and function definition boundaries def/; with %.

Include file searches

  • Proper settings for include, includeexpr, suffixesadd and define. See :h include-search and :h definition-search for details.
  • Jq's default search paths for modules, ~/.jq and $ORIGIN/../lib/jq (where $ORIGIN is the path to the jq executable) are appended to 'path' only when they exist.

Installation

Manual Installation

$ cd ~/.vim/pack/git-plugins/start
$ git clone https://github.com/bfrg/vim-jq

Note: The directory name git-plugins is arbitrary, you can pick any other name. For more details see :help packages.

Plugin Managers

Assuming vim-plug is your favorite plugin manager, add the following to your vimrc:

Plug 'bfrg/vim-jq'

License

Distributed under the same terms as Vim itself. See :help license.