Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: deprecate flutter_quill/extensions.dart #2258

Merged
merged 2 commits into from
Sep 21, 2024

Conversation

EchoEllet
Copy link
Collaborator

Description

Deprecate usages of extensions.dart to indicate that it's for internal usage only. Add flutter_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 for flutter_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. The flutter_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 by flutter_quill.

Type of Change

  • New feature: Adds new functionality without breaking existing features.
  • 🛠️ Bug fix: Resolves an issue without altering current behavior.
  • 🧹 Code refactor: Code restructuring that does not affect behavior.
  • Breaking change: Alters existing functionality and requires updates.
  • 🧪 Tests: Adds new tests or modifies existing tests.
  • 📝 Documentation: Updates or additions to documentation.
  • 🗑️ Chore: Routine tasks, or maintenance.
  • Build configuration change: Changes to build or deploy processes.

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.

@EchoEllet EchoEllet marked this pull request as ready for review September 21, 2024 11:58
@EchoEllet
Copy link
Collaborator Author

It seems that we're using the extensions.dart that exposes the internal API to flutter_quill_extensions inside of flutter_quill. The new name should avoid confusion and be more specific.

Which is:

import 'package:flutter_quill/flutter_quill_internal.dart

Can also be:

import 'package:flutter_quill/internal.dart

@EchoEllet EchoEllet merged commit 409d2d1 into master Sep 21, 2024
2 checks passed
@EchoEllet EchoEllet deleted the chore/deprecate-extensions-file branch September 21, 2024 12:21
CatHood0 pushed a commit to CatHood0/flutter-quill that referenced this pull request Sep 21, 2024
* chore: deprecate flutter_quill/extensions.dart

* chore: remove all usages of extensions.dart in flutter_quill
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant