Conventions

dwdyer edited this page Aug 14, 2010 · 4 revisions

The Uncommons Antlib assumes that the project is divided into modules, each with its own directory in the project tree. A module is a self-contained piece of the project that, when built, produces an artifact (typically a JAR file, WAR file, or similar). Uncommons Antlib assumes that each module directory is arranged according to certain conventions. This assumption greatly simplifies build scripts as it is not necessary to inform the various macros where to find the required files.

Project Directory Layout

The project directory layout is like this (directories in [square brackets] are generated by the macros, directories marked with an asterisk are optional):

    <projectdir>
        <module1>
        <module2>
        <module3>
        lib
          compiletime
          runtime
        [docs]
            [api]
            [test-results]
            [coverage]

You should place the Uncommons Antlib files under lib/compiletime.

Module Directory Layout

And each module directory like this:

    <moduledir>
        lib*
          compiletime
          runtime
        src
            java
                main
                resources*
                test
                test-resources*
        [build]
            [classes]
            [generated]
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.