Perl::LanguageServer(3)

NAME
Perl::LanguageServer - Language Server and Debug Protocol Adapter for Perl

VERSION
Version 2.5.0

SYNOPSIS
This is a Language Server and Debug Protocol Adapter for Perl

It implements the Language Server Protocol which provides syntax-checking, symbol search, etc. Perl to various editors, for example Visual Studio Code or Atom.

<https://microsoft.github.io/language-server-protocol/specification>

It also implements the Debug Adapter Protocol, which allow debugging with various editors/includes

<https://microsoft.github.io/debug-adapter-protocol/overview>

Should work with any Editor/IDE that support the Language-Server-Protocol.

To use both with Visual Studio Code, install the extension "perl"

Any comments and patches are welcome.

DOCUMENTATION
Language Server and Debug Protocol Adapter for Perl

  Features

•   Language Server

    •   Syntax checking

    •   Symbols in file

    •   Symbols in workspace/directory

    •   Goto Definition

    •   Find References

    •   Call Signatures

    •   Supports multiple workspace folders

    •   Document and selection formatting via perltidy

    •   Run on remote system via ssh

    •   Run inside docker container

    •   Run inside kubernetes

•   Debugger

    •   Run, pause, step, next, return

    •   Support for coro threads

    •   Breakpoints

    •   Conditional breakpoints

    •   Breakpoints can be set while program runs and for modules not yet loaded

    •   Variable view, can switch to every stack frame or coro thread

    •   Set variable

    •   Watch variable

    •   Tooltips with variable values

    •   Evaluate perl code in debuggee, in context of every stack frame of coro thread

    •   Automatically reload changed Perl modules while debugging

    •   Debug multiple perl programs at once

    •   Run on remote system via ssh

    •   Run inside docker container

    •   Run inside kubernetes

  Requirements
You need to install the perl module Perl::LanguageServer to make this extension work, e.g. run "cpan Perl::LanguageServer" on your target system.

Please make sure to always run the newest version of Perl::LanguageServer as well.

NOTE: Perl::LanguageServer depend on AnyEvent::AIO and Coro. There is a warning that this might not work with newer Perls. It works fine for Perl::LanguageServer. So just confirm the warning and install it.

Perl::LanguageServer depends on other Perl modules. It is a good idea to install most of then with your linux package manager.

e.g. on Debian/Ubuntu run:

     sudo apt install libanyevent-perl libclass-refresh-perl libcompiler-lexer-perl \
     libdata-dump-perl libio-aio-perl libjson-perl libmoose-perl libpadwalker-perl \
     libscalar-list-utils-perl libcoro-perl

     sudo cpan Perl::LanguageServer

e.g. on Centos 7 run:

      sudo yum install perl-App-cpanminus perl-AnyEvent-AIO perl-Coro
      sudo cpanm Class::Refresh
      sudo cpanm Compiler::Lexer
      sudo cpanm Hash::SafeKeys
      sudo cpanm Perl::LanguageServer

In case any of the above packages are not available for your os version, just leave them out. The cpan command will install missing dependencies. In case the test fails, when running cpan "install", you should try to run "force install".

  Extension Settings
This extension contributes the following settings:

•   "perl.enable": enable/disable this extension

•   "perl.sshAddr": ip address of remote system

•   "perl.sshPort": optional, port for ssh to remote system

•   "perl.sshUser": user for ssh login

•   "perl.sshCmd": defaults to ssh on unix and plink on windows

•   "perl.sshWorkspaceRoot": path of the workspace root on remote system

•   "perl.perlCmd": defaults to perl

•   "perl.perlArgs": additional arguments passed to the perl interpreter that starts the LanguageServer

•   "useTaintForSyntaxCheck": if true, use taint mode for syntax check

•   "perl.sshArgs": optional arguments for ssh

•   "perl.pathMap": mapping of local to remote paths

•   "perl.perlInc": array with paths to add to perl library path. This setting is used by the syntax checker and for the debuggee and also for the LanguageServer itself.

