feat: Allow an about section for scaffolding files

factorial-io · Apr 13, 2023 · 8db3f69 · 8db3f69
1 parent 7fdc67c
commit 8db3f69
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/src/Scaffolder/Scaffolder.php b/src/Scaffolder/Scaffolder.php
@@ -229,6 +229,10 @@ public function scaffold(
             $tokens = Utilities::mergeData($this->readTokens($root_folder, $tokens['name']), $tokens);
         }
 
+        if ($data['about']) {
+            $io->block($data['about'], null, 'fg=yellow', '  ', true);
+        }
+
         $questions = !empty($data['questions']) ? $data['questions'] : [];
         $tokens = $this->askQuestions($questions, $context, $tokens, $options);
         if (!empty($data['variables'])) {

diff --git a/src/Utilities/QuestionFactory.php b/src/Utilities/QuestionFactory.php
@@ -42,8 +42,8 @@ public function askAndValidate(SymfonyStyle $io, $question_data, $value)
         }
 
         if (is_null($value)) {
-            if (!empty($question_data['help'])) {
-                $io->comment($question_data['help']);
+            if ($help_msg = $question_wrapper->getHelp()) {
+                $io->comment($help_msg);
             }
             $value = $question_wrapper->ask($io);
         }

diff --git a/src/Utilities/Questions/QuestionBase.php b/src/Utilities/Questions/QuestionBase.php
@@ -31,4 +31,9 @@ public function validate($value)
         }
         return $value;
     }
+
+    public function getHelp()
+    {
+        return $this->data['help'] ?? false;
+    }
 }
diff --git a/src/Utilities/Questions/QuestionInterface.php b/src/Utilities/Questions/QuestionInterface.php
@@ -12,6 +12,8 @@ public static function getName();
     public function setData($question_data): ValidationService;
 
     public function ask(SymfonyStyle $io);
-    
+
     public function validate($value);
+
+    public function getHelp();
 }