Skip to content

Commit 9108903

Browse files
authored
Update CONTRIBUTING doc for DWDS (#2429)
1 parent 635b0d9 commit 9108903

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

dwds/CONTRIBUTING.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@
88
1. Add an alias to your `.bashrc`/`.zshrc` for Flutter Tools:
99

1010
```
11-
alias flutter_tools='/YOUR_PATH/flutter/bin/dart --observe /YOUR_PATH/flutter/packages/flutter_tools/bin/flutter_tools.dart'
11+
alias flutter_tools_debug='/YOUR_PATH/flutter/bin/dart --observe /YOUR_PATH/flutter/packages/flutter_tools/bin/flutter_tools.dart'
12+
alias flutter_tools='/YOUR_PATH/flutter/bin/dart /YOUR_PATH/flutter/packages/flutter_tools/bin/flutter_tools.dart'
1213
```
1314

1415
> **Explanation:**
1516
>
1617
> - `/PATH_TO_YOUR_FLUTTER_REPO/bin/dart`: This is the path to the Dart SDK that
1718
> Flutter Tools uses
18-
> - `--observe`: This flag specifies we want a Dart DevTools URL for debugging
19+
> - `--observe`: This flag specifies we want a Dart DevTools URL for debugging.
1920
> - `/PATH_TO_YOUR_FLUTTER_REPO/packages/flutter_tools/bin/flutter_tools.dart`:
2021
> This is the path to Flutter Tools itself
2122
>
@@ -31,17 +32,29 @@ alias flutter_tools='/YOUR_PATH/flutter/bin/dart --observe /YOUR_PATH/flutter/pa
3132
path: /YOUR_PATH/dwds
3233
```
3334

35+
Note: This is even easier if you create a `pubspec_overrides.yaml` file in the `flutter_tools` directory, and then git-ignore it. This way you don't have to worry about committing your DWDS override.
36+
3437
4. Choose a Flutter app to run (eg, the
3538
[old](https://github.com/flutter/flutter/tree/master/dev/integration_tests/flutter_gallery)
3639
or [new](https://github.com/flutter/gallery) Flutter Gallery apps).
3740
1. From the Flutter app repo, run your local Flutter Tools with alias you
3841
defined in step #2:
3942

43+
If you want a DevTools URL:
44+
45+
```
46+
flutter_tools_debug run -d chrome
47+
```
48+
49+
If you don't want a DevTools URL:
50+
4051
```
4152
flutter_tools run -d chrome
4253
```
4354

44-
6. Open up the **first** Dart DevTools URL you see printed:
55+
Note: `flutter_tools_debug` can be a bit of a pain, because the app starts paused and you have to first open the DevTools URL and resume before you can do anything. Therefore, when you don't need to set breakpoints you should run `flutter_tools` instead of `flutter_tools_debug`.
56+
57+
6. If running with `flutter_tools_debug`, open up the **first** Dart DevTools URL you see printed:
4558

4659
```
4760
...

0 commit comments

Comments
 (0)