•   "perl.fileFilter": array for filtering perl file, defaults to [.pm,.pl]

•   "perl.ignoreDirs": directories to ignore, defaults to [.vscode, .git, .svn]

•   "perl.debugAdapterPort": port to use for connection between vscode and debug adapter inside Perl::LanguageServer.

•   "perl.debugAdapterPortRange": if debugAdapterPort is in use try ports from debugAdapterPort to debugAdapterPort + debugAdapterPortRange. Default 100.

•   "perl.showLocalVars": if true, show also local variables in symbol view

•   "perl.logLevel": Log level 0-2.

•   "perl.logFile": If set, log output is written to the given logfile, instead of displaying it in the vscode output pane. Log output is always appended. Only use during debugging of LanguageServer itself.

•   "perl.disableCache": If true, the LanguageServer will not cache the result of parsing source files on disk, so it can be used within readonly directories

•   "perl.containerCmd": If set Perl::LanguageServer can run inside a container. Options are: 'docker', 'docker-compose', 'kubectl'

•   "perl.containerArgs": arguments for containerCmd. Varies depending on containerCmd.

•   "perl.containerMode": To start a new container, set to 'run', to execute inside an existing container set to 'exec'. Note: kubectl only supports 'exec'

•   "perl.containerName": Image to start or container to exec inside or pod to use

  Debugger Settings for launch.json

•   "type": needs to be "perl"

•   "request": only "launch" is supported (this is a restriction of perl itself)

•   "name": name of this debug configuration

•   "program": path to perl program to start

•   "stopOnEntry": if true, program will stop on entry

•   "args": optional, array or string with arguments for perl program

•   "env": optional, object with environment settings

•   "cwd": optional, change working directory before launching the debuggee

•   "reloadModules": if true, automatically reload changed Perl modules while debugging

•   "sudoUser": optional, if set run debug process with sudo -u \<sudoUser\>.

•   "useTaintForDebug": optional, if true run debug process with -T (taint mode).

•   "containerCmd": If set debugger runs inside a container. Options are: 'docker', 'docker-compose', 'podman', 'kubectl'

•   "containerArgs": arguments for containerCmd. Varies depending on containerCmd.

•   "containerMode": To start a new container, set to 'run', to debug inside an existing container set to 'exec'. Note: kubectl only supports 'exec'

•   "containerName": Image to start or container to exec inside or pod to use

•   "pathMap": mapping of local to remote paths for this debug session (overwrites global "perl.path_map")

  Remote syntax check & debugging
If you developing on a remote machine, you can instruct the Perl::LanguageServer to run on that remote machine, so the correct modules etc. are available for syntax check and debugger is started on the remote machine. To do so set sshAddr and sshUser, preferably in your workspace configuration.

Example:

    "sshAddr": "10.11.12.13",
    "sshUser": "root"

Also set sshWorkspaceRoot, so the local workspace path can be mapped to the remote one.

Example: if your local path is \10.11.12.13\share\path\to\ws and on the remote machine you have /path/to/ws

    "sshWorkspaceRoot": "/path/to/ws"

The other possibility is to provide a pathMap. This allows one to having multiple mappings.

Examples:

    "perl.pathMap": [
        ["remote uri", "local uri"],
        ["remote uri", "local uri"]
    ]

    "perl.pathMap": [
        [
        "file:///",
        "file:///home/systems/mountpoint/"
        ]
    ]

  Syntax check & debugging inside a container
You can run the LanguageServer and/or debugger inside a container by setting "containerCmd" and "conatinerName". There are more container options, see above.

.vscode/settings.json

    {
        "perl": {
            "enable": true,
            "containerCmd": "docker",
            "containerName": "perl_container",
        }
    }

This will start the whole Perl::LanguageServer inside the container. This is espacally helpfull to make syntax check working, if there is a different setup inside and outside the container.

In this case you need to tell the Perl::LanguageServer how to map local paths to paths inside the container. This is done by setting "perl.pathMap" (see above).

