Extend component types

[atwixfirster]

Purpose of this pull request

This pull request (PR) adds setup component type.

Affected DevDocs pages

• https://devdocs.magento.com/guides/v2.3/extension-dev-guide/prepare/dev-modtypes.html

Links to Magento source code

• ComponentRegistrar.php

Thank you!

[devops-devdocs]

An admin must run tests on this PR before it can be merged.

[jeff-matthews]

We need a better description of "Setup" in the table.

[atwixfirster]

@jeff-matthews

We need a better description of "Setup" in the table.

Agreed but unfortunately I did not work with "Setup" component. Also I did not find an example of usage in Magento CE. This section may be updated later.

What do you think?

Thank you!

[jeff-matthews]

I did a little more searching and found a description of a module "setup" directory:

Setup: contains classes for module database structure and data setup which are invoked when installing or upgrading.

Is it accurate to describe a "setup module" the same way?

https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/module-file-structure.html#common-directories

[atwixfirster]

Is it accurate to describe a "setup module" the same way?

@jeff-matthews, unfortunately, no...

We are talking about COMPONENT TYPE (about module type) here. In the mentioned by you link - the talk is about module folders structure.

Thanks

[jeff-matthews]

Thanks @atwixfirster. I'll check with an internal developer to get a better description.

[atwixfirster]

Thanks @atwixfirster. I'll check with an internal developer to get a better description.

Cool. We need someone who developed this type of component. This will a very useful information for community.

Thank you, @jeff-matthews ! 👍

[jeff-matthews]

@buskamuza, can you help provide an accurate description of the setup component type or let us know who can?

[atwixfirster]

@buskamuza, could you please help us here?

Many thanks! 🌸

CC: @jeff-matthews

[buskamuza]

Most types are described in the Composer plugin https://github.com/magento/magento-composer-installer that uses these types to deploy the package correctly.
There might be other types, which are not used by this plugin and so I don't know where to find their description. For now, I'm not aware of any such types existing. MFTF team is adding a type for functional tests currently, they should sync with DevDocs team to add the new type to this page.

To be honest, I'm not aware of setup type. If this is about Setup folder, it is part of magento2-base package, which includes all the files that do not belong to any module/theme/etc, but still can't live just inside vendor folder, it must be copied to the Magento root folder. But this package uses magento2-component, so the Composer plugin can copy the files in the root.

I'd suggest to start the page from the documentation of the plugin I mentioned. And then sync with @okolesnyk on what types functional tests may add.

[buskamuza]

See my comment above

[atwixfirster]

@jeff-matthews , I 've skipped info about setup component regarding Magento Composer Installer documentation.

@rogyar , could you please re-check this PR and let me know if you have any notices here?

Thank you!

[buskamuza]

Why is it the Migration Tool? It's not a magento2-component from what I can see - https://github.com/magento/data-migration-tool/blob/2.3-develop/composer.json
So far the only example is the Magento base package - the package formed of the files that must be located in root (index.php, .htaccess, etc). This includes dev/tests and setup as well for now.

[atwixfirster]

Why is it the Migration Tool?

Regarding to https://github.com/magento/magento-composer-installer/blob/master/README.md M2 Migration Tool was developed as a magento-component :)

However, I've checked MagentoHackathon\Composer\Magento\PackageTypes and found
the files that must be located in root .

I've fixed a provided description according to your comment. Could you please review?

Thank you, @buskamuza !

[buskamuza]

I see... looks like it's something outdated.
All looks good now.

[jeff-matthews]

running tests

[ghost]

Hi @atwixfirster, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.