DD#main: feat: replace magepath with cwd

Demoli · Demoli · commit 47545dfe385f · 2021-08-31T16:50:15.000+01:00
diff --git a/README.md b/README.md
@@ -16,24 +16,24 @@ chmod +x magegen.php
 ### Download the phar
 
 ```
-curl -o magegen.phar https://github.com/Skywire/MageGen/releases/latest/download/magegen.phar
+curl -o -L magegen.phar https://github.com/Skywire/MageGen/releases/latest/download/magegen.phar
 chmod +x magegen.phar
 sudo mv magegen.phar /usr/local/bin/magegen    
 ```
 
 ## Usage
 
-### Commands
+Run from inside a Magento 2 project directory.
 
-All commands expect magepath as the first argument this is the path to the magento 2 installation.
+`magegen --help`
 
-If omitted the current working directory will be used.
+### Commands
 
 #### Make Module
 
 Create a new Magento module with registration and etc/module.xml files
 
-`./magegen.php make:module <magepath> [<namespace> [<module>]]`
+`./magegen.php make:module [<namespace> [<module>]]`
 
 * vendor - The vendor namespace e.g MyCompanyName
 * module - The module name, e.g MyModuleName
@@ -44,7 +44,7 @@ Create or update a plugin class.
 
 You can update an existing plugin to add new methods.
 
-`./magegen.php make:plugin <magepath> [<subject> [<method> [<class> [<type> [<area>]]]]]`
+`./magegen.php make:plugin [<subject> [<method> [<class> [<type> [<area>]]]]]`
 
 * subject - The plugin subject class or interface, e.g \Magento\Checkout\Api\PaymentInformationManagementInterface
 * method - The plugin subject method e.g. savePaymentInformationAndPlaceOrder
@@ -60,7 +60,7 @@ Create or update a CRUD entity model, with API interface, resource model and col
 When updating a model you can add new properties, this will add the getters and setters to the interface and the model
 class.
 
-`./magegen.php make:entity <magepath> [<module> [<entity> [<table> [<id>]]]]`
+`./magegen.php make:entity [<module> [<entity> [<table> [<id>]]]]`
 
 * module - The module name, e.g. MyCompany_MyModule
 * entity - The entity model name
@@ -71,7 +71,7 @@ class.
 
 Creates a repository and search result model with interfaces.
 
-`./magegen.php make:repository <magepath> [<module> [<entity> [<table> [<id>]]]]`
+`./magegen.php make:repository [<module> [<entity> [<table> [<id>]]]]`
 
 * module - The module name, e.g. MyCompany_MyModule
 * entity - The entity model name
@@ -82,7 +82,7 @@ Create or update db_schema.xml.
 
 Will create entity table with primary key constraint, does not overwrite existing tables
 
-`./magegen.php make:schema [<magepath> [<module> [<entity>]]]`
+`./magegen.php make:schema [[<module> [<entity>]]]`
 
 * module - The module name, e.g. MyCompany_MyModule
 * entity - The entity model name
diff --git a/src/AbstractCommand.php b/src/AbstractCommand.php
@@ -19,6 +19,7 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Twig\Environment;
 
 
@@ -57,11 +58,11 @@ public function __construct(Environment $twig, string $name = null)
 
     protected function configure(): void
     {
-        $this->addArgument('magepath', InputArgument::OPTIONAL, '', getcwd());
+        $this->addOption('magepath', '-m', InputOption::VALUE_REQUIRED, 'Path to Magento installation', getcwd());
     }
 
     protected function getWriter(InputInterface $input)
     {
-        return new ModuleFile($input->getArgument('magepath'));
+        return new ModuleFile($input->getOption('magepath'));
     }
 }
diff --git a/src/MakeEntityCommand.php b/src/MakeEntityCommand.php
@@ -79,7 +79,7 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        require $input->getArgument('magepath') . '/vendor/autoload.php';
+        require $input->getOption('magepath') . '/vendor/autoload.php';
 
         $writer = $this->getWriter($input);
         $io     = new SymfonyStyle($input, $output);
@@ -89,7 +89,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $module = $io->askQuestion(
                 (new Question('Module'))->setAutocompleterValues(
                     (new ModuleAutocomplete())->getAutocompleteValues(
-                        $input->getArgument('magepath')
+                        $input->getOption('magepath')
                     )
                 )
             );
