| commit | b810061511cdcedc642afe822fcccfe494c944b1 | [log] [tgz] |
|---|---|---|
| author | Ben Konyi <bkonyi@google.com> | Thu Jul 03 14:09:23 2025 -0400 |
| committer | dart-internal-monorepo <dart-internal-monorepo@dart-ci-internal.iam.gserviceaccount.com> | Thu Jul 03 11:43:50 2025 -0700 |
| tree | 70024e115b5f52a56fd4d6ca9b9e597b8bb6b1fa | |
| parent | 797401e5033ee013d76c101ea497be1eaaa44f9e [diff] |
[ Widget Previews ] Add support for Pub Workspaces (#171538) Updates the widget previewer to properly handle previews defined across a workspace. This is effectively equivalent to displaying previews from multiple individual projects, which required a fairly significant rework to properly support: - resolving asset paths to the right project - loading assets across projects in the workspace - tracking changes to pubspec.yaml files across the workspace While making this change, it became apparent that we don't need to explicitly list the assets from the various projects explicitly in the scaffold's pubspec.yaml as they're automatically pulled in by adding those project's as dependencies and using the `package/$ASSET_PATH` format to load the assets from the scaffold. This allowed for the removal of a significant amount of logic related to building the scaffold's pubspec. Fixes https://github.com/flutter/flutter/issues/169268 https://dart.googlesource.com/external/github.com/flutter/flutter/+/750b87f551714d72a628ec8f4720d96de6f177bb
Monorepo is:
With depot_tools installed and on your path, create a directory for your monorepo checkout and run these commands to create a gclient solution in that directory:
mkdir monorepo cd monorepo gclient config --unmanaged https://dart.googlesource.com/monorepo gclient sync -D
This gives you a checkout in the monorepo directory that contains:
monorepo/ DEPS - the DEPS used for this gclient checkout commits.json - the pinned commits for Dart, flutter/engine, and flutter/flutter tools/ - scripts used to create monorepo DEPS engine/src/ - the flutter/buildroot repo flutter/ - the flutter/engine repo out/ - the build directory, where Flutter engine builds are created third_party/ - Flutter dependencies checked out by DEPS dart/ - the Dart SDK checkout. third_party - Dart dependencies, also used by Flutter flutter/ - the flutter/flutter repo
Flutter's instructions for building the engine are at Compiling the engine
They can be followed closely, with a few changes:
goma_ctl ensure_start is sufficient.Example build commands that work on linux:
MONOREPO_PATH=$PWD if [[ ! $PATH =~ (^|:)$MONOREPO_PATH/flutter/bin(:|$) ]]; then PATH=$MONOREPO_PATH/flutter/bin:$PATH fi export GOMA_DIR=$(dirname $(command -v gclient))/.cipd_bin goma_ctl ensure_start pushd engine/src flutter/tools/gn --goma --no-prebuilt-dart-sdk --unoptimized --full-dart-sdk autoninja -C out/host_debug_unopt popd
The Flutter commands used to build and run apps will use the locally built Flutter engine and Dart SDK, instead of the one downloaded by the Flutter tool, if the --local-engine option is provided.
For example, to build and run the Flutter spinning square sample on the web platform,
MONOREPO_PATH=$PWD cd flutter/examples/layers flutter --local-engine=host_debug_unopt \ -d chrome run widgets/spinning_square.dart cd $MONOREPO_PATH
To build for desktop, specify the desktop platform device in flutter run as -d macos or -d linux or -d windows. You may also need to run the command
flutter create --platforms=windows,macos,linux
on existing apps, such as sample apps. New apps created with flutter create already include these support files. Details of desktop support are at Desktop Support for Flutter
Tests in the Flutter source tree can be run with the flutter test command, run in the directory of a package containing tests. For example:
MONOREPO_PATH=$PWD cd flutter/packages/flutter flutter test --local-engine=host_debug_unopt cd $MONOREPO_PATH
Please file an issue or email the dart-engprod team with any problems with or questions about using monorepo.
We will update this documentation to address them.
flutter commands may download the engine and Dart SDK files for the configured channel, even though they will be using the local engine and its SDK.gclient sync needs to be run in an administrator session, because some installed dependencies create symlinks.