I have two files in the same directory that is containing issues found by Phan.

When opening the first file the issues is show in the PROBLEMS tab at the bottom. Great!

I now open up the second file (two files opened at the same time). Now the issues from the
first file is removed from the tab and replaced with the issues from the now opened file.

Hi,

The extension checks if there is a config file in the defined phan.analyzedProjectDirectory (function checkValidAnalyzedProjectDirectory).

Phan supports the CLI argument -k/--config-file parameter to use an external config file. This option does not work in the extension and it is being ignored by the checkValidAnalyzedProjectDirectory validation.

Thanks, great extension!

E.g. https://github.com/Microsoft/vscode-tslint is an example of an extension that's multi root ready?

E.g. don't traverse configured files in directory_list such as vendor/, etc, checking for changes to modification date or file size every time there is a change that needs to be analyzed.

Skipping this should bring down latency somewhat, especially without SSDs

• Maybe re-check at most once per 60 seconds instead of every time.

This requires changes to the backend (only for language server, not for phan's earlier Daemon classes)

didOpen/didChange/didClose/rename/etc should be sufficient for most uses.

This may require refactoring the server to be able to check a single file against a list of inclusions and exclusions.

Switching between git branches would break this assumption.
Maybe didChangeWatchedFiles might help?

After disabling Vim (vscodevim 0.16.3, VS Code 1.27.1), no problems were seen

I want specify project root as a relative path in .vscode\settings.json

{
    "phan.analyzedProjectDirectory": "./"
}

However it seems to be invalid for me:

I'm helping a co-worker setup phan in their vscode editor, I can get the extension working on my machine but on his machine it sits on:
starting PHP Phan language server

where as mine will go:

[Extension Host] starting PHP Phan language server
console.ts:137 [Extension Host] starting Phan Language Server /usr/local/bin/php Array(12)
console.ts:137 [Extension Host] [vscode-icons] v9.7.0 activated!
console.ts:137 [Extension Host] PHP process connected

and work, we have tried uninstalling his other extensions and have compared out settings.json, his phan installation also works outside of vscode, how can I debug the starting of the language server?

Phan can be a bit CPU-intensive (particularly when plugins are involved). It would be nice if the extension could be configured to invoke Phan on save instead of during typing.

https://code.visualstudio.com/api/working-with-extensions/bundling-extension

Hi,

I want to use this plugin with phan inside a Docker container, at the moment I'm able to check my code
with https://github.com/cloudflare/docker-phan but I can't see a way to make it work
together with this plugin.

Could you explain to me if is there any way to do that?

Test case:

<?php

class TestClass
{
	/** @var string */
	public $test = 'hi';

	public function anotherTest()
	{
		return true;
	}

	public function other()
	{
		return $this->|
	}
}

It's not showing anything in vscode when I type this out. I have gotten it to trigger local variable completion some times. It seems a bit random as to when it'll work, though.

Here is the terminal command it's running as:
php /home/ddecarmine/.vscode/extensions/tysonandre.php-phan-0.8.0/vendor/phan/phan/phan --language-server-verbose --language-server-completion-vscode --language-server-enable-completion --language-server-enable-hover --language-server-enable-go-to-definition --language-server-analyze-only-on-save --use-fallback-parser --language-server-tcp-connect=127.0.0.1:44861

It is running latest vscode extension version. Another thing is that I had to actually put "phan.enableCompletion": true, in my vscode settings.json file, otherwise it didn't actually set the --language-server-completion-vscode flag. In the release notes it says it's enabled by default now, though.

I am running vscode version 1.30.2

• ast, runkit_object_id (or php 7.2), and pcntl can have substitutes at the cost of performance.
  Use these substitutes by default when starting out, and prompt to improve performance later.
• Caching asts in a tmp folder may improve performance if ast is unavailable (use a binary format such as igbinary if available to save space?)
• Check for xdebug and restart without it silently

https://code.visualstudio.com/updates/v1_25#_language-server-protocol-inspector is hopefully better and more efficient than the console.log events with this extension's own debug setting

Not sure if this can be done.

I would like to be able to do a full directory scan (or workspace) to be able to see all the problems in the PROBLEMS tab without needing to open up every file in the editor.

This is of course an expensive action so I think this is best implemented as a Command that a user can invoke if need.

This I guess would need some visual feedback. Like issue #66.

https://code.visualstudio.com/docs/extensions/example-language-server#_testing-the-language-server

After the analyze on save branch being merged in, it doesn't seem to be working. I tried enabling debugging in the settings, but it's no longer showing in the extension Output tab. In the processlist it's showing up, though. When I run Phan manually it works.

This commit works for me just fine: 12b8bdd
After that it's broken.

In master this is what shows up for "phan" in my processlist:
php /home/ddecarmine/.vscode/extensions/TysonAndre.php-phan-0.0.9/vendor/phan/phan/phan --language-server-verbose --language-server-analyze-only-on-save --use-fallback-parser --language-server-tcp-connect=127.0.0.1:34873

Not sure how to help debug this. =\

Current Behavior

1. Unable to install the extension in a WSL2 ubuntu environment (there is no "install on remote" button, settings get ignored when connected to WSL2).
2. When trying to use the extension in local using the wsl$ share the following error pops up:

ERROR: Unable to read file \\WSL$\UBUNTU-20.04\home\user\dev\SGN\app\Providers\EventServiceProvider.php: SplFileInfo->isReadable() is false, getPerms()=100666(octal)

Steps to Reproduce the Problem

1. Try to use the extension while connected to a remote (WSL2) folder.

Specifications

• Extension Version: 1.4.4
• PHP Version: 8.0
• Platform: Windows 10
• Subsystem: Ubuntu 20.04

https://github.com/microsoft/vscode-extension-samples/tree/master/lsp-multi-server-sample
https://github.com/microsoft/vscode-extension-samples/tree/master/lsp-sample

and https://github.com/microsoft/vscode-extension-samples

(and by default, only start language servers corresponding to files/folders that are open)

I'd been discussing how this could be done in a user-friendly and safe way with the reporter of CVE-2021-31416

For current vscode versions:

I looked into how https://github.com/microsoft/vscode-maven/pull/526/files handled it since the Memento API is backed by a sqlite database in a global configuration database (in a user's home directory?), which is reasonable.

• The first time phan opens a folder and finds a .phan/config.php, prompt the user if they want to trust the extension before executing anything (e.g. checking the php version, etc)

For future vscode versions

There's a feature being previewed right now.

microsoft/vscode#106488 is something along the lines of what I wanted to use for Phan, but it wasn't available when I first published this extension (with respect to phan configs and phan plugins being/invoking executable code by design, etc)

The trusted workspaces concept is intended to centralize and unify a security conscious decision required by a variety of VS Code features. The easiest existing example to understand of this decision is with the ESLint extension. The ESLint extension will try to use the eslint module in the current folder that is opened in VS Code and execute code from it. Since you may have checked out a random repository from the web, this could be dangerous if the repository contains a corrupt eslint module. Notice that ESLint is not trying to be malicious, but rather, the repository/corrupt module is taking advantage of this automatic code execution.

Related to #83

https://code.visualstudio.com/updates/v1_25#_hover-display-options

This might avoid some latency issues when hover is enabled (Or my issues might have been with the VS Code upgrade)

• Not sure if that delays the computation as well

If no new errors are reported in the 2.2.7 release

Keep the last 3 releases in README.md

A nice improvement I find is to default the option "phan.analyzedProjectDirectory" to the main workspace root folder(or in case of a workspace with multi-folders environment search the first workspace folder that has .phan folder).

Another improvement is to make the path possibility to be relative to the main workspace root folder.

This improvement will help when the project is switched across, as a lot of times the .phan folder is placed anyway in the project root folder. Having always to change this is a pain, not too bad for me, but a lot for other people.

Thanks.

Currently, it isn't showing up

Not sure how I should describe this. Please change subject to something better.
I do like my hover but this is pretty annoying. I hope you can find a way to make it stop. :)

