ENGCOM-5517: magento/magento2#: Add description for the --type option of 'setup:db-declaration:generate-patch' command. #23868

Author: sidolov

app/code/Magento/Developer/Console/Command/GeneratePatchCommand.php

@@ -48,41 +48,42 @@ public function __construct(ComponentRegistrar $componentRegistrar)
     }
 
     /**
-     * Configure command
-     *
      * @inheritdoc
+     *
      * @throws InvalidArgumentException
      */
     protected function configure()
     {
         $this->setName(self::COMMAND_NAME)
             ->setDescription('Generate patch and put it in specific folder.')
-            ->setDefinition([
-                new InputArgument(
-                    self::MODULE_NAME,
-                    InputArgument::REQUIRED,
-                    'Module name'
-                ),
-                new InputArgument(
-                    self::INPUT_KEY_PATCH_NAME,
-                    InputArgument::REQUIRED,
-                    'Patch name'
-                ),
-                new InputOption(
-                    self::INPUT_KEY_IS_REVERTABLE,
-                    null,
-                    InputOption::VALUE_OPTIONAL,
-                    'Check whether patch is revertable or not.',
-                    false
-                ),
-                new InputOption(
-                    self::INPUT_KEY_PATCH_TYPE,
-                    null,
-                    InputOption::VALUE_OPTIONAL,
-                    'Find out what type of patch should be generated.',
-                    'data'
-                ),
-            ]);
+            ->setDefinition(
+                [
+                    new InputArgument(
+                        self::MODULE_NAME,
+                        InputArgument::REQUIRED,
+                        'Module name'
+                    ),
+                    new InputArgument(
+                        self::INPUT_KEY_PATCH_NAME,
+                        InputArgument::REQUIRED,
+                        'Patch name'
+                    ),
+                    new InputOption(
+                        self::INPUT_KEY_IS_REVERTABLE,
+                        null,
+                        InputOption::VALUE_OPTIONAL,
+                        'Check whether patch is revertable or not.',
+                        false
+                    ),
+                    new InputOption(
+                        self::INPUT_KEY_PATCH_TYPE,
+                        null,
+                        InputOption::VALUE_OPTIONAL,
+                        'Find out what type of patch should be generated. Available values: `data`, `schema`.',
+                        'data'
+                    ),
+                ]
+            );
 
         parent::configure();
     }
@@ -92,16 +93,17 @@ protected function configure()
      *
      * @return string
      */
-    private function getPatchTemplate() : string
+    private function getPatchTemplate(): string
     {
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         return file_get_contents(__DIR__ . '/patch_template.php.dist');
     }
 
     /**
      * @inheritdoc
      * @throws \InvalidArgumentException
      */
-    protected function execute(InputInterface $input, OutputInterface $output) : int
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $moduleName = $input->getArgument(self::MODULE_NAME);
         $patchName = $input->getArgument(self::INPUT_KEY_PATCH_NAME);
@@ -117,10 +119,13 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
         $patchTemplateData = str_replace('%class%', $patchName, $patchTemplateData);
         $patchDir = $patchToFile = $modulePath . '/Setup/Patch/' . $preparedType;
 
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         if (!is_dir($patchDir)) {
+            // phpcs:ignore Magento2.Functions.DiscouragedFunction
             mkdir($patchDir, 0777, true);
         }
         $patchToFile = $patchDir . '/' . $patchName . '.php';
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         file_put_contents($patchToFile, $patchTemplateData);
         return Cli::RETURN_SUCCESS;
     }