Consider 'library_private_types_in_public_api' for inclusion

[mit-mit]

We had initially selected avoid_private_typedef_functions for inclusion in the recommended lints, but removed it after reconsideration in dart-archive/linter#2517. We have since added library_private_types_in_public_api.

We should decide if library_private_types_in_public_api should be included in the recommended lints.

[goderbauer]

I've enabled this lint in the Flutter code base a few days ago and I think it is a win there: flutter/flutter#81578.

There's one caveat to the lint: It is still possible to reference types in your public API where the referenced type itself is not actually exported in your public API. For Flutter this isn't a problem (we just export everything that's public), but something to be aware of. Still, even with that not having private types in your API seems like a win to me.

[pq]

/fyi @bwilkerson

[goderbauer]

We need to update the stful macro in intellij to not trigger this lint: flutter/flutter-intellij#5962

If VSCode has a similar macro, it would need updating as well.

[goderbauer]

VSCode issue tracked here: Dart-Code/Dart-Code#3827

[DanTup]

This is now fixed for VS Code, will ship in the next release (likely the start of March).

[goderbauer]

@DanTup Thanks!

The IntelliJ plugin has also been updated.