Skip to content

Add note about indexing config classes #19159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 21, 2023
Merged

Add note about indexing config classes #19159

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link

@ghost ghost Nov 21, 2023 •
edited by ghost
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Il afraid it's a bit specific 🤔 I think we should someone from @symfony/team-symfony-docs

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

indexing, otherwise you won't get autocompletion for the ConfigBuilders.

Keep Going!
-----------

Expand Down