Document debugging Phel core/compiler with XDebug #144
Description
It would be useful for Phel core / compiler development if debug guide had a section about setting XDebug and connecting from VSCode (PHP Debug extension) which would also be compatible to other editors like Emacs (dap-mode) and Neovim (nvim-dap) too (using debug adapter protocol). Maybe PHPStorm uses that also or could have a separate section if the setup differs.
XDebug setup can be bit tricky depending on environment with port and folder mappings to containers or VM's bringing some extra complexity.
I'm not sure what would be most generic way to demonstrate this but I've had experience with this particular PHP (WP) dev environment with VirtualBox having pretty good docs:
- https://varyingvagrantvagrants.org/docs/en-US/references/xdebug/
- https://varyingvagrantvagrants.org/docs/en-US/references/xdebug-and-phpstorm/
For custom container setup I've got it installed via Pecl in Dockerfile also but haven't really used it there yet. Example in phel-wp-plugin Dockerfile.