ctasca/mage-bundle

Easily create Magento2/AdobeCommerce PHP/XML/JS files from a set of templates via the command-line.

#1 Installation

composer require --dev ctasca/mage-bundle

#2 Copy template files to Magento root dev/ directory

cd <magento_root>/vendor/ctasca/mage-bundle && composer run-script post-install-cmd

Enable the module

bin/magento module:enable Ctasca_MageBundle

Run setup:upgrade command

bin/magento setup:upgrade

Run setup:di:compile command (optional)

bin/magento setup:di:compile

Available commands

bin/magento magebundle:module:create

Shortcut

bin/magento m:modu:c

bin/magento magebundle:controller:create

Shortcut

bin/magento m:cont:c

bin/magento magebundle:etc:xml:create

Shortcut

bin/magento m:e:x:c

bin/magento magebundle:model:set:create

Shortcut

bin/magento m:m:s:c

bin/magento magebundle:repository:create

Shortcut

bin/magento m:r:c

<config>
    <preference for="Company\Module\Api\Data\$MODEL_NAMEInterface" type="Company\Module\Model\$MODEL_NAME" />
    <preference for="Company\Module\Api\$MODEL_NAMERepositoryInterface" type="Company\Module\Model\$MODEL_NAMERepository" />
    <preference for="Company\Module\Api\Data\$MODEL_NAMESearchResultInterface" type="Company\Module\Model\$MODEL_NAMESearchResult" />
</config>

bin/magento magebundle:model:create

Shortcut

bin/magento m:mode:c

bin/magento magebundle:block:create

Shortcut

bin/magento m:b:c

bin/magento magebundle:helper:create

Shortcut

bin/magento m:h:c

bin/magento magebundle:customer-data:create

Shortcut

bin/magento m:cu:c

bin/magento magebundle:view-model:create

Shortcut

bin/magento m:v:c

bin/magento magebundle:observer:create

Shortcut

bin/magento m:o:c

bin/magento magebundle:plugin:create

Shortcut

bin/magento m:p:c

bin/magento magebundle:cron:create

Shortcut

bin/magento m:cr:c

bin/magento magebundle:console-command:create

Shortcut

bin/magento m:cons:c

bin/magento magebundle:data-patch:create

Shortcut

bin/magento m:d:c

bin/magento magebundle:schema-patch:create

Shortcut

bin/magento m:s:c

bin/magento magebundle:api-interface:create

Shortcut

bin/magento m:a:c

bin/magento magebundle:jquery-widget:create

Shortcut

bin/magento m:j:c

bin/magento magebundle:ui-component:create

Shortcut

bin/magento m:u:c

bin/magento magebundle:logger:create

Shortcut

bin/magento m:l:c

bin/magento magebundle:js:mixin:create

Shortcut

bin/magento m:j:m:c

bin/magento magebundle:exception:create

Shortcut

bin/magento m:e:c

Utilities commands

bin/magento magebundle:util:encryptor

Shortcut

bin/magento m:u:e

Setting custom working directory

Important:

The directory specified in pwd.json must end with a forward-slash

pwd.json example:

{
  "pwd" : "packages/my-package/"
}

About template files:

The repository wiki page

Templates Data Provider

Example

{
  "setTestNamespace" : "\\Ctasca\\MageBundle\\Test",
  "setCustomDataArray" : ["First Value", "Second Value"]
}