-
Notifications
You must be signed in to change notification settings - Fork 3.3k
[flutter_markdown] Ensure customize nested bullet list style. #6384
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
[flutter_markdown] Ensure customize nested bullet list style. #6384
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PTAL @stuartmorgan
CI will not pass without completing these steps; that's why |
I've updated them (I'm new to contribute this package, so I'm not sure this versioning is correct). |
@domesticmouse This is a breaking change isn't it? |
Do we follow SemVer in these packages? If we do, then yeah it is. |
So should I increase the minor version? |
We're generally stricter than that. No breaking changes, we would deprecate this method and add a new one. I'm not sure if that's the policy for this package. @stuartmorgan will know. |
That's for platform interface packages. For regular packages we can do breaking changes (with a corresponding major version bump), but we generally evaluate the importance of the use case and whether we need to do it with a breaking change or there is a less disruptive option. |
Right.
@Kurogoma4D That should be fine. I think change is worth the breaking change. You should also make a note in the changelog about what this pr breaks https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changelog |
typedef MarkdownBulletBuilder = Widget Function( | ||
int index, | ||
BulletStyle style, | ||
int nestLevel, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't done a full review here, but I assume the breaking change is that we're adding a parameter to a method that package clients need to implement?
If so, it would be better to make the breaking change replace it with a parameter object, so that next time it doesn't need a breaking change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree.
Which is better to use class or record, as a parameter object here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding a field to a record later would be breaking (since it changes the type), so it needs to be a class to get the benefit.
@domesticmouse @stuartmorgan |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PTAL @stuartmorgan
Kurogoma4D, I think I've resolved the conflicts appropriately, please check. @tarrinneal @stuartmorgan PTAL |
@domesticmouse Thanks, LGTM :) |
flutter/packages@0e3809d...88a3a56 2024-04-19 [email protected] [camera] Convert iOS Obj-C->Dart calls to Pigeon (flutter/packages#6568) 2024-04-19 [email protected] [flutter_markdown] Ensure customize nested bullet list style. (flutter/packages#6384) 2024-04-18 [email protected] [ci] Add more dev dependency checks, and fix errors (flutter/packages#6563) 2024-04-18 [email protected] Roll Flutter from 3882afb to fb110b9 (56 revisions) (flutter/packages#6565) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
flutter/packages@0e3809d...88a3a56 2024-04-19 [email protected] [camera] Convert iOS Obj-C->Dart calls to Pigeon (flutter/packages#6568) 2024-04-19 [email protected] [flutter_markdown] Ensure customize nested bullet list style. (flutter/packages#6384) 2024-04-18 [email protected] [ci] Add more dev dependency checks, and fix errors (flutter/packages#6563) 2024-04-18 [email protected] Roll Flutter from 3882afb to fb110b9 (56 revisions) (flutter/packages#6565) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
See flutter/flutter#145670 .
Pre-launch Checklist
dart format
.)[shared_preferences]
pubspec.yaml
with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.md
to add a description of the change, following repository CHANGELOG style.///
).If you need help, consider asking for advice on the #hackers-new channel on Discord.