Skip to content

Conversation

@srawlins
Copy link
Contributor

@srawlins srawlins commented Jul 8, 2024

There is a... restriction in dartdoc, such that a library which is @docImported in one library, must be otherwise regularly imported in some other library. Without this case, dartdoc gets a bit lost about where the doc-imported library is.

Combine this restriction with analyzer's restriction that it doesn't super duper handle configuration imports. Since _goldens_io.dart is the "primary" import in all other files, and _goldens_web.dart is the "configured" import, we must only doc-import _goldens_io.dart.

There is a... restriction in dartdoc, such that a library which is `@docImport`ed in one library, must be otherwise regularly imported in some other library. Without this case, dartdoc gets a bit lost about where the doc-imported library is.

Combine this restriction with analyzer's restriction that it doesn't super duper handle configuration imports. Since `_goldens_io.dart` is the "primary" import in all other files, and `_goldens_web.dart` is the "configured" import, we must only doc-import `_goldens_io.dart`.
@github-actions github-actions bot added a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels. labels Jul 8, 2024
@srawlins srawlins requested a review from goderbauer July 8, 2024 15:10
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM

@goderbauer
Copy link
Member

Will there be some kind of a machinery (lint, etc) in place to warn against these "incorrect" imports?

@srawlins
Copy link
Contributor Author

srawlins commented Jul 8, 2024

Dartdoc will fail, as it is doing in dartdoc's CI at present :D

@srawlins srawlins merged commit 00d49b2 into master Jul 8, 2024
@srawlins srawlins deleted the srawlins-patch-1 branch July 8, 2024 16:55
@srawlins
Copy link
Contributor Author

srawlins commented Jul 8, 2024

Other than that, no planned mechanisms. I don't think we can add a performant lint rule, as the issue is how sensitive dartdoc is to these things... maybe there is a specific bug in analyzer's handling of configurable imports that we can fix.

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 8, 2024
victorsanni pushed a commit to victorsanni/flutter that referenced this pull request Jul 8, 2024
…tter#151390)

There is a... restriction in dartdoc, such that a library which is
`@docImport`ed in one library, must be otherwise regularly imported in
some other library. Without this case, dartdoc gets a bit lost about
where the doc-imported library is.

Combine this restriction with analyzer's restriction that it doesn't
super duper handle configuration imports. Since `_goldens_io.dart` is
the "primary" import in all other files, and `_goldens_web.dart` is the
"configured" import, we must only doc-import `_goldens_io.dart`.
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 9, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 9, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 9, 2024
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Jul 9, 2024
flutter/flutter@fafd67d...5103d75

2024-07-09 [email protected] [tool] Remove some usages of deprecated usage package (flutter/flutter#151359)
2024-07-09 [email protected] Write the package config location to the test bootstrap. (flutter/flutter#150440)
2024-07-09 [email protected] [deps] Roll dart-lang/native packages (flutter/flutter#151403)
2024-07-08 [email protected] [tool] make `testUsingContext` provide a `Stdio` (with `hasTerminal` unset) override by default (flutter/flutter#151357)
2024-07-08 [email protected] Make `FittedBox` not throw when child has zero size. (flutter/flutter#150430)
2024-07-08 [email protected] Update `DataTable` documentation (flutter/flutter#151356)
2024-07-08 [email protected] `MaterialState` â�� `WidgetState` in documentation (flutter/flutter#151376)
2024-07-08 [email protected] [ios]A typical news app benchmark with bottom ad banner (flutter/flutter#150991)
2024-07-08 [email protected] Re-enable `SemanticsAction.focus` matchers (flutter/flutter#150990)
2024-07-08 [email protected] Added SliverFloatingHeader.snapMode (flutter/flutter#151289)
2024-07-08 [email protected] Factor out deprecated names in example code (flutter/flutter#151374)
2024-07-08 [email protected] Add cedric vanden bosch to authors (flutter/flutter#151313)
2024-07-08 [email protected] Roll Packages from 97bad7e to 14341d1 (5 revisions) (flutter/flutter#151417)
2024-07-08 [email protected] Update doc-import to primary configured import, _goldens_io.dart (flutter/flutter#151390)
2024-07-08 [email protected] [Reland] - Enable `explicitChildNodes` for the `AlertDialog` content (flutter/flutter#149597)
2024-07-08 [email protected] Add tests for material_state_border_side.0_test.dart (flutter/flutter#151089)
2024-07-08 [email protected] Roll Flutter Engine from ca79a56a66d7 to 69075e7e87d4 (1 revision) (flutter/flutter#151393)
2024-07-08 [email protected] Add tests for action_listener.0.dart (flutter/flutter#150606)
2024-07-07 [email protected] Roll Flutter Engine from 5ca3b856ee5a to ca79a56a66d7 (1 revision) (flutter/flutter#151387)
2024-07-06 [email protected] Roll Flutter Engine from 3600ec613a00 to 5ca3b856ee5a (1 revision) (flutter/flutter#151378)
2024-07-06 [email protected] Roll Flutter Engine from d1ebc5fde630 to 3600ec613a00 (1 revision) (flutter/flutter#151377)
2024-07-06 [email protected] Roll Flutter Engine from e6b09697df1a to d1ebc5fde630 (1 revision) (flutter/flutter#151362)
2024-07-05 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.3.3 to 4.3.4 (flutter/flutter#151354)
2024-07-05 [email protected] Roll Flutter Engine from 4ee09d3b7f3b to e6b09697df1a (2 revisions) (flutter/flutter#151352)
2024-07-05 [email protected] Add tests for color_filtered.0.dart example. (flutter/flutter#151064)
2024-07-05 [email protected] de-duplicate code in analyze.dart (flutter/flutter#151279)
2024-07-05 [email protected] Roll Packages from 754de19 to 97bad7e (1 revision) (flutter/flutter#151350)

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
Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants