Merge branch 'stable' into release/2.5.0

README.md

@@ -140,6 +140,8 @@ The best way to run and test a component package is to use tools like Storybook.
 
   _Be sure to use Figma Components_  
 
+  To run the widgetbook, instead of running the normal `flutter run`, you want to run `flutter run lib/main_widgetbook.g.dart`.
+
 # What's Next?
 Be sure to complete our [Hello World Guide](https://docs.parabeac.com/docs/hello-world-guide) or read the [docs](https://docs.parabeac.com/) so you know how to handle the code generated.
 

lib/generation/generators/value_objects/file_structure_strategy/commands/entry_file_command.dart

@@ -32,7 +32,9 @@ class EntryFileCommand extends NodeFileStructureCommand {
       this.projectName = 'Parabeac-Core Generated Project',
       this.mainCode = 'runApp(MyApp());',
       FileOwnership ownership = FileOwnership.DEV})
-      : super('ENTRY_FILE', '''
+      : super(
+            'ENTRY_FILE',
+            '''
 import 'package:flutter/material.dart';
 $entryScreenImport
 
@@ -55,7 +57,8 @@ class MyApp extends StatelessWidget {
   }
 }
   
-  ''', ownership) {
+  ''',
+            ownership) {
     if ((entryScreenImport == null && entryScreenName != null) ||
         (entryScreenName == null && entryScreenName != null)) {
       throw NullThrownError();
@@ -66,7 +69,6 @@ class MyApp extends StatelessWidget {
   Future write(FileStructureStrategy strategy) {
     strategy.writeDataToFile(
         code, strategy.GENERATED_PROJECT_PATH, p.join('lib', mainFileName),
-        UUID: UUID,
-        ownership: ownership);
+        UUID: UUID, ownership: ownership);
   }
 }

lib/generation/generators/value_objects/file_structure_strategy/commands/export_platform_command.dart

@@ -12,13 +12,9 @@ class ExportPlatformCommand extends NodeFileStructureCommand {
   static final String WIDGET_PATH = 'lib/screens';
 
   ExportPlatformCommand(
-    String UUID,
-    this.platform,
-    this.folderName,
-    this.fileName,
-    String code,
-    {FileOwnership ownership = FileOwnership.PBC}
-  ) : super(UUID, code, ownership);
+      String UUID, this.platform, this.folderName, this.fileName, String code,
+      {FileOwnership ownership = FileOwnership.PBC})
+      : super(UUID, code, ownership);
 
   @override
   Future write(FileStructureStrategy strategy) async {
@@ -28,6 +24,7 @@ class ExportPlatformCommand extends NodeFileStructureCommand {
       folderName,
       platform.toString().toLowerCase().replaceAll('platform.', ''),
     );
-    strategy.writeDataToFile(code, path, fileName, UUID: UUID, ownership: ownership);
+    strategy.writeDataToFile(code, path, fileName,
+        UUID: UUID, ownership: ownership);
   }
 }

lib/generation/generators/value_objects/file_structure_strategy/commands/node_file_structure_command.dart

@@ -1,5 +1,6 @@
 import 'package:parabeac_core/generation/generators/value_objects/file_structure_strategy/commands/file_structure_command.dart';
 import 'package:parabeac_core/generation/generators/value_objects/file_structure_strategy/file_ownership_policy.dart';
+import 'package:path/path.dart';
 
 /// Class that relies on `code` to implement its `write` method.
 abstract class NodeFileStructureCommand extends FileStructureCommand {
@@ -9,7 +10,6 @@ abstract class NodeFileStructureCommand extends FileStructureCommand {
   /// through [write]
   FileOwnership ownership;
 
-  NodeFileStructureCommand(String UUID, this.code,
-      this.ownership)
+  NodeFileStructureCommand(String UUID, this.code, this.ownership)
       : super(UUID);
 }

lib/generation/generators/value_objects/file_structure_strategy/pb_file_structure_strategy.dart

@@ -185,6 +185,10 @@ abstract class FileStructureStrategy implements CommandInvoker {
         p.setExtension(
             name, fileOwnershipPolicy.getFileExtension(ownership, ext)));
 
+    if (FileOwnership.PBC == ownership) {
+      data = _setHeader(data);
+    }
+
     if (_fileSystemAnalyzer.containsFile(file.path) &&
         ownership == FileOwnership.DEV) {
       /// file is going to be ignored
@@ -248,6 +252,18 @@ abstract class FileStructureStrategy implements CommandInvoker {
     }
   }
 
+  String _setHeader(String code) {
+    return '''
+// *********************************************************************************
+// PARABEAC-GENERATED CODE. DO NOT MODIFY.
+// 
+// FOR MORE INFORMATION ON HOW TO USE PARABEAC, PLEASE VISIT docs.parabeac.com
+// *********************************************************************************
+    ''' +
+        '\n\n' +
+        code;
+  }
+
   File getFile(String directory, String name) => File(p.join(directory, name));
 }