Sublime Text Plugin - Exec Parser

Exec Parser is a sublime plugin that allow users to use the built-in commands or to add custom commands (Python) to parse the content before pasting or duplicating line. It takes the advantages of multi-selection in Sublime and behaves exactly like the native paste and duplicate line functions in Sublime.

Internal X to Y plugin:

Internal Camel case plugin:

Installation

• Package Control (Recommended): Install Package Control if you haven't installed it yet. Then use Install Package command to search for Exec Parser.

• Manually: Clone the repo into your packages folder (in Sublime: Preferences > Browse Packages…) and then rename the folder into Exec Parser.

Usage

Plugin Command

• Exec Parser: Parse & Paste (Ctrl+Shift+v) - To parse the string in the clipboard and paste it to the selected regions.

• Exec Parser: Parse & Duplicate (Ctrl+Shift+c) - To parse the string in the selected regions and duplicate it right behind it.

• Exec Parser: Set Parser (Ctrl+Shift+x) - To call the selection box to choose the command you want to apply. After you choose the command, you will be able to apply this command to the parser commands you want. You can apply it to:

  • All - to apply the selected command to “Parse & Paste Command” and “Parse & Duplicate Command”
  • Paste only - to apply the selected command to “Parse & Paste Command”
  • Duplicate only - to apply the selected command to “Parse & Duplicate Command”

• Exec Parser: User Command Options (Ctrl+Shift+z) - To call the option panel for user custom command:

  • Reinitialize commands - After you added/edited any user commands or edited the commmands.json file, you will need to run this command to reinitialize the plugin. Otherwise, the command list in the Set Parser panel won't be updated.
  • Edit commands.json - It is a json file which stores all of the user commands, it is physically located at [Packages]/User/Exec Parser.
  • Add new command - Add a new user command. You will be asked to enter the filename first. Be aware that you don't need to put any extension after the filename. After you entered the filename and if the file doesn't not exist, it will open the commands.json and the command file. You are good to go adding your codes in it. But don't forget to run the Reinitialize commands after you updated it. :-)
  • Edit command - It will show the list of all user commands and you can choose the one you want to edit. But don't forget to run the Reinitialize commands after you updated it. :-)
  • Delete commands - It will show the list of all user commands and you can choose the one you want to delete.

Built-in commands

By default, there are several built-in commands which are ready to use after your fresh install:

none
//Do nothing

dash-case
//Convert to dash case

snake_case
//Convert to snake case

camelCase
//Convert to camel case

X to Y
//Convert X to Y, Width to Height and so on

Swap equal positions
//Change var a = b; into var b = a;

Use the commands

First of all, you need to choose the command you want to use for your parser commands(paste/duplicate). Let's say you want to change the paste command to paste the words in your clipboard with camelCase, you can do the following steps:

1. Hit (Ctrl+Shift+x) to open the Exec Parser: Set Parser panel
2. Choose camelCase
3. Choose Paste only

Then Every time you hit (Ctrl+Shift+v) to trigger the Exec Parser: Parse & Paste parser command, the output will be in camelCase. Same thing for Exec Parser: Parse & Duplicate.

The command you chose will be stored until you change it again or restarting Sublime Text. There is a way to save the command you choose even after you restart the Sublime Text. You can do it by simply adding this to the User Setting json file:

"update_default_command_on_change" : true

By default, the commands for Exec Parser: Parse & Paste and Exec Parser: Parse & Duplicate are both “none”. Which means it does nothing. The reason I did it this way is that, you can change the hotkey of this plugin to replace the native paste and duplicate line functions in sublime. So feel free to replace this plugin's hotkeys with the native paste and duplicate line hotkeys.

Create your own commands

Let's say you want to create a command to add a dollar sign before the numbers. Hit (Ctrl+Shift+z) to open the Exec Parser: User Command Options panel, choose “Add new command”. Type the command filename(without any extension) like “dollarize”, then hit enter. Then it will open 2 files:

• commands.json - A json file which stores all of the user's commands descriptions. You can change the name and description in this file if you want to.
• [filename].py(In this case, dollarize.py) - Where you put your script.

Type the following python script in the dollarize.py

output = re.sub(r'(?<![\$\d])(\d+)', r'$\1', output)

Save it and hit (Ctrl+Shift+z) again to open the Exec Parser: User Command Options panel. select the Reinitialize commands to let the plugin to update the scripts. Now you are good to go to test it out.

The script file you are editing is simply executed by a exec() command in python. Which means you can get advantage of it and make your if/else statements, loops and functions. Here is another example:

def upperAndLower(char, isUpper):
    if isUpper:
        return char.upper()
    else:
        return char.lower()
arr = list(output)
for i in range(0, len(arr)):
    arr[i] = upperAndLower(arr[i], i & 1)
output = ''.join(arr)

<< My name is Edan.
>> mY NaMe iS EdAn.

Easy enough!

Exposed variables

We expose the following variables for you to build your commands:

• output(string) the text in the single line that the parser commands are applying to. If the user select multiply lines, we splitted the lines before passing to the output variable. So in any case, you are only dealing with one line. I know it can be a deal breaker if you want to do multiline parsing. The reason I did this is to try to behave what the native function does. We may expose more content in the later build but right now it is how it works.
• parserType(string) - It shows what parser command the user is using. It can be either “paste” or “duplicate”.
• selectionText(string) - The current selected text. If the user is using multi-selection, every selection is using its own instance. This variable can be multiline.
• clipboardText(string) - The clipboard content. This variable can be multiline.
• lineIndex - The index of the lines you are editing.
• numOfLines - The number of lines in the region.

Exposed Python modules

• shutil
• math
• datetime
• json
• os
• re

SETTING

/* The default parser commands */
"paste_command_id" : "none",
"duplicate_command_id" : "none",

/* To save the command you set as default */
"update_default_command_on_change" : false,

TODO

• Add more default exec commands
• Reduce the times of user's Reinitialize commands calls during command testing

GOAL

The goal of this plugin is completely replace the native paste command and duplicate line command. I coded the way that if you are not using any parser command, it behaves just like the native command.

CONTRIBUTION

It is my first time to try Python and I am not a good coder in general. So if you noticed there are something wrong with it, please make a pull request. If you have a cool command that you want to share, make a pull request. This plugin will get more and more powerful with your contribution :-)

ABOUT ME

My name is Edan Kwan(@edankwan) and I am a front-end web developer. I know nothing about Python and I am bad at programming in general. I always find it annoying to copy the dash-cased HTML attributes to camelCased javascript as variables name and I wanted to build a Sublime Plugin for that. However, I don't want to build a plugin only does one tiny thing so I decided to make it BIG! I am pretty sure you guys can write it better than me. So, make pull requests to help it grow! :)