Add --with-metadata support for workflow:dump command

Author: cfong63

README.md

@@ -573,6 +573,10 @@ You can change the image format with the `--format` option. By default the forma
 
     php artisan workflow:dump workflow_name --format=jpg
 
+Similar to [Symfony](https://symfony.com/doc/current/workflow/dumping-workflows.html#styling). You can use `--with-metadata` to include workflow's metadata
+
+    php artisan workflow:dump workflow_name --with-metadata
+
 If you would like to output to a different directory than root, you can use the `--disk` and `--path` options to set the Storage disk (`local` by default) and path (`root_path()` by default).
 
     php artisan workflow:dump workflow-name --class=App\\BlogPost --disk=s3 --path="workflows/diagrams/"

src/Commands/WorkflowDumpCommand.php

@@ -27,7 +27,8 @@ class WorkflowDumpCommand extends Command
         {--class= : the support class name}
         {--format=png : the image format}
         {--disk=local : the storage disk name}
-        {--path= : the optional path within selected disk}';
+        {--path= : the optional path within selected disk}
+        {--with-metadata : dumps metadata beneath the label }';
 
     /**
      * The console command description.
@@ -50,6 +51,7 @@ public function handle()
         $config = Config::get('workflow');
         $disk = $this->option('disk');
         $optionalPath = $this->option('path');
+        $withMetadata = $this->option('with-metadata');
 
         if ($disk === 'local') {
             $optionalPath ??= '.';
@@ -69,6 +71,10 @@ public function handle()
                 ' Please specify a valid support class with the --class option.');
         }
 
+        $dumper_options = [
+            'with-metadata' => $withMetadata,
+        ];
+
         $subject = new $class();
         $workflow = Workflow::get($subject, $workflowName);
         $definition = $workflow->getDefinition();
@@ -83,7 +89,7 @@ public function handle()
 
         $process = new Process($dotCommand);
         $process->setWorkingDirectory($path);
-        $process->setInput($dumper->dump($definition));
+        $process->setInput($dumper->dump($definition, options: $dumper_options));
         $process->mustRun();
     }
 }