spacemacs/layers/+misc/parinfer/README.org

#+TITLE: Parinfer layer

#+TAGS: layer|misc

* Table of Contents                     :TOC_5_gh:noexport:
- [[#description][Description]]
  - [[#features][Features:]]
- [[#install][Install]]
  - [[#prerequisites][Prerequisites]]
  - [[#dotfile][Dotfile]]
- [[#configuration][Configuration]]
- [[#key-bindings][Key bindings]]

* Description
This layer provides an implementation of [[https://shaunlebron.github.io/parinfer/][parinfer]], a lisp editing paradigm that
controls indentation based on parentheses or vice versa.

** Features:
- Automatic management of parenthesis in Clojure, Emacs Lisp, Common Lisp and
  Scheme following the parinfer editing paradigm.
- Powered by a native library in the background

* Install
** Prerequisites
- This layer requires =parinfer-rust= library being installed. See [[https://github.com/eraserhd/parinfer-rust#installing][here]] for the
  dependencies.
- The =parinfer-rust-mode= package requires Emacs compiled with dynamic module
  support, which can be verified by existence of =MODULES= in the variable
 =system-configuration-features=.
- Currently, ony *nix system is supported.

** Dotfile
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =parinfer= to the existing =dotspacemacs-configuration-layers= list in this
file.

#+BEGIN_SRC emacs-lisp
  (setq-default dotspacemacs-configuration-layers '(pdf))
#+END_SRC

* Configuration
This package comes pre-configured to auto install the native library in your
=spacemacs-cache-directory=. If you don't want this, see [[https://github.com/justinbarclay/parinfer-rust-mode#option-2-building-library-from-sources][here]] for a manual
install option.

=parinfer-rust-mode= operates under [[https://github.com/justinbarclay/parinfer-rust-mode#modes][three modes]]. By default, it starts in
=smart-mode=, and can be toggled via =SPC t P=.

* Key bindings

| Key binding | Description                                         |
|-------------+-----------------------------------------------------|
| ~SPC t P~   | Toggle between parinfer smart indent and paren mode |
Clean up parinfer layer - Move to misc instead of vim - Move add-hook calls into dependent layers - Improve readme 2017-05-29 09:35:22 +00:00			`#+TITLE: Parinfer layer`

Add more tags 2019-05-02 21:49:30 +00:00			`#+TAGS: layer\|misc`

Switch to the new layers generator 2019-05-07 20:05:06 +00:00			`* Table of Contents :TOC_5_gh:noexport:`
Clean up parinfer layer - Move to misc instead of vim - Move add-hook calls into dependent layers - Improve readme 2017-05-29 09:35:22 +00:00			`- [[#description][Description]]`
Fix documentation for parinfer, pdf-tools, yaml, csv and salt layer 2017-10-04 08:13:01 +00:00			`- [[#features][Features:]]`
Clean up parinfer layer - Move to misc instead of vim - Move add-hook calls into dependent layers - Improve readme 2017-05-29 09:35:22 +00:00			`- [[#install][Install]]`
parinfer: cleaning up - Updated layer README.org to include prerequisites - Removed unnecessary layer config variables which are mere re-naming of customization variables from `parinfer-rust-mode`. - Removed the image. 2022-08-04 22:32:27 +00:00			`- [[#prerequisites][Prerequisites]]`
			`- [[#dotfile][Dotfile]]`
Clean up parinfer layer - Move to misc instead of vim - Move add-hook calls into dependent layers - Improve readme 2017-05-29 09:35:22 +00:00			`- [[#configuration][Configuration]]`
			`- [[#key-bindings][Key bindings]]`

			`* Description`
			`This layer provides an implementation of [[https://shaunlebron.github.io/parinfer/][parinfer]], a lisp editing paradigm that`
			`controls indentation based on parentheses or vice versa.`

Fix documentation for parinfer, pdf-tools, yaml, csv and salt layer 2017-10-04 08:13:01 +00:00			`** Features:`
parinfer: cleaning up - Updated layer README.org to include prerequisites - Removed unnecessary layer config variables which are mere re-naming of customization variables from `parinfer-rust-mode`. - Removed the image. 2022-08-04 22:32:27 +00:00			`- Automatic management of parenthesis in Clojure, Emacs Lisp, Common Lisp and`
			`Scheme following the parinfer editing paradigm.`
[parinfer] Switch implementation to parinfer-rust-mode as parinfer-mode is officially unmaintained now. 2021-03-07 21:22:03 +00:00			`- Powered by a native library in the background`
Fix documentation for parinfer, pdf-tools, yaml, csv and salt layer 2017-10-04 08:13:01 +00:00
Clean up parinfer layer - Move to misc instead of vim - Move add-hook calls into dependent layers - Improve readme 2017-05-29 09:35:22 +00:00			`* Install`
parinfer: cleaning up - Updated layer README.org to include prerequisites - Removed unnecessary layer config variables which are mere re-naming of customization variables from `parinfer-rust-mode`. - Removed the image. 2022-08-04 22:32:27 +00:00			`** Prerequisites`
			`- This layer requires =parinfer-rust= library being installed. See [[https://github.com/eraserhd/parinfer-rust#installing][here]] for the`
			`dependencies.`
			`- The =parinfer-rust-mode= package requires Emacs compiled with dynamic module`
			`support, which can be verified by existence of =MODULES= in the variable`
			`=system-configuration-features=.`
			`- Currently, ony *nix system is supported.`

			`** Dotfile`
Clean up parinfer layer - Move to misc instead of vim - Move add-hook calls into dependent layers - Improve readme 2017-05-29 09:35:22 +00:00			`To use this configuration layer, add it to your =~/.spacemacs=. You will need to`
			`add =parinfer= to the existing =dotspacemacs-configuration-layers= list in this`
			`file.`

parinfer: cleaning up - Updated layer README.org to include prerequisites - Removed unnecessary layer config variables which are mere re-naming of customization variables from `parinfer-rust-mode`. - Removed the image. 2022-08-04 22:32:27 +00:00			`#+BEGIN_SRC emacs-lisp`
			`(setq-default dotspacemacs-configuration-layers '(pdf))`
			`#+END_SRC`

Clean up parinfer layer - Move to misc instead of vim - Move add-hook calls into dependent layers - Improve readme 2017-05-29 09:35:22 +00:00			`* Configuration`
parinfer: cleaning up - Updated layer README.org to include prerequisites - Removed unnecessary layer config variables which are mere re-naming of customization variables from `parinfer-rust-mode`. - Removed the image. 2022-08-04 22:32:27 +00:00			`This package comes pre-configured to auto install the native library in your`
			`=spacemacs-cache-directory=. If you don't want this, see [[https://github.com/justinbarclay/parinfer-rust-mode#option-2-building-library-from-sources][here]] for a manual`
			`install option.`

			`=parinfer-rust-mode= operates under [[https://github.com/justinbarclay/parinfer-rust-mode#modes][three modes]]. By default, it starts in`
			`=smart-mode=, and can be toggled via =SPC t P=.`
Clean up parinfer layer - Move to misc instead of vim - Move add-hook calls into dependent layers - Improve readme 2017-05-29 09:35:22 +00:00
			`* Key bindings`

[parinfer] Switch implementation to parinfer-rust-mode as parinfer-mode is officially unmaintained now. 2021-03-07 21:22:03 +00:00			`\| Key binding \| Description \|`
			`\|-------------+-----------------------------------------------------\|`
			`\| ~SPC t P~ \| Toggle between parinfer smart indent and paren mode \|`