danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-30 04:39:00 +01:00
Code Issues Projects Releases Wiki Activity

Document Xdebug usage (#4164)

Browse Source 
* Document Xdebug usage

* Change to non-persistent approache

Co-authored-by: Bruce Weirdan <weirdan@gmail.com>

Co-authored-by: Bruce Weirdan <weirdan@gmail.com>
This commit is contained in:
Adrien LUCAS 2020-09-12 05:35:37 +02:00 committed by GitHub
parent 6d8641ac09
commit 107f596f24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/running_psalm/plugins/authoring_plugins.md
View File

@ -104,6 +104,14 @@ You can also specify an absolute path to your plugin:
</plugins>
```
### Using Xdebug
As Psalm disables _Xdebug_ at runtime, if you need to debug your code step-by-step when authoring a plugin, you can allow the extension by running Psalm as following:
```console
$ PSALM_ALLOW_XDEBUG=1 path/to/psalm
```
## Type system
Understand how Psalm handles types by [reading this guide](plugins_type_system.md).
@ -131,4 +139,3 @@ You can also use more complex rules in the `<issueHandler />` element, as you ca
## Upgrading file-based plugin to composer-based version
Create new plugin project using skeleton, then pass the class name of you file-based plugin to `registerHooksFromClass()` method of the `Psalm\Plugin\RegistrationInterface` instance that was passed into your plugin entry point's `__invoke()` method. See the [conversion example](https://github.com/vimeo/psalm/tree/master/examples/plugins/composer-based/echo-checker/).