+chore: Improve generated output and templates

Author: t0mb3rr

example/example.dart renamed to example/example.md

@@ -1,3 +1,4 @@
+```dart
 //.title
 // ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
 //
@@ -15,16 +16,12 @@
 // ignore_for_file: unnecessary_null_comparison
 // ignore_for_file: unnecessary_question_mark
 
-// This line is not actually in the generated code.
-import 'package:df_generate_dart_models_core/df_generate_dart_models_core.dart';
-
-// This line is in the generated code.
-//part of 'field_model.dart';
+part of 'example.md';
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
 /// Generated class for [_FieldModel].
-class FieldModel extends Model {
+class FieldModel extends _FieldModel {
   //
   //
   //
@@ -337,65 +334,6 @@ class FieldModel extends Model {
     }
   }
 
-  @override
-  T mergeWith<T extends BaseModel>(
-    BaseModel? other, {
-    bool deepMerge = false,
-  }) {
-    final a = toJson();
-    final b = other?.toJson() ?? {};
-    final data = (deepMerge ? mergeDataDeep(a, b) : {...a, ...b}) as Map;
-    return FieldModel.fromJson(data.cast()) as T;
-  }
-
-  /// Creates a copy of this instance, replacing the specified fields.
-  static FieldModel copyWith(
-    FieldModel src, {
-    List<String>? fieldPath,
-    dynamic? fieldType,
-    bool? nullable,
-    List<Map<String, dynamic>>? children,
-    bool? primaryKey,
-    bool? foreignKey,
-    Object? fallback,
-    String? description,
-  }) {
-    return FieldModel.assertRequired(
-      fieldPath: fieldPath ?? src.fieldPath,
-      fieldType: fieldType ?? src.fieldType,
-      nullable: nullable ?? src.nullable,
-      children: children ?? src.children,
-      primaryKey: primaryKey ?? src.primaryKey,
-      foreignKey: foreignKey ?? src.foreignKey,
-      fallback: fallback ?? src.fallback,
-      description: description ?? src.description,
-    );
-  }
-
-  /// Creates a copy of this instance, removing the specified fields.
-  static FieldModel copyWithout(
-    FieldModel src, {
-    bool fieldPath = true,
-    bool fieldType = true,
-    bool nullable = true,
-    bool children = true,
-    bool primaryKey = true,
-    bool foreignKey = true,
-    bool fallback = true,
-    bool description = true,
-  }) {
-    return FieldModel.assertRequired(
-      fieldPath: fieldPath ? src.fieldPath : null,
-      fieldType: fieldType ? src.fieldType : null,
-      nullable: nullable ? src.nullable : null,
-      children: children ? src.children : null,
-      primaryKey: primaryKey ? src.primaryKey : null,
-      foreignKey: foreignKey ? src.foreignKey : null,
-      fallback: fallback ? src.fallback : null,
-      description: description ? src.description : null,
-    );
-  }
-
   /// Returns the value of the [fieldPath] field.
   /// If the field is nullable, the return value may be null; otherwise, it
   /// will always return a non-null value.
@@ -472,3 +410,66 @@ abstract final class FieldModelFieldNames {
   /// The field name of [FieldModel.description].
   static const description = 'description';
 }
+
+extension FieldModelX on FieldModel {
+  /// Creates a copy of this instance, merging another model's fields into
+  /// this model's fields.
+  FieldModel mergeWith(
+    BaseModel? other, {
+    bool deepMerge = false,
+  }) {
+    final a = toJson();
+    final b = other?.toJson() ?? {};
+    final data = (deepMerge ? mergeDataDeep(a, b) : {...a, ...b}) as Map;
+    return FieldModel.fromJson(data.cast());
+  }
+
+  /// Creates a copy of this instance, replacing the specified fields.
+  FieldModel copyWith(
+    FieldModel src, {
+    List<String>? fieldPath,
+    dynamic? fieldType,
+    bool? nullable,
+    List<Map<String, dynamic>>? children,
+    bool? primaryKey,
+    bool? foreignKey,
+    Object? fallback,
+    String? description,
+  }) {
+    return FieldModel.assertRequired(
+      fieldPath: fieldPath ?? this.fieldPath,
+      fieldType: fieldType ?? this.fieldType,
+      nullable: nullable ?? this.nullable,
+      children: children ?? this.children,
+      primaryKey: primaryKey ?? this.primaryKey,
+      foreignKey: foreignKey ?? this.foreignKey,
+      fallback: fallback ?? this.fallback,
+      description: description ?? this.description,
+    );
+  }
+
+  /// Creates a copy of this instance, removing the specified fields.
+  FieldModel copyWithout(
+    FieldModel src, {
+    bool fieldPath = true,
+    bool fieldType = true,
+    bool nullable = true,
+    bool children = true,
+    bool primaryKey = true,
+    bool foreignKey = true,
+    bool fallback = true,
+    bool description = true,
+  }) {
+    return FieldModel.assertRequired(
+      fieldPath: fieldPath ? this.fieldPath : null,
+      fieldType: fieldType ? this.fieldType : null,
+      nullable: nullable ? this.nullable : null,
+      children: children ? this.children : null,
+      primaryKey: primaryKey ? this.primaryKey : null,
+      foreignKey: foreignKey ? this.foreignKey : null,
+      fallback: fallback ? this.fallback : null,
+      description: description ? this.description : null,
+    );
+  }
+}
+```

