[tool] Improve using project files in build targets #166211

loic-sharma · 2025-03-30T00:26:13Z

The Flutter tool's build system executes targets that take inputs and produces outputs. Previously, targets would hardcode paths if they needed to use Flutter project files as inputs/outputs. For example:

class FooTarget extends Target {
  @override
  List<Source> get inputs => <Source>[
    Source.pattern('{PROJECT_DIR}/foo/bar'),
  ];
}

This is problematic as the FlutterProject is the source of truth for where a Flutter project's files are located:

If we change a project file's location, we need to update FlutterProject as well as any hardcoded target inputs/outputs.
Project files' location can be dynamic. For example, a Flutter app puts iOS files in the ios/ directory, but a Flutter module puts iOS files in the .ios/ directory. Targets need to duplicate FlutterProject's logic to determine the project file's location.

As a result, hardcoding project file paths in targets can be error-prone.

This introduces a new Source factory that lets you use the FlutterProject to create the source:

class FooTarget extends Target {
  @override
  List<Source> get inputs => <Source>[
    Source.fromProject((FlutterProject project) => project.fooFile),
  ];
}

Part of #163874

Next pull request: #165916

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

loic-sharma · 2025-03-30T00:29:59Z

packages/flutter_tools/lib/src/build_system/source.dart

@@ -222,12 +226,26 @@ class SourceVisitor implements ResolvedFiles {
    }
    sources.add(entity as File);
  }
