Skip to content

Final fixes before pub.dev release#31

Merged
RZEROSTERN merged 2 commits intomasterfrom
chore/pubdev-preparation
Mar 25, 2026
Merged

Final fixes before pub.dev release#31
RZEROSTERN merged 2 commits intomasterfrom
chore/pubdev-preparation

Conversation

@RZEROSTERN
Copy link
Collaborator

This pull request introduces several improvements and refinements to the editorjs_flutter package and its demo, focusing on documentation, code quality, and usability. Highlights include enhanced documentation, stricter linting, dependency updates, and minor code cleanups for clarity and maintainability.

Documentation and Public API:

  • Expanded the README.md with updated usage instructions, clearer project status, and badges for pub, CI, and code coverage. Also clarified API stability and added an example for loading JSON directly into the editor. [1] [2] [3]

Project Metadata and Dependencies:

  • Updated pubspec.yaml with new homepage, repository, and issue tracker URLs, and added flutter_lints as a dev dependency for improved code quality. [1] [2]
  • Updated the example dependency version in documentation to ^0.5.0.

Linting and Code Quality:

  • Enabled strict linting rules in both the main package and demo app by including flutter_lints and specifying additional rules in analysis_options.yaml. [1] [2]

Demo and Testing Improvements:

  • Simplified the demo app's widget test to a basic smoke test and removed boilerplate comments for clarity.
  • Refactored asset loading in the demo app for readability by storing the bundle in a variable.

Code Consistency and Minor Fixes:

  • Added missing const constructors in toolbar block creation for better performance and consistency in editorjs_toolbar.dart. [1] [2]
  • Fixed unnecessary use of this. in editorjs_view.dart for cleaner code.
  • Added missing const in a test helper for custom block registration.

Copilot AI review requested due to automatic review settings March 25, 2026 22:56
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR prepares editorjs_flutter for a pub.dev release by tightening project metadata/linting, refreshing documentation, and applying small code/test cleanups across the package and demo.

Changes:

  • Updated package metadata + added flutter_lints with shared analysis_options.yaml for stricter linting.
  • Refined docs (README badges/usage) and added an MIT LICENSE.
  • Minor code/test cleanups (const usage, removing unnecessary this., simpler demo smoke test, demo asset loading refactor).

Reviewed changes

Copilot reviewed 9 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
test/unit/editor_controller_test.dart Uses const for the custom mapper in the registry test helper.
pubspec.yaml Updates homepage/repo links and adds flutter_lints dev dependency; removes boilerplate.
pubspec.lock Lockfile updated to reflect dependency graph changes.
lib/src/presentation/widgets/editorjs_view.dart Removes unnecessary this. qualifiers when accessing config.
lib/src/presentation/widgets/editorjs_toolbar.dart Adds const to some block creations in toolbar actions.
demo/test/widget_test.dart Replaces default counter test with a minimal smoke test.
demo/lib/main.dart Refactors asset loading by reusing the AssetBundle instance.
demo/analysis_options.yaml Adds lint include for demo (flutter_lints).
coverage/lcov.info Updates committed coverage output.
analysis_options.yaml Adds repo-wide lint configuration based on flutter_lints.
README.md Expands/updates documentation, badges, and adds fromJson example.
LICENSE Adds MIT license text.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 25, 2026 23:05
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 12 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@RZEROSTERN RZEROSTERN merged commit 6154d2b into master Mar 25, 2026
5 checks passed
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.

2 participants