Example:

    "perl.pathMap": [
        [
        "file:///path/inside/the/container",
        "file:///local/path/outside/the/container"
        ]
    ]

It's also possible to run the LanguageServer outside the container and only the debugger inside the container. This is especially helpfull, when the container is not always running, while you are editing. To make only the debugger running inside the container, put "containerCmd", "conatinerName" and "pasth_map" in your "launch.json". You can have different setting for each debug session.

Normaly the arguments for the "containerCmd" are automatically build. In case you want to use an unsupported "containerCmd" you need to specifiy apropriate "containerArgs".

  FAQ
Working directory is not defined

It is not defined what the current working directory is at the start of a perl program. So Perl::LanguageServer makes no assumptions about it. To solve the problem you can set the directory via cwd configuration parameter in launch.json for debugging.

Module not found when debugging or during syntax check

If you reference a module with a relative path or if you assume that the current working directory is part of the Perl search path, it will not work. Instead set the perl include path to a fixed absolute path. In your settings.json do something like:

        "perl.perlInc": [
            "/path/a/lib",
            "/path/b/lib",
            "/path/c/lib",
        ],
Include path works for syntax check and inside of debugger.
C<perl.perlInc> should be an absolute path.

AnyEvent, Coro Warning during install

You need to install the AnyEvent::IO and Coro. Just ignore the warning that it might not work. For Perl::LanguageServer it works fine.

'richterger.perl' failed: options.port should be >= 0 and < 65536

Change port setting from string to integer

Error "Can't locate MODULE_NAME"

Please make sure the path to the module is in "perl.perlInc" setting and use absolute path names in the perlInc settings or make sure you are running in the expected directory by setting the "cwd" setting in the lauch.json.

ERROR: Unknown perlmethod rpcnotsetTraceNotification

This is not an issue, that just means that not all features of the debugging protocol are implemented. Also it says ERROR, it's just a warning and you can safely ignore it.

The debugger sometimes stops at random places

Upgrade to Version 2.4.0

Message about Perl::LanguageServer has crashed 5 times

This is a problem when more than one instance of Perl::LanguageServer is running. Upgrade to Version 2.4.0 solves this problem.

The program I want to debug needs some input via stdin

You can read stdin from a file during debugging. To do so add the following parameter to your "launch.json":

""args": [ "<", "/path/to/stdin.txt" ]"

e.g.

"{
    "type": "perl",
    "request": "launch",
    "name": "Perl-Debug",
    "program": "${workspaceFolder}/${relativeFile}",
    "stopOnEntry": true,
    "reloadModules": true,
    "env": {
        "REQUEST_METHOD": "POST",
        "CONTENT_TYPE": "application/x-www-form-urlencoded",
        "CONTENT_LENGTH": 34
    }
    "args": [ "<", "/path/to/stdin.txt" ] }"

Carton support

If you are using L<https://metacpan.org/pod/Carton> to manage dependencies, add the full path to the Carton "lib" dir to your workspace settings file at ".vscode/settings.json". For example:

Linux

    {
      "perl.perlInc": ["/home/myusername/projects/myprojectname/local/lib/perl5"]
    }

Mac

    {
      "perl.perlInc": ["/Users/myusername/projects/myprojectname/local/lib/perl5"]
    }

  Known Issues
Does not yet work on windows, due to issues with reading from stdin. I wasn't able to find a reliable way to do a non-blocking read from stdin on windows. I would be happy, if anyone knows how to do this in Perl.

Anyway, Perl::LanguageServer runs without problems inside of Windows Subsystem for Linux (WSL).

  Release Notes
see CHANGELOG.md

  More Info

•   Presentation at German Perl Workshop 2020:

https://github.com/richterger/Perl-LanguageServer/blob/master/docs/Perl-LanguageServer%20und%20Debugger%20f%C3%BCr%20Visual%20Studio%20Code%20u.a.%20Editoren%20-%20Perl%20Workshop%202020.pdf

