icyflame / json-where

Where are you inside a JSON file?

json-where

Where are you inside a JSON file?

Note: I place the cursor on various keys in the JSON file and then type the mapping <leader>jw, which invokes the JsonWhere() vim function, which in turn invokes the json-where executable. You can look at the bottom left corner of the video to see the JSON path being printed to the screen.

Contents

• Usage
  • Command line
  • Vim
• Compile from source
• Credits
• TODO
• License

Usage

json-where can be used from the command line. You can also set it up to run using a keybinding inside the editor of your choice.

Command line

# json-where file-name line column
$ json-where test.json 250  14
.[5].tags[3]

Vim

After installing json-where, you can use this function to invoke it based on your cursor position from within vim.

function JsonWhere()
    if executable("json-where") == 0
        return 'ERROR: json-where not found'
    endif

    let cursor = getcurpos()
    let lnum = cursor[1]
    let colnum = cursor[2]

    let filename = expand('%:p')
    if len(filename) == 0
        let filename = tempname() + ".json"
        silent exe("write! " . filename)
        silent exe("edit " . filename)
    endif

    let cmd_list = [ ]
    let cmd_list += [ 'json-where' ]
    let cmd_list += [ filename ]
    let cmd_list += [ lnum ]
    let cmd_list += [ colnum ]

    let cmd = join(cmd_list, ' ')
    let json_where_output = systemlist(cmd)

    if len(json_where_output) > 0
        return json_where_output[len(json_where_output)-1]
    else
        return 'ERROR: json-where output is invalid'
    endif
endfunction

You can attach a keybinding to this function in normal mode:

nmap <leader>jw :echo JsonWhere()<cr>

Note: For best results, call JsonWhere with the cursor on the first character in the JSON key or value.

Compile from source

json-where is a C++11 program. It can be compiled and installed using the standard GNU program compile process:

$ ./configure
$ make
$ sudo make install

When this repository is cloned, the configure script will be missing. You can create it by running the autogen.sh script.

By default, these commands will install the executable json-where inside /usr/local/bin/. You can change the destination by running the configure script with the --prefix option. Other options that you can pass to the configure script can be found on the autoconf manual.

Credits

• giacomodrago/minijson_reader
• Using GNU autotools to distribute C++ programs

TODO

• Move the Vim function in this readme to it's own Vim plugin
• Man page

License

minijson_reader's LICENSE is included here and appended to the LICENSE notice at the root of this repository.

Everything else in this repository is licensed under the MIT license.

Copyright (C) 2019 Siddharth Kannan [email protected]