forked from richterger/Perl-LanguageServer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
132 lines (91 loc) · 4.5 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
Perl::LanguageServer - Language Server and Debug Protocol Adapter for Perl
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
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.
FEATURES
* Language Server
* Syntax checking
* Symbols in file
* Symbols in workspace/directory
* Goto Definition
* Find References
* Supports multiple workspace folders
* Document and selection formatting via perltidy
* Run on remote system via ssh
* Debugger
* Run, pause, step, next, return
* Support for coro threads
* Breakpoints
* Conditional breakpoints
* Breakpoints can be set while programm 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 programm at once
* Run on remote system via ssh
INSTALLATION
To install this module, run the following commands:
perl Makefile.PL
make
make test
make install
NOTE: Only tested with Perl 5.18 and newer. So in case you want to use
is with older versions of Perl slight modifications might be necessary.
To use it with Visual Studio Code, install the extension "perl"
SUPPORT AND DOCUMENTATION
After installing, you can find documentation for this module with the
perldoc command.
perldoc Perl::LanguageServer
Presentation on 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
You can also look for information at:
Github:
https://github.com/richterger/Perl-LanguageServer
RT, CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl-LanguageServer
CPAN Ratings
http://cpanratings.perl.org/d/Perl-LanguageServer
MetaCPAN
https://metacpan.org/release/Perl-LanguageServer
LICENSE AND COPYRIGHT
Copyright (C) 2018-2020 grichter
This program is free software; you can redistribute it and/or modify it
under the terms of the 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.