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

[srawlins]

As @goderbauer found earlier, when removing the name portion of a library directive, e.g. s/library widgets;/library; changes the URI of the generated docs for the widgets library.

It turns out this should have worked; there is code in Library.dirName that picks a "dir name" for an anonymous library. That code should strip the package prefix from libraries in the "default package." When generating docs for the Flutter SDK, the Flutter "package" is considered "default," but it's name is capitalized: "Flutter." Because of this, the stripping behavior does not work.

This issue prevents the flutter SDK from adopting the unnecessary_library_names lint rule.

[goderbauer]

I just gave this another try in flutter/flutter#159445 with dartdoc 8.3.0 and I am running into the same problem:

Generated URL: package-flutter_driver_flutter_driver/FlutterDriver/FlutterDriver.connectedTo.html
Expected URL: flutter_driver/FlutterDriver/FlutterDriver.connectedTo.html

[srawlins]

I cannot reproduce :( Can you double check? I just loaded up 8.3.0 locally, and served the docs with

dart pub global run dhttpd --port 8000 and see the following URL:

Are you referring to a specific link to FluttterDriver.connectTo? I found this URL via searching for 'FlutterDriver.connectTo'.

[goderbauer]

@srawlins Did you remove the library name from packages/flutter_driver/lib/flutter_driver.dart [1] before running dartdoc? With the library name (currently checked in) it does not reproduce, without the library name (code is in flutter/flutter#159445) I can reproduce it locally and also on CI [2] with:

dartdoc version: 8.3.0
flutter version: 3.27.0-1.0.pre.643

Executing: (cd "/b/s/w/ir/x/w/flutter/dev/docs" ; /b/s/w/ir/x/w/flutter/bin/flutter pub global run --enable-asserts dartdoc --output /b/s/w/ir/x/w/flutter/dev/docs/doc/flutter --allow-tools --no-validate-links --link-to-source-excludes /b/s/w/ir/x/w/flutter/bin/cache --link-to-source-root /b/s/w/ir/x/w/flutter --link-to-source-uri-template [https://github.com/flutter/flutter/blob/main/%f%#L%l](https://github.com/flutter/flutter/blob/main/%25f%25#L%25l)% --inject-html --use-base-href --header /b/s/w/ir/x/w/flutter/dev/docs/styles.html --header /b/s/w/ir/x/w/flutter/dev/docs/analytics-header.html --header /b/s/w/ir/x/w/flutter/dev/docs/survey.html --header /b/s/w/ir/x/w/flutter/dev/docs/snippets.html --header /b/s/w/ir/x/w/flutter/dev/docs/opensearch.html --footer /b/s/w/ir/x/w/flutter/dev/docs/analytics-footer.html --footer-text /b/s/w/ir/x/w/flutter/dev/docs/footer.html --allow-warnings-in-packages Flutter,platform_integration,flutter,flutter_localizations,integration_test,flutter_web_plugins,flutter_goldens,flutter_test,flutter_driver --exclude-packages analyzer,args,barback,csslib,flutter_goldens,flutter_goldens_client,front_end,fuchsia_remote_debug_protocol,glob,html,http_multi_server,io,isolate,js,kernel,logging,mime,mockito,node_preamble,plugin,shelf,shelf_packages_handler,shelf_static,shelf_web_socket,utf,watcher,yaml --exclude dart:io/network_policy.dart,package:Flutter/temp_doc.dart,package:http/browser_client.dart,package:intl/intl_browser.dart,package:matcher/mirror_matchers.dart,package:quiver/io.dart,package:quiver/mirrors.dart,package:vm_service_client/vm_service_client.dart,package:web_socket_channel/html.dart --favicon /b/s/w/ir/x/w/flutter/dev/docs/favicon.ico --package-order flutter,Dart,platform_integration,flutter_test,flutter_driver --auto-include-dependencies)
dartdoc:stdout: Documenting Flutter...

<lines omitted for brevity>

Unhandled exception:
Exception: Missing "/b/s/w/ir/x/w/flutter/dev/docs/doc/flutter/flutter_driver/FlutterDriver/FlutterDriver.connectedTo.html", which probably means the documentation failed to build correctly.
#0      DartdocGenerator._sanityCheckDocs (file:///b/s/w/ir/x/w/flutter/dev/tools/create_api_docs.dart:748:9)
#1      DartdocGenerator.generateDartdoc (file:///b/s/w/ir/x/w/flutter/dev/tools/create_api_docs.dart:696:5)
<asynchronous suspension>
#2      main (file:///b/s/w/ir/x/w/flutter/dev/tools/create_api_docs.dart:150:3)
<asynchronous suspension>

[1] https://github.com/flutter/flutter/pull/159445/files#diff-4175a2d5dc31762727066811624f7d7c4a9127cba08df196fcb184bb4acc2833
[2] https://logs.chromium.org/logs/flutter/buildbucket/cr-buildbucket/8730254807617968321/+/u/run_test.dart_for_docs_shard_and_subshard_None/stdout

[srawlins]

Did you remove the library name from packages/flutter_driver/lib/flutter_driver.dart [1] before running dartdoc?

I did not! 🤣 thanks for the tip 😁