Minor mode for Emacs that deals with parens pairs and tries to be smart about it.
Emacs Lisp Shell
Permalink
Failed to load latest commit information.
.github Add GitHub issues template (#704) Feb 27, 2017
dev Add old notes as well Mar 12, 2017
docs Fix the documentation index Sep 25, 2016
images Reworking README to showcase best features. Dec 12, 2015
test [Fix #663] Add trigger for wrapping. Apr 22, 2017
.gitignore Ignore local stuff locally in .git/info/exclude Mar 12, 2017
.travis.yml Test against 25.1 and trunk too Dec 31, 2016
Cask Release 1.10.1 Apr 24, 2017
LICENSE [Issue #295] Add LICENSE Feb 4, 2014
README.md Update README.md Mar 27, 2017
make-release.sh Make release script executable Apr 24, 2017
smartparens-clojure.el Match "`" with "`" in Clojure-related modes Oct 15, 2016
smartparens-config.el Introduce smartparens-javascript Apr 17, 2017
smartparens-elixir.el add `defp` to elixir config Apr 3, 2017
smartparens-ess.el [Fix #632] [Fix #578] Do not insert extra spaces if slurping won't br… Apr 22, 2017
smartparens-haskell.el Use `comint-last-prompt' in smartparens-haskell Oct 27, 2015
smartparens-html.el Add missing docstrings to silence doccheck Mar 11, 2017
smartparens-javascript.el Introduce smartparens-javascript Apr 17, 2017
smartparens-latex.el [Fix #632] [Fix #578] Do not insert extra spaces if slurping won't br… Apr 22, 2017
smartparens-lua.el Add missing docstrings to silence doccheck Mar 11, 2017
smartparens-ml.el [Fix #632] [Fix #578] Do not insert extra spaces if slurping won't br… Apr 22, 2017
smartparens-pkg.el Release 1.10.1 Apr 24, 2017
smartparens-python.el [Fix #632] [Fix #578] Do not insert extra spaces if slurping won't br… Apr 22, 2017
smartparens-racket.el Add configuration for racket modes Oct 27, 2015
smartparens-ruby.el [Fix #671] Use lexical binding Mar 11, 2017
smartparens-rust.el Add missing docstrings to silence doccheck Mar 11, 2017
smartparens-scala.el changes after review of PR Jul 10, 2015
smartparens.el [Fix #663] Add trigger for wrapping. Apr 22, 2017

README.md

Smartparens

MELPA Documentation Status MELPA Stable Documentation Status Build Status Coverage Status Paypal logo

Table of Contents

Smartparens is a minor mode for dealing with pairs in Emacs.

It can automatically insert pairs:

smartparens insert

wrap, unwrap and rewrap pairs:

smartparens wrapping

expand and contract pairs:

smartparens slurping

navigate pairs:

smartparens navigating

and much more!

Getting Started

We generally target GNU Emacs version 24.3 and newer, however, everything should work mostly fine on anything newer than version 24.

You can install smartparens from MELPA. Once installed, enable the default configuration:

(require 'smartparens-config)

You can now use smartparens with M-x smartparens-mode. To automatically enable smartparens in a programming mode:

;; Always start smartparens mode in js-mode.
(add-hook 'js-mode-hook #'smartparens-mode)

You may want to try smartparens-strict-mode. This enforces that pairs are always balanced, so commands like kill-line keep your code well-formed.

Usage

Inside Emacs, M-x sp-cheat-sheet will show you all the commands available, with examples.

There's also a great article demonstrating movement and editing in smartparens and extensive documentation in the wiki.

Contributing

We love pull requests. Please include tests. Smartparens uses ert-runner for testing. To run all the tests, run:

$ cask exec ert-runner

Alternatively, you can open the individual files in Emacs, then M-x eval-buffer M-x ert.

There are also some ecukes tests, but these are deprecated.

You can learn more about how we test on the testing wiki page.

Language Support

Smartparens has a default configuration that works well for most languages. For language-specific behaviour, smartparens has a separate smartparens-FOO.el file for every language and smartparens-config.el loads these automatically.

Supporting Smartparens

If you want to support this project, you can:

  • Contribute code. If you have an idea that is not yet implemented and will benefit this project, feel free to implement it and submit a pull request. If you have any concerns whether your contribution will be accepted, ask beforehand. You can email the author or start an issue on the tracker.

  • Contribute ideas. Even if you can't code Emacs Lisp, you can still contribute valuable ideas for other programmers to implement. Simply start new issue on the tracker and submit your suggestion.

  • You can make a financial donation through PayPal or Patreon. If you like smartparens and can spare a modest amount on a donation, feel free to do so. These donations are expressions of your gratitude and are used for my personal "rewards" (books, games, music etc.). You can also gift me a game on Steam or buy something on Amazon. Regardless of the donations, smartparens will always be free both as in beer and as in speech.

Related Projects

Other Emacs projects that deal with pairs include:

Smartparens aims to provide a superset of these features, in all programming languages.