zero1/magento-dev

2.1.0 2024-06-25 14:07 UTC

Requires

• composer/composer: ^2.0
• galbar/jsonpath: ^3.0 || ^2.0
• league/flysystem: ~2.4.5
• magento/framework: ^100.1|^101.0|^102.0|^103.0
• mikehaertl/php-shellcommand: ^1.7
• mustache/mustache: *
• saloonphp/xml-wrangler: ^1.2
• shanethehat/pretty-xml: ^1.0
• spatie/array-to-xml: ^2.7 || ^3.3
• symfony/console: ~4.4.0||~5.4.0
• symfony/filesystem: ^2.8.52 || ^3.4.35 || ^4.4 || ^5.0 || ^6.0
• symfony/yaml: *
• vyuldashev/xml-to-array: ^v1.1

Suggests

• mdoq/module-connector: Improves DevOps for Magento2

GPL-3.0-or-later

• magento
• magento 2

README

This project takes inspiration from the Laravel artisan make commands. This is very much a work in progress, any feedback or contributes are welcome.

Features

• Create patch for vendor files
• Create a module
• Make CLI Command
• Make Controller
• Make Observer

TODO

• refactor routes logic to OOP (like observer logic)
• refactor cli command logic to OOP (like observer logic)

Vendor Patches

The ability to generate patches from the vendor directory. For example if you have had to craft a fix for a module and the vendor hasn't supplied a patch yet.

Summary

./vendor/bin/magentodev vendor:diff

Detail / patch generation

./vendor/bin/magentodev vendor:diff --package=magento/framework

Module Creation

Summary

./vendor/bin/magentodev module:make

Make CLI Command

Description:
  Add a CLI command to an existing extension.

Usage:
  make:cli-command [options] [--] [<--force>]

Arguments:
  --force                                        If supplied and class/file exists,  it will be overwritten [default: false]

Options:
      --name=NAME                                Name of the module (Magento module name, MyCompany_MyModule)
      --command-class-name[=COMMAND-CLASS-NAME]  Name of the class for the command (MyCommand)
      --command-signature[=COMMAND-SIGNATURE]    The signature of the command. (defaults to example:command)
      --command-help[=COMMAND-HELP]              The help/description of the command (default "")
  -h, --help                                     Display this help message
  -q, --quiet                                    Do not output any message
  -V, --version                                  Display this application version
      --ansi                                     Force ANSI output
      --no-ansi                                  Disable ANSI output
  -n, --no-interaction                           Do not ask any interactive question
  -v|vv|vvv, --verbose                           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Example

./vendor/bin/magentodev make:cli-command

Make Controller

Description:
  Create a controller

Usage:
  make:controller [options]

Options:
      --name=NAME                    Name of the module (Magento module name, MyCompany_MyModule)
      --area=AREA                    Area (frontend, adminhtml, rest-api)
      --frontname=FRONTNAME          Front name of the controller (e.g https://www.example.com/FRONTNAME/controller/action)
      --controller=CONTROLLER        Controller (e.g https://www.example.com/frontname/CONTROLLER/action)
      --action=ACTION                Action (e.g https://www.example.com/frontname/controller/ACTION)
      --response-type=RESPONSE-TYPE  Response type (html, json, txt)
      --http-method=HTTP-METHOD      HTTP Method (GET, POST)
      --force                        Overwrite files without asking.
  -h, --help                         Display help for the given command. When no command is given display help for the list command
  -q, --quiet                        Do not output any message
  -V, --version                      Display this application version
      --ansi|--no-ansi               Force (or disable --no-ansi) ANSI output
  -n, --no-interaction               Do not ask any interactive question
  -v|vv|vvv, --verbose               Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  This command allows you to create a controller within a module

Make Observer

Description:
  Create an observer

Usage:
  make:observer [options]

Options:
      --name=NAME       Name of the module (Magento module name, MyCompany_MyModule)
      --area=AREA       Area (global, adminhtml, crontab, frontend, graphql, webapi_rest, webapi_soap), provide comma separated list for multiple.
      --event=EVENT     Event name to listen to
      --force           Overwrite files without asking.
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  This command allows you to create an observer for a specific event within a module

Planned Features

• Templates for modules
• Nicer interface for managing submodules
• Create plugins / components / models automatically.

Know Issues

• at present comments are lost in xml files when the file is updated.

Deving on module

1. git submodule add --name Zero1_MagentoDeveloperUtils --branch dev [e-mail]:zero1limited/magento2-developer-utils.git extensions/zero1/magento2-developer-utils

"zero1-dev-extensions": {
      "type": "path",
      "url": "extensions/zero1/magento2-developer-utils",
      "options": {
          "symlink": true
      }
  }

1. composer require --dev zero1/magento-dev:@dev