lib/src/models/data_ref/_data_ref_model.g.dart

@@ -20,7 +20,7 @@ part of 'data_ref_model.dart';
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
 /// Generated class for [_DataRefModel].
-class DataRefModel extends Model {
+class DataRefModel extends _DataRefModel {
   //
   //
   //
@@ -31,29 +31,36 @@ class DataRefModel extends Model {
   @override
   String get $className => CLASS_NAME;
 
-  
+  /// The document ID within the database. If null, the reference points to a collection instead of a specific document.
+  final String? id;
+
+  /// A list representing the hierarchical path where the document or collection resides.
+  final List<String>? collection;
 
   /// Constructs a new instance of [DataRefModel]
   /// from optional and required parameters.
   const DataRefModel({
-    
-  }) ;
+    this.id,
+    required this.collection,
+  });
 
   /// Construcs a new instance of [DataRefModel],
   /// forcing all parameters to be optional.
   const DataRefModel.optional({
-    
-  }) ;
-
+    this.id,
+    this.collection,
+  });
 
   /// Constructs a new instance of [DataRefModel],
   /// and asserts that all required parameters are not null.
   factory DataRefModel.assertRequired({
-    
+    String? id,
+    List<String>? collection,
   }) {
-    
-    return const DataRefModel(
-      
+    assert(collection != null);
+    return DataRefModel(
+      id: id,
+      collection: collection,
     );
   }
 
@@ -80,7 +87,6 @@ class DataRefModel extends Model {
     return fromJsonOrNull(another?.toJson())!;
   }
 
-
   /// Constructs a new instance of [DataRefModel],
   /// from the fields of [another] instance. Throws if the conversion fails.
   factory DataRefModel.of(
@@ -113,7 +119,7 @@ class DataRefModel extends Model {
     try {
       return fromJsonStringOrNull(jsonString)!;
     } catch (e) {
-     assert(false, '$DataRefModel.fromJsonString: $e');
+      assert(false, '$DataRefModel.fromJsonString: $e');
       rethrow;
     }
   }
@@ -157,9 +163,18 @@ class DataRefModel extends Model {
     Map<String, dynamic>? json,
   ) {
     try {
-      
-      return const DataRefModel(
-        
+      final id = json?['id']?.toString().trim().nullIfEmpty;
+      final collection = letListOrNull<dynamic>(json?['collection'])
+          ?.map(
+            (p0) => p0?.toString().trim().nullIfEmpty,
+          )
+          .nonNulls
+          .nullIfEmpty
+          ?.toList()
+          .unmodifiable;
+      return DataRefModel(
+        id: id,
+        collection: collection,
       );
     } catch (e) {
       return null;
@@ -202,9 +217,17 @@ class DataRefModel extends Model {
     bool includeNulls = false,
   }) {
     try {
-      
+      final id0 = id?.trim().nullIfEmpty;
+      final collection0 = collection
+          ?.map(
+            (p0) => p0?.trim().nullIfEmpty,
+          )
+          .nonNulls
+          .nullIfEmpty
+          ?.toList();
       final withNulls = {
-        
+        'id': id0,
+        'collection': collection0,
       };
       return includeNulls ? withNulls : withNulls.nonNulls;
     } catch (e) {
@@ -213,13 +236,27 @@ class DataRefModel extends Model {
     }
   }
 
-  
+  /// Returns the value of the [id] field.
+  /// If the field is nullable, the return value may be null; otherwise, it
+  /// will always return a non-null value.
+  @pragma('vm:prefer-inline')
+  String? get id$ => id;
+
+  /// Returns the value of the [collection] field.
+  /// If the field is nullable, the return value may be null; otherwise, it
+  /// will always return a non-null value.
+  @pragma('vm:prefer-inline')
+  List<String> get collection$ => collection!;
 }
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
 abstract final class DataRefModelFieldNames {
-  
+  /// The field name of [DataRefModel.id].
+  static const id = 'id';
+
+  /// The field name of [DataRefModel.collection].
+  static const collection = 'collection';
 }
 
 extension DataRefModelX on DataRefModel {
@@ -236,22 +273,26 @@ extension DataRefModelX on DataRefModel {
   }
 
   /// Creates a copy of this instance, replacing the specified fields.
-  DataRefModel copyWith(DataRefModel src, {
-    
+  DataRefModel copyWith(
+    DataRefModel src, {
+    String? id,
+    List<String>? collection,
   }) {
-    final src = this;
     return DataRefModel.assertRequired(
-      
+      id: id ?? this.id,
+      collection: collection ?? this.collection,
     );
   }
 
   /// Creates a copy of this instance, removing the specified fields.
-  DataRefModel copyWithout(DataRefModel src, {
-    
+  DataRefModel copyWithout(
+    DataRefModel src, {
+    bool id = true,
+    bool collection = true,
   }) {
-    final src = this;
     return DataRefModel.assertRequired(
-      
+      id: id ? this.id : null,
+      collection: collection ? this.collection : null,
     );
   }
-}
+}