https://github.com/phpactor/vscode-phpactor

Phpactor VS Code Extension
https://github.com/phpactor/vscode-phpactor

Last synced: 9 months ago
JSON representation

Phpactor VS Code Extension

• Host: GitHub
• URL: https://github.com/phpactor/vscode-phpactor
• Owner: phpactor
• License: mit
• Created: 2020-06-01T19:35:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T15:16:52.000Z (about 1 year ago)
• Last Synced: 2024-10-24T20:44:09.123Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 842 KB
• Stars: 119
• Watchers: 5
• Forks: 8
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Phpactor VSCode Extension

![phpactor2sm](https://user-images.githubusercontent.com/530801/27995098-82e72c4c-64c0-11e7-96d2-f549c711ca8b.png)

[![vs marketplace](https://img.shields.io/vscode-marketplace/v/phpactor.vscode-phpactor.svg?label=vs%20marketplace)](https://marketplace.visualstudio.com/items?itemName=phpactor.vscode-phpactor) [![downloads](https://img.shields.io/vscode-marketplace/d/phpactor.vscode-phpactor.svg)](https://marketplace.visualstudio.com/items?itemName=phpactor.vscode-phpactor) [![rating](https://img.shields.io/vscode-marketplace/r/phpactor.vscode-phpactor.svg)](https://marketplace.visualstudio.com/items?itemName=phpactor.vscode-phpactor)

Extension which integrates [Phpactor](https://github.com/phpactor/phpactor)

with [VSCode](https://github.com/neoclide/coc.nvim).

## Installation

### Normal Installation

Install from Marketplace or install manually.

1. Download the `phpactor.vsix` file from the [lastest release](https://github.com/phpactor/vscode-phpactor/releases/latest)

2. Run `code --install-extension /path/to/phpactor.vsix`

### Development

For development it is easier

1. Install [npm](https://www.npmjs.com/get-npm).

2. Install typescript: `npm install -g typescript`

3. Git clone this package

4. `npm install`

5. Run `composer install`

6. Open the folder in VSCode

7. Start watch compilation by selecting `Terminal / Run Build Task...`

8. Open the Run and Debug side menu, select `Launch Extension` from the debug configuration and hit run (`F5`)

9. Additionally you can also run `Listen for Xdebug` to debug the Language Server - but has to be run before the Language Server starts.

Note that the Phpactor Language Server currently only runs on Linux and macOS so if you are on Windows you might need to make use of WSL or a Linux VM combined with VSCode Remote.

Before submitting a PR also run `npm run lint` or `Terminal / Run Tasks... / npm: lint`.

## Commands

- `phpactor.status`: Show Phpactor's status

- `phpactor.reindex`: Reindex the project.

- `phpactor.services.list`: List Phpactor's currently running services.

- `phpactor.config.dump`: Dump Phpactor's configuratoin to the log window.

## Documentation

For full documentation see [the docs](https://phpactor.readthedocs.io/en/master/index.html).