refactor: config management (#302)

* refactor: move default config to seperated file

* chore: modify readme reference default config to source code

Co-authored-by: Daichi Furiya <[email protected]>

Author: lcdsmao

README.md

@@ -109,7 +109,7 @@ $ fluttergen -c example/pubspec.yaml
 ## Configuration file
 
 [FlutterGen] generates dart files based on the key **`flutter`** and **`flutter_gen`** of [`pubspec.yaml`](https://dart.dev/tools/pub/pubspec).  
-Default configuration can be found [here](#default-configuration). 
+Default configuration can be found [here](https://github.com/FlutterGen/flutter_gen/tree/main/packages/core/lib/settings/config_default.dart). 
 
 ```yaml
 # pubspec.yaml
@@ -714,68 +714,6 @@ class ColorName {
 </p>
 </details>
 
-### Default Configuration
-
-The following are the default settings.
-The options you set in `pubspec.yaml` will override the corresponding default options.
-
-```yaml
-flutter_gen:
-  # Optional
-  output: lib/gen/
-  # Optional
-  line_length: 80
-
-  # Optional
-  integrations:
-    flutter_svg: false
-    flare_flutter: false
-    rive: false
-    lottie: false
-
-  assets:
-    # Optional
-    enabled: true
-    # Optional
-    outputs: 
-      # Optional
-      # Set to true if you want this package to be a package dependency
-      # See: https://flutter.dev/docs/development/ui/assets-and-images#from-packages
-      package_parameter_enabled: false
-      # Optional
-      # Avaliable values:
-      # - camel-case
-      # - snake-case
-      # - dot-delimiter
-      style: dot-delimiter
-      # Default is Assets
-      class_name: MyAssets
-    
-  fonts:
-    # Optional
-    enabled: true
-    # Optional
-    outputs:
-      # Default is FontFamily
-      class_name: MyFontFamily
-
-  colors:
-    # Optional
-    enabled: true
-    # Optional
-    inputs: []
-    # Optional
-    outputs:
-      # Default is ColorName
-      class_name: MyColorName 
-
-flutter:
-  # See: https://flutter.dev/docs/development/ui/assets-and-images#specifying-assets
-  assets: []
-  # See: https://flutter.dev/docs/cookbook/design/fonts#2-declare-the-font-in-the-pubspec
-  fonts: []
-```
-
 ## Credits
 
 The material color generation implementation is based on [mcg](https://github.com/mbitson/mcg) and [TinyColor](https://github.com/bgrins/TinyColor).

packages/core/lib/settings/config.dart

@@ -1,11 +1,12 @@
 import 'dart:io';
 
-import 'package:flutter_gen_core/utils/error.dart';
-import 'package:flutter_gen_core/utils/version.dart';
+import 'package:flutter_gen_core/settings/config_default.dart';
 import 'package:path/path.dart';
 import 'package:yaml/yaml.dart';
 
+import '../utils/error.dart';
 import '../utils/map.dart';
+import '../utils/version.dart';
 import 'pubspec.dart';
 
 class Config {
@@ -23,7 +24,7 @@ Config loadPubspecConfig(File pubspecFile) {
   ))}');
   final content = pubspecFile.readAsStringSync();
   final userMap = loadYaml(content) as Map?;
-  final defaultMap = loadYaml(_defaultConfig) as Map?;
+  final defaultMap = loadYaml(configDefaultYamlContent) as Map?;
   final mergedMap = mergeMap([defaultMap, userMap]);
   final pubspec = Pubspec.fromJson(mergedMap);
   return Config._(pubspec: pubspec, pubspecFile: pubspecFile);
@@ -39,40 +40,3 @@ Config? loadPubspecConfigOrNull(File pubspecFile) {
   }
   return null;
 }
-
-const _defaultConfig = '''
-name: $invalidStringValue
-
-flutter_gen:
-  output: lib/gen/
-  line_length: 80
-
-  integrations:
-    flutter_svg: false
-    flare_flutter: false
-    rive: false
-    lottie: false
-
-  assets:
-    enabled: true
-    outputs:
-      class_name: Assets
-      package_parameter_enabled: false
-      style: dot-delimiter
-    exclude: []
-    
-  fonts:
-    enabled: true
-    outputs:
-      class_name: FontFamily
-
-  colors:
-    enabled: true
-    inputs: []
-    outputs:
-      class_name: ColorName
-
-flutter:
-  assets: []
-  fonts: []
-''';

packages/core/lib/settings/config_default.dart

@@ -0,0 +1,56 @@
+const configDefaultYamlContent = '''
+name: UNKNOWN
+
+flutter_gen:
+  # Optional
+  output: lib/gen/
+  # Optional
+  line_length: 80
+
+  # Optional
+  integrations:
+    flutter_svg: false
+    flare_flutter: false
+    rive: false
+    lottie: false
+
+  assets:
+    # Optional
+    enabled: true
+    # Optional
+    outputs:
+      # Optional
+      # Set to true if you want this package to be a package dependency
+      # See: https://flutter.dev/docs/development/ui/assets-and-images#from-packages
+      package_parameter_enabled: false
+      # Optional
+      # Available values:
+      # - camel-case
+      # - snake-case
+      # - dot-delimiter
+      style: dot-delimiter
+      class_name: Assets
+    exclude: []
+
+  fonts:
+    # Optional
+    enabled: true
+    # Optional
+    outputs:
+      class_name: FontFamily
+
+  colors:
+    # Optional
+    enabled: true
+    # Optional
+    inputs: []
+    # Optional
+    outputs:
+      class_name: ColorName
+
+flutter:
+  # See: https://flutter.dev/docs/development/ui/assets-and-images#specifying-assets
+  assets: []
+  # See: https://flutter.dev/docs/cookbook/design/fonts#2-declare-the-font-in-the-pubspec
+  fonts: []
+''';

packages/core/lib/settings/pubspec.dart

@@ -2,9 +2,7 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'pubspec.g.dart';
 
-/// Edit this file, then run `make generate-config-model`
-
-const invalidStringValue = 'FLUTTER_GEN_INVALID';
+// NOTE: Run `melos gen:build_runner` after editing this file
 
 @JsonSerializable()
 class Pubspec {