@@ -101,7 +101,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $entity = $io->askQuestion(
                 (new Question(sprintf('Entity %s', $prefix)))->setAutocompleterValues(
                     (new EntityAutocomplete())->getAutocompleteValues(
-                        $input->getArgument('magepath'),
+                        $input->getOption('magepath'),
                         $module
                     )
                 )
@@ -125,7 +125,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         if ($isAmend) {
-            $classWriter = new ClassFile($input->getArgument('magepath'));
+            $classWriter = new ClassFile($input->getOption('magepath'));
 
             $io->title('Class exists, adding new properties');
 
diff --git a/src/MakePluginCommand.php b/src/MakePluginCommand.php
@@ -72,10 +72,10 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        require $input->getArgument('magepath') . '/vendor/autoload.php';
+        require $input->getOption('magepath') . '/vendor/autoload.php';
 
         $writer      = $this->getWriter($input);
-        $classWriter = new ClassFile($input->getArgument('magepath'));
+        $classWriter = new ClassFile($input->getOption('magepath'));
 
         $io = new SymfonyStyle($input, $output);
 
diff --git a/src/MakeRepositoryCommand.php b/src/MakeRepositoryCommand.php
@@ -77,7 +77,7 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        require $input->getArgument('magepath') . '/vendor/autoload.php';
+        require $input->getOption('magepath') . '/vendor/autoload.php';
 
         $io = new SymfonyStyle($input, $output);
 
@@ -86,7 +86,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $module = $io->askQuestion(
                 (new Question('Module'))->setAutocompleterValues(
                     (new ModuleAutocomplete())->getAutocompleteValues(
-                        $input->getArgument('magepath')
+                        $input->getOption('magepath')
                     )
                 )
             );
@@ -98,7 +98,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $entity = $io->askQuestion(
                 (new Question(sprintf('Entity %s', $prefix)))->setAutocompleterValues(
                     (new EntityAutocomplete())->getAutocompleteValues(
-                        $input->getArgument('magepath'),
+                        $input->getOption('magepath'),
                         $module
                     )
                 )
diff --git a/src/MakeSchemaCommand.php b/src/MakeSchemaCommand.php
@@ -72,7 +72,7 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        require $input->getArgument('magepath') . '/vendor/autoload.php';
+        require $input->getOption('magepath') . '/vendor/autoload.php';
 
         $io = new SymfonyStyle($input, $output);
 
@@ -81,7 +81,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $module = $io->askQuestion(
                 (new Question('Module'))->setAutocompleterValues(
                     (new ModuleAutocomplete())->getAutocompleteValues(
-                        $input->getArgument('magepath')
+                        $input->getOption('magepath')
                     )
                 )
             );
@@ -93,7 +93,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $entity = $io->askQuestion(
                 (new Question(sprintf('Entity %s', $prefix)))->setAutocompleterValues(
                     (new EntityAutocomplete())->getAutocompleteValues(
-                        $input->getArgument('magepath'),
+                        $input->getOption('magepath'),
                         $module
                     )
                 )

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`use Symfony\Component\Console\Command\Command;`
`20`	`20`	`use Symfony\Component\Console\Input\InputArgument;`
`21`	`21`	`use Symfony\Component\Console\Input\InputInterface;`
	`22`	`+use Symfony\Component\Console\Input\InputOption;`
`22`	`23`	`use Twig\Environment;`
`23`	`24`
`24`	`25`
`@@ -57,11 +58,11 @@ public function __construct(Environment $twig, string $name = null)`
`57`	`58`
`58`	`59`	`protected function configure(): void`
`59`	`60`	`{`
`60`		`- $this->addArgument('magepath', InputArgument::OPTIONAL, '', getcwd());`
	`61`	`+ $this->addOption('magepath', '-m', InputOption::VALUE_REQUIRED, 'Path to Magento installation', getcwd());`
`61`	`62`	`}`
`62`	`63`
`63`	`64`	`protected function getWriter(InputInterface $input)`
`64`	`65`	`{`
`65`		`- return new ModuleFile($input->getArgument('magepath'));`
	`66`	`+ return new ModuleFile($input->getOption('magepath'));`
`66`	`67`	`}`
`67`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ protected function configure(): void`
`79`	`79`
`80`	`80`	`protected function execute(InputInterface $input, OutputInterface $output): int`
`81`	`81`	`{`
`82`		`- require $input->getArgument('magepath') . '/vendor/autoload.php';`
	`82`	`+ require $input->getOption('magepath') . '/vendor/autoload.php';`
`83`	`83`
`84`	`84`	`$writer = $this->getWriter($input);`
`85`	`85`	`$io = new SymfonyStyle($input, $output);`
`@@ -89,7 +89,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`89`	`89`	`$module = $io->askQuestion(`
`90`	`90`	`(new Question('Module'))->setAutocompleterValues(`
`91`	`91`	`(new ModuleAutocomplete())->getAutocompleteValues(`
`92`		`- $input->getArgument('magepath')`
	`92`	`+ $input->getOption('magepath')`
`93`	`93`	`)`
`94`	`94`	`)`
`95`	`95`	`);`
`@@ -101,7 +101,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`101`	`101`	`$entity = $io->askQuestion(`
`102`	`102`	`(new Question(sprintf('Entity %s', $prefix)))->setAutocompleterValues(`
`103`	`103`	`(new EntityAutocomplete())->getAutocompleteValues(`
`104`		`- $input->getArgument('magepath'),`
	`104`	`+ $input->getOption('magepath'),`
`105`	`105`	`$module`
`106`	`106`	`)`
`107`	`107`	`)`
`@@ -125,7 +125,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`if ($isAmend) {`
`128`		`- $classWriter = new ClassFile($input->getArgument('magepath'));`
	`128`	`+ $classWriter = new ClassFile($input->getOption('magepath'));`
`129`	`129`
`130`	`130`	`$io->title('Class exists, adding new properties');`
`131`	`131`
Original file line number	Diff line number	Diff line change
`@@ -72,10 +72,10 @@ protected function configure(): void`
`72`	`72`
`73`	`73`	`protected function execute(InputInterface $input, OutputInterface $output): int`
`74`	`74`	`{`
`75`		`- require $input->getArgument('magepath') . '/vendor/autoload.php';`
	`75`	`+ require $input->getOption('magepath') . '/vendor/autoload.php';`
`76`	`76`
`77`	`77`	`$writer = $this->getWriter($input);`
`78`		`- $classWriter = new ClassFile($input->getArgument('magepath'));`
	`78`	`+ $classWriter = new ClassFile($input->getOption('magepath'));`
`79`	`79`
`80`	`80`	`$io = new SymfonyStyle($input, $output);`
`81`	`81`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ protected function configure(): void`
`77`	`77`
`78`	`78`	`protected function execute(InputInterface $input, OutputInterface $output): int`
`79`	`79`	`{`
`80`		`- require $input->getArgument('magepath') . '/vendor/autoload.php';`
	`80`	`+ require $input->getOption('magepath') . '/vendor/autoload.php';`
`81`	`81`
`82`	`82`	`$io = new SymfonyStyle($input, $output);`
`83`	`83`
`@@ -86,7 +86,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`86`	`86`	`$module = $io->askQuestion(`
`87`	`87`	`(new Question('Module'))->setAutocompleterValues(`
`88`	`88`	`(new ModuleAutocomplete())->getAutocompleteValues(`
`89`		`- $input->getArgument('magepath')`
	`89`	`+ $input->getOption('magepath')`
`90`	`90`	`)`
`91`	`91`	`)`
`92`	`92`	`);`
`@@ -98,7 +98,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`98`	`98`	`$entity = $io->askQuestion(`
`99`	`99`	`(new Question(sprintf('Entity %s', $prefix)))->setAutocompleterValues(`
`100`	`100`	`(new EntityAutocomplete())->getAutocompleteValues(`
`101`		`- $input->getArgument('magepath'),`
	`101`	`+ $input->getOption('magepath'),`
`102`	`102`	`$module`
`103`	`103`	`)`
`104`	`104`	`)`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ protected function configure(): void`
`72`	`72`
`73`	`73`	`protected function execute(InputInterface $input, OutputInterface $output): int`
`74`	`74`	`{`
`75`		`- require $input->getArgument('magepath') . '/vendor/autoload.php';`
	`75`	`+ require $input->getOption('magepath') . '/vendor/autoload.php';`
`76`	`76`
`77`	`77`	`$io = new SymfonyStyle($input, $output);`
`78`	`78`
`@@ -81,7 +81,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`81`	`81`	`$module = $io->askQuestion(`
`82`	`82`	`(new Question('Module'))->setAutocompleterValues(`
`83`	`83`	`(new ModuleAutocomplete())->getAutocompleteValues(`
`84`		`- $input->getArgument('magepath')`
	`84`	`+ $input->getOption('magepath')`
`85`	`85`	`)`
`86`	`86`	`)`
`87`	`87`	`);`
`@@ -93,7 +93,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`93`	`93`	`$entity = $io->askQuestion(`
`94`	`94`	`(new Question(sprintf('Entity %s', $prefix)))->setAutocompleterValues(`
`95`	`95`	`(new EntityAutocomplete())->getAutocompleteValues(`
`96`		`- $input->getArgument('magepath'),`
	`96`	`+ $input->getOption('magepath'),`
`97`	`97`	`$module`
`98`	`98`	`)`
`99`	`99`	`)`