feat: add path option to create Widget command (#25)

* Add `path` option to create Widget command * Commits dart --fix changes * Update packages --------- Co-authored-by: Dane Mackier <[email protected]>
Stacked-Org · Jun 22, 2023 · 47a5623 · 47a5623
1 parent bd7b656
commit 47a5623
Show file tree

Hide file tree

Showing 9 changed files with 262 additions and 253 deletions.
diff --git a/lib/src/commands/create/create_widget_command.dart b/lib/src/commands/create/create_widget_command.dart
@@ -49,6 +49,11 @@ class CreateWidgetCommand extends Command with ProjectStructureValidator {
         abbr: 'c',
         help: kCommandHelpConfigFilePath,
       )
+      ..addOption(
+        ksPath,
+        abbr: 'p',
+        help: kCommandHelpPath,
+      )
       ..addFlag(
         ksModel,
         defaultsTo: true,
@@ -64,10 +69,13 @@ class CreateWidgetCommand extends Command with ProjectStructureValidator {
       final workingDirectory =
           argResults!.rest.length > 1 ? argResults!.rest[1] : null;
 
+      // load configuration
       await _configService.composeAndLoadConfigFile(
         configFilePath: argResults![ksConfigPath],
         projectPath: workingDirectory,
       );
+      // override [widgets_path] value on configuration
+      _configService.setWidgetsPath(argResults![ksPath]);
 
       _processService.formattingLineLength = argResults![ksLineLength];
       await _pubspecService.initialise(workingDirectory: workingDirectory);

diff --git a/lib/src/constants/command_constants.dart b/lib/src/constants/command_constants.dart
@@ -29,6 +29,7 @@ const String ksAnalyze = 'analyze';
 const String ksModel = 'model';
 const String ksConfigPath = 'config-path';
 const String ksWatch = 'watch';
+const String ksPath = 'path';
 
 /// A list of strings that are used to run the run build_runner
 /// [build or watch] --delete-conflicting-outputs command.

diff --git a/lib/src/constants/message_constants.dart b/lib/src/constants/message_constants.dart
@@ -47,6 +47,8 @@ const String kCommandHelpCreateAppTemplate =
 const String kCommandHelpConfigFilePath =
     'Sets the file path for the custom config.';
 
+const String kCommandHelpPath = 'Sets the relative path for the component.';
+
 const String kCommandHelpCreateViewTemplate =
     'Selects the type of view to create instead of the default empty view.';
 

diff --git a/lib/src/models/config_model.freezed.dart b/lib/src/models/config_model.freezed.dart
@@ -112,27 +112,44 @@ abstract class $ConfigCopyWith<$Res> {
       _$ConfigCopyWithImpl<$Res, Config>;
   @useResult
   $Res call(
-      {@JsonKey(name: 'views_path') String viewsPath,
-      @JsonKey(name: 'services_path') String servicesPath,
-      @JsonKey(name: 'widgets_path') String widgetsPath,
-      @JsonKey(name: 'bottom_sheets_path') String bottomSheetsPath,
+      {@JsonKey(name: 'views_path')
+          String viewsPath,
+      @JsonKey(name: 'services_path')
+          String servicesPath,
+      @JsonKey(name: 'widgets_path')
+          String widgetsPath,
+      @JsonKey(name: 'bottom_sheets_path')
+          String bottomSheetsPath,
       @JsonKey(name: 'bottom_sheet_type_file_path')
-      String bottomSheetTypeFilePath,
+          String bottomSheetTypeFilePath,
       @JsonKey(name: 'bottom_sheet_builder_file_path')
-      String bottomSheetBuilderFilePath,
-      @JsonKey(name: 'dialogs_path') String dialogsPath,
-      @JsonKey(name: 'dialog_type_file_path') String dialogTypeFilePath,
-      @JsonKey(name: 'dialog_builder_file_path') String dialogBuilderFilePath,
-      @JsonKey(name: 'stacked_app_file_path') String stackedAppFilePath,
-      @JsonKey(name: 'test_helpers_file_path') String testHelpersFilePath,
-      @JsonKey(name: 'test_services_path') String testServicesPath,
-      @JsonKey(name: 'test_views_path') String testViewsPath,
-      @JsonKey(name: 'test_widgets_path') String testWidgetsPath,
-      @JsonKey(name: 'locator_name') String locatorName,
-      @JsonKey(name: 'register_mocks_function') String registerMocksFunction,
-      @JsonKey(name: 'v1') bool v1,
-      @JsonKey(name: 'line_length') int lineLength,
-      @JsonKey(name: 'prefer_web') bool preferWeb});
+          String bottomSheetBuilderFilePath,
+      @JsonKey(name: 'dialogs_path')
+          String dialogsPath,
+      @JsonKey(name: 'dialog_type_file_path')
+          String dialogTypeFilePath,
+      @JsonKey(name: 'dialog_builder_file_path')
+          String dialogBuilderFilePath,
+      @JsonKey(name: 'stacked_app_file_path')
+          String stackedAppFilePath,
+      @JsonKey(name: 'test_helpers_file_path')
+          String testHelpersFilePath,
+      @JsonKey(name: 'test_services_path')
+          String testServicesPath,
+      @JsonKey(name: 'test_views_path')
+          String testViewsPath,
+      @JsonKey(name: 'test_widgets_path')
+          String testWidgetsPath,
+      @JsonKey(name: 'locator_name')
+          String locatorName,
+      @JsonKey(name: 'register_mocks_function')
+          String registerMocksFunction,
+      @JsonKey(name: 'v1')
+          bool v1,
+      @JsonKey(name: 'line_length')
+          int lineLength,
+      @JsonKey(name: 'prefer_web')
+          bool preferWeb});
 }
 
 /// @nodoc
@@ -256,27 +273,44 @@ abstract class _$$_ConfigCopyWith<$Res> implements $ConfigCopyWith<$Res> {
   @override
   @useResult
   $Res call(
-      {@JsonKey(name: 'views_path') String viewsPath,
-      @JsonKey(name: 'services_path') String servicesPath,
-      @JsonKey(name: 'widgets_path') String widgetsPath,
-      @JsonKey(name: 'bottom_sheets_path') String bottomSheetsPath,
+      {@JsonKey(name: 'views_path')
+          String viewsPath,
+      @JsonKey(name: 'services_path')
+          String servicesPath,
+      @JsonKey(name: 'widgets_path')
+          String widgetsPath,
+      @JsonKey(name: 'bottom_sheets_path')
+          String bottomSheetsPath,
       @JsonKey(name: 'bottom_sheet_type_file_path')
-      String bottomSheetTypeFilePath,
+          String bottomSheetTypeFilePath,
       @JsonKey(name: 'bottom_sheet_builder_file_path')
-      String bottomSheetBuilderFilePath,
-      @JsonKey(name: 'dialogs_path') String dialogsPath,
-      @JsonKey(name: 'dialog_type_file_path') String dialogTypeFilePath,
-      @JsonKey(name: 'dialog_builder_file_path') String dialogBuilderFilePath,
-      @JsonKey(name: 'stacked_app_file_path') String stackedAppFilePath,
-      @JsonKey(name: 'test_helpers_file_path') String testHelpersFilePath,
-      @JsonKey(name: 'test_services_path') String testServicesPath,
-      @JsonKey(name: 'test_views_path') String testViewsPath,
-      @JsonKey(name: 'test_widgets_path') String testWidgetsPath,
-      @JsonKey(name: 'locator_name') String locatorName,
-      @JsonKey(name: 'register_mocks_function') String registerMocksFunction,
-      @JsonKey(name: 'v1') bool v1,
-      @JsonKey(name: 'line_length') int lineLength,
-      @JsonKey(name: 'prefer_web') bool preferWeb});
+          String bottomSheetBuilderFilePath,
+      @JsonKey(name: 'dialogs_path')
+          String dialogsPath,
+      @JsonKey(name: 'dialog_type_file_path')
+          String dialogTypeFilePath,
+      @JsonKey(name: 'dialog_builder_file_path')
+          String dialogBuilderFilePath,
+      @JsonKey(name: 'stacked_app_file_path')
+          String stackedAppFilePath,
+      @JsonKey(name: 'test_helpers_file_path')
+          String testHelpersFilePath,
+      @JsonKey(name: 'test_services_path')
+          String testServicesPath,
+      @JsonKey(name: 'test_views_path')
+          String testViewsPath,
+      @JsonKey(name: 'test_widgets_path')
+          String testWidgetsPath,
+      @JsonKey(name: 'locator_name')
+          String locatorName,
+      @JsonKey(name: 'register_mocks_function')
+          String registerMocksFunction,
+      @JsonKey(name: 'v1')
+          bool v1,
+      @JsonKey(name: 'line_length')
+          int lineLength,
+      @JsonKey(name: 'prefer_web')
+          bool preferWeb});
 }
 
 /// @nodoc
@@ -394,34 +428,44 @@ class __$$_ConfigCopyWithImpl<$Res>
 @JsonSerializable()
 class _$_Config implements _Config {
   _$_Config(
-      {@JsonKey(name: 'views_path') this.viewsPath = 'ui/views',
-      @JsonKey(name: 'services_path') this.servicesPath = 'services',
-      @JsonKey(name: 'widgets_path') this.widgetsPath = 'ui/widgets/common',
+      {@JsonKey(name: 'views_path')
+          this.viewsPath = 'ui/views',
+      @JsonKey(name: 'services_path')
+          this.servicesPath = 'services',
+      @JsonKey(name: 'widgets_path')
+          this.widgetsPath = 'ui/widgets/common',
       @JsonKey(name: 'bottom_sheets_path')
-      this.bottomSheetsPath = 'ui/bottom_sheets',
+          this.bottomSheetsPath = 'ui/bottom_sheets',
       @JsonKey(name: 'bottom_sheet_type_file_path')
-      this.bottomSheetTypeFilePath = 'enums/bottom_sheet_type.dart',
+          this.bottomSheetTypeFilePath = 'enums/bottom_sheet_type.dart',
       @JsonKey(name: 'bottom_sheet_builder_file_path')
-      this.bottomSheetBuilderFilePath = 'ui/setup/setup_bottom_sheet_ui.dart',
-      @JsonKey(name: 'dialogs_path') this.dialogsPath = 'ui/dialogs',
+          this.bottomSheetBuilderFilePath = 'ui/setup/setup_bottom_sheet_ui.dart',
+      @JsonKey(name: 'dialogs_path')
+          this.dialogsPath = 'ui/dialogs',
       @JsonKey(name: 'dialog_type_file_path')
-      this.dialogTypeFilePath = 'enums/dialog_type.dart',
+          this.dialogTypeFilePath = 'enums/dialog_type.dart',
       @JsonKey(name: 'dialog_builder_file_path')
-      this.dialogBuilderFilePath = 'ui/setup/setup_dialog_ui.dart',
+          this.dialogBuilderFilePath = 'ui/setup/setup_dialog_ui.dart',
       @JsonKey(name: 'stacked_app_file_path')
-      this.stackedAppFilePath = 'app/app.dart',
+          this.stackedAppFilePath = 'app/app.dart',
       @JsonKey(name: 'test_helpers_file_path')
-      this.testHelpersFilePath = 'helpers/test_helpers.dart',
-      @JsonKey(name: 'test_services_path') this.testServicesPath = 'services',
-      @JsonKey(name: 'test_views_path') this.testViewsPath = 'viewmodels',
+          this.testHelpersFilePath = 'helpers/test_helpers.dart',
+      @JsonKey(name: 'test_services_path')
+          this.testServicesPath = 'services',
+      @JsonKey(name: 'test_views_path')
+          this.testViewsPath = 'viewmodels',
       @JsonKey(name: 'test_widgets_path')
-      this.testWidgetsPath = 'widget_models',
-      @JsonKey(name: 'locator_name') this.locatorName = 'locator',
+          this.testWidgetsPath = 'widget_models',
+      @JsonKey(name: 'locator_name')
+          this.locatorName = 'locator',
       @JsonKey(name: 'register_mocks_function')
-      this.registerMocksFunction = 'registerServices',
-      @JsonKey(name: 'v1') this.v1 = false,
-      @JsonKey(name: 'line_length') this.lineLength = 80,
-      @JsonKey(name: 'prefer_web') this.preferWeb = false});
+          this.registerMocksFunction = 'registerServices',
+      @JsonKey(name: 'v1')
+          this.v1 = false,
+      @JsonKey(name: 'line_length')
+          this.lineLength = 80,
+      @JsonKey(name: 'prefer_web')
+          this.preferWeb = false});
 
   factory _$_Config.fromJson(Map<String, dynamic> json) =>
       _$$_ConfigFromJson(json);
@@ -619,29 +663,44 @@ class _$_Config implements _Config {
 
 abstract class _Config implements Config {
   factory _Config(
-      {@JsonKey(name: 'views_path') final String viewsPath,
-      @JsonKey(name: 'services_path') final String servicesPath,
-      @JsonKey(name: 'widgets_path') final String widgetsPath,
-      @JsonKey(name: 'bottom_sheets_path') final String bottomSheetsPath,
+      {@JsonKey(name: 'views_path')
+          final String viewsPath,
+      @JsonKey(name: 'services_path')
+          final String servicesPath,
+      @JsonKey(name: 'widgets_path')
+          final String widgetsPath,
+      @JsonKey(name: 'bottom_sheets_path')
+          final String bottomSheetsPath,
       @JsonKey(name: 'bottom_sheet_type_file_path')
-      final String bottomSheetTypeFilePath,
+          final String bottomSheetTypeFilePath,
       @JsonKey(name: 'bottom_sheet_builder_file_path')
-      final String bottomSheetBuilderFilePath,
-      @JsonKey(name: 'dialogs_path') final String dialogsPath,
-      @JsonKey(name: 'dialog_type_file_path') final String dialogTypeFilePath,
+          final String bottomSheetBuilderFilePath,
+      @JsonKey(name: 'dialogs_path')
+          final String dialogsPath,
+      @JsonKey(name: 'dialog_type_file_path')
+          final String dialogTypeFilePath,
       @JsonKey(name: 'dialog_builder_file_path')
-      final String dialogBuilderFilePath,
-      @JsonKey(name: 'stacked_app_file_path') final String stackedAppFilePath,
-      @JsonKey(name: 'test_helpers_file_path') final String testHelpersFilePath,
-      @JsonKey(name: 'test_services_path') final String testServicesPath,
-      @JsonKey(name: 'test_views_path') final String testViewsPath,
-      @JsonKey(name: 'test_widgets_path') final String testWidgetsPath,
-      @JsonKey(name: 'locator_name') final String locatorName,
+          final String dialogBuilderFilePath,
+      @JsonKey(name: 'stacked_app_file_path')
+          final String stackedAppFilePath,
+      @JsonKey(name: 'test_helpers_file_path')
+          final String testHelpersFilePath,
+      @JsonKey(name: 'test_services_path')
+          final String testServicesPath,
+      @JsonKey(name: 'test_views_path')
+          final String testViewsPath,
+      @JsonKey(name: 'test_widgets_path')
+          final String testWidgetsPath,
+      @JsonKey(name: 'locator_name')
+          final String locatorName,
       @JsonKey(name: 'register_mocks_function')
-      final String registerMocksFunction,
-      @JsonKey(name: 'v1') final bool v1,
-      @JsonKey(name: 'line_length') final int lineLength,
-      @JsonKey(name: 'prefer_web') final bool preferWeb}) = _$_Config;
+          final String registerMocksFunction,
+      @JsonKey(name: 'v1')
+          final bool v1,
+      @JsonKey(name: 'line_length')
+          final int lineLength,
+      @JsonKey(name: 'prefer_web')
+          final bool preferWeb}) = _$_Config;
 
   factory _Config.fromJson(Map<String, dynamic> json) = _$_Config.fromJson;
 

diff --git a/lib/src/services/config_service.dart b/lib/src/services/config_service.dart
@@ -352,4 +352,11 @@ class ConfigService {
   String exportConfig() {
     return JsonEncoder.withIndent("    ").convert(_customConfig.toJson());
   }
+
+  /// Overrides [widgets_path] value on configuration.
+  void setWidgetsPath(String? path) {
+    _customConfig = _customConfig.copyWith(
+      widgetsPath: path ?? _customConfig.widgetsPath,
+    );
+  }
 }