-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Use a show over a hide for test_api exports
#128298
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
Conversation
The members which are currently hidden may get removed from `package:test_api` because they have no uses. dart-lang/test#2030 Switch to a `show` and list all the exported APIs. This is currently a no-op change, and is forward compatible with the breaking change when it lands. A `show` is also safer than a `hide` when exporting across package boundaries. Adding a new member to a library _can be_ breaking, but is often treated as non-breaking. If a new member is added to `package:test_api/scaffolding.dart` it will need to be manually added to the list to be usable from `package:flutter_test`, but we anyways want to add a CHANGELOG entry for user facing changes.
|
It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!). If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix? Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. |
christopherfujino
left a comment
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.
Thanks!
| export 'package:test_api/scaffolding.dart' | ||
| hide group, setUp, setUpAll, tearDown, tearDownAll, test; | ||
| show | ||
| OnPlatform, |
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 went with the dart format formatting for a long list of shown members.
In package:flutter I mostly see a format with show on the same line as import and 2 spaces for the members.
In package:flutter_tools I mostly see a format like this, but a few use 2/4 space indent instead of 4/8.
In package:flutter_test there aren't other examples with enough members to split across lines.
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.
yeah in general if pushed i would say that any time you can't fit them on one line it's probably a mistake to be using show/hide anyway. :-) (This being one of the rare exceptions where it's reasonable, I think.)
|
test-exempt: code refactor with no semantic change |
Roll Flutter from 0b74153 to 8a5c22e (46 revisions) flutter/flutter@0b74153...8a5c22e 2023-06-07 [email protected] Super tiny MediaQuery doc update (flutter/flutter#127904) 2023-06-07 [email protected] Revert "Make inspector weakly referencing the inspected objects." (flutter/flutter#128436) 2023-06-07 [email protected] Update menu API docs to help developers migrate to m3 (flutter/flutter#128351) 2023-06-07 [email protected] [tools] allow explicitly specifying the JDK to use via a new config setting (flutter/flutter#128264) 2023-06-07 [email protected] Roll Flutter Engine from 6f9df0f988c1 to 59d5444cf06c (3 revisions) (flutter/flutter#128376) 2023-06-07 [email protected] Do not try to load main/default asset image if only higher-res variants exist (flutter/flutter#128143) 2023-06-07 [email protected] Addressed Ambiguity in transform.scale constructor docs (flutter/flutter#128182) 2023-06-07 [email protected] Super tiny fix of dead link (flutter/flutter#128160) 2023-06-07 [email protected] Refactor tests (flutter/flutter#128371) 2023-06-07 [email protected] Make inspector weakly referencing the inspected objects. (flutter/flutter#128095) 2023-06-07 [email protected] Add viewId to PointerEvents (flutter/flutter#128287) 2023-06-07 [email protected] Show error message in release mode when box is not laid out without losing performance (flutter/flutter#126302) 2023-06-06 [email protected] Roll Flutter Engine from ca499463ec2e to 6f9df0f988c1 (1 revision) (flutter/flutter#128363) 2023-06-06 [email protected] Update Draggable YouTube video link (flutter/flutter#128078) 2023-06-06 [email protected] Remove more rounding hacks from TextPainter (flutter/flutter#127826) 2023-06-06 [email protected] Roll Flutter Engine from 4571695f9e76 to ca499463ec2e (1 revision) (flutter/flutter#128356) 2023-06-06 [email protected] [Android] Update plugin and module templates to use Flutter constant for `compileSdkVersion` (flutter/flutter#128073) 2023-06-06 [email protected] handleSelectWord in MultiSelectableSelectionContainerDelegate should handle rects inside of rects (flutter/flutter#127478) 2023-06-06 [email protected] [flutter_tools] never tree shake 0x20 (space) font codepoints on web (flutter/flutter#128302) 2023-06-06 [email protected] Remove `textScaleFactor` dependent logic from `AppBar` (flutter/flutter#128112) 2023-06-06 [email protected] Roll Flutter Engine from b6d37f8f74ad to 4571695f9e76 (6 revisions) (flutter/flutter#128350) 2023-06-06 [email protected] Fix `Null check operator used on a null value` on TextField with contextMenuBuilder (flutter/flutter#128114) 2023-06-06 [email protected] Roll Packages from db4e5c2 to da72219 (10 revisions) (flutter/flutter#128348) 2023-06-06 [email protected] Updating cirrus docker image to ubuntu focal. (flutter/flutter#128291) 2023-06-06 [email protected] Adding example for migrating to navigation drawer (flutter/flutter#128295) 2023-06-06 [email protected] Roll Flutter Engine from 722aad83e5fe to b6d37f8f74ad (2 revisions) (flutter/flutter#128341) 2023-06-06 [email protected] Clean-up viewId casts in flutter_test (flutter/flutter#128256) 2023-06-06 [email protected] Update cherry-pick issue template to more uniform labels. (flutter/flutter#128333) 2023-06-06 [email protected] Use Material3 in the 2D viewport tests (flutter/flutter#128155) 2023-06-06 [email protected] Use a `show` over a `hide` for `test_api` exports (flutter/flutter#128298) 2023-06-06 [email protected] Roll Flutter Engine from aaa7574375a6 to 722aad83e5fe (1 revision) (flutter/flutter#128307) 2023-06-06 [email protected] Migration guide for moving from BottomNavigationBar to NavigationBar (flutter/flutter#128263) 2023-06-06 [email protected] [web] Use 'Uri' instead of 'dart:html' to extract pathname (flutter/flutter#127983) 2023-06-06 [email protected] Roll Flutter Engine from 2b353ae90731 to aaa7574375a6 (4 revisions) (flutter/flutter#128301) 2023-06-05 [email protected] Roll Flutter Engine from 220ece4d9faa to 2b353ae90731 (1 revision) (flutter/flutter#128293) 2023-06-05 49699333+dependabot[bot]@users.noreply.github.com Bump actions/labeler from 4.0.4 to 4.1.0 (flutter/flutter#128290) 2023-06-05 [email protected] Roll Flutter Engine from 7f12e3497428 to 220ece4d9faa (6 revisions) (flutter/flutter#128282) 2023-06-05 [email protected] [framework] attempt non-key solution (flutter/flutter#128273) 2023-06-05 [email protected] [labeler] Fix adding labels when name is directory (flutter/flutter#128243) 2023-06-05 [email protected] Remove scrollbar deprecations isAlwaysShown and hoverThickness (flutter/flutter#127351) 2023-06-05 [email protected] Fix update drag error that made NestedScrollView un-scrollable (flutter/flutter#127718) 2023-06-05 [email protected] Roll Flutter Engine from f9f72388a4da to 7f12e3497428 (4 revisions) (flutter/flutter#128271) 2023-06-05 [email protected] Migrate SemanticsBinding to onSemanticsActionEvent (flutter/flutter#128254) 2023-06-05 [email protected] Roll Flutter Engine from c838a1b05924 to f9f72388a4da (19 revisions) (flutter/flutter#128252) 2023-06-05 [email protected] [framework] force flexible space background to rebuild. (flutter/flutter#128138) 2023-06-05 [email protected] Roll Packages from 75085ed to db4e5c2 (4 revisions) (flutter/flutter#128246) ...
The members which are currently hidden may get removed from
package:test_apibecause they have no uses.dart-lang/test#2030
Switch to a
showand list all the exported APIs. This is currently a no-op change, and is forward compatible with the breaking change when it lands.A
showis also safer than ahidewhen exporting across package boundaries. Adding a new member to a library can be breaking, but is often treated as non-breaking. If a new member is added topackage:test_api/scaffolding.dartit will need to be manually added to the list to be usable frompackage:flutter_test, but we anyways want to add a CHANGELOG entry for user facing changes.