Skip to content
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

Strip the enclosing package's lower-case name from a library's dir name #3883

Merged
merged 1 commit into from
Sep 16, 2024

Conversation

srawlins
Copy link
Member

@srawlins srawlins commented Sep 15, 2024

Fixes #3882

I wish I could write a unit test for this fix but it would be a lot of work, and I fear making too small a unit test (like literally just mocking out a package name to be 'Flutter' and basically just testing toLowerCase) would be unhelpful. To make a less mock-y test, with a real SDK-provided 'Flutter' package, and documenting dependencies, and running dartdoc how Flutter does, would be fragile and very complex.

In any case, I did manually check this fix:

  1. Run dart tool/task.dart doc flutter; see that the generated HTML has the flutter/widgets/widgets-library.html path for the widgets library.
  2. Edit the flutter checkout that the above command created, in a temp space, to have an unnamed library.
  3. Re-run the create_api_docs.dart command that is printed out in the first step; see that the generated HTML still has the correct path.

  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

@srawlins
Copy link
Member Author

Ready for review, @dart-lang/analyzer-team

@srawlins srawlins merged commit 526dbd5 into dart-lang:main Sep 16, 2024
7 checks passed
@srawlins srawlins deleted the lower-case-package-name branch September 16, 2024 01:26
copybara-service bot pushed a commit to dart-lang/sdk that referenced this pull request Sep 23, 2024
Revisions updated by `dart tools/rev_sdk_deps.dart`.

