composer.json – Publish Using Composer
We recommend to create a composer.json
file for each plugin. we have created a composer installer for plugins, which make it easy to install plugins in the correct folder by a single line of code:
composer require mycompany/my-cool-plugin:dev-master
here is an example composer.json
file which must be located in the root of your repository, if you add a composer.json
file to your repository please also add your repository to Packagist.org
{
"name": "mycompany/my-cool-plugin", // will result in install path: plugins/mycompany/myCoolPlugin
"type": "phile-plugin", // this type is important
"version": "1.0.0",
"license": "MIT",
"description": "a short description of your plugin", // add a short description here
"homepage": "http://philecms.com", // feel free to add your homepage or repo url
"keywords": ["cms", "phile", "myTag"], // please use the tags "cms" and "phile" for each plugin and add your own
"authors": [
{
"name": "Dave Developer",
"email": "dave@example.com",
"homepage": "http://example.com/",
"role": "Developer"
}
],
"require": {
// feel free to add more requirements for your plugin here
"phile-cms/phile": "1.0.0", // version 1.0.0 of phile cms is required
"phile-cms/plugin-installer-plugin": "1.0.0" // version 1.0.0 of the composer plugin installer is required
}
}