Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.19 KB
Raw

Contributing

Clone this whole repository and in the root directory execute:

composer install
npm install
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 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.

# 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:

{
    "phan.phanScriptPath": "/path/to/folder/phan_git_checkout/phan"
}

For guidance on how to set up a Phan project, please see phan/phan, and the article Getting Started