Minor mode for Emacs that deals with parens pairs and tries to be smart about it.
Emacs Lisp Cucumber Makefile
Latest commit 453687e Jul 21, 2016 @aaronjensen aaronjensen committed with Limit binding of case fold search (#628)
* Fix typo

* Only bind case-fold-search if necessary

Binding case-fold-search is O(n) for the number of buffers you have
open, so it is slow.

http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18522#201
http://debbugs.gnu.org/db/23/23928.html

* Switch description to imperative
Failed to load latest commit information.
features Remove features where we have equivalents in sp-wrapping-test.el. Dec 26, 2015
images Reworking README to showcase best features. Dec 12, 2015
test [Fix #593] Add smartparens-clojure.el (#620) Jul 15, 2016
.gitignore Update gitignore Jan 6, 2014
.travis.yml Don't run older emacs tests until cask dependency management is fixed Nov 14, 2015
Cask [Fix #593] Add smartparens-clojure.el (#620) Jul 15, 2016
LICENSE [Issue #295] Add LICENSE Feb 4, 2014
Makefile Document testing. Nov 27, 2015
README.md Update README May 13, 2016
smartparens-clojure.el [Fix #593] Add smartparens-clojure.el (#620) Jul 15, 2016
smartparens-config.el Fix elisp prefix regexp May 21, 2016
smartparens-haskell.el Use `comint-last-prompt' in smartparens-haskell Oct 26, 2015
smartparens-html.el Update copyright notice to include year 2014 Jan 10, 2014
smartparens-latex.el [Fix #586] Insert spaces after wrapping to preserve LaTeX macros. Apr 8, 2016
smartparens-lua.el Update copyright notice to include year 2014 Jan 10, 2014
smartparens-pkg.el Release 1.7.1 May 11, 2016
smartparens-python.el [#374] Fix single quotes in python not autoskiping properly. Jun 18, 2016
smartparens-racket.el Add configuration for racket modes Oct 26, 2015
smartparens-ruby.el Add smartparens support for motion-mode. (#600) May 7, 2016
smartparens-rust.el Don't pair ' in strings in Rust. Feb 8, 2016
smartparens-scala.el changes after review of PR Jul 10, 2015
smartparens.el Limit binding of case fold search (#628) Jul 21, 2016
smartparens.org Updated docs Nov 20, 2012

README.md

Smartparens

MELPA MELPA Stable 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:

$ make test

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.