feat: support XDebug v3 (#435)

* ci: support XDebug v3

* docs: update readme

* ci: don't run test twice

* ci: make builds easier to read

* ci: use matrix.include

* ci: set port to 9000

* docs: document port 9000 setting

* test: use trigger_error()

Many error cases were reclassified in PHP 8.

* docs: update port docs

* ci: run matrix on new version

Author: felixfbecker

.editorconfig

@@ -7,7 +7,7 @@ insert_final_newline = true
 end_of_line = lf
 charset = utf-8
 
-[{*.json,*.yml,.prettierrc}]
+[{*.json,*.yml,.prettierrc,*.md}]
 indent_size = 2
 
 [*.md]

.github/workflows/build.yml

@@ -7,17 +7,17 @@ env:
 
 jobs:
   test:
+    if: github.event_name == 'pull_request' || github.ref == 'refs/heads/main'
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os:
-          - ubuntu-18.04
-          - windows-2019
-          - macos-10.15
-        xdebug:
-          - '2.9.8'
-        php:
-          - '7.4'
+        include:
+          # Latest version
+          - { xdebug: xdebug-3.0.1, php: '8.0', os: ubuntu-18.04 }
+          - { xdebug: xdebug-3.0.1, php: '8.0', os: windows-2019 }
+          - { xdebug: xdebug-3.0.1, php: '8.0', os: macos-10.15 }
+          # Old versions
+          - { xdebug: xdebug-2.9.8, php: '7.4', os: ubuntu-18.04 }
     steps:
       - uses: actions/checkout@v2
       - name: Setup Node.js
@@ -36,8 +36,14 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: xdebug-${{ matrix.xdebug }}
+          extensions: ${{ matrix.xdebug }}
+          # Top: XDebug v3
+          # Bottom: XDebug v2
           ini-values: >-
+            xdebug.mode = debug,
+            xdebug.start_with_request = yes,
+            xdebug.client_port = 9000,
+
             xdebug.remote_enable = 1,
             xdebug.remote_autostart = 1,
             xdebug.remote_log = /tmp/xdebug.log

README.md

@@ -20,13 +20,22 @@ This extension is a debug adapter between VS Code and [XDebug](https://xdebug.or
 
 3. Enable remote debugging in your `php.ini`:
 
+   For XDebug v3.x.x:
+
+   ```ini
+   xdebug.mode = debug
+   xdebug.start_with_request = yes
+   xdebug.client_port = 9000
+   ```
+
+   For XDebug v2.x.x:
+
    ```ini
-   [XDebug]
    xdebug.remote_enable = 1
    xdebug.remote_autostart = 1
    ```
 
-   There are other ways to tell XDebug to connect to a remote debugger than `remote_autostart`, like cookies, query parameters or browser extensions. I recommend `remote_autostart` because it "just works". There are also a variety of other options, like the port (by default 9000), please see the [XDebug documentation on remote debugging](https://xdebug.org/docs/remote#starting) for more information.
+   There are other ways to tell XDebug to connect to a remote debugger, like cookies, query parameters or browser extensions. I recommend `remote_autostart` (XDebug v2)/`start_with_request` (XDebug v3) because it "just works". There are also a variety of other options, like the port, please see the [XDebug documentation on remote debugging](https://xdebug.org/docs/remote#starting) for more information. Please note that the default XDebug port changed between XDebug v2 to v3 from 9000 to 9003. The extension still defaults to 9000, so make sure your configuration in `launch.json` and `php.ini` match.
 
 4. If you are doing web development, don't forget to restart your webserver to reload the settings.
 

testproject/error.php

@@ -2,11 +2,11 @@
 
 $array = array('hello' => 'world');
 
-// Notice (undefined index)
-echo $array['undefined_index'];
+// Notice
+trigger_error("Test notice", E_USER_NOTICE);
 
-// Warning (illegal offset type)
-$array[array()] = 123;
+// Warning
+trigger_error("Test warning", E_USER_WARNING);
 
 // Exception
 throw new Exception('this is an exception');