Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Fuco1/smartparens

Minor mode for Emacs that deals with parens pairs and tries to be smart about it.
https://github.com/Fuco1/smartparens

emacs emacs-lisp lisp pairs parentheses smartparens

Last synced: about 1 month ago
JSON representation

Minor mode for Emacs that deals with parens pairs and tries to be smart about it.

Host: GitHub
URL: https://github.com/Fuco1/smartparens
Owner: Fuco1
License: gpl-3.0
Created: 2012-11-18T11:54:15.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2024-07-13T10:02:15.000Z (about 2 months ago)
Last Synced: 2024-07-13T11:22:05.815Z (about 2 months ago)
Topics: emacs, emacs-lisp, lisp, pairs, parentheses, smartparens
Language: Emacs Lisp
Homepage:
Size: 4.45 MB
Stars: 1,808
Watchers: 25
Forks: 194
Open Issues: 241
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-starred - smartparens - Minor mode for Emacs that deals with parens pairs and tries to be smart about it. (Emacs Lisp)

README

        # Smartparens

[![Join the chat at https://gitter.im/smartparens/Lobby](https://badges.gitter.im/smartparens/Lobby.svg)](https://gitter.im/smartparens/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![MELPA](http://melpa.org/packages/smartparens-badge.svg)](http://melpa.org/#/smartparens)

[![Documentation Status](https://readthedocs.org/projects/smartparens/badge/?version=latest)](http://smartparens.readthedocs.io/en/latest/?badge=latest)

[![MELPA Stable](http://stable.melpa.org/packages/smartparens-badge.svg)](http://stable.melpa.org/#/smartparens)

[![Documentation Status](https://readthedocs.org/projects/smartparens/badge/?version=stable)](http://smartparens.readthedocs.io/en/latest/?badge=stable)

[![Build Status](https://github.com/Fuco1/smartparens/workflows/CI/badge.svg)](https://github.com/Fuco1/smartparens/actions?query=workflow%3ACI)

[![Coverage Status](https://coveralls.io/repos/github/Fuco1/smartparens/badge.svg)](https://coveralls.io/github/Fuco1/smartparens)

[![Paypal logo](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A5PMGVKCQBT88)

[![Patreon](https://c5.patreon.com/external/logo/logomarkOrange.svg)](https://www.patreon.com/user?u=3282358&ty=h)

**Table of Contents**

- [Smartparens](#smartparens)

    - [Getting Started](#getting-started)

    - [Usage](#usage)

    - [Contributing](#contributing)

        - [Language Support](#language-support)

    - [Supporting Smartparens](#supporting-smartparens)

    - [Related Projects](#related-projects)

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

It can automatically insert pairs:

![smartparens insert](images/smartparens-insert.gif)

wrap, unwrap and rewrap pairs:

![smartparens wrapping](images/smartparens-wrap.gif)

expand and contract pairs:

![smartparens slurping](images/smartparens-slurp.gif)

navigate pairs:

![smartparens navigating](images/smartparens-navigate.gif)

and much more!

## Getting Started

We generally target GNU Emacs version 25 and newer, however,

everything should work mostly fine on anything newer than version 24.

You can install smartparens from [MELPA](http://melpa.org/).  Once

installed, enable the [default configuration](https://github.com/Fuco1/smartparens/wiki/Default-configuration):

```elisp

(require 'smartparens-config)

```

You can now use smartparens with `M-x smartparens-mode`. To

automatically enable smartparens in a programming mode:

```elisp

;; 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.

You can also use `use-package` to install and setup `smartparens`.  An example config is:

``` elisp

(use-package smartparens

  :ensure smartparens  ;; install the package

  :hook (prog-mode text-mode markdown-mode) ;; add `smartparens-mode` to these hooks

  :config

  ;; load default config

  (require 'smartparens-config))

```

## 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](https://ebzzry.com/en/emacs-pairs/)

and [extensive documentation in the wiki](https://github.com/Fuco1/smartparens/wiki).

## Contributing

We love pull requests. Please include tests. Smartparens uses

[ert-runner](https://github.com/rejeep/ert-runner.el) 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`.

You can learn more about how we test on the [testing](https://github.com/Fuco1/smartparens/wiki/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](https://github.com/Fuco1/smartparens/issues/new) 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](https://github.com/Fuco1/smartparens/issues/new)

  on the tracker and submit your suggestion.

* You can make a financial donation through

  [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A5PMGVKCQBT88)

  or [Patreon](https://www.patreon.com/user?u=3282358&ty=h).  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](http://steamcommunity.com/profiles/76561198265034071/wishlist)

  or buy something on

  [Amazon](http://www.amazon.com/gp/registry/wishlist/2I8DOQH8OZEUR).

  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:

* [autopair](https://github.com/capitaomorte/autopair)

* [wrap-region](https://github.com/rejeep/wrap-region)

* [electric-pair-mode](http://www.emacswiki.org/emacs/ElectricPair)

* [paredit](http://emacswiki.org/emacs/ParEdit)

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

programming languages.