cheatsheet.py

from talon import  Module, actions, registry
import sys, os


def list_to_markdown_table(file, list_name):

    file.write(f"# {list_name} \n\n")
    command_list = registry.lists[list_name][0].items()
    file.write(f">\n")
    file.write(f"> command word  {list_name}   \n\n")
    for key, value in command_list:
        file.write( "> **" + key + "** *" + value + "*\n>\n")

    file.write("\n\n")


def write_alphabet(file):
    list_to_markdown_table(file, 'user.letter')

def write_numbers(file):
    list_to_markdown_table(file, 'user.number_key')

def write_modifiers(file):
    list_to_markdown_table(file, 'user.modifier_key')

def write_special(file):
    list_to_markdown_table(file, 'user.special_key')

def write_symbol(file):
    list_to_markdown_table(file, 'user.symbol_key')

def write_arrow(file):
    list_to_markdown_table(file, 'user.arrow_key')

def write_punctuation(file):
    list_to_markdown_table(file, 'user.punctuation')

def write_function(file):
    list_to_markdown_table(file, 'user.function_key')



def write_formatters(file):
    file.write(f"# formatters \n\n")
    command_list = registry.lists['user.formatters'][0].items()
    file.write("> command word  user.formatters  \n")
#    file.write("|------|-----|\n")
    for key, value in command_list:
        file.write( "> **"+ key + "** `" + actions.user.formatted_text(f"example of formatting with {key}", key) + "` \n>\n")

def write_context_commands(file, commands): 
    # write out each command and it's implementation
    for key in commands:
        try:
            rule = commands[key].rule.rule
            implementation = commands[key].target.code.replace("\n","\n\t\t")
        except Exception:
            continue
        file.write("\n - **" + rule + "**  `" + implementation + "`\n")

def pretty_print_context_name(file, name):
    ## The logic here is intended to only print from talon files that have actual voice commands.  
        splits = name.split(".")
        index = -1
        
        os = ""
        
        if "mac" in name:
            os = "mac"
        if "win" in name: 
            os = "win"
        if "linux" in name:
            os = "linux"

        if "talon" in splits[index]:
            index = -2
            short_name = splits[index].replace("_", " ")
        else:
            short_name = splits[index].replace("_", " ")

        if "mac" == short_name or "win" == short_name or "linux" == short_name:
            index = index - 1
            short_name = splits[index].replace("_", " ")

        file.write("\n\n\n" + "# " + os + " " + short_name + "\n\n")

mod = Module()

@mod.action_class
class user_actions:
        def cheatsheet():
            """Print out a sheet of talon commands"""
            #open file

            this_dir = os.path.dirname(os.path.realpath(__file__))
            file_path = os.path.join(this_dir, 'cheatsheet.md')
            file = open(file_path,"w") 


            write_alphabet(file)
            write_numbers(file)
            write_modifiers(file)
            write_special(file)
            write_symbol(file)
            write_arrow(file)
            write_punctuation(file)
            write_function(file)


            write_formatters(file)

            #print out all the commands in all of the contexts

            list_of_contexts = registry.contexts.items()
            for key, value in list_of_contexts:
                
                commands= value.commands #Get all the commands from a context
                if len(commands) > 0:
                    pretty_print_context_name(file, key)
                    write_context_commands(file,commands)
            file.close()