Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TysonAndre committed Oct 1, 2017
1 parent c1e3bc2 commit 5d96857
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 11 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# Phan for Visual Studio Code
# PHP Phan (Analyzer)

[![Build Status](https://travis-ci.org/TysonAndre/vscode-php-phan.svg?branch=master)](https://travis-ci.org/TysonAndre/vscode-php-phan) [![Minimum PHP Version](https://img.shields.io/badge/php-%3E=%207.1-8892BF.svg)](https://php.net/)
[![Latest Release](https://vsmarketplacebadge.apphb.com/version-short/TysonAndre.php-phan.svg)](https://marketplace.visualstudio.com/items?itemName=TysonAndre.php-phan) [![Installs](https://vsmarketplacebadge.apphb.com/installs/TysonAndre.php-phan.svg)](https://marketplace.visualstudio.com/items?itemName=TysonAndre.php-phan) [![Rating](https://vsmarketplacebadge.apphb.com/rating-short/TysonAndre.php-phan.svg)](https://marketplace.visualstudio.com/items?itemName=TysonAndre.php-phan) [![Build Status](https://travis-ci.org/TysonAndre/vscode-php-phan.svg?branch=master)](https://travis-ci.org/TysonAndre/vscode-php-phan) [![Minimum PHP Version](https://img.shields.io/badge/php-%3E=7.1-8892BF.svg)](https://php.net/)

Based on [PHP IntelliSense](https://github.com/felixfbecker/vscode-php-intellisense)
**Supports Unix/Linux.**

This adds improved [static analysis from Phan](https://github.com/phan/phan#features) to Visual Studio Code.
## Features

+ Adds improved [error detection from Phan](https://github.com/phan/phan#features) to Visual Studio Code.
+ Analyze code while you're typing.
+ Optionally analyze code with syntax errors.

## Issue Tracker

**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](https://github.com/TysonAndre/vscode-php-phan). Phan is implemented purely in PHP [in its own repository](https://github.com/phan/phan),
bugs in Phan analysis need to be implemented there and all issues should be reported [there](https://github.com/phan/phan/issues).**

**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.**
However, bugs in this VS code extension (crashes, etc) or related to the language server protocol should be reported [in this extension's issue tracker](https://github.com/TysonAndre/vscode-php-phan/issues)

## Installation

Expand All @@ -18,6 +25,8 @@ This adds improved [static analysis from Phan](https://github.com/phan/phan#feat
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)

A future release may support Windows, but it won't be as fast.
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

Expand Down Expand Up @@ -57,7 +66,7 @@ Add these entries to your VSCode config (Open the menu at File > Preferences > S
}
```

## Features
## Examples

### Error Detection

Expand Down Expand Up @@ -109,6 +118,8 @@ And then point to that phan installation:

**For guidance on how to set up a Phan project, please see [phan/phan](https://github.com/phan/phan).**

## Source
## Credits

This VS Code extension and many parts of the language server protocol implementation are based on [PHP IntelliSense](https://github.com/felixfbecker/vscode-php-intellisense)

[github.com/TysonAndre/vscode-php-phan](https://github.com/TysonAndre/vscode-php-phan)
This uses [Phan](https://github.com/phan/phan)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "php-phan-vscode",
"displayName": "Phan - PHP Analyzer",
"name": "php-phan",
"displayName": "PHP Phan (Analyzer)",
"description": "Phan - static analyzer for PHP, minimizing false positives.",
"publisher": "TysonAndre",
"author": "Tyson Andre <[email protected]>",
Expand Down

0 comments on commit 5d96857

Please sign in to comment.