Fix PhpStorm integration instructions, fixes #4083 #4128
Conversation
There was a problem hiding this comment.
The revision of the documentation looks really good to me. Great work!
As noted above I suggest to make more clear that the DDEV Integration Plugin is an alternative to the manual steps listed.
Please let me know if there is any step on this list that is not covered by the plugin yet.
| 4. In the "Path mappings" of the "Server" you may have to map the local paths (which on WSL2 means /home/...) to the in-container paths, especially if you have mutagen enabled. So "Virtual Machine Path" would be "/var/www/html" and "Local path" would be something like `/Users/rfay/workspace/d9` (on macOS) or `\\wsl$\Ubuntu\home\rfay\workspace\d9` on Windows using WSL2. (The plugin will already have done this for you.) | ||
| 5. Now back in the "Configure Remote PHP Interpreter" for "Configuration files" use `.ddev/.ddev-docker-compose-full.yaml`. On macOS, you may need to use `<cmd><shift>.`, (Command+Shift+Dot) to show hidden dotfiles. (The plugin will have done this for you.) | ||
| 6. Service: web (Plugin will have done this.) | ||
| 7. Add an environment variable `COMPOSE_PROJECT_NAME=ddev-<projectname>`. In this case, it's `ddev-d9`. (Note that DDEV project names that contain dots do not currently work due to a [PhpStorm bug](https://youtrack.jetbrains.com/issue/WI-63293). You'll need to rename your project to get these instructions to work.) (Plugin will have done this.) |
There was a problem hiding this comment.
Is setting the environment variable still required? I thought this would also be related to phpstorm using docker run instead of exec which should be fixed now.
There was a problem hiding this comment.
The environment variable is not required in v1.21.1, so I guess with an update on the version at the top, it will be OK.
| ### Setup Technique | ||
|
|
||
| 1. Open a DDEV project. In this example, the project name is "d9" and the site is "d9.ddev.site". | ||
| 1. Preferably, install the [DDEV Integration Plugin](https://plugins.jetbrains.com/plugin/18813-ddev-integration) so you don't have to do much of this. |
There was a problem hiding this comment.
If you use the plugin you shouldn't need to do any of the following steps. So suggesting the plugin shoudln't be part of the list but an alternative to it.
This would also make the "(plugin will have done this)" redundant.
There was a problem hiding this comment.
Well, except the phpunit.
I do think this can be much better with a separate section for phpunit.
|
The thing that the plugin does not do is configuring phpunit. Not sure if it can do that. |
rfay
force-pushed
the
20220817_phpstorm_instructions
branch
from
f917df1 to
86b18fd
Compare
|
Thanks @nico-loeber - incorporated your comments. The one thing I've decided to add is using Jetbrains Gateway on WSL2. Tricky because of having to enable ssh. |
2 participants
The Problem/Issue/Bug:
How this PR Solves The Problem:
Rewrite, please review.
Manual Testing Instructions:
Walk through the instructions.