Add note about indexing config classes #19159
Conversation
| @@ -1304,6 +1304,11 @@ namespace ``Symfony\Config``:: | |||
| Nested configs (e.g. ``\Symfony\Config\Framework\CacheConfig``) are regular | |||
| PHP objects which aren't autowired when using them as an argument type. | |||
|
|
|||
| .. note:: | |||
|
|
|||
| Be sure to not exclude the ``kernel.build_dir`` directory from your IDE | |||
There was a problem hiding this comment.
Very nice addition. This is exactly what I've stumbled on today.
However the problem is that by default kernel.build_dir equals to cache directory. I don't think devs want to have this dir indexed. On the other hand even if build dir is different then I wouldn't like to have all of it indexed as well.
What I did in my IDE (PHPStorm) is to mark a subdir var/cache/dev/Symfony/Config as not excluded while the var dir remains marked as excluded.
Do you think we can be specific about this in this note?
There was a problem hiding this comment.
Il afraid it's a bit specific 🤔 I think we should someone from @symfony/team-symfony-docs
There was a problem hiding this comment.
I was divided about this ... but at the end I added a explicit mention to this directory (a3fe108). It's true that it's very specific ... but this note is specifically talking about that, so I think it's fine. Thanks!
|
Thanks Alex! I love when contributors add changes that solve recurring questions from the community. |
Fix #19156
This is a recurring question as far as I know in the repo issues so let's add a note about it? 🙂