Send code and text to macOS and Linux Terminals, iTerm, ConEmu, Cmder, Tmux, Terminus; R (RStudio), Julia, IPython.
Python AppleScript
Latest commit ade469a Jul 29, 2018

README.md

SendCode for Sublime Text

Send code and text to macOS and Linux Terminals, iTerm, ConEmu, Cmder, Tmux, Terminus; R (RStudio), Julia, IPython.

Following Programs are supported

  • Mac: Terminal, iTerm (>=2.9), R GUI, RStudio Desktop, RStudio and Jupyter running on Chrome and Safari
  • Windows: Cmder, ConEmu, R GUI, RStudio Desktop
  • Linux: Tmux, Screen, Gnome-Terminal, Pantheon-Terminal, Mate-Terminal, Konsole, RStudio Desktop
  • Others: Terminus, TerminalView

Installation

You could install SendCode via Package Control.

  • If you don't have Package Control installed, follow the installation instructions on the Package Control website.
  • In Sublime Text, type cmd+shift+p (Mac) or ctrl+shift+p (Windows/Linux) to bring up the command palette.
  • Into the command palette start typing Package Control: Install Package and select the option when in pops up.
  • In the Install Package window start typing SendCode and select the option when it pops up.
  • SendCode should then be installed.

If you are using Linux, we might need to install xdotool to use some features. Ubuntu users can use

sudo apt-get install xdotool

If it cannot be found, you will be prompted to download a binary distribution.

Usage

Select a program using the command SendCode: Choose Program in command palette. The default program on macOS, windows and linux are Terminal, Cmder and tmux respectively. Each syntax binds to its own program. For instance, you could bind R to r files and tmux to python files.

There are two main keybindings:

  • cmd+enter (Mac) or ctrl+enter (Windows/Linux)

    If text is selected, it sends the text to the program selected. If no text is selected, then it sends the current block (if found). Finally, it moves the cursor to the next line.

  • cmd+b (Mac) or ctrl+b (Windows/Linux): source current file (R, Julia and Python (IPython) only)

    SendCode uses Sublime build system to source files, you might have to choose the Source File option in a pop up window.

Troubleshooting

  1. Python console

    IPython (5.0 or above, or any repls which support bracketed paste mode) are assumed to be used.

  2. rtichoke console

    You might want to turn on bracketed_paste_mode if rtichoke is used.

  3. RStudio on Windows

    Make sure RStudio v1.1.383 or above is used.

  4. R Gui on Windows

    Make sure the corresponding R program is opened when you are sending the text.

  5. Cmder/ Conemu on Windows

    You might need to set the path to ConEmuC.exe in SendCode settings. For Cmder, the file is located at <path to cmder folder>\\vendor\\conemu-maximus5\\ConEmu\\ConEmuC.exe.

  6. Safari-Jupyter on macOS

    Most likely you haven't enabled JavaScript for AppleScript. Check the option "Allow JavaScript from Apple Events" in the Develop menu (the Develope menu needs to be enabled in the preferences).

Custom Keybindings

It is fairly easy to create your own keybinds for commands which you frequently use. For example, the following keybinds execute changing working directory commands for R, Python and Julia.

[
    {
        "keys": ["ctrl+shift+h"], "command": "send_code",
        "args": {"cmd": "setwd(\"$file_path\")"},
        "context": [
            { "key": "selector", "operator": "equal", "operand": "source.r" }
        ]
    },
    {
        "keys": ["ctrl+shift+h"], "command": "send_code",
        "args": {"cmd": "%cd \"$file_path\""},
        "context": [
            { "key": "selector", "operator": "equal", "operand": "source.python" }
        ]
    },
    {
        "keys": ["ctrl+shift+h"], "command": "send_code",
        "args": {"cmd": "cd(\"$file_path\")"},
        "context": [
            { "key": "selector", "operator": "equal", "operand": "source.julia" }
        ]
    }
]

SendCode expands following variables in the cmd field:

  • $file, the full path to the file
  • $file_path, the directory contains the file
  • $file_name, the file name
  • $file_basename, the file name without extension
  • $file_extension, the file extension
  • $folder, the first folder of current window
  • $project_path, the directory where sublime-project is stored
  • $current_folder, the folder of the window which contains the current view
  • $selection, the text selected, or the word under cursor
  • $line, the current line number

It also supports placeholders for variables, details can be found in the unofficial documentation.

${file_path:$folder}

This will emit the directory of current file if there is one, otherwise the first folder of the current window.

You also don't have to worry about escaping quotes and backslashes between quotes, SendCode will handle them for you.

The prog argument determines which program to use

[
    {
        "keys": ["ctrl+shift+enter"], "command": "send_code",
        "args": {"cmd": "\n", "prog": "tmux"}
    }
]

User settings

A couple of settings can be found Preferences: SendCode Settings

Block expansion

SendCode uses the following logics to expand cursor when sending code.

  • Expand current line to match (), [] and {}.
  • R: multiline code seperated by operators and knitr-spin #+ decorators.
  • Julia: # %% decorators and begin, end indented pairs.
  • Python: indentations or # %%/# In[] decorators.
  • Markdown fenced code blocks of Markdown Extended and R Markdown: put the cursor at the line of ``` to send the whole block.