Need explanation for forge addon folder structure

[mani_mylavarapu]

I always have a doubt that why does a forge addon folder structure is something like

• addon
• impl
• api
• tests

what is the relation between each other.And when we install addon why do we have to run install command on addon folder.Is there any meaning behind it?Please brief me about this folder structure.

Thanks.

[alwad]

Hello Mani,

AFAIK, you can run the install command from any directory as long as you specify the project root of your addon.

I presume the main point is because this is where the pom is.

Cheers,

Jérôme

[mani_mylavarapu]

Hi Jerome,

                 Thank you!But i would also be interested to know why forge addon structure is like this.

[gastaldi]

Hello Mani,

Here is an explanation of each module and their relationship:

• addon: The addon project. This module should depend on api (and spi if available) in compile time and impl in runtime. The artifact produced by this project should be a JAR with the classifier forge-addon
• api: any artifact that is supposed to be exposed by your addon.
• impl: this is where the implementation of your API lies and they should never be accessed externally.
• spi (when feasible): Use a SPI when you want other addons to provide extensions for your addon.
• tests: This is where the integration tests are kept.

[mani_mylavarapu]

Thank you for clarifying.I always had this doubt!!