Skip to content

chore!: move spell checker to example #2145

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

Merged
merged 8 commits into from
Aug 24, 2024

Conversation

EchoEllet
Copy link
Collaborator

Description

Remove simple_spell_checker from flutter_quill_extensions to make it optional in order to reduce bundle size. Implementing this feature in the example.

This PR will not require any additional changes to build the app however it will disable the spell-checking feature.

Initially, I planned on moving this feature into a new package (flutter_quill_spell_checker) and while doing so, I decided to only implement it in the example for a few reasons.

The README.md has been updated.

Apologies for the frequent breaking changes; we're continuously refining decisions to improve the project's direction.

Tip

For existing apps that expect this feature, you can take a look at the example and Spelling checker page.

Open to feedback—feel free to ask any questions or share thoughts.

Related Issues

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

I recommend that we focus on code quality by refactoring and enhancing the existing code, documenting it, making it more extensible by allowing to write extensions to provide any feature in a clean way, and more tests since we have regressions more often than before.

Copy link
Collaborator

@CatHood0 CatHood0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now I'm fine with these changes, however, I think it's important to point out in the project's README that having this feature could increase the bundle size.

Thanks for taking the time to make these changes.

As you mentioned, it's best to focus for now on the existing code that still causes some issues (some I haven't been able to find the solution for).

Ellet added 2 commits August 24, 2024 11:13
…dicates this feature doesn't support many translations
… and remove the part regarding the supported translations.
@CatHood0 CatHood0 marked this pull request as ready for review August 24, 2024 20:43
@singerdmx singerdmx merged commit d8e83b5 into master Aug 24, 2024
2 checks passed
@EchoEllet EchoEllet deleted the chore/move-spell-checker-to-example branch August 25, 2024 00:42
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.

Make spell checker package optional
3 participants