Magento 2 – How to Use Composer for Extension

magento-2.1magento2

Im developing an extension and would want to use some composer extensions in it. So I have a composer.json file in app/code/Vendor/Extension/ path.

Do I simply run composer update in the extension directory? This will put the vendor directory into the extension right? Is there a way I can have magento pick up the composer.json of my extension when I run a update from root?

Also most importantly what is the best practice in this?

Best Answer

There are two options here:

Described in the comments: create a package or a repository from your extension. If you don't want to push it to the world, you can create a Git repo locally. The repo should contain just your extension and composer.json in the root. Then link your extension's repository as a package to the Magento project in Magento's composer.json (see an example in https://getcomposer.org/doc/04-schema.md#repositories). Use "dev-xxx" version, where xxx is the branch name in your repo - then Composer will always be fetching the latest commit. Then, when you run composer update your package will be loaded with all its dependencies.
Leave file structure as is and duplicate all dependencies, autoload and any other deployment-specific information from your extension's composer.json you the Magento's root composer.json. Then when running composer update (in Magento root) all dependencies of your extension will be deployed.

Related Solutions

Magento – Magento 2 Composer Error

You could actually put it anywhere, what really matters is where you run it from. If you download composer and put it somewhere in your cli PATH then all you need to do is cd to your magento directory and then run "composer update", however you could also put it in the magento directory and run it from there.

You may already know but just to be clear. The CLI tool doesn't actually have anything to do with running the Magento application. The main thing Composer takes care of is downloading and installing the dependencies of the project, it will also create an autoload file so that those dependencies can easily be loaded from the application.

Magento – What are the best practices for installing third party extensions in Magento 2

Install module via composer is the best way to Magento 2. Becuase there are many advantages if we install module via composer.
If you want to upgrade module you just need to change the version in composer.json file and run composer update command at the rootMagentoento.
While in manual installation you need to first download module and replace old files and run setup:upgrade command to upgrade module.
All modules which are installed via composer are downloaded in vendor folder.
Magento uses default https://repo.magento.com/ URL to download module If you purchase module from Magento Marketplace.
If you purchase module from third-party website. You need to add a repository in composer.json to download and install a module.

For Example

"repositories": {
    "0": {
        "type": "composer",
        "url": "https://repo.magento.com/" //Default Magento Repositry
    },
    "thirdparty-module": {
        "type": "composer",
        "url": "https://mymodule.thirdparty.com/" //Third Party Repositary
    }
},

In my opinion composer is the best and proper way to install module in Magento 2.

Install Third Party Module Via composer:

Run this command to add new repository in conposer.json

composer config repositories.thirdparty-module git https://thirdparty-composer-url.com

Now run this command to add component and version of module in composer.json

composer require [component-name]:[version]

Forex.  composer require prince/helloword:1.0.0

Now run composer update to download module from repository.

composer update

Now run setup:upgrade to install and register module in config.php

php bin/magento setup:upgrade

Best Answer

Related Solutions

Magento – Magento 2 Composer Error

Magento – What are the best practices for installing third party extensions in Magento 2

Related Topic