summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbscan <10503608+bscan@users.noreply.github.com>2022-02-27 16:47:44 -0500
committerbscan <10503608+bscan@users.noreply.github.com>2022-02-27 16:47:44 -0500
commitd23aef85fd9dd265de30d632c2cef63e7999d390 (patch)
tree0d1c190a38d412472aaa32682a5dc10a07ba8210
parentd4ed0af7de9a69e5e4fc618a41ce89eeee507656 (diff)
downloadPerlNavigator-d23aef85fd9dd265de30d632c2cef63e7999d390.zip
Adding perltidy instructions
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8b68ef7..66b8f40 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ Install the vscode extension from here: https://marketplace.visualstudio.com/ite
* Perl Critic static code analysis/suggestions
* Smart context-aware autocompletion and navigation
* Code Navigation ("Go To Definition") anywhere, including to installed modules and compile-time dependencies
+* Code formatting via Perl::Tidy
* Outline view
* Hover for more details about objects, subs, and modules
* Does not write any cache directories or temp files.
@@ -40,6 +41,8 @@ You should specify a Perl::Critic profile via "perlnavigator.perlcriticProfile".
If that also does not exist, a default profile will be used. This default profile is not very strict.
The default severities are reasonable, (primarily used for coloring the squiggly underlines) but you can change "perlnavigator.severity1" through severity5. Allowable options are error, warning, info, and hint.
+### Perl Tidy Customization
+It is recommended to set "perlnavigator.perltidyProfile" if you would like customized formatting. Otherwise, the default settings will be used. I might create a default profile at some point.
## Installation For Other Editors
Currently, this is not yet packaged for other editors but you can build from source. You'll need to have node.js and npm installed.