mirror of https://github.com/flutter/flutter synced 2024-10-13 11:42:54 +00:00

History

Jonah Williams 2526ef1235 [flutter_tools] update size analysis (#63617 )		2020-08-13 11:28:52 -07:00
..
bin	Remove unused `l` and `--isolate-filter` tools (#63336 )	2020-08-10 10:51:04 -07:00
doc	Return devtools serve response instead of printing (#62702 )	2020-08-03 10:26:12 -07:00
gradle	[flutter_tools] ensure x64 is built if target-platforms is not specified (#62096 )	2020-07-24 15:33:13 -07:00
ide_templates/intellij	Move stocks example app into dev/benchmarks/test_apps (#49559 )	2020-01-30 09:31:07 -08:00
lib	[gen_l10n] Absolute project path parameter (#63368 )	2020-08-13 05:11:05 -07:00
schema	[Material] Updated icons and fonts (#61778 )	2020-07-24 15:41:13 -07:00
static	Implement screenshot test for flutter web. (#45530 )	2019-12-06 14:25:39 -08:00
templates	Fix App.framework path in Podfile (#63412 )	2020-08-12 13:36:12 -07:00
test	[gen_l10n] Absolute project path parameter (#63368 )	2020-08-13 05:11:05 -07:00
tool	[flutter_tools] check in script for generating per library unit coverage (#61996 )	2020-07-22 18:40:12 -07:00
analysis_options.yaml	Reland: [flutter_tool] Where possible, catch only subtypes of Exception (#52021 )	2020-03-06 10:22:12 -08:00
build.yaml	Reland support flutter test on platform chrome (#33859 )	2019-06-05 15:27:49 -07:00
dart_test.yaml	Clean up test infrastructure (#43030 )	2019-10-18 16:35:39 -07:00
pubspec.yaml	[flutter_tools] update size analysis (#63617 )	2020-08-13 11:28:52 -07:00
README.md	✒ Spell Check All `.md` Files Related to Flutter 💙 (#61564 )	2020-07-22 18:23:47 -07:00

README.md

Flutter Tools

This section of the Flutter repository contains the command line developer tools for building Flutter applications.

Working on Flutter Tools

Be sure to follow the instructions on CONTRIBUTING.md to set up your development environment. Further, familiarize yourself with the style guide, which we follow.

Setting up

First, ensure that the Dart SDK and other necessary artifacts are available by invoking the Flutter Tools wrapper script. In this directory run:

$ ../../bin/flutter --version

Running the Tool

To run Flutter Tools from source, in this directory run:

$ ../../bin/cache/dart-sdk/bin/dart bin/flutter_tools.dart

followed by command-line arguments, as usual.

Running the analyzer

To run the analyzer on Flutter Tools, in this directory run:

$ ../../bin/flutter analyze

Writing tests

As with other parts of the Flutter repository, all changes in behavior must be tested. Tests live under the test/ subdirectory.

Hermetic unit tests of tool internals go under test/general.shard.
Tests of tool commands go under test/commands.shard. Hermetic tests go under its hermetic/ subdirectory. Non-hermetic tests go under its permeable sub-directory.
Integration tests (e.g. tests that run the tool in a subprocess) go under test/integration.shard.

In general, the tests for the code in a file called file.dart should go in a file called file_test.dart in the subdirectory that matches the behavior of the test.

We measure test coverage post-submit. A change that deletes code might decrease test coverage, however, most changes that add new code should aim to increase coverage. In particular, the coverage of the diff should be close to the average coverage, and should ideally be better.

Running the tests

To run the tests in the test/ directory, first ensure that there are no connected devices. Then, in this directory run:

$ ../../bin/cache/dart-sdk/bin/pub run test

The tests in test/integration.shard are slower to run than the tests in test/general.shard. To run only the tests in test/general.shard, in this directory run:

$ ../../bin/cache/dart-sdk/bin/pub run test test/general.shard

To run the tests in a specific file, run:

$ ../../bin/cache/dart-sdk/bin/pub run test test/general.shard/utils_test.dart

Forcing snapshot regeneration

To force the Flutter Tools snapshot to be regenerated, delete the following files:

$ rm ../../bin/cache/flutter_tools.stamp ../../bin/cache/flutter_tools.snapshot