|
1 | 1 | # SendTextPlus for Sublime Text |
2 | | - |
3 | | ----- |
4 | | -### *Note* |
5 | | - |
6 | | -SendTestPlus will be deprecated soon in favour of [SendREPL](https://github.com/randy3k/SendREPL). |
7 | | - |
8 | 2 | ---- |
9 | 3 |
|
10 | | -This package improves [SendText](https://github.com/wch/SendText), particularly for `r`, `python` and `julia` syntaxes (Note: [IPython](https://ipython.org) is assumed for python codes.). It supports |
11 | | - |
12 | | -- Mac: Terminal, iTerm (>=2.9), RStudio, R GUI, and Jupyter running on Chrome and Safari |
13 | | -- Linux: gnome-terminal, screen, tmux and RStudio. `xdotool` is required for gnome-terminal and RStudio, it can be installed via `apt-get install xdotool`. As gnome-terminal doesn't accept keystrokes while it is not in focus, we need to switch focus temporarily to gnome-terminal in order to send the code. |
14 | | -- Windows: Cmder (see below to configure Cmder), Cygwin, R32, R64 and RStudio. Due to an issue of RStudio (see [RStudio](https://support.rstudio.com/hc/en-us/community/posts/208160308-ctrl-enter-doesn-t-work-in-R-console-without-a-source-file-opened-) and [this](https://github.com/rstudio/rstudio/commit/52f87a8ebec89a8ee7fcfe0b138cc7c13b72d488)), it doesn't accept the `ctrl-enter` key when there is no file opened, so make sure there is at least one (possibly untitled) source file opened. |
15 | | - |
16 | | - |
17 | | -### Installation |
18 | | - |
19 | | -Via Package Control. |
20 | | - |
21 | | -### Usage |
22 | | - |
23 | | -Use the command `SendText+: Choose Program` in command palette to quickly change the active program. |
24 | | -Terminal is the default for Mac, Cmder for Windows and tmux for Linux. |
25 | | - |
26 | | -- <kbd>cmd</kbd>+<kbd>enter</kbd> (Mac) or <kbd>ctrl</kbd>+<kbd>enter</kbd> (Windows/Linux) |
27 | | - |
28 | | - 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. |
29 | | - |
30 | | - |
31 | | -- <kbd>cmd</kbd>+<kbd>\\</kbd> (Mac) or <kbd>ctrl</kbd>+<kbd>\\</kbd> (Windows/Linux): change working directory (R, Julia and Python only) |
32 | | - |
33 | | - |
34 | | -- <kbd>cmd</kbd>+<kbd>b</kbd> (Mac) or <kbd>ctrl</kbd>+<kbd>b</kbd> (Windows/Linux): source current file (R, Julia and Python only) |
35 | | - |
36 | | - SendTextPlus uses Sublime build system to source files, you might have to choose the `Source File` option in a pop up window. |
37 | | - |
38 | | - |
39 | | -### Platform and syntax specific settings. |
40 | | - |
41 | | -You can use different settings for different platforms and syntaxes by editing the default settings at `Preferences` -> `Package Settings` -> `SendTextPlus`. It understands platform and syntax specifications. The list of supported programs are |
42 | | - |
43 | | -- Mac: Terminal, iTerm, R, RStudio, Chrome-RStudio, Chrome-Jupyter, Safari-RStudio, Safari-Jupyter |
44 | | -- Liniux: gnome-terminal, tmux, screen, RStudio |
45 | | -- Windows: Cmder, Cygwin, R64, R32, RStudio |
46 | | -- or SublimeREPL |
47 | | - |
48 | | -Order matters, SendTextPlus will pick the first match out of the list. |
49 | | - |
50 | | -For example: |
51 | | - |
52 | | -```json |
53 | | -{ |
54 | | - "user" : [ |
55 | | - { |
56 | | - "platform": "osx", |
57 | | - "scopes": ["source.r"], |
58 | | - "prog": "RStudio", |
59 | | - }, |
60 | | - { |
61 | | - "platform": "osx", |
62 | | - "scopes": ["source.python"], |
63 | | - "prog": "Chrome-Jupyter", |
64 | | - "remove_line_indentation": false |
65 | | - }, |
66 | | - { |
67 | | - "platform": "osx", |
68 | | - "scopes": ["source.julia"], |
69 | | - "prog": "Terminal", |
70 | | - "bracketed_paste_mode": false |
71 | | - } |
72 | | - ] |
73 | | -} |
74 | | -``` |
75 | | -Make sure [User] is selected in `SendText+: Choose Program`. |
76 | | - |
77 | | -### Custom Keybind |
78 | | - |
79 | | -It is fairly easy to create your own keybinds for commands which you frequently use. For example, the following keybind run the `R` command `source("<the current file>")` in the active program. |
80 | | -SendTextPlus understands the following variables in the `cmd` field: |
81 | | - |
82 | | -- `$file`, the full path to the file |
83 | | -- `$file_path`, the directory contains the file |
84 | | -- `$file_name`, the file name |
85 | | -- `$file_basename`, the file name without extension |
86 | | -- `$file_extension`, the file extension |
87 | | -- `$project_path`, the active folder, if not found, use the directory of current file |
88 | | -- `$selection`, the text selected, or the word under cursor |
89 | | - |
90 | | -An example |
91 | | - |
92 | | -```json |
93 | | - { |
94 | | - "keys": ["super+shift+a"], "command": "send_text_plus", |
95 | | - "args": {"cmd": "source(\"$file\")"}, |
96 | | - "context": [ |
97 | | - { "key": "selector", "operator": "equal", "operand": "source.r" } |
98 | | - ] |
99 | | - }, |
100 | | -``` |
101 | | - |
102 | | -### Cmder settings |
103 | | - |
104 | | -- Go to `Paste` in the settings, uncheck, "Confirm <enter> keypress" and "Confirm pasting more than..." |
105 | | -- Change the default paste all lines command from <kbd>shift</kbd>+<kbd>insert</kbd> to <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>v</kbd>. I actually posted an [issue](https://github.com/cmderdev/cmder/issues/710) at Cmder about the default keybind. |
| 4 | +SendTestPlus is be deprecated in favour of [SendREPL](https://github.com/randy3k/SendREPL). |
106 | 5 |
|
| 6 | +Previous README can be found [here](README.old.md). |
107 | 7 |
|
108 | | -### Some details about block detection |
109 | 8 |
|
110 | | -- R blocks are detected by `{`,`}` pairs. |
111 | | -- Julia blocks are detected by `begin`, `end` pairs and indentations. |
112 | | -- Python blocks are detected by indentations or by `# %%`/`# In[]` decorators. |
113 | | -- Markdown fenced code of [Markdown Extended](https://github.com/jonschlinkert/sublime-markdown-extended) and [R Markdown](https://github.com/randy3k/R-Box) is also supported. |
0 commit comments