blob: 6ec944b0058adeacc4adc2d1862325b8056a5589 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-112407000-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'UA-112407000-2');
</script>
<!-- Google Tag Manager -->
<script>
(function (w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({
'gtm.start': new Date().getTime(),
event: 'gtm.js'
});
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s),
dl = l != 'dataLayer' ? '&l=' + l : '';
j.async = true;
j.src =
'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', 'GTM-KS8HHSF');
</script>
<!-- End Google Tag Manager -->
<head>
<base href="/codewind/" />
<title>IntelliJ tech preview | Codewind</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="IntelliJ tech preview">
<meta name="keywords" content="news, new, updates, update, version, intellij, techpreview"/>
<link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png">
<link href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans:300,400,600&display=swap" rel="stylesheet">
<!-- Bootstrap CSS CDN -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" />
<link rel="stylesheet" href="css/styles.css">
<link rel="stylesheet" href="css/docs.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/themes/prism.min.css">
</head>
<body data-spy="scroll" data-target="#toc">
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KS8HHSF"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<div class="main">
<!-- Bootstrap NavBar -->
<nav class="navbar navbar-expand-lg navbar-light cw-banner fixed-top" aria-label="topnav">
<button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse"
data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false"
aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<a class="navbar-brand" href="">
<img alt="Codewind logo image" title="Codewind logo image" src="images/header-logo.svg" class="cw-header-logo" alt="">
</a>
<div class="collapse navbar-collapse justify-content-end cw-navbar-padding" id="navbarNavDropdown">
<ul class="navbar-nav cw-navbar-nav">
<li class="nav-item cw-navbar-item cw-header-link-docs">
<a class="nav-link cw-nav-link cw-header-link-text" href="gettingstarted.html">Docs</a>
</li>
<li class="nav-item cw-navbar-item cw-header-link-news">
<a class="nav-link cw-nav-link cw-header-link-text" href="news.html">News</a>
</li>
<li class="nav-item cw-navbar-item cw-header-link-news">
<a class="nav-link cw-nav-link cw-header-link-text" href="https://medium.com/codewind">Blog</a>
</li>
<li class="nav-item cw-navbar-item cw-header-link">
<a class="nav-link cw-nav-link" href="https://github.com/eclipse/codewind"><img alt="github icon" class="banner-image" title="github icon" data-toggle="tooltip" data-placement="top" id="cw_github_stars" title="..." src="images/banner/github.svg"/></a>
</li>
<li class="nav-item cw-navbar-item cw-header-link">
<a class="nav-link cw-nav-link" href="https://twitter.com/EclipseCodewind"><img alt="twitter icon" class="banner-image" title="twitter icon" src="images/banner/twitter.png"/></a>
</li>
<li class="nav-item cw-navbar-item cw-header-link">
<a class="nav-link cw-nav-link" href="https://mattermost.eclipse.org/eclipse/channels/eclipse-codewind"><img alt="mattermost icon" class="banner-image" title="mattermost icon" src="images/banner/mattermost.png"/></a>
</li>
<li class="nav-item cw-navbar-item cw-header-link">
<a class="nav-link cw-nav-link" href="https://www.youtube.com/channel/UCnKCVK6RFDyHFqUmXlAhCHQ"><img alt="youtube icon" class="banner-image" title="youtube icon" src="images/banner/youtube.png"/></a>
</li>
<!-- li class="nav-item cw-navbar-item" id="download-li">
<button onClick="window.location.href='https://microclimate.dev/download/codewind';" type="button" class="btn cw-download-button">Download</button>
<a href="https://microclimate.dev/download/codewind" class="nav-link cw-nav-link cw-download-link" href="#">Download</a>
</li> -->
<!-- Smaller devices menu END -->
</ul>
</div>
</nav>
<!-- End Bootstrap NavBar -->
<!-- Bootstrap row -->
<div class="row" id="body-row">
<!-- Sidebar -->
<div id="sidebar-container" class="bg-light" role="navigation" aria-label="sidebar">
<!-- Bootstrap List Group -->
<ul class="list-group sticky-top bg-light cw-sticky-offset">
<!-- Hard coded TOC -->
<!-- Start single page getting started -->
<a href="intellijtechpreview.html"
class="cw-current-page bg-light list-group-item list-group-item-action">
IntelliJ tech preview
</a>
<a href="news08.html"
class="bg-light list-group-item list-group-item-action">
Codewind 0.8.0
</a>
<a href="news07.html"
class="bg-light list-group-item list-group-item-action">
Codewind 0.7.0
</a>
<a href="news06.html"
class="bg-light list-group-item list-group-item-action">
Codewind 0.6.0
</a>
<a href="news05.html"
class="bg-light list-group-item list-group-item-action">
Codewind 0.5.0
</a>
<a href="news04.html"
class="bg-light list-group-item list-group-item-action">
Codewind 0.4.0
</a>
<a href="news03.html"
class="bg-light list-group-item list-group-item-action">
Codewind 0.3.0
</a>
<a href="newstechpreview.html"
class="bg-light list-group-item list-group-item-action">
Codewind tech preview
</a>
<!-- END hard coded TOC -->
</ul>
<!-- List Group END-->
</div>
<!-- sidebar-container END -->
<!-- MAIN -->
<div id="content-container">
<div class="py-5 px-5">
<div class="cw-docs-spacer"></div>
<div role="main"><h1 id="intellij-tech-preview">IntelliJ tech preview</h1>
<p>Introducing the tech preview of Codewind on the IntelliJ IDE! We want to make our tools available to as many developers as possible in their preferred IDEs. Many people have asked about IntelliJ, as it is a popular option among Java developers, so we are working hard to bring the effortless Codewind experience to IntelliJ. With this tech preview, you can now use Codewind on IntelliJ locally.</p>
<h2 id="installing-codewind-on-intellij">Installing Codewind on IntelliJ</h2>
<p>Complete the prerequisites and choose to install Codewind on IntelliJ with either the custom plug-in repository or the Eclipse Downloads page.</p>
<h3 id="prerequisites">Prerequisites</h3>
<ul>
<li>Install <a href="https://www.jetbrains.com/idea/download/#section=mac">IntelliJ</a>.</li>
<li>Install Docker.</li>
<li>If you use Linux, also install Docker Compose.</li>
</ul>
<h3 id="installing-codewind-on-intellij-with-the-custom-plug-in-repository">Installing Codewind on IntelliJ with the custom plug-in repository</h3>
<ol>
<li>From IntelliJ, open either <strong>Preferences</strong> or <strong>Settings</strong>. A new window appears.
<ul>
<li>On macOS, go to <strong>Main</strong>&gt;<strong>Preferences</strong>.</li>
<li>On Windows, go to <strong>File</strong>&gt;<strong>Settings</strong>.</li>
</ul>
</li>
<li>Click <strong>Plugins</strong>.</li>
<li>Click the <strong>Manage Repositories, Configure Proxy or Install Plugin from Disk</strong> gear icon.</li>
<li>From the menu, click the <strong>Manage Plugin Repositories…</strong> gear icon.</li>
<li>Click the <strong>+</strong> button.</li>
<li>Enter <code class="highlighter-rouge">https://download.eclipse.org/codewind/milestone/0.9.0/updatePlugins.xml</code>.</li>
<li><strong>For IntelliJ on Linux and Windows:</strong> After you paste the URL, click outside the entry field so that the URL is deselected. If the URL isn’t deselected before clicking <strong>OK</strong>, the URL is saved as a blank entry, and an error occurs.</li>
<li>Click <strong>OK</strong>.</li>
<li>Click the <strong>Marketplace</strong> heading.</li>
<li>In the search field, type <code class="highlighter-rouge">codewind</code>. The <code class="highlighter-rouge">codewind-intellij</code> plug-in appears. Click <strong>Install</strong>.</li>
</ol>
<h3 id="installing-codewind-on-intellij-from-the-eclipse-downloads-page">Installing Codewind on IntelliJ from the Eclipse Downloads page</h3>
<ol>
<li>Go to the <a href="https://download.eclipse.org/codewind/milestone/0.9.0/codewind-intellij-0.9.0.zip">Eclipse Downloads page</a> and click <code class="highlighter-rouge">codewind-intellij-0.9.0.zip</code> to download the file.</li>
<li>From IntelliJ, open either <strong>Preferences</strong> or <strong>Settings</strong>. A new window appears.
<ul>
<li>On macOS, go to <strong>Main</strong>&gt;<strong>Preferences</strong>.</li>
<li>On Windows, go to <strong>File</strong>&gt;<strong>Settings</strong>.</li>
</ul>
</li>
<li>Click <strong>Plugins</strong>.</li>
<li>Click the <strong>Manage Repositories, Configure Proxy or Install Plugin from Disk</strong> gear icon. From the menu, click <strong>Install Plugin from Disk…</strong>. A window appears that displays the files on your computer.</li>
<li>Choose the <code class="highlighter-rouge">codewind-intellij-0.9.0.zip</code> file and click <strong>Open</strong>.</li>
</ol>
<h2 id="creating-your-first-project-from-a-template">Creating your first project from a template</h2>
<ol>
<li>Start IntelliJ. From the welcome page, click <strong>Create New Project</strong>. The <strong>New Project</strong> window opens.</li>
<li>Create a Codewind project by clicking <strong>Codewind</strong>.
<ul>
<li>If Codewind isn’t installed yet, click <strong>Install Codewind</strong> to complete the installation.</li>
<li>If Codewind isn’t running yet, click <strong>Start Codewind</strong>. A <strong>Starting Codewind</strong> window appears.</li>
</ul>
</li>
<li>After Codewind is installed and started, click <strong>Next</strong>. A list of available templates appears.
<ul>
<li>Currently, IntelliJ supports only the Java language templates.</li>
</ul>
</li>
<li>Click the template of your choice. Then, click <strong>Next</strong>.</li>
<li>Enter the <strong>Project name:</strong> field to name your project and enter the <strong>Project location:</strong> field to choose where to put it.</li>
<li>Click <strong>Finish</strong>. A window for your project appears.</li>
<li>IntelliJ detects a <code class="highlighter-rouge">pom.xml</code> file and asks if you want to add the file as a Maven project. In the <strong>Non-managed pom.xml file found:</strong> notification, click <strong>Add as Maven Project</strong> to create the correct project structure.
<ul>
<li>The <strong>Non-managed pom.xml file found:</strong> notification might disappear after some time. To create the correct project structure, go to the IntelliJ project view and right-click the <code class="highlighter-rouge">pom.xml</code> file. From the context menu, click <strong>Add as Maven Project</strong> to create the correct project structure.</li>
</ul>
</li>
<li>To access the Codewind view, click the <strong>Codewind</strong> tab. From the Codewind view, right-click your project to open an application, start a build, and more.</li>
</ol>
<h2 id="creating-more-projects-from-templates">Creating more projects from templates</h2>
<ol>
<li>From an IntelliJ project that’s already open, go to <strong>File</strong>&gt;<strong>New</strong>&gt;<strong>Project…</strong>. The <strong>New Project</strong> window appears.
<ul>
<li><strong>Note:</strong> Unlike other IDEs, IntelliJ doesn’t have a <strong>Create New Project</strong> menu item in the Codewind view.</li>
</ul>
</li>
<li>Click <strong>Next</strong>.</li>
<li>Click the template of your choice and click <strong>Next</strong>. A list of available templates appears.
<ul>
<li>Currently, IntelliJ supports only the Java language templates.</li>
</ul>
</li>
<li>Enter the <strong>Project name:</strong> and <strong>Project location:</strong> and click <strong>Finish</strong>. The <strong>Open Project</strong> window appears.</li>
<li>To create a new project, click <strong>New Window</strong>. A new window appears for the new project.</li>
<li>IntelliJ detects a <code class="highlighter-rouge">pom.xml</code> file and asks if you want to add the file as a Maven project. In the <strong>Non-managed pom.xml file found:</strong> notification, click <strong>Add as Maven Project</strong> to create the correct project structure.
<ul>
<li>The <strong>Non-managed pom.xml file found:</strong> notification might disappear after some time. To create the correct project structure, go to the IntelliJ project view and right-click the <code class="highlighter-rouge">pom.xml</code> file. From the context menu, click <strong>Add as Maven Project</strong> to create the correct project structure.</li>
</ul>
</li>
<li>To access the Codewind view, click the <strong>Codewind</strong> tab.
<ul>
<li>The new project appears with any other projects.</li>
<li>Right-click your project to open an application, start a build, and more.</li>
</ul>
</li>
</ol>
<h2 id="making-a-code-change">Making a code change</h2>
<ol>
<li>From a project, open the file that you want to edit, for example, <strong>Project1</strong>&gt;<strong>src</strong>&gt;<strong>main</strong>&gt;<strong>java</strong>&gt;<strong>application</strong>&gt;<strong>rest</strong>&gt;<strong>v1</strong>&gt;<strong>example</strong>.</li>
<li>Edit your file.</li>
<li>Save your changes. By default, IntelliJ automatically saves your changes. However, if you manually save your changes, you can help Codewind detect changes more quickly.</li>
<li>Open the application again. Your changes appear.</li>
</ol>
<h2 id="removing-a-project">Removing a project</h2>
<ol>
<li>If you delete a project, it is removed from Codewind.</li>
<li>However, the files remain in the file system, and you need to manually delete them.</li>
</ol>
<h1 id="troubleshooting">Troubleshooting</h1>
<h2 id="cannot-find-codewind-in-marketplace-when-attempting-to-install-in-intellij">Cannot find Codewind in Marketplace when attempting to install in IntelliJ</h2>
<p>When attempting to install Codewind in IntelliJ, you cannot locate the Codewind plug-in in Marketplace, and if you verify the custom plug-in repository link, you get a <code class="highlighter-rouge">Connection failed</code> error message.</p>
<p>This error occurs because the custom plug-in repository link contains an additional space.</p>
<p><strong>Workaround</strong>
Remove the extra space from the custom plug-in repository link.</p>
</div>
</div>
</div>
</div>
<!-- footer row -->
<footer>
<div id="footer-div-mobile">
<div class="row">
<div class="col-sm-12 text-center">
<span>Useful Links:</span>
<br/><br/>
<a class="cw-footer-links" href="http://www.eclipse.org">Eclipse Foundation</a><br/>
<a class="cw-footer-links" href="http://www.eclipse.org/legal/privacy.php">Privacy policy</a><br/>
<a class="cw-footer-links" href="http://www.eclipse.org/legal/termsofuse.php">Website terms of use</a><br/>
<a class="cw-footer-links" href="http://www.eclipse.org/legal/copyright.php">Copyright agent</a><br/>
<a class="cw-footer-links" href="http://www.eclipse.org/legal">Legal</a><br/>
</div>
</div>
<div class="cw_footer_display_flex cw-footer-same-height cw-footer-center">
<div class="cw_footer_display_icons row">
<div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12">
<div>
<div>
<a href="mailto:codewind-dev@eclipse.org"><img alt="email icon" title="email icon" src="images/email-icon.svg" class="cw-logo" /></a>
</div>
</div>
</div>
<div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12">
<div>
<div>
<a href="https://twitter.com/EclipseCodewind"><img alt="twitter icon" title="twitter icon" src="images/twitter-logo.svg" class="cw-logo" /></a>
</div>
</div>
</div>
<div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12">
<div>
<div>
<a href="https://github.com/eclipse/codewind"><img alt="github icon" title="github icon" src="images/github-logo.svg"
class="cw-logo" /></a>
</div>
</div>
</div>
<div class=" cw-footer-col text-center col-md-3 col-sm-6 col-xs-12">
<div>
<div>
<a href="https://mattermost.eclipse.org/eclipse/channels/eclipse-codewind"><img alt="mattermose icon" title="mattermose icon" src="images/mattermost-logo.png" class="cw-logo-mm" /></a>
</div>
</div>
</div>
<div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12">
<div>
<div>
<a href="https://www.youtube.com/channel/UCnKCVK6RFDyHFqUmXlAhCHQ"><img alt="youtube icon" title="youtube icon" src="images/youtube-logo-dark.svg"
class="cw-logo" /></a>
</div>
</div>
</div>
<div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12">
<div>
<div>
<a href="http://www.eclipse.org"><img class="cw-logo-eclipse-mobile" alt="eclipse icon" title="eclipse icon" src="images/eclipse.svg"/></a>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="row cw-footer-desktop" id="footer-div">
<div class="cw-footer-left">
<div class="px-5 cw-font-12>
<span class="cw-font-14">Useful Links:</span>
<br/><br/>
<a class="cw-footer-links" href="http://www.eclipse.org">Eclipse Foundation</a><br/>
<a class="cw-footer-links" href="http://www.eclipse.org/legal/privacy.php">Privacy policy</a><br/>
<a class="cw-footer-links" href="http://www.eclipse.org/legal/termsofuse.php">Website terms of use</a><br/>
<a class="cw-footer-links" href="http://www.eclipse.org/legal/copyright.php">Copyright agent</a><br/>
<a class="cw-footer-links" href="http://www.eclipse.org/legal">Legal</a><br/>
</div>
</div>
<div class="cw-footer-border-right"></div>
<div class="cw_footer_display_flex cw-footer-same-height cw-footer-center">
<div class="cw_footer_display_icons">
<div class="cw-footer-col text-center">
<div>
<div>
<a href="mailto:codewind-dev@eclipse.org"><img alt="email icon" title="email icon" src="images/email-icon.svg" class="cw-logo" /></a>
</div>
</div>
</div>
<div class="cw-footer-col text-center">
<div>
<div>
<a href="https://twitter.com/EclipseCodewind"><img alt="twitter icon" title="twitter icon" src="images/twitter-logo.svg" class="cw-logo" /></a>
</div>
</div>
</div>
<div class="cw-footer-col text-center">
<div>
<div>
<a href="https://github.com/eclipse/codewind"><img alt="github icon" title="github icon" src="images/github-logo.svg"
class="cw-logo" /></a>
</div>
</div>
</div>
<div class=" cw-footer-col text-center">
<div class="cw-logo-mm" >
<div class="cw-logo-mm" >
<a href="https://mattermost.eclipse.org/eclipse/channels/eclipse-codewind"><img alt="mattermost icon" title="mattermost icon" src="images/mattermost-logo.png" class="cw-logo-mm" /></a>
</div>
</div>
</div>
<div class="cw-footer-col text-center">
<div>
<div>
<a href="https://www.youtube.com/channel/UCnKCVK6RFDyHFqUmXlAhCHQ"><img alt="youtube icon" title="youtube icon" src="images/youtube-logo-dark.svg"
class="cw-logo" /></a>
</div>
</div>
</div>
</div>
</div>
<div class="cw-footer-border-right"></div>
<div class="cw-footer-right cw-footer-same-height cw-footer-vcenter">
<div class="cw-footer-eclipse-img cw-footer-same-height px-5 ">
<a href="http://www.eclipse.org">
<img alt="eclipse icon" title="eclipse icon" src="images/eclipse.svg"/>
</a>
</div>
</div>
</div>
</footer>
<!-- footer row END -->
<!-- Main Col END -->
<!-- Jquery -->
<script
src="https://code.jquery.com/jquery-3.4.1.min.js"
integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo="
crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js"
integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous">
</script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js"
integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous">
</script>
<!-- Font Awesome JS -->
<script defer src="https://use.fontawesome.com/releases/v5.0.13/js/solid.js"
integrity="sha384-tzzSw1/Vo+0N5UhStP3bvwWPq+uvzCMfrN1fEFe+xBmv1C/AtVX5K0uZtmcHitFZ" crossorigin="anonymous">
</script>
<script defer src="https://use.fontawesome.com/releases/v5.0.13/js/fontawesome.js"
integrity="sha384-6OIrr52G08NpOFSZdxxz1xdNSndlD4vdcf/q2myIUVO0VsqaGHJsB0RaBE01VTOY" crossorigin="anonymous">
</script>
<script src="js/jquery.matchHeight-min.js"></script>
<script src="js/index.js"></script>
<script src="js/docs.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/prism.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/components/prism-docker.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/components/prism-json.min.js"></script>
</div>
</body>
</html>