docs: added comments on generated code

kishormainali · Nov 28, 2023 · 303a5b7 · 303a5b7
1 parent 03e37d4
commit 303a5b7
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+# 1.0.2
+- added comments on generated code
+
 # 1.0.1
 - remove duplicate imports from generated code
 

diff --git a/example/lib/src/core/register_adapters.dart b/example/lib/src/core/register_adapters.dart
diff --git a/lib/src/type_register_builder.dart b/lib/src/type_register_builder.dart
@@ -79,9 +79,22 @@ class TypeRegisterBuilder implements Builder {
 
     var library = Library(
       (builder) => builder
+        ..comments.addAll([
+          'GENERATED CODE - DO NOT MODIFY BY HAND',
+          'ignore_for_file: lines_longer_than_80_chars',
+        ])
         ..directives.addAll(imports)
         ..body.addAll(
           [
+            const Code('\n'),
+            const Code(
+                '//*****************************************************************************'),
+            const Code('\n'),
+            const Code('// Type Adapters'),
+            const Code('\n'),
+            const Code(
+                '//*****************************************************************************'),
+            const Code('\n'),
             const Code('void registerAdapters(){'),
             ...files
                 .map((e) => Code('Hive.registerAdapter(${e.adapterName}());')),

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: type_register
 description: Generator which generates method named registerAdapters with all the hive adapters for the types annotated with @HiveType.
-version: 1.0.1
+version: 1.0.2
 topics: 
   - type-register-generator
   - dart