Skip to content

Commit 8ae9356

Browse files
authored
Update install instructions for Gradle (#5862)
1 parent 10fb2dd commit 8ae9356

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ NEEDS UPDATING a/o 9 NOV 21
2323
* Fork `https://github.com/flutter/flutter-intellij` into your own GitHub account.
2424
If you already have a fork, and are now installing a development environment on a new machine,
2525
make sure you've updated your fork so that you don't use stale configuration options from long ago.
26-
* `git clone git@github.com:<your_name_here>/flutter-intellij.git`
26+
* `git clone https@github.com:<your_name_here>/flutter-intellij.git`
2727
* `cd flutter-intellij`
28-
* `git remote add origin git@github.com:flutter/flutter-intellij.git`
28+
* `git remote add origin https@github.com:flutter/flutter-intellij.git`
2929
(So that you fetch from the master repository, not your clone, when running git fetch et al.)
3030
The name `origin` can be whatever you want
3131

@@ -37,11 +37,11 @@ NEEDS UPDATING a/o 9 NOV 21
3737
- Determine the directory of your downloaded IntelliJ Community Edition installation
3838
(e.g, `IntelliJ IDEA CE.app`, `~/idea-IC-183.4886.37` or
3939
`~/Library/Application Support/JetBrains/Toolbox/apps/IDEA-U/ch-0/211.6693.111/IntelliJ IDEA.app`)
40-
* Download Dart dependencies from the command line:
40+
* Download Dart and other dependencies from the command line:
4141
- `cd path/to/flutter-intellij`
4242
- `flutter pub get`
43-
- `cd tool/plugin`
44-
- `flutter pub get`
43+
- `(cd tool/plugin; flutter pub get)`
44+
- `bin/plugin test`
4545
* Start IntelliJ
4646
* In the "Project Structure" dialog (`File | Project Structure`):
4747
- Select "Platform Settings > SDKs" click the "+" sign at the top "Add New SDK (Alt+Insert)" to configure the JDK
@@ -61,17 +61,15 @@ NEEDS UPDATING a/o 9 NOV 21
6161
* One-time Dart plugin install - first-time a new IDE is installed and run you will need to install the Dart plugin
6262
- Find `Plugins` (in Settings/Preferences) and install the Dart plugin, then restart the IDE
6363
* Open the flutter-intellij project in IntelliJ (select and open the directory of the flutter-intellij repository).
64-
- If you see a popup with "Gradle build scripts found", please "Skip" or ignore it since the project cannot be imported as a gradle project
64+
- If you see a popup with "Gradle build scripts found", confirm loading the Gradle project and confirm that you trust it
65+
- Ignore suggestion for protobuf-java plugin, unless you want it
6566
- Build the project using `Build` | `Build Project`
66-
* Run the tests from the command line:
67-
- `cd path/to/flutter-intellij`
68-
- `bin/plugin test`
69-
* Try running the plugin; there is an existing launch config for "Flutter Plugin". This should open the "runtime workbench",
67+
* Try running the plugin; elect the `flutter-intellij [runIde]` run config then click the Debug icon. This should open the "runtime workbench",
7068
a new instance of IntelliJ with the plugin installed.
7169
* If the Flutter Plugin doesn't load (Dart code or files are unknown) see above "One-time Dart plugin install"
72-
- Install the Dart plugin, exit, and launch again
70+
- Install the Dart plugin, exit
7371
* Verify installation of the Flutter plugin:
74-
- Select `Flutter Plugin` in the Run Configuration drop-down list
72+
- Select `flutter-intellij [runIde]` in the Run Configuration drop-down list
7573
- Click Debug button (to the right of that drop-down)
7674
- In the new IntelliJ process that spawns, open the `path/to/flutter/examples/hello_world` project
7775
- Choose `Edit Configurations...` in the Run Configuration drop-down list
@@ -102,6 +100,8 @@ The definition is in `resources/intellij/External Tools.xml`.
102100

103101
## Flutter plugin development on Windows
104102

103+
THIS SECTION IS OUT-OF-DATE SINCE THE CONVERSION TO GRADLE
104+
105105
These are notes taken while making a Windows dev env for the Flutter plugin.
106106
It assumes familiarity with the section about set-up on MacOS.
107107
However, this configuration includes IntelliJ source code. Before starting,
@@ -173,10 +173,8 @@ exercise app use cases.
173173
174174
In order to be able to debug a single test class or test method you need to do the following:
175175
176-
* Open the test source file in the editor. Navigate to `flutter-idea/testSrc/unit/...` to open it. Do *not*
177-
use `testSrc` in the root directory. Tests must run using Gradle, so be sure to open the source from the Gradle module.
178-
The reason `testSrc` exists in the root is historic; we lost the ability to run tests outside of Gradle.
179-
176+
* Open the test source file in the editor. Navigate to `flutter-idea/testSrc/unit/...` to open it.
177+
* Tests must run using Gradle, so be sure to open the source from the Gradle module.
180178
* Find the test you want to run. Right-click the green triangle next to the test name and choose `Debug <test-name>`.
181179
182180
The test configuration can be tricky due to IntelliJ platform versioning. The plugin tool (below) can be a more

0 commit comments

Comments
 (0)