dartdoc (https://github.com/dart-lang/dartdoc/compare/8100ccf..526dbd5):
  526dbd55  2024-09-15  Sam Rawlins  Strip the enclosing package's lower-case name from a library's dir name (dart-lang/dartdoc#3883)
  98dd9dad  2024-09-13  Sam Rawlins  Add output-size info to the '--stats' flag on various tasks. (dart-lang/dartdoc#3879)
  090b05ba  2024-09-13  Sam Rawlins  Bump to 8.2.0 (dart-lang/dartdoc#3880)
  0a529762  2024-09-12  Sam Rawlins  Fix search which is not using canonical libraries as enclosing elements (dart-lang/dartdoc#3877)
  d4dff9a4  2024-09-12  Konstantin Scheglov  Stop using 'augmented' from the element model. (dart-lang/dartdoc#3878)
  d6b865f9  2024-09-11  Sam Rawlins  Support multiple partial calls from a single template (dart-lang/dartdoc#3873)
  25c9edf3  2024-09-10  Parker Lougheed  Standardize to newer SDK APIs (dart-lang/dartdoc#3872)
  b61de2f2  2024-09-10  Sam Rawlins  Clean up some sorting, naming, and doc nits (dart-lang/dartdoc#3876)
  55ce1164  2024-09-10  Sam Rawlins  Use latest language version for DartFormatter (dart-lang/dartdoc#3875)
  2a262818  2024-09-10  Sam Rawlins  Comply with analyzer 6.9.0 APIs (dart-lang/dartdoc#3874)
  ca98b898  2024-09-09  Sam Rawlins  Include extension members on the extended type's page (dart-lang/dartdoc#3863)

mockito (https://github.com/dart-lang/mockito/compare/d0fda0c..b66be81):
  b66be81  2024-09-13  Googler  Migration for analyzer APIs.

stack_trace (https://github.com/dart-lang/stack_trace/compare/090d3d1..5b82965):
  5b82965  2024-09-19  Ömer Sinan Ağacan  Relax URI matching in V8 Wasm frame regex (dart-lang/stack_trace#161)
  9b1ed4f  2024-09-19  Ömer Sinan Ağacan  Add support for parsing Wasm stack frames of Chrome (V8), Firefox, Safari (dart-lang/stack_trace#159)
  d38eee8  2024-09-17  Ömer Sinan Ağacan  Fix analysis issues (dart-lang/stack_trace#160)

test (https://github.com/dart-lang/test/compare/9a2d155..22835e2):
  22835e2e  2024-09-13  Nate Bosch  Add support for multiple full paths on macos (dart-lang/test#2276)

web (https://github.com/dart-lang/web/compare/933a37d..d8549a3):
  d8549a3  2024-09-13  Srujan Gaddam   Add a generate-all flag to emit all bindings (dart-lang/web#302)

Change-Id: Ib07e4c0eda9c8ea180ef989c7d9cf20c390457e8
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/386260
Commit-Queue: Konstantin Shcheglov <[email protected]>
Auto-Submit: Devon Carew <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>
FMorschel pushed a commit to FMorschel/sdk that referenced this pull request Sep 25, 2024
Revisions updated by `dart tools/rev_sdk_deps.dart`.

dartdoc (https://github.com/dart-lang/dartdoc/compare/8100ccf..526dbd5):
  526dbd55  2024-09-15  Sam Rawlins  Strip the enclosing package's lower-case name from a library's dir name (dart-lang/dartdoc#3883)
  98dd9dad  2024-09-13  Sam Rawlins  Add output-size info to the '--stats' flag on various tasks. (dart-lang/dartdoc#3879)
  090b05ba  2024-09-13  Sam Rawlins  Bump to 8.2.0 (dart-lang/dartdoc#3880)
  0a529762  2024-09-12  Sam Rawlins  Fix search which is not using canonical libraries as enclosing elements (dart-lang/dartdoc#3877)
  d4dff9a4  2024-09-12  Konstantin Scheglov  Stop using 'augmented' from the element model. (dart-lang/dartdoc#3878)
  d6b865f9  2024-09-11  Sam Rawlins  Support multiple partial calls from a single template (dart-lang/dartdoc#3873)
  25c9edf3  2024-09-10  Parker Lougheed  Standardize to newer SDK APIs (dart-lang/dartdoc#3872)
  b61de2f2  2024-09-10  Sam Rawlins  Clean up some sorting, naming, and doc nits (dart-lang/dartdoc#3876)
  55ce1164  2024-09-10  Sam Rawlins  Use latest language version for DartFormatter (dart-lang/dartdoc#3875)
  2a262818  2024-09-10  Sam Rawlins  Comply with analyzer 6.9.0 APIs (dart-lang/dartdoc#3874)
  ca98b898  2024-09-09  Sam Rawlins  Include extension members on the extended type's page (dart-lang/dartdoc#3863)

mockito (https://github.com/dart-lang/mockito/compare/d0fda0c..b66be81):
  b66be81  2024-09-13  Googler  Migration for analyzer APIs.

stack_trace (https://github.com/dart-lang/stack_trace/compare/090d3d1..5b82965):
  5b82965  2024-09-19  Ömer Sinan Ağacan  Relax URI matching in V8 Wasm frame regex (dart-lang/stack_trace#161)
  9b1ed4f  2024-09-19  Ömer Sinan Ağacan  Add support for parsing Wasm stack frames of Chrome (V8), Firefox, Safari (dart-lang/stack_trace#159)
  d38eee8  2024-09-17  Ömer Sinan Ağacan  Fix analysis issues (dart-lang/stack_trace#160)

test (https://github.com/dart-lang/test/compare/9a2d155..22835e2):
  22835e2e  2024-09-13  Nate Bosch  Add support for multiple full paths on macos (dart-lang/test#2276)

web (https://github.com/dart-lang/web/compare/933a37d..d8549a3):
  d8549a3  2024-09-13  Srujan Gaddam   Add a generate-all flag to emit all bindings (dart-lang/web#302)

Change-Id: Ib07e4c0eda9c8ea180ef989c7d9cf20c390457e8
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/386260
Commit-Queue: Konstantin Shcheglov <[email protected]>
Auto-Submit: Devon Carew <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>
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.

Names of anonymous libraries in 'Flutter' package are not stripped of 'package' prefix
2 participants