laminas / laminas-component-installer

Composer plugin for injecting modules and configuration providers into application configuration
https://docs.laminas.dev/laminas-component-installer/
BSD 3-Clause "New" or "Revised" License
27 stars 12 forks source link

[RFC]: Renaming of `component-whitelist` #50

Closed boesing closed 2 years ago

boesing commented 2 years ago

RFC

Q A
Proposed Version(s) 3.0.0
BC Break? No

Goal

I'd like to get rid of whitelist in the current naming as we already dropped master and other stuff.

Background

There is no industry standard where everyone aligned to. I think in this case (usage in this component), we can just totally avoid the whole "include"/"exclude"/"whitelist"/"blacklist" stuff.

Considerations

We can provide a backport to v2 in order to provide smooth transition to v3.0.0. This is most commonly used in our very own skeleton apps and should not have any impact on any upstream project. I am not even aware of any project in our company (and we have plenty of laminas-mvc and mezzio applications) which uses this feature as it is only useful once the application is installed for the very first time.

So this component does:

So whenever the entry already exists, nothing will happen and thus useless in non-skeleton projects with composer create-project component installs (at runtime).

Proposal(s)

Instead of having component-whitelist, we could use one of:

I do actually prefer autoinstalls since thats actually what it is. Whenever a component is being installed which is is not yet added to the application config, this component checks that list and in case it is listed, it will be added to the application config without bothering the developer currently running composer install/require/create-project

Appendix

For #33, using component-ignorelist might work as well. As we do simply ignore these components and do not bother the developer the same way we would to in case of the includelist. We just do not add that component to the application config.