•   Github: https://github.com/richterger/Perl-LanguageServer

•   MetaCPAN: https://metacpan.org/release/Perl-LanguageServer

For reporting bugs please use GitHub issues.

  References
This is a Language Server and Debug Protocol Adapter for Perl

It implements the Language Server Protocol which provides syntax-checking, symbol search, etc. Perl to various editors, for example Visual Studio Code or Atom.

https://microsoft.github.io/language-server-protocol/specification

It also implements the Debug Adapter Protocol, which allows debugging with various editors/includes

https://microsoft.github.io/debug-adapter-protocol/overview

To use both with Visual Studio Code, install the extension "perl"

https://marketplace.visualstudio.com/items?itemName=richterger.perl

Any comments and patches are welcome.

  LICENSE AND COPYRIGHT
Copyright 2018-2022 Gerald Richter.

This program is free software; you can redistribute it and/or modify it under the terms of the Artistic License (2.0). You may obtain a copy of the full license at:

L<http://www.perlfoundation.org/artistic_license_2_0>

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Change Log

  2.6.2 "2023-12-23"

•   avoid given/when/smartmatch because these features are deprecated in perl 5.38 (#199) [real-dam]

  2.6.1 "2023-07-26"

•   Fix: Formatting with perltidy was broken in 2.6.0

  2.6.0 "2023-07-23"

•   Add debug setting for running as different user. See sudoUser setting. (#174) [wielandp]

•   Allow to use a string for debuggee arguments. (#149, #173) [wielandp]

•   Add stdin redirection (#166) [wielandp]

•   Add link to issues to META files (#168) [szabgab/issues]

•   Add support for podman

•   Add support for run Perl::LanguageServer outside, but debugger inside a container

•   Add setting useTaintForSyntaxCheck. If true, use taint mode for syntax check (#172) [wielandp]

•   Add setting useTaintForDebug. If true, use taint mode inside debugger (#181) [wielandp]

•   Add debug adapter request "source", which allows to display source of eval or file that are not available to vscode (#180) [wielandp]

•   Fix: Spelling (#170, #171) [pkg-perl-tools]

•   Fix: Convert charset encoding of debugger output according to current locale (#167) [wielandp]

•   Fix: Fix diagnostic notifications override on clients (based on #185) [bmeneg]

  2.5.0 "2023-02-05"

•   Set minimal Perl version to 5.16 (#91)

•   Per default environment from vscode will be passed to debuggee, syntax check and perltidy.

•   Add configuration "disablePassEnv" to not pass environment variables.

•   Support for "logLevel" and "logFile" settings via LanguageServer protocol and not only via command line options (#97) [schellj]

•   Fix: "No DB::DB routine defined" (#91) [peterdragon]

•   Fix: Typos and spelling in README (#159) [dseynhae]

•   Fix: Update call to gensym(), to fix 'strict subs' error (#164) [KohaAloha]

•   Convert identention from tabs to spaces and remove trailing whitespaces

  2.4.0 "2022-11-18"

•   Choose a different port for debugAdapterPort if it is already in use. This avoids trouble with starting "Perl::LanguageServer" if another instance of "Perl::LanguageServer" is running on the same machine (thanks to hakonhagland)

•   Add configuration "debugAdapterPortRange", for choosing range of port for dynamic port assignment

•   Add support for using LanguageServer and debugger inside a Container. Currently docker containers und containers running inside kubernetes are supported.

•   When starting debugger session and "stopOnEntry" is false, do not switch to sourefile where debugger would stop, when "stopOnEntry" is true.

•   Added some FAQs in README

•   Fix: Debugger stopps at random locations

•   Fix: debugAdapterPort is now numeric

•   Fix: debugging loop with each statement (#107)

•   Fix: display of arrays in variables pane on mac (#120)

•   Fix: encoding for "perltidy" (#127)

•   Fix: return error if "perltidy" fails, so text is not removed by failing formatting request (#87)

•   Fix: FindBin does not work when checking syntax (#16)

  2.3.0 "2021-09-26"

•   Arguments section in Variable lists now @ARGV and @_ during debugging (#105)

•   @_ is now correctly evaluated inside of debugger console

•   $#foo is now correctly evaluated inside of debugger console

•   Default debug configuration is now automatically provided without the need to create a "launch.json" first (#103)

•   Add Option "cacheDir" to specify location of cache dir (#113)

•   Fix: Debugger outputted invalid thread reference causes "no such coroutine" message, so watchs and code from the debug console is not expanded properly

•   Fix: LanguageServer hangs when multiple request send at once from VSCode to LanguageServer

•   Fix: cwd parameter for debugger in launch.json had no effect (#99)

•   Fix: Correctly handle paths with drive letters on windows

•   Fix: sshArgs parameter was not declared as array (#109)

•   Disable syntax check on windows, because it blocks the whole process when running on windows, until handling of child's processes is fixed

•   Fixed spelling (#86,#96,#101) [chrstphrchvz,davorg,aluaces]

  2.2.0 "2021-02-21"

•   Parser now supports Moose method modifieres before, after and around, so they can be used in symbol view and within reference search

•   Support Format Document and Format Selection via perltidy

•   Add logFile config option

•   Add perlArgs config option to pass options to Perl interpreter. Add some documentation for config options.

•   Add disableCache config option to make LanguageServer usable with readonly directories.

•   updated dependencies package.json & package-lock.json

•   Fix deep recursion in SymbolView/Parser which was caused by function prototypes. Solves also #65

•   Fix duplicate req id's that caused cleanup of still running threads which in turn caused the LanguageServer to hang

•   Prevent dereferencing an undefined value (#63) [Heiko Jansen]

•   Fix datatype of cwd config options (#47)

•   Use perlInc setting also for LanguageServer itself (based only pull request #54 from ALANVF)

•   Catch Exceptions during display of variables inside debugger

•   Fix detecting duplicate LanguageServer processes

•   Fix spelling in documentation (#56) [Christopher Chavez]

•   Remove notice about Compiler::Lexer 0.22 bugs (#55) [Christopher Chavez]

•   README: Typo and grammar fixes. Add Carton lib path instructions. (#40) [szTheory]

•   README: Markdown code block formatting (#42) [szTheory]

•   Makefile.PL: add META_MERGE with GitHub info (#32) [Christopher Chavez]

•   search.cpan.org retired, replace with metacpan.org (#31) [Christopher Chavez]

  2.1.0 "2020-06-27"

•   Improve Symbol Parser (fix parsing of anonymous subs)

•   showLocalSymbols

•   function names in breadcrump

•   Signature Help for function/method arguments

•   Add Presentation on Perl Workshop 2020 to repos

•   Remove Compiler::Lexer from distribution since version is available on CPAN

•   Make stdout unbuffered while debugging

•   Make debugger use perlInc setting

•   Fix fileFilter setting

•   Sort Arrays numerically in variables view of debugger

•   Use rootUri if workspaceFolders not given

•   Fix env config setting

•   Recongnice changes in config of perlCmd

  2.0.2 "2020-01-22"

•   Plugin: Fix command line parameters for plink

•   Perl::LanguageServer: Fix handling of multiple parallel request, improve symlink handling, add support for UNC paths in path mapping, improve logging for logLevel = 1

  2.0.1 "2020-01-14"
Added support for reloading Perl module while debugging, make log level configurable, make sure tooltips don't call functions

  2.0.0 "2020-01-01"
Added Perl debugger

  0.9.0 "2019-05-03"
Fix issues in the Perl part, make sure to update Perl::LanguageServer from cpan

  0.0.3 "2018-09-08"
Fix issue with not reading enough from stdin, which caused LanguageServer to hang sometimes

  0.0.2 "2018-07-21"
Fix quitting issue when starting Perl::LanguageServer, more fixes are in the Perl part

  0.0.1 "2018-07-13"
Initial Version