How to include files inside pub, lib folder to composer?

Question

I am a developer myself and I built extension for Magento 2. So far it is only zip package file. User just unzip the file, uploads it to ftp and then runs php bin/magento setup:upgrade. Now I need to create also Composer option for installation so our customers can install the extension without uploading zip files but using composer.

One of the problem is that we have some files outside app folder (inside pub and lib). More than 100 files. I think that composer doesn't have option to include files outside app folder because composer will install it in vendor folder.

Is it possible to include into composer also files from lib and pub folder?

Answer 1

If you really need the files in these locations, you will need a second composer package of the type magento2-component instead of magento2-module. The module then depends on the component so that both are installed.

In the component's composer.json you can specify which files in the package should be copied where into the project. Take a look at magento/base to see how it works.

For example, this is a composer.json to copy everything in src into pub, as well as into the root directory (for installations that do not use pub as document root)

{
  "name": "example/example",
  "type": "magento2-component",
  "extra": {
    "map": [
      [
        "src/*",
        ""
      ],
      [
        "src/*",
        "pub"
      ]
    ]
  }
}

Answer 2

You can keep all the folders/files in Vendor and create symlinks to those in lib or pub folders. Many of the extensions do this.