You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updates for developing with a local DevTools version (#8017)
This PR:
- Updates the CONTRIBUTING docs to include instructions for how to run
IntelliJ with a local DevTools
- Changes the `devtools_tool` command to `dt` now that is has been
renamed
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-1
Original file line number
Diff line number
Diff line change
@@ -379,7 +379,9 @@ Obviously, unit tests can only be run from the command line.
379
379
then adjust it to point to `flutter-intellij/third_party/lib/dart-plugin/xxx.yyyy/Dart.jar`.
380
380
Delete the Dart module from the Project Structure modules list.
381
381
382
-
## Working with Embedded DevTools (JxBrowser)
382
+
## Flutter DevTools Integration
383
+
384
+
### Working with Embedded DevTools (JxBrowser)
383
385
384
386
We use [JxBrowser](https://www.teamdev.com/jxbrowser),
385
387
a commercial product, to embed DevTools within IntelliJ.
@@ -398,3 +400,17 @@ To set up the license key:
398
400
1. Copy the template at resources/jxbrowser/jxbrowser.properties.template
399
401
and save it as resources/jxbrowser/jxbrowser.properties.
400
402
2. Replace `<KEY>` with the actual key.
403
+
404
+
### Developing with local DevTools
405
+
406
+
By default, the DevTools version in IntelliJ will match the DevTools version shipped with Flutter. To instead use a local DevTools version (which will be launched with `dt serve`), the following steps are required:
407
+
408
+
1. Make sure you have `dt` installed
409
+
- Follow instructions in the [DevTools set-up guide](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md#set-up-your-devtools-environment)
410
+
2. Set the registry key to your DevTools directory
411
+
- Go to Help > Find action > Registry > Find "flutter.local.devtools.dir" and set to your DevTools directory. (e.g. Users/user/dev/devtools)
412
+
- Optional: If you want to pass additional arguments to `dt serve`, put these in the option "flutter.local.devtools.args"
413
+
3. Restart IntelliJ
414
+
4. Open Help > Show log in finder > Open idea.log
415
+
- Verify you see output like see output `"DevTools startup: <various messages that come from running dt serve>"`
416
+
5. To stop using local DevTools, go back to the registry key set in step 2 and remove it
0 commit comments