directory to artifact name mapping

[Reto Bachmann-Gmür <re...@apache.org>]

I've just resolved STANBOL-843 which required some artifacts to be renamed.

Also I've seen that the directory ldtemplaterenderer has been renamed to
ldpathtemplate in r1420603 to match the naming in the pom.

This raises two point:
- Are there strict rules on the artifact-id to directory mapping?
- "ldpathtemplate" as a name might be a bit misleading as one might expect
a working bundleization of ldpathtemplate but in fact it's a service
rendering graphnodes using ldpathtemplate. So maybe it would be better to
rename the artifact.

Cheers,
Reto

Re: directory to artifact name mapping

[Reto Bachmann-Gmür <re...@apache.org>]

another option would be to define a special case for directory name "core"
that this need not to be part of the artifact name. so that we could have

commons/web/base/core -> commons.web.base
commons/web/base/jersey -> commons.web.base.jersey

The counterpart could be the convention that the artifact suffix "parent"
need not be matched by a folder name which can be handy if for some modules
you wan to have parent and reactor in one.

Cheers,
Reto



On Wed, Dec 19, 2012 at 6:12 AM, Rupert Westenthaler <
rupert.westenthaler@gmail.com> wrote:

> On Tue, Dec 18, 2012 at 10:11 PM, Fabian Christ
> <ch...@googlemail.com> wrote:
> > I have also seen directories with a dot "." in the name like
> "base.jersey".
> > I have not see such a use of dots in directory names before and to me
> this
> > is also a bit confusing. Maybe because of the Java convention using the
> dot
> > as a package / directory splitter.
>
> There are some examples where a '.' in the artifact id is mapped to an
> '-' in the svn path. In addition typically the {framework-name} is in
> front of the {module-role}.
> I think the first module using this template was the "opennlp-ner"
> EnhancementEngine.
>
> If we apply this to the /commons/web/base.jersey than the module path
> would be renamed to "jersey-base" and also the artifact id and
> packages would swap the last two elements. However for me it would be
> also fine if we just rename the folder from "base.jersey" to
> "base-jersey"
>
> best
> Rupert
>
> --
> | Rupert Westenthaler             rupert.westenthaler@gmail.com
> | Bodenlehenstraße 11                             ++43-699-11108907
> | A-5500 Bischofshofen
>

Re: directory to artifact name mapping

[Rupert Westenthaler <ru...@gmail.com>]

On Tue, Dec 18, 2012 at 10:11 PM, Fabian Christ
<ch...@googlemail.com> wrote:
> I have also seen directories with a dot "." in the name like "base.jersey".
> I have not see such a use of dots in directory names before and to me this
> is also a bit confusing. Maybe because of the Java convention using the dot
> as a package / directory splitter.

There are some examples where a '.' in the artifact id is mapped to an
'-' in the svn path. In addition typically the {framework-name} is in
front of the {module-role}.
I think the first module using this template was the "opennlp-ner"
EnhancementEngine.

If we apply this to the /commons/web/base.jersey than the module path
would be renamed to "jersey-base" and also the artifact id and
packages would swap the last two elements. However for me it would be
also fine if we just rename the folder from "base.jersey" to
"base-jersey"

best
Rupert

--
| Rupert Westenthaler             rupert.westenthaler@gmail.com
| Bodenlehenstraße 11                             ++43-699-11108907
| A-5500 Bischofshofen

Re: directory to artifact name mapping

[Fabian Christ <ch...@googlemail.com>]

Hi,

the directory name should fit the artifact name. Otherwise it is just
confusing when searching in the code tree for the artifact. That's why I
did the renaming of "ldpathtemplate" because the artifact was named like
this.

I have also seen directories with a dot "." in the name like "base.jersey".
I have not see such a use of dots in directory names before and to me this
is also a bit confusing. Maybe because of the Java convention using the dot
as a package / directory splitter.

It is always a good idea to ask the community for naming suggestions if
unsure about the name before bringing it in the code base.

Best,
 - Fabian


2012/12/18 Reto Bachmann-Gmür <re...@apache.org>

> I've just resolved STANBOL-843 which required some artifacts to be renamed.
>
> Also I've seen that the directory ldtemplaterenderer has been renamed to
> ldpathtemplate in r1420603 to match the naming in the pom.
>
> This raises two point:
> - Are there strict rules on the artifact-id to directory mapping?
> - "ldpathtemplate" as a name might be a bit misleading as one might expect
> a working bundleization of ldpathtemplate but in fact it's a service
> rendering graphnodes using ldpathtemplate. So maybe it would be better to
> rename the artifact.
>
> Cheers,
> Reto
>



-- 
Fabian
http://twitter.com/fctwitt