Skip to content

Commit d86f0e2

Browse files
jonahwilliamscommit-bot@chromium.org
authored andcommitted
[frontend_server] add API stability documentatioon
Document some of the API stability guarantees that are required for the command line API of the frontend_server binary. This will allow package:test and the webdev CLI to begin using the frontend_server Change-Id: I4bf05757c527e491b1059489b5dda53dfda876a4 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/174840 Reviewed-by: Alexander Aprelev <aam@google.com> Commit-Queue: Jonah Williams <jonahwilliams@google.com>
1 parent b67a585 commit d86f0e2

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

pkg/frontend_server/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
The frontend_server package is used by both the flutter command line tool and the frontend_server_client package (used by webdev and package:test).
2+
3+
## API Stability
4+
5+
Changes to the command line API or behavior should be tested against the follwing test suites (in addition to normal HHH testing):
6+
* flutter_tools: https://github.com/flutter/flutter/tree/master/packages/flutter_tools
7+
* frontend_server_client: https://github.com/dart-lang/webdev/tree/master/frontend_server_client
8+
9+
Otherwise these changes will need to be carefully coordinated with the flutter tooling and frontend_server_client teams.
10+
11+
This API stability does not cover any of the source code APIs.
12+
13+
14+
### Stable subset
15+
16+
* The frontend_server kernel compilation and expression evaluation for kernel should be considered "stable".
17+
* The frontend_server JavaScript compilation is semi-stable, but clients should anticipate coordinated breaking changes in the future.
18+
* The frontend_server JavaScript expression evaluation is experimental and is expected to change significantly from Dec 2020 through the end of 2021.
19+
* Specific flags like the --flutter-widget-cache may be added for experimentation and should not be considered stable.

0 commit comments

Comments
 (0)