Skip to content

Getting started

Jump to bottom
Alexandr Evstigneev edited this page Aug 4, 2015 · 11 revisions

#Installation

  • Install IntelliJ IDEA from JetBrains site (you may also use other JB IDE).
  • Go to Settings -> Plugins -> Browse repository and install Camelcade plugin
  • Restart IDEA
  • Before starting, please, check out the list of implemented features and known issues.

Creating and configuring project

Choose File -> New -> Project:

Creating new project

Open project structure:

Opening Project structure

Goto Platform Settings -> SDK and choose add Perl Interpreter:

Add Perl5 interpreter into IDEA

In opened directory choosing dialog you should select a bin directory where perl executable is located. Usually, this directory is already selected in opened dialog. Click Ok.

If everything went right, you'll see Perl interpreter string and classpaths will be filled with Perl's @INC paths:

Added Perl5 interpreter

If paths were not added automatically, you may add them manually. Don't forget to report the problem into our issue tracker (specify IDE name, version and your OS).

After that, go to Project tab and choose added Perl Interpreter there:

Choosing project SDK

#Creating and configuring a module

Go to Modules tab and choose Add: New Module:

Adding a module

In opened dialog choose Perl5 module:

Choosing module type

Type module name, choose content root and module file (iml) location:

Choosing module name and paths

Choose added Perl Interpreter:

Choosing module SDK

If you've done everything right, you'll see something like this:

Properly created module

Here you may mark directories of your module as Sources and Tests. Also you may Exclude some directories to avoid searching sources in there:

Marking directories as source, tests. Excluding some of them.

To let Camelcade search for package files, you should add your lib directory (what you are doing with -I parameter of Perl interpreter). On the Dependencies tab, choose Add -> JARs or directories... and select your lib directory:

Adding project's lib directory

Remember, all packages being resolved relatively to one of the lib dirs: module or SDK-specific.

In opened directory type dialog choose Classes:

Choosing lib directory type

Move your module lib directory above the SDK's one. Otherwise, Camelcade may find package in Perl's lib path if module is already installed:

Moving library up into resolution order

#How should it look like

If everything was done right, you'll see a similar picture:

  • You module
  • Colorized directories of your module (depending on type)
  • Your lib directory will have annotation library home

Configured project

Enjoy!

Clone this wiki locally