README

Русский | English

Плагин Composer

Плагин Composer служит для установки ресурсов веб‑приложения RosGear — в том числе компонентов, тем и библиотек.

Чтобы установить ресурс, вам нужно добавить атрибут "type" в ваш файл composer.json и присвоить ему соответствующие значение, а в разделе "extra" указать дополнительные настройки.

Для установки ресурсов, таких как:

• компоненты (модули, расширения модулей, виджеты и плагины), необходимо указать "type" : "component".

В разделе "extra" вы можете дополнительно добавить путь установки или идентификатор компонента, например:

{"extra" : {"ge": {"path": "/your-name/component-dir"} } }

или

{"extra" : {"ge": {"id": "component.id", "vendor": "your-name"} } }

• темы, необходимо указать "type" : "theme".

В разделе "extra" вы можете дополнительно добавить тип и название темы, например:

{"extra" : {"ge": {"type": "frontend", "name": "theme-name"} } }

или

{"extra" : {"ge": {"type": "backend", "name": "theme-name"} } }

• пакеты компонентов или библиотеки Ge Framework, необходимо указать "type" : "ge".

В разделе "extra" вы можете дополнительно добавить путь установки, например:

{"extra" : {"ge": {"path": "/public/vendors/ge/panel"} } }

• сторонние библиотеки (библиотеки других разработчиков), необходимо указать "type" : "library".

В разделе "extra" вы можете дополнительно добавить название библиотеки или локальный путь относительно проекта, например:

{"extra" : {"ge": {"path": "/vendor/library-dir"} } }

или

{"extra" : {"ge": {"name": "library-name"} } }

• локализации, необходимо указать "type" : "lang";
• файлы и папки редакции веб-приложения RosGear, необходимо указать "type": "skeleton".

В раздел "require" необходимо добавить "rosgear/ge-composer-plugin": "*", а в файле проекта composer.json указать:

{
    ...,
    "config": {
        "allow-plugins": {
            "rosgear/ge-composer-plugin": true
        }
    }
}

Composer plugin

The Composer plugin is used to install RosGear web application resources, including components, themes, and libraries.

To install a resource, you need to add the "type" attribute to your composer.json file and assign it the appropriate value, and specify additional settings in the "extra" section.

To install resources such as:

• components (modules, module extensions, widgets, and plugins), must be specified "type" : "component".

In the "extra" section you can optionally specify the installation path or component ID, for example:

{"extra" : {"ge": {"path": "/your-name/component-dir"} } }

or

{"extra" : {"ge": {"id": "component.id", "vendor": "your-name"} } }

• themes, must be specified "type" : "theme".

In the "extra" section you can additionally specify the type and name of the theme, for example:

{"extra" : {"ge": {"type": "frontend", "name": "theme-name"} } }

or

{"extra" : {"ge": {"type": "backend", "name": "theme-name"} } }

• Ge Framework component packages or libraries, must be specified "type" : "ge".

In the "extra" section you can additionally specify the installation path, for example:

{"extra" : {"ge": {"path": "/public/vendors/ge/panel"} } }

• third-party libraries (libraries from other developers), must be specified "type" : "library".

In the "extra" section you can optionally specify the library name or local path relative to the project, for example:

{"extra" : {"ge": {"path": "/vendor/library-dir"} } }

or

{"extra" : {"ge": {"name": "library-name"} } }

• localization, must be specified "type" : "lang";
• RosGear web application edition files and folders, must be specified "type": "skeleton".

In the "require" section you need to add "rosgear/ge-composer-plugin": "*", and in the project file composer.json specify:

{
    ...,
    "config": {
        "allow-plugins": {
            "rosgear/ge-composer-plugin": true
        }
    }
}