+
+  void visitProjectSource(ProjectSourceBuilder builder, bool optional) {
+    final File source = builder(_project);


In the future, we could allow the builder to return Files or Directorys by changing its return type to FileSystemEntity. We don't have any scenarios that need this today, so I didn't implement this.

vashworth

Awesome improvement!

vashworth · 2025-03-31T18:42:13Z

packages/flutter_tools/lib/src/build_system/source.dart

+  /// The source is provided by a [FlutterProject].
+  ///
+  /// If [optional] is true, the file is not required to exist. In this case, it
+  /// is never resolved as an input.


Nit: Can you provide an example in the comment?

auto-submit · 2025-04-01T03:45:24Z

autosubmit label was removed for flutter/flutter/166211, because - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

…r/flutter#166211)

Roll Flutter from 05b5e7910544 to a0b1b3253416 (37 revisions) flutter/flutter@05b5e79...a0b1b32 2025-04-01 [email protected] Roll Dart SDK from b4d374ec59ec to 4e1f02bc704f (2 revisions) (flutter/flutter#166342) 2025-04-01 [email protected] Trim any text before osascript JSON response (flutter/flutter#166296) 2025-04-01 [email protected] [Gen-l10n] Add `Message.resourceId` and `locale` to all `L10nException` error messages (flutter/flutter#163654) 2025-04-01 [email protected] Add `--ignore-timeouts` flag for `flutter test` command (flutter/flutter#164437) 2025-04-01 [email protected] Update TESTOWNERS username (flutter/flutter#166191) 2025-04-01 [email protected] Roll Skia from 4b07443e6071 to 52cbb917fffd (4 revisions) (flutter/flutter#166329) 2025-04-01 [email protected] Roll Dart SDK from 6b07a09cbd2d to b4d374ec59ec (2 revisions) (flutter/flutter#166321) 2025-04-01 [email protected] [tool] Improve using project files in build targets (flutter/flutter#166211) 2025-04-01 [email protected] Rename FlRenderer to FlCompositorOpenGL (flutter/flutter#166037) 2025-04-01 [email protected] [engine, web_ui] Fix instances of library_private_types_in_public_api (flutter/flutter#166156) 2025-04-01 [email protected] Roll Dart SDK from 509faa921c95 to 6b07a09cbd2d (1 revision) (flutter/flutter#166301) 2025-04-01 [email protected] [Impeller] small cpu perf for text contents. (flutter/flutter#166199) 2025-04-01 [email protected] [android_engine_test] disable old HC mode tests. (flutter/flutter#166293) 2025-04-01 [email protected] [impeller] fixes diagonal antialiased lines (flutter/flutter#166298) 2025-04-01 [email protected] Roll Skia from 5f262bd2cbb4 to 4b07443e6071 (10 revisions) (flutter/flutter#166299) 2025-03-31 [email protected] [Impeller] Directly tessellate conics to linear path segments (flutter/flutter#166165) 2025-03-31 [email protected] [tool] Don't write the .flutter-plugins-dependencies file if it is unchanged (flutter/flutter#166164) 2025-03-31 [email protected] Move `.cxx` directory out of `android/app` (flutter/flutter#166277) 2025-03-31 [email protected] Fix typo in carousel.dart (flutter/flutter#164727) 2025-03-31 [email protected] Roll Dart SDK from c5fa06710bb6 to 509faa921c95 (1 revision) (flutter/flutter#166283) 2025-03-31 [email protected] Public nodes needing paint or layout (flutter/flutter#166148) 2025-03-31 [email protected] [Gen-l10n] Infer placeholder types on both templates and localizations (flutter/flutter#163690) 2025-03-31 [email protected] [Engine][iOS] Cancel animation when recieved `UIKeyboardWillHideNotification` with duration 0.0 (flutter/flutter#164884) 2025-03-31 [email protected] [fuchsia] Remove explicit LogSink and InspectSink routing and use dictionaries instead (flutter/flutter#162780) 2025-03-31 [email protected] Updated to latest AVD to Support Android 16 (API 36) (flutter/flutter#165926) 2025-03-31 [email protected] Feat: Add brightnessOf method for theme (flutter/flutter#163733) 2025-03-31 [email protected] Marks Linux_mokey new_gallery__crane_perf to be flaky (flutter/flutter#165964) 2025-03-31 [email protected] [ Tool ] Correctly select entrypoint target for web build from positional argument list (flutter/flutter#166260) 2025-03-31 [email protected] [Impeller] remove validation warning ignores. (flutter/flutter#166205) 2025-03-31 [email protected] [Impeller] handle shader ordering bug on macOS. (flutter/flutter#165937) 2025-03-31 [email protected] Fix CODEOWNERS for the iOS review team (flutter/flutter#166178) 2025-03-31 [email protected] Remove `<meta content="IE=Edge" http-equiv="X-UA-Compatible">` (flutter/flutter#166252) 2025-03-31 [email protected] Roll Dart SDK from b9c35e05feb5 to c5fa06710bb6 (1 revision) (flutter/flutter#166251) 2025-03-31 [email protected] Roll Skia from 418c68ea5ccb to 5f262bd2cbb4 (2 revisions) (flutter/flutter#166244) 2025-03-31 [email protected] Roll Skia from b6a3bbd1d153 to 418c68ea5ccb (1 revision) (flutter/flutter#166236) 2025-03-31 [email protected] [Impeller] fix min filter for GL external textures. (flutter/flutter#166224) 2025-03-31 [email protected] Roll Skia from 10f4cf9a817d to b6a3bbd1d153 (13 revisions) (flutter/flutter#166231) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose ...

…r#8985) Roll Flutter from 05b5e7910544 to a0b1b3253416 (37 revisions) flutter/flutter@05b5e79...a0b1b32 2025-04-01 [email protected] Roll Dart SDK from b4d374ec59ec to 4e1f02bc704f (2 revisions) (flutter/flutter#166342) 2025-04-01 [email protected] Trim any text before osascript JSON response (flutter/flutter#166296) 2025-04-01 [email protected] [Gen-l10n] Add `Message.resourceId` and `locale` to all `L10nException` error messages (flutter/flutter#163654) 2025-04-01 [email protected] Add `--ignore-timeouts` flag for `flutter test` command (flutter/flutter#164437) 2025-04-01 [email protected] Update TESTOWNERS username (flutter/flutter#166191) 2025-04-01 [email protected] Roll Skia from 4b07443e6071 to 52cbb917fffd (4 revisions) (flutter/flutter#166329) 2025-04-01 [email protected] Roll Dart SDK from 6b07a09cbd2d to b4d374ec59ec (2 revisions) (flutter/flutter#166321) 2025-04-01 [email protected] [tool] Improve using project files in build targets (flutter/flutter#166211) 2025-04-01 [email protected] Rename FlRenderer to FlCompositorOpenGL (flutter/flutter#166037) 2025-04-01 [email protected] [engine, web_ui] Fix instances of library_private_types_in_public_api (flutter/flutter#166156) 2025-04-01 [email protected] Roll Dart SDK from 509faa921c95 to 6b07a09cbd2d (1 revision) (flutter/flutter#166301) 2025-04-01 [email protected] [Impeller] small cpu perf for text contents. (flutter/flutter#166199) 2025-04-01 [email protected] [android_engine_test] disable old HC mode tests. (flutter/flutter#166293) 2025-04-01 [email protected] [impeller] fixes diagonal antialiased lines (flutter/flutter#166298) 2025-04-01 [email protected] Roll Skia from 5f262bd2cbb4 to 4b07443e6071 (10 revisions) (flutter/flutter#166299) 2025-03-31 [email protected] [Impeller] Directly tessellate conics to linear path segments (flutter/flutter#166165) 2025-03-31 [email protected] [tool] Don't write the .flutter-plugins-dependencies file if it is unchanged (flutter/flutter#166164) 2025-03-31 [email protected] Move `.cxx` directory out of `android/app` (flutter/flutter#166277) 2025-03-31 [email protected] Fix typo in carousel.dart (flutter/flutter#164727) 2025-03-31 [email protected] Roll Dart SDK from c5fa06710bb6 to 509faa921c95 (1 revision) (flutter/flutter#166283) 2025-03-31 [email protected] Public nodes needing paint or layout (flutter/flutter#166148) 2025-03-31 [email protected] [Gen-l10n] Infer placeholder types on both templates and localizations (flutter/flutter#163690) 2025-03-31 [email protected] [Engine][iOS] Cancel animation when recieved `UIKeyboardWillHideNotification` with duration 0.0 (flutter/flutter#164884) 2025-03-31 [email protected] [fuchsia] Remove explicit LogSink and InspectSink routing and use dictionaries instead (flutter/flutter#162780) 2025-03-31 [email protected] Updated to latest AVD to Support Android 16 (API 36) (flutter/flutter#165926) 2025-03-31 [email protected] Feat: Add brightnessOf method for theme (flutter/flutter#163733) 2025-03-31 [email protected] Marks Linux_mokey new_gallery__crane_perf to be flaky (flutter/flutter#165964) 2025-03-31 [email protected] [ Tool ] Correctly select entrypoint target for web build from positional argument list (flutter/flutter#166260) 2025-03-31 [email protected] [Impeller] remove validation warning ignores. (flutter/flutter#166205) 2025-03-31 [email protected] [Impeller] handle shader ordering bug on macOS. (flutter/flutter#165937) 2025-03-31 [email protected] Fix CODEOWNERS for the iOS review team (flutter/flutter#166178) 2025-03-31 [email protected] Remove `<meta content="IE=Edge" http-equiv="X-UA-Compatible">` (flutter/flutter#166252) 2025-03-31 [email protected] Roll Dart SDK from b9c35e05feb5 to c5fa06710bb6 (1 revision) (flutter/flutter#166251) 2025-03-31 [email protected] Roll Skia from 418c68ea5ccb to 5f262bd2cbb4 (2 revisions) (flutter/flutter#166244) 2025-03-31 [email protected] Roll Skia from b6a3bbd1d153 to 418c68ea5ccb (1 revision) (flutter/flutter#166236) 2025-03-31 [email protected] [Impeller] fix min filter for GL external textures. (flutter/flutter#166224) 2025-03-31 [email protected] Roll Skia from 10f4cf9a817d to b6a3bbd1d153 (13 revisions) (flutter/flutter#166231) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose ...

[tool] Improve using project files in build targets

5037c98

github-actions bot added tool Affects the "flutter" command-line tool. See also t: labels. team-ios Owned by iOS platform team labels Mar 30, 2025

loic-sharma mentioned this pull request Mar 30, 2025

[iOS/macOS] Add Xcode error if dev dependencies are incorrect #165916

Open

9 tasks

loic-sharma commented Mar 30, 2025

View reviewed changes

loic-sharma requested review from vashworth and bkonyi March 31, 2025 17:44

vashworth approved these changes Mar 31, 2025

View reviewed changes

Add example

a40ad32

loic-sharma requested a review from a team as a code owner March 31, 2025 22:47

loic-sharma added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 1, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 1, 2025

loic-sharma added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 1, 2025

auto-submit bot added this pull request to the merge queue Apr 1, 2025

Merged via the queue into flutter:master with commit a48a1f0 Apr 1, 2025
138 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 1, 2025

engine-flutter-autoroll mentioned this pull request Apr 1, 2025

Roll Flutter from 1d954f4e96bd to 70cd54c3fd13 (259 revisions) flutter/packages#8973

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 1, 2025

a48a1f07b [tool] Improve using project files in build targets (flutte…

9e868ab

…r/flutter#166211)

engine-flutter-autoroll mentioned this pull request Apr 1, 2025

Roll Flutter from 1d954f4e96bd to 0befaaafc952 (260 revisions) flutter/packages#8974

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 1, 2025

a48a1f07b [tool] Improve using project files in build targets (flutte…

4f6aff3

…r/flutter#166211)

engine-flutter-autoroll mentioned this pull request Apr 1, 2025

Roll Flutter from 1d954f4e96bd to dbef1314b186 (261 revisions) flutter/packages#8976

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 1, 2025

a48a1f07b [tool] Improve using project files in build targets (flutte…

2e2f23b

…r/flutter#166211)

engine-flutter-autoroll mentioned this pull request Apr 1, 2025

Roll Flutter from 1d954f4e96bd to a0b1b3253416 (262 revisions) flutter/packages#8977

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 1, 2025

a48a1f07b [tool] Improve using project files in build targets (flutte…

b1a172a

…r/flutter#166211)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 2, 2025

a48a1f07b [tool] Improve using project files in build targets (flutte…

2f64066

…r/flutter#166211)

This was referenced Apr 2, 2025

Roll Flutter from 05b5e7910544 to a0b1b3253416 (37 revisions) flutter/packages#8983

Closed

Roll Flutter from 05b5e7910544 to a0b1b3253416 (37 revisions) flutter/packages#8985

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 2, 2025

a48a1f07b [tool] Improve using project files in build targets (flutte…

acb4e11

…r/flutter#166211)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[tool] Improve using project files in build targets #166211

[tool] Improve using project files in build targets #166211

loic-sharma commented Mar 30, 2025

loic-sharma Mar 30, 2025 •

edited

Loading

vashworth left a comment

vashworth Mar 31, 2025

loic-sharma Mar 31, 2025

auto-submit bot commented Apr 1, 2025

[tool] Improve using project files in build targets #166211

[tool] Improve using project files in build targets #166211

Conversation

loic-sharma commented Mar 30, 2025

Pre-launch Checklist

loic-sharma Mar 30, 2025 • edited Loading

Choose a reason for hiding this comment

vashworth left a comment

Choose a reason for hiding this comment

vashworth Mar 31, 2025

Choose a reason for hiding this comment

loic-sharma Mar 31, 2025

Choose a reason for hiding this comment

auto-submit bot commented Apr 1, 2025

loic-sharma Mar 30, 2025 •

edited

Loading