feat: remove the reference of the deprecated values (#304)

* feat: remove the reference of the deprecated values * chore: add migration guide
AppFlowy-IO · Jul 12, 2023 · 5f136df · 5f136df
1 parent f8da435
commit 5f136df
Show file tree

Hide file tree

Showing 40 changed files with 281 additions and 3,459 deletions.
diff --git a/README.md b/README.md
@@ -115,6 +115,9 @@ Below are some examples of shortcut event customizations:
  * [BIUS](https://github.com/AppFlowy-IO/appflowy-editor/tree/main/lib/src/editor/editor_component/service/shortcuts/character_shortcut_events/format_single_character) demonstrates how to make text bold/italic/underline/strikethrough through shortcut keys
  * Need more examples? Check out [shortcuts](https://github.com/AppFlowy-IO/appflowy-editor/tree/main/lib/src/editor/editor_component/service/shortcuts)
 
+## Migration Guide
+Please refer to the [migration documentation]((https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/migration.md)).
+
 ## Glossary
 Please refer to the API documentation.
 

diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -10,7 +10,5 @@ linter:
     - use_decorated_box
 
 analyzer:
-  errors:
-    deprecated_member_use_from_same_package: ignore
   exclude:
     - lib/src/l10n/**
diff --git a/documentation/migration.md b/documentation/migration.md
@@ -0,0 +1,9 @@
+# Migration Guide
+
+## From 1.1.0 to 1.2.0
+
+- `AppFlowyEditor.custom` and `AppFlowyEditor.standard` have been removed. Use `AppFlowyEditor.` instead.
+  - For now, we provide the default values to the `blockComponentBuilders`, `characterShortcutEvents`, and `commandShortcutEvents` if you do not customize them.
+- `DefaultSelectable` has been renamed to `DefaultSelectableMixin`
+- `FlowyRichText` has been renamed to `AppFlowyRichText`.
+- Added new parameter called `context`(BuildContext) into `TextSpanDecoratorForAttribute`.
diff --git a/lib/src/commands/attributes_commands.dart b/lib/src/commands/attributes_commands.dart
diff --git a/lib/src/commands/command_extension.dart b/lib/src/commands/command_extension.dart
diff --git a/lib/src/commands/text/text_commands.dart b/lib/src/commands/text/text_commands.dart
diff --git a/lib/src/core/document/document.dart b/lib/src/core/document/document.dart
@@ -119,16 +119,17 @@ class Document {
     return true;
   }
 
-  /// Updates the [TextNode] at the given [Path]
+  /// Updates the [Node] with [Delta] at the given [Path]
   bool updateText(Path path, Delta delta) {
     if (path.isEmpty) {
       return false;
     }
     final target = nodeAtPath(path);
-    if (target == null || target is! TextNode) {
+    final targetDelta = target?.delta;
+    if (target == null || targetDelta == null) {
       return false;
     }
-    target.delta = target.delta.compose(delta);
+    target.updateAttributes({'delta': (targetDelta.compose(delta)).toJson()});
     return true;
   }