refactor: restructure project into modular architecture for flutter_quill #2032
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
Use the modular structure for
flutter_quill
to improve maintainability.Our current project structure almost has no architecture, which was suitable when the project first started out. This is a partial fix.
Note
Notice this is not final and we should improve it further, by moving and splitting functionalities instead of having one big file.
There might be inconsistency or some minor issues, misleading, or further improvements.
In case I have any examples I would already fix it, for example, there might be some files in a module that should be in another module for clarity. Or it might be in the wrong directory.
We will improve anything later. For now, this structure can be easier to maintain than the current one.
The new project structure (not final and might be changed):
We're open to all feedback.
Related Issues
Checklist
CHANGELOG.md
nor the package version inpubspec.yaml
files../scripts/before_push.sh
and it all passed successfullyBreaking Change
Does your PR require developers to manually update their apps to accommodate your change?
!
in the title as explained in Conventional Commits).This change is a breaking change if you import files directly from the
src
directory:By default, dart analysis will give you a warning and the IDE will not import or suggest from the
src
directory unless you explicitly import.flutter_quill_extensions
is no longer compatible with an older version offlutter_quill
, we use the same version for all packages on this repo for automated publishing and to improve compatibility.