here is a GIF showing what is happening.

Hi... my project takes about 10-15 seconds to be parsed by phan... It will be very nice if there was an indicator in status bar that will say when the phan is parsing(like PHP Sniffer: validating... ).

Thanks.

(e.g. missing dependency libraries, etc.)

Maybe this is more about phan itself again.

I have many Bedrock-enabled WordPress websites where I used to configure each plugin independently across different sites which resulted in a mess in my custom configuration in VSCode, so I went and tried to abstract my configuration to the site root and configure each directory to analyze there (may be not the best use case).

Setup:

<site-root-dir>
  .phan
    config.php
  dir1
  ...
  dirx

config.php has been created with phan's --init command, and it contains only one directory to analyze. It works fine when running it via cli.

VSCode settings' phan.analyzedProjectDirectory points to <site-root-dir> (above), I see no errors during startup:

[Extension Host] starting PHP Phan language server
[Extension Host] starting Phan Language Server
C:\php\php.exe 
Array(8)
0: "c:\Users\Adam_Marton\.vscode\extensions\tysonandre.php-phan-0.8.3\vendor\phan\phan\phan"
1: "--language-server-verbose"
2: "--language-server-allow-missing-pcntl"
3: "--allow-polyfill-parser"
4: "--language-server-completion-vscode"
5: "--language-server-enable-completion"
6: "--use-fallback-parser"
7: "--language-server-tcp-connect=127.0.0.1:51310"

