Copy path of searched key to clipboard

[drew-wallace]

It would be really useful if when you search for a key, it would copy the path to that key to the clipboard or at least display it somewhere.

[themartorana]

I don't want to go overwriting clipboards unnecessarily. Maybe if an option was selected with a modifier key?

[drew-wallace]

Sublime has a clipboard history function built in. I'm sure it wouldn't be that bad.

[Ovsyanka]

I think that any realisation of this future will be better then nothing =) And it would be really useful thing.

[aletez]

Here's my attempt.
It's almost an identical TextCommand. It provides some bumpy live preview of what part of the json file is being highlighted in the quick panel, and after selection is done -- it copies the chosen path to clipboard in form of a proper JSONReference. So after selection you still need to paste it somewhere and the assumed destination is the original position before using the command, so the position is brought back to view.
I've made it a separate command so it's easy to bind to to a different key combination.

import sublime, sublime_plugin, json
from collections import OrderedDict
import re

class CopyJsonReferenceCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        self.original_position = list(self.view.sel())
        self.keys = []
        self.trimkeys = []
        content = self.view.substr(sublime.Region(0, self.view.size()))
        try:
            #json_data = json.loads(content)
            json_data = json.JSONDecoder(object_pairs_hook=OrderedDict).decode(content)
            self.fill_keys(json_data)
            sublime.active_window().show_quick_panel(self.keys, self.copy_insert_path, 0, 1, self.goto)
        except Exception as ex:
            print(ex)

    def fill_keys(self, json_data, indent=0):
        if isinstance(json_data, OrderedDict):
            for key in json_data:
                item = json_data[key]
                post = '"..."'
                if isinstance(item, dict):
                    post = '{...}'
                elif isinstance(item, list):
                    post = '[...]'
                self.keys.append('%s%s: %s' % (' ' * indent, key, post))
                self.trimkeys.append('"%s"' % key)
                self.fill_keys(json_data[key], indent+3)
        elif isinstance(json_data, list):
            for index, item in enumerate(json_data):
                if isinstance(item, str):
                    self.keys.append('%s%d. %s' % (' ' * indent, index, item))
                    self.trimkeys.append('"%s"' % item)
                elif isinstance(item, dict):
                    self.keys.append('%s%d. {...}' % (' ' * indent, index))
                    self.trimkeys.append('')
                    self.fill_keys(item, indent+3)



    def goto(self, arrpos):
        # The position gives us the line number
        strgo = self.trimkeys[arrpos]

        # Check for matches in the array before 48
        found = 0
        for index, item in enumerate(self.trimkeys):
            if index >= arrpos:
                break
            if item == strgo:
                found += 1

        # Now we need to find that string N times in 
        # the text, and go to its line number
        # and highlight it, why not?
        regions = self.view.find_all(strgo, sublime.LITERAL)
        region = regions[found]
        self.view.sel().clear()
        self.view.sel().add(region)
        self.view.show(region)

    def copy_insert_path(self, arrpos):
        # The position gives us the line number
        strgo = self.trimkeys[arrpos]

        # Check for matches in the array before 48
        found = 0
        for index, item in enumerate(self.trimkeys):
            if index >= arrpos:
                break
            if item == strgo:
                found += 1


        def indent(pretty_name):
            '''Return number of leading spaces'''
            return len(pretty_name) - len(pretty_name.lstrip(' '))

        def pretty_stripped(pretty_name):
            '''Return the part that goes to path'''
            cut_tail = re.sub("[.:] .\.\.\..", "", pretty_name)
            cut_rest = cut_tail.strip(" \"")
            return cut_rest

        # Compose absolute path in json to cursor
        path = [pretty_stripped(self.trimkeys[arrpos])]
        cur_indent = indent(self.keys[arrpos])
        for pos in range(arrpos,-1,-1):
            prev_key = self.keys[pos]
            new_indent = indent(prev_key)
            if new_indent < cur_indent:
                path.append(pretty_stripped(prev_key))
                cur_indent = new_indent
                if new_indent == 0:
                    path.append("#")
                    break
            else:
                continue
        final_path = "/".join(path[::-1])
        JSONReference = '{{"$ref": "{}"}}'.format(final_path)


        self.view.sel().clear()
        self.view.sel().add_all(self.original_position)
        self.view.show(self.original_position[0])
        sublime.set_clipboard(JSONReference)