[native_assets_cli] Document the protocol

dart-lang / native

Dart packages related to FFI and native assets bundling.

BSD 3-Clause "New" or "Revised" License

115 stars 40 forks source link

[native_assets_cli] Document the protocol #95

Open dcharkes opened 1 year ago

dcharkes commented 1 year ago

Currently, the protocol between the Dart (and Flutter) SDK and packages' build.dart is specified by its implementation in package:native_assets_cli. This package also provides a way to parse and unparse the protocol.

@jonasfj mentioned it could be that the community likes to reimplement the protocol in another package. For this, we would need to specify the protocol (in a markdown file for example).

jonasfj commented 1 year ago

It also makes it easier to track if changes are breaking or not, and forces you to be intentional about what the Dart SDK requires, and what is an implementation detail added for easy debugging.