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

Potential library path conflicts #3881

Open
srawlins opened this issue Sep 13, 2024 · 0 comments
Open

Potential library path conflicts #3881

srawlins opened this issue Sep 13, 2024 · 0 comments
Labels
P3 A lower priority bug or feature request type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@srawlins
Copy link
Member

The code that determines the path of the HTML file for a library is mostly contained in Library.dirName, which quickly branches on whether a library is anonymous. The Flutter SDK uses library directives with names, so they end up with pretty paths at api.flutter.dev:

However, all of the other package docs that are also located at api.flutter.dev have much longer paths, seeming to use the route for anonymous libraries:

And then some other paths that are more like the Flutter SDK libraries:

Anyways, since Flutter just bundles together a few dozen dependencies at api.flutter.dev, whose library names are not controlled by Flutter, there is real potential for collisions. And the names that are preferred for api.flutter.dev are the ones with potential collisions, e.g. "animation/animation-library.html". I can easily imagine two libraries from different packages choosing the name, "async" or "element" or "testing" for a library.

@srawlins srawlins added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) P2 A bug or feature request we're likely to work on P3 A lower priority bug or feature request and removed P2 A bug or feature request we're likely to work on labels Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 A lower priority bug or feature request type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

1 participant