-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Modified version of php language server, supporting Phan static analyzer
This extension allows analyzing a single PHP project. (Each project with a .phan/config.php requires a different Phan server running in the background. It's simplest to implement support for just one). In the future, it may allow analyzing multiple projects. - Require users to provide a single folder for a project to analyze. Unfortunately, the phan server will autostart right now, even if the file is outside of that project. - With more work, it should be possible to set up multiple folders, but I'm not familiar with the VS code extension API. Change config options, refactor the extension to check for Phan and its dependencies. - Support `phan.` as the config prefix for VS code. Update README, LICENSE Update documentation Add composer.lock Update documentation, add options, document option for syntax error tolerance update .travis.yml - Remove deploy section - install php-ast - Add travis build status
- Loading branch information
1 parent
211890f
commit 3876a8c
Showing
21 changed files
with
1,180 additions
and
2,320 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,6 @@ | ||
| out/ | ||
| node_modules/ | ||
| vendor/ | ||
| composer.lock | ||
| typings/ | ||
| .DS_Store | ||
| package-lock.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,114 @@ | ||
| # PHP IntelliSense | ||
| # Phan for Visual Studio Code | ||
|
|
||
| [](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [](https://travis-ci.org/felixfbecker/vscode-php-intellisense) [](https://gemnasium.com/felixfbecker/vscode-php-intellisense) [](https://php.net/) [](https://gitter.im/felixfbecker/vscode-php-intellisense?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) | ||
| [](https://travis-ci.org/TysonAndre/vscode-php-phan) [](https://php.net/) | ||
|
|
||
| Advanced PHP IntelliSense for Visual Studio Code. | ||
| Based on [PHP IntelliSense](https://github.com/felixfbecker/vscode-php-intellisense) | ||
|
|
||
| **Note: This is just the VS Code extension that spawns the actual language server. The language server itself is implemented purely in PHP [in its own repository](https://github.com/felixfbecker/php-language-server), all features need to be implemented there and all issues should be reported there.** | ||
| This adds improved [static analysis from Phan](https://github.com/phan/phan#features) to Visual Studio Code. | ||
|
|
||
| **Supports Unix/Linux.** Doesn't support Windows due to the server having a dependency on the `pcntl` PHP module. | ||
|
|
||
| **Note: This is just the VS Code extension that spawns Phan. Phan is implemented purely in PHP [in its own repository](https://github.com/phan/phan), all features need to be implemented there and all issues should be reported there.** | ||
|
|
||
| ## Installation | ||
|
|
||
| You need at least PHP 7 installed for the extension to work. You can either add it to your PATH or set the `php.executablePath` setting. | ||
| ### Dependencies: | ||
|
|
||
| I recommend to disable VS Code's built-in PHP IntelliSense by setting `php.suggest.basic` to `false` to avoid duplicate suggestions. | ||
| 1. PHP 7.1+ must be installed. | ||
| You can either add it to your PATH or set the `phan.executablePath` setting. | ||
| 2. Your Operating System must be Unix/Linux | ||
| (Phan support depends on `pcntl` module being installed, which is only available on those platforms) | ||
| 3. [The `php-ast` PECL extension](https://pecl.php.net/package/ast) must be installed and enabled. | ||
| 4. Depends on using a checkout of Phan with https://github.com/phan/phan/pull/1144 installed | ||
|
|
||
| ## Features | ||
|
|
||
| ### Completion | ||
|  | ||
| ### Installing from source | ||
|
|
||
| This extension hasn't been published yet. It can be installed locally with the following method: | ||
|
|
||
| ### Workspace symbol search | ||
|  | ||
| ```bash | ||
| npm install | ||
| npm run build | ||
| node node_modules/.bin/vsce package | ||
| ``` | ||
|
|
||
| ### Find all References | ||
|  | ||
| The generated VSIX file can be used locally with the steps from https://stackoverflow.com/a/38866913 | ||
|
|
||
| ### Setup steps | ||
|
|
||
| This assumes you have already installed the [dependencies](#dependencies). | ||
|
|
||
| Add these entries to your VSCode config (Open the menu at File > Preferences > Settings) | ||
|
|
||
|
|
||
| ``` | ||
| { | ||
| // Currently, this extension is limited to analyzing only a single folder. | ||
| // The config value must be the root of the project, | ||
| // and contain a .phan/config.php file with a Phan config for that project | ||
| // (including files to parse and analyze). | ||
| "phan.analyzedProjectDirectory": "/path/to/folder/to/analyze", | ||
| // Path to a php 7.1 binary with the php-ast PECL extension installed and enabled | ||
| "phan.phpExecutablePath": "/path/to/php7.1", | ||
| // Files which this should analyze | ||
| "phan.analyzedFileExtensions": ["php"] | ||
| } | ||
| ``` | ||
|
|
||
| ### Go to Definition | ||
|  | ||
| ## Features | ||
|
|
||
| ### Hover | ||
|  | ||
| ### Error Detection | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ### Find all symbols | ||
|  | ||
| Phan's capabilities are summarized in [Phan's README](https://github.com/phan/phan#features) | ||
|
|
||
| ### Format code | ||
|  | ||
| ### Error Tolerant Parsing | ||
|
|
||
| ### Column-accurate error reporting | ||
|  | ||
|  | ||
|
|
||
| Optional, enabled by `phan.useFallbackParser` | ||
|
|
||
| ## Todo | ||
| - Rename | ||
| - Signature help | ||
|
|
||
| ## Contributing | ||
|
|
||
| Clone whole repository and in root directory execute: | ||
|
|
||
| ```bash | ||
| composer install | ||
| composer install | ||
| npm install | ||
| npm run compile | ||
| npm run build | ||
| code . | ||
| ``` | ||
|
|
||
| The last command will open the folder in VS Code. Hit `F5` to launch an Extension Development Host with the extension. | ||
| For working on the language server, the easiest way is to replace the language server installation from composer in `vendor/felixfbecker/language-server` with a symlink to your local clone. | ||
| For working on the Phan language server, the easiest way is to override your config for the Phan language server installation from composer to point to the phan script within a git checkout of phan (Must set it up with `composer install` inside that checkout.). | ||
|
|
||
| First, checkout and setup a phan installation. | ||
|
|
||
| ```sh | ||
| # Replace the placeholders /path/to/folder and phan_git_checkout with the folders you plan to use. | ||
|
|
||
| cd /path/to/folder/ | ||
| git clone [email protected]:phan/phan phan_git_checkout | ||
| # Optionally, check out the branch being developed | ||
| # git checkout master | ||
| cd /path/to/folder/phan_git_checkout | ||
| composer install | ||
| ``` | ||
|
|
||
| And then point to that phan installation: | ||
|
|
||
| ```json | ||
| { | ||
| "phan.phanScriptPath": "/path/to/folder/phan_git_checkout/phan" | ||
| } | ||
| ``` | ||
|
|
||
| **For guidance on how to set up a Phan project, please see [phan/phan](https://github.com/phan/phan).** | ||
|
|
||
| ## Source | ||
|
|
||
| **For guidance on how to work on the language server, please see the [language server repository](https://github.com/felixfbecker/php-language-server).** | ||
| [github.com/TysonAndre/vscode-php-phan](https://github.com/TysonAndre/vscode-php-phan) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.