Pre-10.0.0 release hygiene: packaging, formatting, docs#91
Merged
Conversation
The sources were last formatted with the pre-3.7 short style; the package targets Dart >=3.10, whose formatter uses the tall style. Reformat so dart format is clean (and pana stops docking formatting points). No behavior change.
- Add .pubignore excluding SPEC.md / REQUIREMENTS.md from the published archive (internal governance docs that dominated the package; 237KB -> 149KB) - Fix stale DartPingIOS doc reference in address_family.dart -> IosPing (the type was removed in 10.0.0; iOS now constructs IosPing directly) - README: clarify that stream.first yields a PingEvent (possibly PingError), not necessarily a successful reply - pubspec: add 'ios' topic - analysis_options: refresh stale pedantic/Google lint comment and dead URL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Pre-release review pass for 10.0.0. The package, tests, and docs were already in good shape (
dart analyze --fatal-infosclean, 238 non-live tests passing, CHANGELOG/README accurate); this PR cleans up the packaging and hygiene items found in review.Changes
Packaging
.pubignoreexcludingSPEC.md(177 KB) andREQUIREMENTS.md(102 KB) — internal governance docs that dominated the published archive and add no value for consumers. Published archive 237 KB → 149 KB. They stay in the repo.Formatting (
d25c579, isolated commit)dart format .across lib/hook/test. The sources had been formatted with the pre-3.7 short style, but the package targets Dart ≥3.10 whose formatter uses the tall style — sodart formatwas dirty and pana would dock formatting points. No behavior change; reviewable separately from the substantive commit.Docs / hygiene
DartPingIOSdoc reference inaddress_family.dart→IosPing(that type was removed in 10.0.0; iOS now constructsIosPingdirectly).stream.firstyields aPingEvent(possibly aPingError), not necessarily a successful reply.iostopic.Verification
dart analyze --fatal-infos→ cleandart format --set-exit-if-changed→ cleandart test -x live→ 238 passingdart pub publish --dry-run→ 0 package warningsNot included
hoston the WindowsforceCodepagepath — filed as Security: command injection via host on Windows forceCodepage path #90 to track separately. It's opt-in, Windows-only, and not a 10.0.0 regression, so it isn't a release blocker.dart format --set-exit-if-changedCI step (would prevent the formatting drift from recurring) — happy to add if wanted.