From f5c45f83edb2bf73b90cff2f35fd252d391ed278 Mon Sep 17 00:00:00 2001 From: Brandon Max Date: Thu, 9 Nov 2017 19:15:36 -0500 Subject: [PATCH] docs(contributing): document how to use XDebug (#518) --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8e7117c..b25680e 100644 --- a/README.md +++ b/README.md @@ -201,3 +201,9 @@ Lint with The project parses PHPStorm's PHP stubs to get support for PHP builtins. It re-parses them as needed after Composer processes, but after some code changes (such as ones involving the index or parsing) you may have to explicitly re-parse them: composer run-script parse-stubs + +To debug with xDebug ensure that you have this set as an environment variable + + COMPOSER_ALLOW_XDEBUG=1 + +This tells the Language Server to not restart without XDebug if it detects that XDebug is enabled (XDebug has a high performance impact).