/extempore-sublime

Sublime Text plugin for Extempore

Primary LanguagePython

Extempore-Sublime

Note: this plugin is no-longer actively developed---if you're a keen ST & Extempore user and want to try and resurrect it, pull requests welcome 😊

A Sublime Text 2 and 3 plugin for Extempore. The plugin provides syntax highlighting, as well as some commands and keybindings for connecting to and working with a running Extempore process.

Installation

To install the plugin, simply download or clone this repo into your Sublime Text packages directory.

Installation instructions for Extempore can be found at Extempore's github page.

Working with Extempore in ST

The plugin provides three commands:

  • extempore_connect will connect to a running (local) Extempore process on the default port. You have to start this Extempore process yourself, generally in another terminal.

  • extempore_disconnect does what it says on the tin.

  • extempore_evaluate will evaluate either the currently highlighted region (if applicable) or the current top-level def surrounding the cursor. This is how you send code to the Extempore process for evaluation.

You can trigger the commands either through the menu (Tools > Extempore), or the command palette (ctrl+shift+P) or through the shortcut keys. The default keybindings are the same as the Extempore Emacs mode, but you can change them to whatever you like.

Keybindings

If you want to set up your own keybindings for e.g. extempore_evaluate, then you can do that in Default.sublime-keymap.

Known Issues

The syntax highlighting currently doesn't cover a few edge cases---so if you end up tinkering with Extempore.JSON-tmLanguage to fix anything then feel free to submit a patch.

Licence

Copyright (c) 2012--2019, Mikhail Lozanov, Ben Swift

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the authors nor other contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLEXTD. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.