spacemacs/layers/+lang/perl5/README.org

#+TITLE: Perl5 layer

[[file:img/perl5.png]]

* Table of Contents                                         :TOC_4_gh:noexport:
- [[#description][Description]]
  - [[#features][Features:]]
- [[#install][Install]]
  - [[#layer][Layer]]
  - [[#auto-completion-plsense][Auto-completion: PlSense]]
- [[#key-bindings][Key Bindings]]
  - [[#perldoc][Perldoc]]
  - [[#pod-and-here-doc][POD and HERE doc]]
  - [[#find-symbol][Find Symbol]]
  - [[#formating-code][Formating Code]]

* Description
This layer adds support for the Perl5 language.

** Features:
- Syntactic and semantic checking using [[https://github.com/flycheck/flycheck][flycheck]]
- Auto-completion using [[https://github.com/CeleritasCelery/company-plsense][company-plsense]]
- Format code with =perltidy=
- Jump to symbol definition

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

** Auto-completion: PlSense
=company-plsense= requires installation of the =plsense= server from [[https://github.com/aki2o/plsense#install][here]].

* Key Bindings
** Perldoc
Browse formated perldocs.

| Key Binding | Description                     |
|-------------+---------------------------------|
| ~SPC m h h~ | view perldoc of symbol at point |
| ~SPC m h d~ | view perldoc of any symbol      |

** POD and HERE doc
Select a POD or HERE doc.

| Key Binding | Description                            |
|-------------+----------------------------------------|
| ~SPC m v~   | select entire POD or HERE doc at point |

** Find Symbol
Jump to symbol definition.

| Key Binding | Description                               |
|-------------+-------------------------------------------|
| ~SPC m g g~ | jump to symbol definition                 |
| ~SPC m g G~ | jump to symbol definition in other window |

** Formating Code

| Key Binding | Description                   |
|-------------+-------------------------------|
| ~SPC m = =~ | format current line or region |
| ~SPC m = b~ | format current buffer         |
| ~SPC m = f~ | format current function       |