chore: deprecate flutter_quill/extensions.dart #2258
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Deprecate usages of
extensions.dart
to indicate that it's for internal usage only. Addflutter_quill_internal.dart
as a replacement.I have seen that some users are using the
extensions.dart
directly in their project which is a file forflutter_quill_extensions
only and contains internal APIs that will change and update for the extensions package without any notice, which introduce breaking changes, users are often don't see the file itself from source and use it directly. Adding a comment is not clear enough. Theflutter_quill_internal
makes sure to make it more clear that it's for internal usage only.Should increase the minimum version of
flutter_quill_extensions
byflutter_quill
.Type of Change
Suggestions
For now, avoid introducing APIs as part of the public API, make it more clear it's for internal usage only using docs comment and
internal
annotation.