feat: integrate awesome_lints and upgrade to Flutter 3.38 (#1173)

* chore: update Flutter SDK to version 3.38.5

Upgrade Flutter from 3.32.4 to 3.38.5 to meet awesome_lints
requirement for Dart SDK 3.10.0+. Update CI workflow to use
the new Flutter version and add custom_lint verification step.

* chore: integrate awesome_lints with custom lint rules

Add awesome_lints and custom_lint dependencies, configure
analysis_options.yaml to enable newline lint rules: newline_before_case,
newline_before_constructor, newline_before_method, and newline_before_return.

* style: apply newline formatting per awesome_lints rules

Add blank lines before case clauses, return statements, method
declarations, and constructors throughout the codebase to comply
with awesome_lints newline rules.

* fix: replace deprecated translate with leftTranslateByDouble

Update Matrix4.translate() calls to use the new leftTranslateByDouble()
API to resolve deprecation warnings in Flutter SDK 3.38.5.

* chore: improve code readability with blank line formatting

Author: LucasXu0

.fvmrc

@@ -1,3 +1,3 @@
 {
-  "flutter": "3.32.4"
+  "flutter": "3.38.5"
 }

.github/workflows/test.yml

@@ -33,7 +33,7 @@ jobs:
       - uses: subosito/flutter-action@v2
         with:
           channel: "stable"
-          flutter-version: "3.32.4"
+          flutter-version: "3.38.5"
           cache: true
 
       - name: Run tests
@@ -42,6 +42,7 @@ jobs:
           flutter pub get
           flutter analyze .
           dart format --set-exit-if-changed .
+          dart run custom_lint
           flutter test --coverage
 
       - name: Upload coverage to Codecov

analysis_options.yaml

@@ -11,4 +11,14 @@ linter:
 
 analyzer:
   exclude:
-    - lib/src/l10n/**
+    - lib/src/l10n/**
+  plugins:
+    - custom_lint
+
+custom_lint:
+  enable_all_lint_rules: false
+  rules:
+    - newline_before_case
+    - newline_before_constructor
+    - newline_before_method
+    - newline_before_return

lib/src/core/document/deprecated/document.dart

@@ -22,6 +22,7 @@ class DocumentV0 {
 
     final document = Map<String, Object>.from(json['document'] as Map);
     final root = NodeV0.fromJson(document);
+
     return DocumentV0(root: root);
   }
 
@@ -31,6 +32,7 @@ class DocumentV0 {
       type: 'editor',
       children: LinkedList<NodeV0>()..add(TextNodeV0.empty()),
     );
+
     return DocumentV0(
       root: root,
     );
@@ -54,6 +56,7 @@ class DocumentV0 {
       for (final node in nodes) {
         target.insertBefore(node);
       }
+
       return true;
     }
 
@@ -62,6 +65,7 @@ class DocumentV0 {
       for (var i = 0; i < nodes.length; i++) {
         parent.insert(nodes.elementAt(i), index: path.last + i);
       }
+
       return true;
     }
 
@@ -83,6 +87,7 @@ class DocumentV0 {
       target = next;
       length--;
     }
+
     return true;
   }
 
@@ -96,6 +101,7 @@ class DocumentV0 {
       return false;
     }
     target.updateAttributes(attributes);
+
     return true;
   }
 
@@ -109,6 +115,7 @@ class DocumentV0 {
       return false;
     }
     target.delta = target.delta.compose(delta);
+
     return true;
   }
 

lib/src/core/document/deprecated/node.dart

@@ -87,13 +87,15 @@ final class NodeV0 extends ChangeNotifier with LinkedListEntry<NodeV0> {
     if (subtype != null) {
       return '$type/$subtype';
     }
+
     return type;
   }
 
   String? get subtype {
     if (attributes[BuiltInAttributeKey.subtype] is String) {
       return attributes[BuiltInAttributeKey.subtype] as String;
     }
+
     return null;
   }
 
@@ -136,6 +138,7 @@ final class NodeV0 extends ChangeNotifier with LinkedListEntry<NodeV0> {
       entry.parent = this;
       children.add(entry);
       notifyListeners();
+
       return;
     }
 
@@ -188,6 +191,7 @@ final class NodeV0 extends ChangeNotifier with LinkedListEntry<NodeV0> {
     if (attributes.isNotEmpty) {
       map['attributes'] = attributes;
     }
+
     return map;
   }
 
@@ -208,6 +212,7 @@ final class NodeV0 extends ChangeNotifier with LinkedListEntry<NodeV0> {
         );
       }
     }
+
     return node;
   }
 
@@ -222,6 +227,7 @@ final class NodeV0 extends ChangeNotifier with LinkedListEntry<NodeV0> {
       }
       index += 1;
     }
+
     return parent!._computePath([index, ...previous]);
   }
 }
@@ -245,7 +251,9 @@ final class TextNodeV0 extends NodeV0 {
         );
 
   Delta _delta;
+
   Delta get delta => _delta;
+
   set delta(Delta v) {
     _delta = v;
     notifyListeners();
@@ -255,6 +263,7 @@ final class TextNodeV0 extends NodeV0 {
   Map<String, Object> toJson() {
     final map = super.toJson();
     map['delta'] = delta.toJson();
+
     return map;
   }
 
@@ -277,6 +286,7 @@ final class TextNodeV0 extends NodeV0 {
         );
       }
     }
+
     return textNode;
   }
 
@@ -293,6 +303,7 @@ extension NodeV0Equality on Iterable<NodeV0> {
         return false;
       }
     }
+
     return true;
   }
 

lib/src/core/document/diff.dart

@@ -71,6 +71,7 @@ List<Operation> diffNodes(Node oldNode, Node newNode) {
         }
       }
     }
+
     return combinedOperations;
   }
 
@@ -99,6 +100,7 @@ List<Operation> diffNodes(Node oldNode, Node newNode) {
         }
       }
     }
+
     return combinedOperations;
   }
 

lib/src/core/document/document.dart

@@ -41,6 +41,7 @@ class Document {
 
     final document = Map<String, Object>.from(json['document'] as Map);
     final root = Node.fromJson(document);
+
     return Document(root: root);
   }
 
@@ -51,6 +52,7 @@ class Document {
       type: 'document',
       children: LinkedList<Node>()..add(TextNode.empty()),
     );
+
     return Document(
       root: root,
     );
@@ -66,6 +68,7 @@ class Document {
       type: 'page',
       children: withInitialText ? [paragraphNode()] : [],
     );
+
     return Document(
       root: root,
     );
@@ -83,6 +86,7 @@ class Document {
     while (current != null && current.children.isNotEmpty) {
       current = current.children.last;
     }
+
     return current;
   }
 
@@ -110,6 +114,7 @@ class Document {
       for (final node in nodes) {
         target.insertBefore(node);
       }
+
       return true;
     }
 
@@ -118,6 +123,7 @@ class Document {
       for (var i = 0; i < nodes.length; i++) {
         parent.insert(nodes.elementAt(i), index: path.last + i);
       }
+
       return true;
     }
 
@@ -139,6 +145,7 @@ class Document {
       target = next;
       length--;
     }
+
     return true;
   }
 
@@ -147,13 +154,15 @@ class Document {
     // if the path is empty, it means the root node.
     if (path.isEmpty) {
       root.updateAttributes(attributes);
+
       return true;
     }
     final target = nodeAtPath(path);
     if (target == null) {
       return false;
     }
     target.updateAttributes(attributes);
+
     return true;
   }
 
@@ -168,6 +177,7 @@ class Document {
       return false;
     }
     target.updateAttributes({'delta': (targetDelta.compose(delta)).toJson()});
+
     return true;
   }
 

lib/src/core/document/node.dart

@@ -84,15 +84,18 @@ final class Node extends ChangeNotifier with LinkedListEntry<Node> {
 
   /// The children of the node.
   final LinkedList<Node> _children;
+
   List<Node> get children {
     _cacheChildren ??= _children.toList(growable: false);
+
     return _cacheChildren!;
   }
 
   List<Node>? _cacheChildren;
 
   /// The attributes of the node.
   Attributes _attributes;
+
   Attributes get attributes => {..._attributes};
 
   /// The path of the node.
@@ -138,6 +141,7 @@ final class Node extends ChangeNotifier with LinkedListEntry<Node> {
 
     final index = path.first;
     final child = childAtIndexOrNull(index);
+
     return child?.childAtPath(path.sublist(1));
   }
 
@@ -161,6 +165,7 @@ final class Node extends ChangeNotifier with LinkedListEntry<Node> {
     if (_children.isEmpty) {
       _children.add(entry);
       notifyListeners();
+
       return;
     }
 
@@ -213,6 +218,7 @@ final class Node extends ChangeNotifier with LinkedListEntry<Node> {
 
     parent?.notifyListeners();
     parent = null;
+
     return true;
   }
 
@@ -235,6 +241,7 @@ final class Node extends ChangeNotifier with LinkedListEntry<Node> {
     if (attributes['delta'] is List) {
       return Delta.fromJson(attributes['delta']);
     }
+
     return null;
   }
 
@@ -253,6 +260,7 @@ final class Node extends ChangeNotifier with LinkedListEntry<Node> {
       // filter the null value
       map['data'] = attributes..removeWhere((_, value) => value == null);
     }
+
     return map;
   }
 
@@ -281,6 +289,7 @@ final class Node extends ChangeNotifier with LinkedListEntry<Node> {
     }
     node.externalValues = externalValues;
     node.extraInfos = extraInfos;
+
     return node;
   }
 
@@ -297,6 +306,7 @@ final class Node extends ChangeNotifier with LinkedListEntry<Node> {
       return previous;
     }
     final index = parent.children.indexOf(this);
+
     return parent._computePath([index, ...previous]);
   }
 
@@ -351,8 +361,10 @@ final class TextNode extends Node {
   String get subtype => '';
 
   Delta _delta;
+
   @override
   Delta get delta => _delta;
+
   set delta(Delta v) {
     _delta = v;
     notifyListeners();
@@ -362,6 +374,7 @@ final class TextNode extends Node {
   Map<String, Object> toJson() {
     final map = super.toJson();
     map['delta'] = delta.toJson();
+
     return map;
   }
 
@@ -385,6 +398,7 @@ final class TextNode extends Node {
         );
       }
     }
+
     return textNode;
   }
 
@@ -401,6 +415,7 @@ extension NodeEquality on Iterable<Node> {
         return false;
       }
     }
+
     return true;
   }