Skip to content

Commit

Permalink
Prepare for 2.5.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
richterger committed Feb 5, 2023
1 parent 833e1f1 commit 6d2dbfa
Show file tree
Hide file tree
Showing 6 changed files with 1,309 additions and 1,278 deletions.
59 changes: 37 additions & 22 deletions Changes.pod
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
=head1 Change Log

=head2 2.4.1 C<unreleased>
=head2 2.5.0 C<2023-02-05>

=over

=item * Set minimal Perl version to 5.16 (#91)

=item * Per default enviroment from vscode will be passed to debuggee, syntax check and perltidy.

=item * Add configuration C<disablePassEnv> to not pass enviroment variables.

=item * Support for C<logLevel> and C<logFile> settings via LanguageServer protocol and
not only via command line options (#97) [schellj]

=item * Fix: "No DB::DB routine defined" (#91) [peterdragon]

=item * Fix: typos and spelling in README (#159) [dseynhae]
=item * Fix: Typos and spelling in README (#159) [dseynhae]

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

=item * Convert identention from tabs to spaces and remove trailing whitespaces

=back

Expand All @@ -17,31 +28,31 @@
=over

=item * 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 runing on the same machine (thanks to hakonhagland)
avoids trouble with starting C<Perl::LanguageServer> if another instance
of C<Perl::LanguageServer> is runing on the same machine (thanks to hakonhagland)

=item * Add configuration debugAdapterPortRange, for choosing range of port for dynamic
=item * Add configuration C<debugAdapterPortRange>, for choosing range of port for dynamic
port assignment

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

=item * When starting debugger session and stopOnEntry is false, do not switch to sourefile
where debugger would stop, when stopOnEntry is true.
=item * When starting debugger session and C<stopOnEntry> is false, do not switch to sourefile
where debugger would stop, when C<stopOnEntry> is true.

=item * Added some FAQs in README

=item * Fix: Debugger stopps at random locations

=item * Fix: debugAdapterPort is now numeric

=item * Fix: debugging loop with each statement (#107)
=item * Fix: debugging loop with each statement (#107)

=item * Fix: display of arrays in variables pane on mac (#120)

=item * Fix: encoding for perltidy (#127)
=item * Fix: encoding for C<perltidy> (#127)

=item * Fix: return error if perltidy fails, so text is not removed by failing
=item * Fix: return error if C<perltidy> fails, so text is not removed by failing
formatting request (#87)

=item * Fix: FindBin does not work when checking syntax (#16)
Expand All @@ -52,18 +63,18 @@ formatting request (#87)

=over

=item * Arguments section in Variable lists now @ARGV and @_ during debugging (#105)
=item * Arguments section in Variable lists now C<@ARGV> and C<@_> during debugging (#105)

=item * @_ is now correctly evaluated inside of debugger console
=item * C<@_> is now correctly evaluated inside of debugger console

=item * $#foo is now correctly evaluated inside of debugger console
=item * C<$#foo> is now correctly evaluated inside of debugger console

=item * Default debug configuration is now automatically provided without
the need to create a launch.json first (#103)
the need to create a C<launch.json> first (#103)

=item * Add Option cacheDir to specify location of cache dir (#113)
=item * Add Option C<cacheDir> to specify location of cache dir (#113)

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

=item * Fix: LanguageServer hangs when multiple request send at once from VSCode to LanguageServer
Expand All @@ -74,7 +85,7 @@ so watchs and code from the debug console is not expanded properly

=item * Fix: sshArgs parameter was not declared as array (#109)

=item * Disable syntax check on windows, because it blocks the whole process when running on windows,
=item * Disable syntax check on windows, because it blocks the whole process when running on windows,
until handling of childs processes is fixed

=item * Fixed spelling (#86,#96,#101) [chrstphrchvz,davorg,aluaces]
Expand All @@ -85,7 +96,7 @@ until handling of childs processes is fixed

=over

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

=item * Support Format Document and Format Selection via perltidy
Expand Down Expand Up @@ -142,7 +153,7 @@ running threads which in turn caused the LanguageServer to hang

=item * Add Presentation on Perl Workshop 2020 to repos

=item * Remove Compiler::Lexer from distribution since
=item * Remove Compiler::Lexer from distribution since
version is available on CPAN

=item * Make stdout unbuffered while debugging
Expand All @@ -163,9 +174,13 @@ version is available on CPAN

=head2 2.0.2 C<2020-01-22>

Plugin: Fix command line parameters for plink
=over

=item * 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
=item * Perl::LanguageServer: Fix handling of multiple parallel request, improve symlink handling, add support for UNC paths in path mapping, improve logging for logLevel = 1

=back

=head2 2.0.1 C<2020-01-14>

Expand Down
20 changes: 10 additions & 10 deletions README.pod
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Language Server and Debug Protocol Adapter for Perl

=item * Support for coro threads

=item * Breakpoints
=item * Breakpoints

=item * Conditional breakpoints

Expand All @@ -66,7 +66,7 @@ Language Server and Debug Protocol Adapter for Perl

=item * Run inside docker container

=item * Run inside kubernetes
=item * Run inside kubernetes

=back

Expand Down Expand Up @@ -182,7 +182,7 @@ This extension contributes the following settings:

=item * C<args>: optional, array with arguments for perl program

=item * C<env>: optional, object with environment settings
=item * C<env>: optional, object with environment settings

=item * C<cwd>: optional, change working directory before launching the debuggee

Expand Down Expand Up @@ -247,13 +247,13 @@ There are more container options, see above.

=head3 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
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.

=head3 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
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:

Expand All @@ -268,7 +268,7 @@ C<perl.perlInc> should be an absolute path.

=head3 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.
You need to install the AnyEvent::IO and Coro. Just ignore the warning that it might not work. For Perl::LanguageServer it works fine.

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

Expand All @@ -281,7 +281,7 @@ or make sure you are running in the expected directory by setting the C<cwd> set

=head3 ERROR: Unknow perlmethod I<rpcnot>setTraceNotification

This is not an issue, that just means that not all features of the debugging protocol are implemented.
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.

=head3 The debugger sometimes stops at random places
Expand All @@ -291,7 +291,7 @@ Upgrade to Version 2.4.0
=head3 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 solve this problem.
Upgrade to Version 2.4.0 solves this problem.

=head3 Carton support

Expand All @@ -314,7 +314,7 @@ If you are using LL<https://metacpan.org/pod/Carton> to manage dependencies, add
=head2 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 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).
Expand Down
57 changes: 29 additions & 28 deletions clients/vscode/perl/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,65 @@
# Change Log

## 2.4.1 `unreleased`
## 2.5.0 `2023-02-05`

- Set minimal Perl version to 5.16 (#91)
- Per default enviroment from vscode will be passed to debuggee, syntax check and perltidy.
- Add configuration `disablePassEnv` to not pass enviroment 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: 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 runing on the same machine (thanks to hakonhagland)
- Add configuration debugAdapterPortRange, for choosing range of port for dynamic
avoids trouble with starting `Perl::LanguageServer` if another instance
of `Perl::LanguageServer` is runing 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.
- 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.
- 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: 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
- 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
- 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,
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,
- Disable syntax check on windows, because it blocks the whole process when running on windows,
until handling of childs 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,
- 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
Expand All @@ -66,7 +69,6 @@
- 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]
Expand All @@ -80,7 +82,7 @@
- function names in breadcrump
- Signature Help for function/method arguments
- Add Presentation on Perl Workshop 2020 to repos
- Remove Compiler::Lexer from distribution since
- Remove Compiler::Lexer from distribution since
version is available on CPAN
- Make stdout unbuffered while debugging
- Make debugger use perlInc setting
Expand All @@ -91,9 +93,8 @@
- 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
- 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
Expand All @@ -107,7 +108,7 @@ 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`
## 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`
Expand Down
2 changes: 1 addition & 1 deletion clients/vscode/perl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ 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 solve this problem.
Upgrade to Version 2.4.0 solves this problem.

### Carton support

Expand Down
2 changes: 1 addition & 1 deletion clients/vscode/perl/src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ export async function activate(context: vscode.ExtensionContext)
}
let logFile : string = config.get('logFile') || '' ;
let logLevel : number = config.get('logLevel') || 0 ;
let client_version : string = "2.4.0" ;
let client_version : string = "2.5.0" ;
let perlArgsOpt : string[] = [...perlIncOpt,
...perlArgs,
'-MPerl::LanguageServer', '-e', 'Perl::LanguageServer::run', '--',
Expand Down
Loading

0 comments on commit 6d2dbfa

Please sign in to comment.