Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update dev instructions for IDEA 12

  • Loading branch information...
commit 7aa8cdc4ee8b625a3a02895b7e1671c57f374b6c 1 parent 849a558
@dmarcotte authored
View
37 developer_environment.md
@@ -2,12 +2,12 @@
## Download IDEA and its sources
* Ensure you have the latest version of the open source [Intellij IDEA Community Edition](http://www.jetbrains.com/idea/free_java_ide.html)
-* Launch your copy of the Community Edition and find its build number (found under `Intellij IDEA -> About Intellij IDEA` on Mac, and `Help -> About` on Linux and Windows). You should see something like `IC-117.963`; the `117.963` part is the build number
-* Clone the Intellij IDEA Community Edition [github repo](https://github.com/JetBrains/intellij-community)
-* In your clone of the Community Edition source code, check out the tag that corresponds to the version of Community Edition you downloaded. All tags for IDEA have the form "idea/\<build_number\>", so the command for our example build number above is:
+* Launch your copy of the Community Edition and find its build number (found under `Intellij IDEA -> About Intellij IDEA` on Mac, and `Help -> About` on Linux and Windows). You should see something like `IC-123.169`; the `123.169` part is the build number
+* Clone the [Intellij IDEA Community Edition GitHub repo](https://github.com/JetBrains/intellij-community)
+* In your clone of the Community Edition, check out the tag that corresponds to the version of Community Edition you downloaded. All tags for IDEA have the form `idea/<build_number>`, so the command for our example build number above is:
```
-git checkout idea/117.963
+git checkout idea/123.169
```
* To get the latest tags in your clone, issue the following command:
```
@@ -15,22 +15,19 @@ git pull --tags
```
## Create an IDEA-Handlebars project
-* Fork this project, clone it to your dev machine, and launch IDEA (can be the Community Edition you downloaded above, or some other edition you use in your day-to-day work)
-* In IDEA, create a new project from scratch, and configure it like the following, with `/code/idea-handlebars` replaced with the path where you cloned your fork of the project. Note that the module is of type **Plugin Module**.
-![ProjectSettings](https://raw.github.com/dmarcotte/idea-handlebars/master/markdown_images/project_setup.png)
-* IDEA will tell you sources have been found. Press `Next`.
-* When you are asked to "Please select Intellij IDEA Plugin SDK", chances are you don't have any yet. Click `Next`, and say `OK` when it warns you **No SDK Specified**. We'll configure one in a second.
-* Right-click idea-handlebars/resources, and choose "Mark Directory As->Source Root"
+* Fork this project, clone it to your machine, and launch IDEA (can be the Community Edition you downloaded above, or some other edition you use in your day-to-day work)
+* In IDEA, create a new project from scratch, and configure it like the following, with `/projects/idea-handlebars` replaced with the path where you cloned your fork of the project
+* Note that the project is of type **Intellij IDEA Plugin** (if you do not see that option, ensure that "Plugin DevKit" is enabled in `Settings->Plugins`)
+* Also note that the **Project SDK** is set to `IDEA IC-\<build_number\>`. To set this, click "New" and choose the location of your Community Edition install, then choose Java 1.6 when prompted
+![ProjectSettings](markdown_images/project_setup.png)
+* Click `OK`. Once the project loads up, configure the resources and test directories:
+ * right-click the "idea-handlebars/resources" folder, and choose `Mark Directory As->Source Root`
+ * right-click the "idea-handlebars/test/src" folder, and choose `Mark Directory As->Test Source Root`
+* Add the Intellij source code
+ * Open the "Project Structure" pane (`File -> Product Structure`)
+ * In the `Sourcepath` tab of your IDEA SDK, add the directory where you cloned the Community Edition source code. This will make debugging and exploring the source much more pleasant.
-## Configure an IDEA Plugin SDK
-* Open the "Project Structure" pane (`File -> Product Structure`)
- * You should already have a 1.6 SDK configured. If you don't, now's a fine time to set it up.
- * Ensure that your **Project Language Level** is at `6.0`, then click on `New...` under **Project SDK**, choosing `Intellij IDEA Plugin SDK`
- * **Project compiler output** is left to your discretion, though the default is probably fine
-![ProjectSettings](https://raw.github.com/dmarcotte/idea-handlebars/master/markdown_images/sdk_setup_1.png)
- * At the file chooser prompt, select the root of the install folder of the Community Edition you downloaded earlier (i.e. `Applications -> Intellij IDEA 11 ICE` on Mac)
- * You will then be prompted to **Select Java SDK to be used as IDEA internal platform**. Ensure this is your 1.6 SDK; IDEA 11 does not play well with Java 1.7
- * Finally, choose `Edit` on your new Plugin SDK, choose the `Sourcepath` tab, and add the directory where you cloned the Community Edition source code. This will make debugging and exploring the source much more pleasant.
+![ProjectSettings](markdown_images/sdk_setup_1.png)
## Ready to go
And that's it! At this point, you should automatically have an `idea-handlebars` Run Configuration in IDEA (if not, create one of type "Plugin" and you should be good to go). If you Run/Debug this configuration, it will launch the Community Edition with your build of the plugin installed.
@@ -40,7 +37,7 @@ And that's it! At this point, you should automatically have an `idea-handlebars
* **Enable Internal Tools:** add `-Didea.is.internal=true` to the VM Options of your plugin Run Configurations to add various internal IDEA-development tools to your menu options. Many of these look interesting, but the one you absolutely need is `Tools -> View PSI Structure of Current File...`
* **Test against any Jetbrains IDE:** you can run your plugin build inside of any IDEA-platform-based IDE (the Ultimate Edition, IDEA 12 EAP, Rubymine, PhpStorm, etc.) by setting up a Plugin SDK pointing at the install location of the IDE you want to test against. You will not have the full source for most of these, but this comes in handy when backporting features, testing against an IDEA EAP, or troubleshooting IDE-specific problems.
* *Note:* you do not need a license for any of the products you want to test against. The plugin SDK will let you use a trial license, and you can "renew" this any time by deleting the **Sandbox Home** folder defined in `Project Structure -> SDKs`
-![ProjectSettings](https://raw.github.com/dmarcotte/idea-handlebars/master/markdown_images/sdk_setup_2.png)
+![ProjectSettings](markdown_images/sdk_setup_2.png)
* **Hack on any open source plugin:** these setup instructions should apply for just about any plugin, so now you should be able to easily explore the code of [all of your favorite open source plugins](http://blogs.jetbrains.com/idea/2012/10/check-out-more-than-200-open-source-plugins/).
## Problems with these instructions?
View
BIN  markdown_images/project_setup.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  markdown_images/sdk_setup_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  markdown_images/sdk_setup_2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Please sign in to comment.
Something went wrong with that request. Please try again.