mirror of https://github.com/slap-editor/slap.git synced 2024-11-12 18:30:26 +03:00

Sublime-like terminal-based text editor

Go to file

Dan Kaplun 037686264f style(flags): improves -v logic		2015-06-26 00:58:57 -04:00
lib	style(flags): improves -v logic	2015-06-26 00:58:57 -04:00
spec	fix(tests): detach pane on quit instead of child editor	2015-06-26 00:26:57 -04:00
.gitignore	Initial commit	2014-04-20 20:39:14 -07:00
.travis.yml	fix(test): don't test node v0.8	2015-06-03 22:07:21 -04:00
default-config.ini	docs(config): references to other default config files	2015-06-13 12:06:47 -04:00
install.sh	Replaces `npm install -g slap` with `npm install -g slap@latest` which mitigates possibility of npm using local path $PWD/slap instead of remote package slap	2015-05-15 12:02:24 -04:00
LICENSE	Initial commit	2014-04-20 20:39:14 -07:00
package.json	fix(engines): support <0.11 >=0.12.5	2015-06-26 00:43:39 -04:00
README.md	style(readme): change header	2015-06-03 22:11:34 -04:00
screenshot.png	Updates screenshot	2014-06-23 03:57:18 -05:00
slap.ini	refactor(editor-widget): move editor config to editor-widget	2015-06-11 21:46:26 -04:00
slap.js	fix(cmd): bin/slap.js -> slap.js	2015-06-02 22:14:51 -04:00

slap 👋

slap is a Sublime-like terminal-based text editor that strives to make editing from the terminal easier. It has:

first-class mouse support (even over an SSH connection)
a Sublime-like file sidebar
double-click to select word, highlight other occurrences
configurable Sublime-like keybindings * (Ctrl+S save, Ctrl+Z undo, etc.)
copying/pasting with OS clipboard support
infinite undo/redo
syntax highlighting for 100+ languages
bracket matching
autoindentation
heavily customizeable via plugins
... many other features that will make you leave nano, vim, and emacs behind

Installation

$ curl -sL https://raw.githubusercontent.com/slap-editor/slap/master/install.sh | sh

If you already have NodeJS installed:

$ sudo npm install -g slap@latest

Usage

$ slap fish.c
$ slap fish1.c fish2.c
$ slap redfish/ # open dir in browser
$ slap # new file in current dir

Configuration

Use ~/.slap/config to override the defaults in slap/slap.ini:

[header.style]
bg = "red"

Alternatively, pass options in via command line:

$ slap --header.style.bg red file.c

Plugins

Slap is fully customizeable and supports plugins written in JS. You can place single JS files, or NodeJS packages, into ~/.slap/plugins/.

To write your own plugin, a good starting point is slap-clipboard-plugin. Please note that plugin packages must have "keywords": ["slap-plugin"] in package.json.

OS support

OSX

iTerm2 supports the mouse and most keybindings out of the box. For optimal Terminal.app usage, see slap-Terminal.app-profile.

Linux

If you are using X.Org, ensure xclip is installed for OS clipboard support.

Windows

Most terminal emulators in Windows do not support mouse events, PuTTY being a notable exception. In Cygwin, slap crashes on startup due to joyent/node#6459.

Issues

Join us in #slap on Freenode for troubleshooting, theme/plugin/core development, or palm strike discussion of any nature.

Some keys don't work!

Unfortunately most terminal emulators do not support certain keystrokes and as such there is no way to handle them. These include C-backspace, S-home/end, and S-pageup/down. Most of these actions have alternate keybindings, inspired by emacs and other editors, but if you find one that doesn't work, please submit an issue!

Too slow!

Try --editor.highlight false or adding the following to ~/.slap/config:

[editor]
highlight = false

If that doesn't improve performance, please run with --perf.profile true and submit an issue with the newly-created v8.log file.

README.md