PROJECT_SETUP.md

Project Set up

This tutorial was created using IntelliJ IDEA 2016.3. Should be similar for other versions including Android Studio.

Pre-requisites

According to the official guidelines:

1. Download and install a JDK.
2. Make sure that the Plugin DevKit plugin is enabled.
3. Optionally, download the IntelliJ IDEA Community Edition sources. This will make debugging your plugins much easier.
4. You also need to configure IntelliJ Platform Plugin SDK. Instructions here

IDE Set up

1. Open up IntelliJ and select Create project from version control
2. Select GitHub and enter https://github.com/afcastano/AutoValuePlugin.git. Click clone
3. Select Create project from existing sources and click next
4. Select location and name and click next
5. Un-select all folders except the first two corresponding to src and test
6. If a library is detected, remove it. In this case AutoValuePlugin on the dist folder might have been detected. Un-select it and click next.
7. In the module structure dialog, select the module and click next.
8. A warning will appear indicating that the module already exists. Click Reuse.
9. After this, make sure the IntelliJ Platform Plugin SDK appears on the list (According to pre-requisites ) and hit next.
10. Click Finish.
11. Go to Project settings and select 7 - Diamonds as the Language level. Click OK.

That's it, the project should be configured and ready to go.

Testing the plugin

• To run the tests, Right click on the test folder and Run 'All Tests'

• To manually test the plugin:

  • Create a new run configuration of type plugin, Give any name and select AutoValuePlugin for the "Use Classpath of module" box.
  • Run the new configuration, it will fire up a new instance of IntelliJ with the development version of the plugin installed.