intellij-sdk-code-samples/basics/getting_started/setting_up_environment.html
2016-01-14 19:38:06 -08:00

166 lines
7.5 KiB
HTML

<!doctype html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<title>Setting Up a Development Environment / IntelliJ Platform SDK DevGuide</title>
<link rel="stylesheet" href="/intellij/sdk/docs/app/css/styles.min.css">
<!-- non-retina iPad pre iOS 7 -->
<link rel="apple-touch-icon" href="/intellij/sdk/docs/apple-touch-icon-72x72.png" sizes="72x72">
<!-- retina iPhone pre iOS 7 -->
<link rel="apple-touch-icon" href="/intellij/sdk/docs/apple-touch-icon-114x114.png" sizes="114x114">
<!-- retina iPad pre iOS 7 -->
<link rel="apple-touch-icon" href="/intellij/sdk/docs/apple-touch-icon-144x144.png" sizes="144x144">
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/intellij/sdk/docs/apple-touch-icon-precomposed.png">
<!-- normal favicon -->
<link rel="shortcut icon" type="image/x-icon" href="/intellij/sdk/docs/favicon.ico">
<link rel="icon" type="image/png" href="/intellij/sdk/docs/favicon.png">
<link rel="stylesheet" href="/intellij/sdk/docs/styles/styles.css"></head>
<body data-id="basics/getting_started/setting_up_environment">
<div class="wrapper">
<section class="panel _nav">
<header class="panel__header">
<div class="container">
<form class="search-box">
<label for="search-box__input" class="search-box__label">
<input type="text" class="search-box__input" id="search-box__input" placeholder="Search IntelliJ Platform SDK DevGuide">
</label>
<div class="search-box__clear" title="Clear"></div>
</form>
</div>
</header>
<nav class="panel__content">
<div class="container _nav">
<menu class="nav-tree"></menu>
</div>
<div class="container _footer panel__footer">
<p><a href="https://youtrack.jetbrains.com/issues/IJSDK">Send feedback</a></p>
<p>&copy; 2000&ndash;2016 <a href="//www.jetbrains.com">JetBrains</a> s.r.o.<br>
All rights reserved.</p>
</div>
</nav>
</section>
<main class="panel _main" role="main">
<header class="panel__header">
<div class="container">
<h3>IntelliJ Platform SDK DevGuide</h3>
<div class="shortcuts-switcher"><label for="switch-shortcuts">Keymap:</label><select id="switch-shortcuts" class="select _shortcuts" height="1">
<option data-group="primary" value="default" selected>Default</option>
<option data-group="primary" value="default_for_gnome">GNOME</option>
<option data-group="primary" value="default_for_kde">KDE</option>
<option data-group="primary" value="default_for_xwin">XWindow</option>
<option data-group="primary" value="emacs">Emacs</option>
<option data-group="primary" value="jbuilder">JBuilder</option>
<option data-group="primary" value="visual_studio">Visual Studio</option>
<option data-group="primary" value="netbeans_6.5">NetBeans 6.5</option>
<option data-group="primary" value="eclipse">Eclipse</option>
<option data-group="secondary" value="mac_os_x_10.5_">OS X 10.5+</option>
<option data-group="secondary" value="mac_os_x">OS X</option>
<option data-group="secondary" value="eclipse_mac_os_x">OS X Eclipse</option></select>
</div>
<div class="panel-trigger"></div>
</div>
</header>
<section class="panel__content">
<div class="container">
<article class="article" data-shortcut-switcher="false">
<h1>Setting Up a Development Environment</h1>
<a name="preliminary-steps" class="elem-anchor"></a>
<h3>Preliminary Steps<a href="#preliminary-steps" class="anchor-link"><span></span></a></h3>
<p>Use the following check list to ensure that you are ready to develop your custom plugins.</p>
<ul>
<li><strong>IntelliJ IDEA</strong> version 9.0 or later (either Community Edition or Ultimate) must be installed on your computer.</li>
<li><strong>IntelliJ IDEA CE source code</strong> should be checked out to your local computer. This is not a requirement but will make it much easier for you to debug your plugins. For detailed instructions, refer to <a href="/intellij/sdk/docs/basics/checkout_and_build_community.html"><span>Check Out And Build Community Edition</span></a>.</li>
<li><strong>IntelliJ Platform SDK</strong> must configured for your IDEA project. For more information, see <a href="#configuring-intellij-platform-sdk"><span>Configuring IntelliJ Platform SDK</span></a> below.</li>
</ul>
<a name="configuring-intellij-platform-sdk" class="elem-anchor"></a>
<h3>Configuring IntelliJ Platform SDK<a href="#configuring-intellij-platform-sdk" class="anchor-link"><span></span></a></h3>
<p>To set up your plugin development environment:</p>
<ul>
<li>
<p>Check out the source code of IntelliJ IDEA Community Edition as described in
<a href="/intellij/sdk/docs/basics/checkout_and_build_community.html"><span>Check Out And Build Community Edition</span></a>.</p>
</li>
<li>
<p>Create a new <em>IntelliJ Platform SDK</em> under <strong>File | Project Structure</strong>:</p>
<p><img src="img/create_intellij_idea_sdk.png" alt="Create IntelliJ Platform SDK" /></p>
</li>
<li>
<p>Specify the installation folder of <em>IntelliJ IDEA Community Edition</em> as the home directory.</p>
<p><img src="img/set_home_directory.png" alt="Set Home Directory" /></p>
</li>
<li>
<p>Select the <strong>IDEA jdk</strong> created in <a href="/intellij/sdk/docs/basics/checkout_and_build_community.html"><span>Check Out And Build Community Edition</span></a> as the default Java SDK:</p>
<p><img src="img/set_java_sdk.png" alt="Set IDEA JDK" /></p>
</li>
</ul>
<aside class="warning">
<p> You may use IntelliJ IDEA Ultimate as an alternative, but debugging the core code will only work with the <em>Community Edition</em>.</p>
</aside>
<ul>
<li>
<p>In the Sourcepath tab of the SDK settings, click the <em>Add</em> button:</p>
<p><img src="img/add_sourcepath.png" alt="Add Sourcepath" /></p>
</li>
<li>
<p>Specify the directory into which you have checked out the sources of the <em>Community Edition</em>:</p>
<p><img src="img/community_sources_directory.png" alt="Specify Source Paths" /></p>
</li>
<li>
<p>Select <strong>File | New | Module</strong> and choose the <em>IntelliJ Platform Plugin</em> module type</p>
<p><img src="img/intellij_platform_plugin_module.png" alt="IntelliJ Platform Plugin Module" /></p>
</li>
<li>
<p>Enter your desired plugin name.</p>
</li>
<li>
<p>Go to <strong>File | Project Structure</strong> and select the newly created <em>IntelliJ Platform SDK</em> as the default SDK for the plugin module:</p>
<p><img src="img/set_plugin_module_sdk.png" alt="Set Plugin Module SDK" /></p>
</li>
</ul>
<div class="last-modified">
Last modified: 23 November 2015
</div>
</article>
<section class="disqus">
<div id="disqus_thread"></div>
</section>
</div>
</section>
</main>
</div>
<script data-main="/intellij/sdk/docs/app/js/main.build" data-baseurl="/intellij/sdk/docs/" src="/intellij/sdk/docs/app/js/vendor/requirejs/require.js"></script>
</body>
</html>