The Groovy Eclipse Plugin allows you to edit, compile and run groovy scripts and classes.
Note that the plugin is work in progress, but for dear devils it might be useful. Since the plugin is in no shape to be released, you will need to obtain your copy from CVS (see below). You can check the current status of the plugin here: issues and bugs
Eclipse version compatability
- Eclipse 3.1 : working
Other versions of Eclipse "may" also work. Please edit this page to report other versions currently not listed.
Download and build from CVS
- Check out groovy/ide/groovy-eclipse/GroovyEclipse from CVS (see here http://groovy.codehaus.org/cvs-usage.html for CVS info) into a separate Eclipse project. Just use simple check-outs, CVS already contains all the information Eclipse needs to create the projects properly (i.e. .project and .classpath and other files)
Detailed description of how to accomplish the above in Eclipse.
- Select the Window Menu -> Other -> CVS Repository Exploring.
- In the context menu of the CVS Repositories pane, select New Repository Location
- Enter CVS information obtained from http://groovy.codehaus.org/cvs-usage.html;
- Open these folders HEAD/groovy/ide/groovy-eclipse/
- Select the GroovyEclipse module
- Right-click to get its context menu and select Check out (not Check out as)
- Now you should have a project called GroovyEclipse in your package explorer view; it should have compiled with 0 errors and 45 warnings (this may not stay this many for very long).
Testing the plugin
It might be useful to test the plugin before you export it and use it in your main eclipse installation. To accomplish this
- Simply select or double clock the file called plugin.xml from the GroovyEclipse project. This should bring up an editor for the plugin description; the first page should be called Overview.
- In this page, select the link Launch an Eclipse application. This should start a new Eclipse instance in which you have no projects.
- Create a new Java project and configure the project (perhaps adding a package first).
- Create a new Groovy class. Do this on the context menu of the package in which you want your groovy class; like so: New -> Other -> Groovy -> Groovy Class.
- Fill in the groovy code of your desire, for example something like this:
(THE REST OF THIS PAGE WILL BE UPDATED LATER)
- Select the GroovyEclipse project in the package explorer view, right mouse click, select Export and a pop-up window called Export shows up.
- In the Export pop-up, select "Deployable plug-ins and fragments", click Next, then:
- In the Available Plug-ins and Fragments list, select "org.codehaus.groovy", "org.codehaus.groovy.eclipse"
- In Export Options/Deploy as, Select "as single Zip file"
- In the Destination, enter or browse for a file name
- Click on Finish, and you are done.
... then Install and Test
The zip file you just created (or downloaded) is now just like any other plug-in zip file, that can be unzipped under the eclipse root directory.
To install and test the plug-in:
- Open the zip file and extract its content to the eclipse root directory.
You can check that two folders have been created under eclipse/plugin:
org.codehaus.groovy.eclipse_1.0.0 and org.codehaus.groovy_1.0.0
- Restart Eclipse to install the Groovy plug-in
- For quick test of the plug-in:
- Create a new Java project, right mouse-click on the src folder, and select New/Other/Groovy/Groovy Class
- Create a new Groovy class called GTest,
- or alternatively create a new plain file and give it the name of the class you want to create plus the .groovy extension
- When prompted "Add runtime groovy support and auto-build to project?" , click Yes! (You may be prompted that question twice... always say Yes!)
- You can paste the following snippet into the GTest.groovy editor:
- In the Project Explorer, select GTest.groovy, then right mouse-click and Run/Run
- In the Run pop-up, select Groovy in the list of configurations, then click New, and click the Search button to search for the Main Class.
The GTest class should appear in the list of Groovy classes to run. Select it and click OK.
- Click Apply, then Run... check your console view, it should read Rod, Phil...
YOU ARE REALLY DONE!
For more code examples to play with, you can check also the Groovy Home page, or check some recent fine articles published here and there:
- 2004-09-29 - Groovy, Java's New Scripting Language
- 2004-09-28 - The New Bloglines Web Services
- visit Marc Hedlund's page, an avid Groovy blogger
- check justgroovy.org
- give a shot to Biscuit http://biscuit.javanicus.com/
- ... and also search the web for Groovy snippets
- A site update page has been built on http://vivelafrique.org/GroovySite. I have only tested it with Eclipse 3.0.2. Just copy and paste that URL into the URL location when adding a new Update Site in Eclipse.
Some known problesm...
- When you create a new run configuration, it doesn't automatically find the class that you select in the package explorer or navigator. You have to enter the name of the class manually, or select browse.