Skip to content

release: 1.0.0 - #42

Merged
RZEROSTERN merged 24 commits into
masterfrom
release/1.0.0
Nov 10, 2026
Merged

RZEROSTERN merged 24 commits into
masterfrom
release/1.0.0

Conversation

@RZEROSTERN

Copy link
Copy Markdown
Collaborator

Type of change

  • Bug fix
  • New feature
  • Refactor
  • Chore / dependency update
  • Documentation

Summary

Releases everything merged into develop since 0.5.0 (PRs #34 to #41) as 1.0.0. The features are listed in CHANGELOG.md and were each reviewed in their own PR. Only the last commit on this branch is new; it is described below.

Release changes

  • pubspec.yaml version 0.5.0-beta.1 → 1.0.0; example/pubspec.lock follows.
  • The [Unreleased] changelog section becomes [1.0.0] - 2026-11-10.
  • README: the install snippet says ^1.0.0, and the "pre-1.0" disclaimer is replaced by a short status section. That section states that the package follows semantic versioning from 1.0 on. Please confirm you want to make that commitment.

Fixes found while preparing the release

All three were approved before being applied.

  1. A fresh install did not compile. html 0.15.7 (August 2026) removed a function that flutter_html 3.0.0 calls, and 3.0.0 is the latest flutter_html. The lockfile here pins html 0.15.6, so the tests and CI passed, but an app that added the package resolved to 0.15.7 and failed with Method not found: 'matches'. The demo app failed this way. The package now depends on html: ">=0.15.5 <0.15.7". An app that needs html 0.15.7 or later for another package will get a version conflict; the README says so.
  2. flutter_html: ^3.0.0-beta.2 → ^3.0.0. pub publish --dry-run warned that a stable release cannot depend on a pre-release. The tests have only ever run against 3.0.0.
  3. The minimum Flutter was declared wrong. pubspec.yaml said Flutter 3.10, but the quote renderer has used Color.withValues (Flutter 3.27) since March. It now declares Flutter 3.27 and Dart 3.6. I analyzed lib/ with Flutter 3.16, and that one line was the only error, so nothing else needs a version newer than 3.16.

Housekeeping (requested)

  • CI now also runs on pushes and pull requests to develop.
  • CLAUDE.md and README rule 1 describe git flow: work branches from develop, a release/<version> branch into master, version set on the release branch, changelog notes under [Unreleased]. The versioning rule now says a breaking change needs a major version (it said minor, which fitted pre-1.0).

Checks

  • fvm flutter analyze: no issues.
  • fvm flutter test --coverage: 469 tests pass, 95.5 % line coverage.
  • fvm flutter pub publish --dry-run: 0 warnings.
  • Demo app: I drove it with a temporary widget test, resolved from scratch with the html cap. The viewer loaded the sample document, the editor added seven kinds of block, and the export produced EditorJS 2.31.7 JSON with no errors. I did not run it on a device or simulator.

Not in this PR

  • The package archive that pub publish would upload includes demo/ (with its Android and iOS folders), coverage/ and CLAUDE.md. A .pubignore would keep them out.
  • CI installs from the lockfile, which is why it could not see the html break. A job that runs flutter pub upgrade before the tests would catch the next one.
  • The Spanish and French translations have not been checked by a native speaker.

Breaking changes

For apps on 0.5.0, the changelog section "Behaviour changes" lists them. The ones that can require a code change:

  • ListStyle has a third value, checklist, so an exhaustive switch needs a new case.
  • BlockDocument.blocks and EditorController.blocks now include UnknownBlocks, which used to be dropped.
  • The toolbar's "Checklist" button creates a list block with the checklist style; the old behaviour is the "Checklist (legacy)" button.
  • Requires Flutter 3.27; html is limited to versions below 0.15.7.

Migration notes

  • Change the dependency to editorjs_flutter: ^1.0.0.
  • If your EditorJS setup still uses the @editorjs/checklist plugin, hide the new checklist button with EditorConfig.toolbarItems.
  • If you added a dependency_overrides entry for html to work around the compile error, remove it.

After merging

  1. Merge master back into develop.
  2. Publish to pub.dev when you are ready (fvm flutter pub publish). I have not published anything.

Test plan

  • fvm flutter analyze passes with no issues
  • Relevant unit/widget tests added or updated (469 tests pass, 95.5 % line coverage)
  • Demo app tested manually on at least one platform (driven by a widget test only, see Checks)

🤖 Generated with Claude Code

RZEROSTERN and others added 24 commits November 10, 2026 00:46
Opening a document saved by current EditorJS and saving it again lost
data. Parse -> edit -> serialize now reproduces every block exactly.

- Keep block id and tunes: read into BlockDocument.metadata
  (BlockMetadata) and written back. EditorController.blockIds holds the
  EditorJS ids; the new blockTunes getter exposes tunes. Both follow
  their block through update, move and undo/redo.
- Keep unknown blocks: a block with no registered mapper, or whose
  mapper throws, becomes an UnknownBlock and is written back untouched.
  The viewer skips it without leaving a gap.
- Keep backend-defined fields: TableBlock.stretched,
  ImageBlock.fileExtras, AttachesBlock.fileExtras, LinkToolMeta.extras.
- Stamp version 2.31.7 (BlockDocument.editorJsVersion) instead of the
  hard-coded 2.19.0.
- Read every mapper field through tolerant JsonReader helpers, so a
  mistyped value no longer throws a TypeError out of EditorJSView or
  EditorController.fromJson.

The package version is not bumped: notes are under [Unreleased] in
CHANGELOG.md and the bump to 1.0.0 happens on the release branch.

Co-Authored-By: Claude <noreply@anthropic.com>
feat: lossless round-trip with EditorJS 2.31 (ids, tunes, unknown blocks) and parser hardening
@editorjs/list 2.x merged the nested-list and checklist tools into the
list block. A checklist-style list was shown as bullets and lost its
ticks on save, and an ordered list's start number and counter type were
dropped.

- Entity: ListStyle.checklist, ListItem.checked, ListBlock.start,
  ListBlock.counterType and the ListCounterType enum.
- Mapper: read the 2.x format and normalize the legacy list 1.x,
  nested-list and checklist item shapes the way the EditorJS tool does.
- Renderer: tick box per checklist item at every level; ordered lists
  honour start and counterType and number nested items 1.1., 1.2., ...
- Editor: style selector, "Start with" and counter-type options for
  ordered lists, tick box per checklist item.
- Lists are written in the 2.x shape (root and per-item meta).

The toolbar's Checklist button still creates the legacy checklist
block; nested items are rendered but not yet editable.

Co-Authored-By: Claude <noreply@anthropic.com>
Which checklist a document can use depends on the tools installed in
the EditorJS instance that reads it, so the toolbar now has a button
for each: "Checklist" adds a list 2.x checklist (a list block with the
checklist style) and "Checklist (legacy)" adds the older checklist
block the button used to create.

The extra button pushes the link button past the default test
viewport, so the two hyperlink tests scroll it into view first.

Co-Authored-By: Claude <noreply@anthropic.com>
feat: List 2.x support (checklist style, ordered start and counter type)
EditorJS saves every editable field as HTML, but the viewer only
treated paragraph, list and quote text that way.

- Tables: flex columns inside a horizontal scroll view gave the table
  zero width, so it showed as a strip with one letter per line. Columns
  now take the width of their content; a stretched table fills the
  available width.
- Inline formatting and entities now render in headers, table cells,
  legacy checklist items, warnings and image, embed and quote captions.
  All text goes through one widget, InlineHtml.
- Links: <a> taps did nothing. They now open externally (http, https,
  mailto, tel) or go to the new EditorConfig.onLinkTap. Link, embed and
  attachment cards use the same path, exposed to custom renderers as
  EditorLinkScope.open.
- Alignment: paragraph, quote and raw text lose their extra horizontal
  margin, and list markers line up with their item's text.

Co-Authored-By: Claude <noreply@anthropic.com>
Review feedback on the viewer fidelity change.

- Links: the default now opens http and https only. Other schemes are
  opt-in through the new EditorConfig.allowedLinkSchemes, which
  EditorLinkScope carries down to the renderers.
- Tables: as in EditorJS, a table spans the full width with equal
  columns and wraps the text in its cells, instead of sizing columns to
  their content. A table whose columns would be narrower than 96 px
  keeps that width and scrolls sideways. stretched no longer changes
  the layout; it is still read and written back.

Co-Authored-By: Claude <noreply@anthropic.com>
feat: viewer fidelity (visible tables, inline HTML everywhere, tappable links)
A heading's level was fixed at creation: the only way to turn an H2
into an H3 was to delete the block and add a new one. The header editor
now has an H1-H6 selector next to the text. A level outside that range
in a loaded document is shown as the nearest valid one.

Co-Authored-By: Claude <noreply@anthropic.com>
The toolbar always showed every button, so an app could not hide the
ones its EditorJS setup cannot read (for example one of the two
checklist kinds). EditorConfig.toolbarItems now takes the buttons to
show, in order, as EditorToolbarItem values; the default is every
button in the previous order.

The toolbar builds its buttons from that list instead of a fixed
sequence of widgets.

Co-Authored-By: Claude <noreply@anthropic.com>
Picking a new image replaced the whole block, which reset its caption
and its border, stretch and background flags, and always stored the
path of the file on the device. There was no way to enter a URL or a
caption.

- EditorConfig.imageUploader stores a picked image and returns its
  public URL plus any extra file fields, like the uploader of the
  EditorJS image tool. Without one the local path is stored as before.
- The editor shows upload progress and reports picker and upload
  failures without losing the current image.
- New fields for the image URL and the caption, and toggles for
  border, stretch and background.
- Picking or retyping the URL keeps the caption and options, and drops
  only the fields that described the previous file.
- ImageBlock.copyWith.

Co-Authored-By: Claude <noreply@anthropic.com>
The list editor only showed top-level items: nested items were kept but
could not be seen, changed, added or removed.

The editor now treats the list as an outline. Every item is a row with
a depth, shown indented, and each row can be indented under the item
above it, outdented, or removed. Moving an item takes its children
along; removing one moves its children up a level instead of deleting
them. Enter in an item adds a sibling below it and moves the cursor
there. Ordered markers follow the nesting (3.1., 3.1.1.) and checklist
items can be ticked at any depth.

The per-row buttons are narrower than a default icon button so the item
text still has room on a phone.

Co-Authored-By: Claude <noreply@anthropic.com>
Changelog entry under [Unreleased], README sections on uploading images
and choosing the toolbar buttons, and the block table and backlog in
CLAUDE.md.

Co-Authored-By: Claude <noreply@anthropic.com>
feat: editor improvements (image upload, heading level, nested lists, configurable toolbar)
Removing an item that had nested items kept them and moved them up a
level. Per review, removing an item now removes its whole subtree.

The list still always keeps at least one item, so the remove button is
disabled when the item and its children are all that is left. The
depth-repair helper is no longer needed: removing a complete subtree
cannot leave an invalid outline.

Co-Authored-By: Claude <noreply@anthropic.com>
These four block types were viewer-only: the editor showed an
"Unsupported block" placeholder for them and could not create them.

- Embed: link and caption. The service and embed URL are derived from
  the link with the patterns and templates of @editorjs/embed.
- Link: link, title, description and preview image, with an optional
  EditorConfig.linkPreviewFetcher behind a "Fetch preview" button.
- Attachment: file URL and title, with an optional
  EditorConfig.attachmentPicker behind a "Choose file" button, since
  the package bundles no file picker.
- Raw: the HTML source.

Each has a toolbar button (EditorToolbarItem.embed, linkPreview,
attachment, rawHtml).

The image editor's ImageUploadScope becomes a general EditorConfigScope
so block editors can read any EditorConfig hook.

Co-Authored-By: Claude <noreply@anthropic.com>
The only way to add a link was the toolbar's Hyperlink button, which
appends a new paragraph containing nothing but the link.

The paragraph format bar now has a Link button. With text selected it
wraps the selection in a link; with nothing selected it inserts the
address as the link text. With the caret in an existing link it opens
that link for editing: saving replaces only the address and keeps the
text, inner formatting and other attributes, and "Remove link" keeps
the text.

A bare address is completed to https://; mailto:, tel: and in-site
targets are left as typed. The address is escaped for the attribute.

Co-Authored-By: Claude <noreply@anthropic.com>
fix: removing a list item removes its children too
feat: editors for embed, link, attachment and raw blocks
feat: add, edit and remove links in paragraphs
Every label, tooltip, hint and message was hard-coded in English across
the toolbar, the block controls, the block editors and three viewer
cards.

EditorStrings now holds all 104 of those texts with English defaults;
the ones that include a value are functions. EditorConfig.strings takes
an instance, so an app overrides only what it wants. Widgets read the
texts through EditorConfigScope.stringsOf, which EditorJSView now
provides as well and which falls back to the defaults for a widget used
on its own. The two dialogs are handed the texts because they are built
outside the editor's subtree.

localization_test renders every block editor and the toolbar with all
texts marked and fails if anything on screen was not looked up.

Co-Authored-By: Claude <noreply@anthropic.com>
EditorTranslations exposes complete Spanish and French EditorStrings
(es, fr) and forLanguage(code), which accepts a language code or a
locale tag and falls back to English.

Each language is one file under config/translations. translations_test
reads those files and fails when one misses a text, has an unknown one,
or is not registered.

The README explains how to use a bundled language, reword single texts,
add a translation in an app, and contribute one to the package.

Co-Authored-By: Claude <noreply@anthropic.com>
feat: translatable editor and viewer text, with Spanish and French
Set the version to 1.0.0 and turn the unreleased changelog section into
the 1.0.0 entry.

Fixes found while preparing the release:
- Cap html below 0.15.7. flutter_html 3.0.0 calls a function that
  html 0.15.7 removed, so an app resolving to it failed to compile.
- Depend on flutter_html ^3.0.0 instead of ^3.0.0-beta.2.
- Declare Flutter 3.27 / Dart 3.6 as the minimum; the quote renderer
  already needed it.

Also run CI for develop, and describe git flow in CLAUDE.md and the
README.

Co-Authored-By: Claude <noreply@anthropic.com>
@RZEROSTERN
RZEROSTERN merged commit d820df8 into master Nov 10, 2026
1 check 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.

1 participant