Skip to content

Latest commit

 

History

History
125 lines (96 loc) · 7.13 KB

CONTRIBUTING.md

File metadata and controls

125 lines (96 loc) · 7.13 KB
Raw

Contributing code

GitHub contributors

We gladly accept contributions via GitHub pull requests!

You must complete the Contributor License Agreement. You can do this online, and it only takes a minute. If you've never submitted code before, you must add your (or your organization's) name and contact info to the AUTHORS file.

Flutter plugin development

  • Download and install the latest stable version of IntelliJ
  • Start IntelliJ
  • In the Project Structure dialog (File | Project Structure), select "Platform Settings > SDKs" click the "+" sign at the top "Add New SDK (Alt+Insert)" to configure an IntelliJ Platform Plugin SDK
    • Point it to the directory of your downloaded IntelliJ Community Edition installation (e.g, IntelliJ IDEA CE.app/Contents or ~/idea-IC-183.4886.37)
    • Change the name to IntelliJ IDEA Community Edition
    • Extend it with additional plugin libraries by adding to Classpath:
      • plugins/android/lib/android.jar
      • plugins/gradle/lib/gradle-common.jar
      • plugins/gradle-dsl-impl/lib/gradle-dsl-impl.jar
      • plugins/git4idea/lib/git4idea.jar
  • In the 'Kotlin Compiler' preference page, make sure that the 'Target JVM Version' is set to 1.8.
  • One-time Dart plugin install - first-time a new IDE is installed and run you will need to install the Dart plugin. Find Plugins (in Settings/Preferences) and install the Dart plugin, then restart the IDE
  • Open flutter-intellij project in IntelliJ (select and open the directory of the flutter-intellij repository). Build it using Build | Build Project
  • Try running the plugin; there is an existing launch config for "Flutter IntelliJ". This should open the "runtime workbench", a new intance of IntelliJ with the plugin installed.
  • If the Flutter Plugin doesn't load (Dart code or files are unknown) see above "One-time Dart plugin install"
  • If libraries are deleted from .iml files, you can try running flutter pub get to get them back. However, random changes to the .iml files are common and generally it's okay to remove these changes before making commits.
  • Install Flutter SDK from Flutter SDK download or github and set it up according to its instructions.
  • Verify installation from the command line:
    • Connect an android device with USB debugging.
    • cd <flutter>/examples/hello_world
    • flutter doctor
    • flutter run
  • Verify installation of the Flutter plugin:
    • Select IDEA in the Run Configuration drop-down list.
    • Click Debug button (to the right of that drop-down).
    • In the new IntelliJ process that spawns, open the hello_world example.
    • Choose Edit Configuration in the Run Configuration drop-down list.
    • Expand Defaults and verify that Flutter is present.
    • Click [+] and verify that Flutter is present.

Running plugin tests

Using test run configurations in IntelliJ

The repository contains two pre-defined test run configurations. One is for 'unit' tests; that is currently defined as tests that do not rely on the IntelliJ APIs. The other is for 'integration' tests - tests that do use the IntelliJ APIs. In the future we would like for the unit tests to be able to access IntelliJ APIs, and for the integration tests to be larger, long-running tests that excercise app use cases.

In order to be able to run a single test class or test method you need to do the following:

  • Open Run | Edit Configurations, select 'Flutter tests' run configuration, copy its VM Options to clipboard
  • In the same dialog (Run/Debug Configurations) expand Defaults node, find JUnit under it and paste VM Options to the corresponding field
  • Repeat the same with Working directory field - it must point to intellij-community/bin

If running the full unit test suite fails, check the run configuration and verify that 'Use classpath of module' is set to flutter-intellij.test.

The test configuration can be tricky due to IntelliJ platform versioning. The plugin tool (below) can be a more reliable way to run tests.

Using the plugin tool on the command line

To run unit tests on the command line:

bin/plugin test

See TestCommand in tool/plugin/lib/plugin.dart for more options.

The plugin tool unpacks the dependencies required to run tests, including the correct version of IntelliJ. Once that's been done it is possible to run tests directly with Gradle:

./gradlew test

If you wanted to run a subset of the tests you could do so this way. See the Gradle docs for more info about testing.

Note that the tests do not currently run on Windows.

Adding platform sources

Sometimes browsing the source code of IntelliJ is helpful for understanding platform details that aren't documented.

  • In order to have the platform sources handy, clone the IntelliJ IDEA Community Edition repo (git clone https://github.com/JetBrains/intellij-community)
  • Sync it to the same version of IDEA that you are using (git checkout idea/171.3780.107). It will be in 'detached HEAD' mode.
  • Open the Project Structure dialog (File > Project Structure). In the IntelliJ IDEA Community Edition sdk, go to the Sourcepaths tab and add the path to intellij-community. Accept all the root folders found by the IDE after scanning.
  • Do the same for the intellij-plugins repo to get Dart plugin sources. Sync to the same version as in lib/dart-plugin. (git checkout webstorm/171.4006)

Working with Android Studio

  1. Initialize Android Studio sources.
  2. Checkout Flutter plugin sources, tip of tree.
  3. Follow the directions for setting up the Dart plugin sources in intellij-plugins/Dart/README.md with these changes:
    • you do not need to clone the intellij-community repo
    • open studio-master-dev/tools/idea in IntelliJ
    • possibly skip running intellij-community/getPlugins.sh
  4. Checkout Dart plugin sources, branch 171.
  5. Using the Project Structure editor, import
    • intellij-plugins/Dart/Dart-community.iml
    • flutter-intellij/flutter-intellij-community.iml
  6. Select the community-main module and add a module dependency to flutter-intellij-community.

Working with Embedded DevTools (JxBrowser)

We use JxBrowser, a commercial product, to embed DevTools within IntelliJ. A license key is required to use this feature in development, but it is not required for developing unrelated (most) features.

Getting a key to develop JxBrowser features:

  • Internal contributors: Ask another internal contributor to give you access to the key.
  • External contributors: Our license key cannot be transferred externally, but you can acquire your own trial or regular license from TeamDev to use here.

To set up the license key:

  1. Copy the template at resources/jxbrowser/jxbrowser.properties.template and save it as resources/jxbrowser/jxbrowser.properties.
  2. Replace <KEY> with the actual key.