But, when opening a file in the analyzed directory, I'll get the following message:

/C:/Users/Adam_Marton/AppData/Local/Programs/Microsoft VS Code/resources/app/out/vs/workbench/workbench.main.js:303
[Extension Host] Request:
{"Content-Length":"52"}
Data:
{"jsonrpc":"2.0","method":"initialized","params":{}}

Received message in coroutine: {"method":"initialized","params":{},"jsonrpc":"2.0"}
Called initialized on language server, currently a no-op
...
<here I get my custom VSCode settings back in JSON>

I saw that this comes straight from phan, but since it works fine in cli I posted this here instead.

I'm on Windows 10, VSCode is 1.30.2, PHP-Phan is 0.8.3.

Please let me know if you need more details.

Suggested remediation: Disable completion in phan's settings or in the other plugin's settings

e.g. for https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client it looks like intelliphense's maintainers have encountered similar issues - disabling the individual features (hover, completion, etc.) of either phan/intelliphense may be enough to fix this

This extension may conflict with other PHP extensions which provide similar functionality. Should you experience duplicate suggestions, incorrect results and/or poor performance, try disabling other extensions first before reporting an issue. Disabling the built-in VSCode PHP Language Features is recommended. Please check the configuration section for language server options.

https://github.com/tysonandre/vscode-php-phan#completion

This is enabled by default. To disable this, add "phan.enableCompletion": false in your config.json settings.

This issue duplicates the findings in phan/phan#2651 (comment)

Yes, there's a chance that this is an issue with Phan itself, but otherwise Phan runs really well on the very same machine/code base/everything.

Env:

• Windows 10
• php-ast: 1.0.0

Debug output:

[Extension Host] Starting accepting connections on the language server (pid=281540)
[Extension Host] Error: Call to undefined function Phan\LanguageServer\pcntl_signal() in C:\Users\<username>\.vscode\extensions\tysonandre.php-phan-0.6.2\vendor\phan\phan\src\Phan\LanguageServer\LanguageServer.php:248
Stack trace:
#0 C:\Users\<username>\.vscode\extensions\tysonandre.php-phan-0.6.2\vendor\phan\phan\src\Phan\Phan.php(227): Phan\LanguageServer\LanguageServer::run(Object(Phan\CodeBase), Object(Closure), Array)
#1 C:\Users\<username>\.vscode\extensions\tysonandre.php-phan-0.6.2\vendor\phan\phan\src\phan.php(41): Phan\Phan::analyzeFileList(Object(Phan\CodeBase), Object(Closure))
#2 C:\Users\<username>\.vscode\extensions\tysonandre.php-phan-0.6.2\vendor\phan\phan\phan(2): require_once('C:\\Users\\<username>')
#3 {main}

(Phan 1.1.2 crashed due to an uncaught Throwable)

config.php:

<?php
return [
    'target_php_version' => '7.2',
    'directory_list' => [
        'classes'
    ],
    "exclude_analysis_directory_list" => [
        'vendor/'
    ],
];

Both globally installed and the packaged version of Phan runs perfectly fine, I only get these exceptions within VSCode.

Please let me know if you need more information.

Thanks,
Adam

Add --language-server-enable-completion and upgrade to Phan 1.0.6+

Test that this works in various scenarios without issues

Disable completion support by default, initially.

• Fix/work around edge cases with completions of properties and variables
• enable completion by default

@TysonAndre the extension page in the VSCode marketplace currently points almost everything to the phan repo instead of to this repo-->you almost certainly unintentionally add too much friction to locating this repo, thus dissuading other developers from contributing to your extension

• One way to fix this would be to implement or use an actual dispatcher that would route requests for files to the best matching directory.
• I'm not sure if there's a way to prevent the third party NodeJS language client from forwarding requests outside of the targeted directory. That would be worth looking into.

The extension should look for a .phan/config.php inside each opened workspace instead of analysing only one folder.

The multi-project analysis is a very important feature, e.g.: I can't configure just one path in a company we work with 5+ projects at the same time.

How do you set target_php_version for this extension?