Missing documentation details in IntelliJ Platform SDK DevGuide

Hi all

I'm reading out your dev guide for creating plugins but I think there are missing bits and pieces that let me to confusion.
In the Custom Language Support -> Language and File Type page, points from 2.1 to 2.4 shows the creation of a bunch of classes but it never tells where those should be created.
The screenshot provided in point 2.6 shows the project structure but the class files just mentioned are not shown in there.

Where should we create the classes as explained in the tutorial?
Could you please clarify paths, etc when dealing with code components throughout the various wikis so not have implementors guess the location of these components?

11 comments
Comment actions Permalink

I'd have an update. On the page following to the one mentioned above there's a screenshots that shows the classes initially mentioned, so that helped clarifying a bit but I still think that no assumption should be made in the documentation so to ease the understanding process for new starters.

0
Comment actions Permalink

Hi Walter,


package com.simpleplugin;

so in your custom plugin project
under src

add folders:
com
simpleplugin (or another folder of your choice)

the example files go right there

the reason the created files do not appear in 2.6 Run the project is:
this is test project opened in a new window, using your plugin, not the plugin project.

;)

0
Comment actions Permalink

The platform SDK documentation assumes basic familiarity with Java development in IntelliJ IDEA. If you've never created a Java project in IntelliJ IDEA, you can find other sources of information showing you how the project configuration process works.

0
Comment actions Permalink

auUMJMC3e wrote:

add folders:
com
simpleplugin (or another folder of your choice)


Do you mean:

com
|__ simpleplugin

Or do you mean:

_ com.simpleplugin (as shown in the last page I mentioned)

?

auUMJMC3e wrote:
 
the reason the created files do not appear in 2.6 Run the project is:
this is test project opened in a new window, using your plugin, not the plugin project.

;)


I'm not sure what you mean here.
I'm working directly on my plugin by reading the documentation. So instead of actually implementing the example plugin (com.simpleplugin) I'm doing it directly with mine (say, com.myfirstplugin).

Thanks!

0
Comment actions Permalink

yole wrote:

The platform SDK documentation assumes basic familiarity with Java development in IntelliJ IDEA. If you've never created a Java project in IntelliJ IDEA, you can find other sources of information showing you how the project configuration process works.


Thanks, Dmitry. No, I'm not familiar with Java development in IntelliJ IDEA yet. I mostly work with PHP and this would be my first plugin for PhpStorm :)

0
Comment actions Permalink

> Do you mean:

com
|__ simpleplugin


yes:

add folder com under src
add folder myfirstplugin under src/com

now all files added to folder myfirstplugin should be automatically placed in package com.myfirstplugin




> instead of actually implementing the example plugin (com.simpleplugin) I'm doing it directly with mine (say, com.myfirstplugin).

well once your plugin is ready, you are going to package, install it, then start using it on other projects. Once you start using plugin, you will no longer see plugin code, only your non-plugin project code. The plugin will go behind the scenes.

in the same vein we do not see Idea code or other plugin code anywhere. Only the code we work on.

example 2.6 shows the other (non-plugin project) window opened (via either run or debug button) from the project where you work on your own plugin (com.myfirstplugin).

0
Comment actions Permalink

Thanks Imants, that's helpul info. Just getting used to the practices and processes applied around Jetbrains related products development ;)

0
Comment actions Permalink

Will have a look. Thanks!

0
Comment actions Permalink

The easiest way to get started with plugins is to take the SimplePlugin Project which has recently moved to: https://github.com/JetBrains/intellij-sdk-docs/tree/master/code_samples/simple_language_plugin and get that to compile and run. You can make changes and see if the result is what you would expect.

At least you know the code works and it will work it is only a matter of getting the basic project/module configuration right.

I still refer to the simple plugin once in a while for a sanity check or as a base for experimentation.

I highly recommend starting with a project that already works and getting your feet wet that way. Play with it, set break points, explore the dynamic nature of the environment.

0

Please sign in to leave a comment.